Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NeuVector Container API

Operations about Container

NeuVector Container API is one of 31 APIs that NeuVector publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Container. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and an API reference.

This API exposes 12 operations across 10 paths, and defines 32 schemas. It is described by OpenAPI 2.0, at version 5.6.0.

Requests are made against the base URL https://localhost:10443.

12 operations 10 paths 32 schemas 9 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
5.6.0
Base URL
https://localhost:10443
Authentication
API Key, API Key
License
Resource Areas
1

Authentication & Security 2

NeuVector Container API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Auth-Apikey (ApiKeyAuth). An API key is passed in the header as X-Auth-Token (TokenAuth).

Paths & Operations 12

Across 10 paths, the API surfaces 12 operations — 9 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Container 12

Operations about Container

GET
/v1/workload
Get container list
→ 200
GET
/v2/workload
Get container list (starting from 5.0, rest client should call this api.)
→ 200
POST
/v2/workload
Get container list that match the provided ID list
1 param → 200
GET
/v1/workload/{id}
Get container detail
1 param → 200
PATCH
/v1/workload/{id}
Update Container
2 params → 200
GET
/v2/workload/{id}
Get container detail (starting from 5.0, rest client should call this api.)
1 param → 200
GET
/v1/workload/{id}/stats
get container stats
1 param → 200
GET
/v1/workload/{id}/config
Get a container configure
1 param → 200
GET
/v1/workload/{id}/process
Get a container process
1 param → 200400
GET
/v1/workload/{id}/process_history
Get a container process history
1 param → 200
GET
/v1/workload/{id}/compliance
Get a container compliance report
1 param → 200
POST
/v1/workload/request/{id}
Container request
2 params → 200

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are RESTWorkload (42 properties), RESTWorkloadDetail (33 properties), RESTWorkloadBriefV2 (15 properties), RESTWorkloadDetailV2 (14 properties). Each schema is shown below with its type and property counts.

RESTWorkloadV2
object
13 properties 13 required
RESTWorkloadStatsData
object
3 properties 3 required
RESTAssetIDList
object
1 property 1 required
RESTWorkloadConfigData
object
1 property 1 required
RESTWorkloadRequest
object
1 property
RESTWorkloadsDataV2
object
1 property 1 required
RESTProcessList
object
1 property 1 required
RESTWorkload
object
42 properties 39 required
RESTWorkloadDetailMiscV2
object
3 properties 3 required
RESTPwdProfileBasic
object
5 properties 5 required
RESTWorkloadConfig
object
3 properties 1 required
RESTWorkloadDetailDataV2
object
1 property 1 required
RESTWorkloadRtAttribesV2
object
12 properties 11 required
RESTWorkloadBriefV2
object
15 properties 13 required
RESTWorkloadDetailV2
object
14 properties 14 required
RESTImportTaskData
object
1 property 1 required
RESTWorkloadSecurityV2
object
10 properties 9 required
RESTStats
object
5 properties 5 required
RESTImportTask
object
8 properties 3 required
RESTBenchItem
object
11 properties 11 required
RESTIPAddr
object
3 properties 3 required
RESTWorkloadRequestData
object
1 property 1 required
RESTProcessProfileEntry
object
10 properties 6 required
RESTWorkloadPorts
object
4 properties 4 required
RESTMetry
object
10 properties 8 required
RESTComplianceData
object
6 properties 6 required
RESTWorkloadDetail
object
33 properties 30 required
RESTProcessInfo
object
11 properties 11 required
RESTError
object
5 properties 3 required
RESTScanBrief
object
9 properties 9 required
RESTWorkloadDetailData
object
1 property 1 required
RESTWorkloadsData
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neuvector-container-api-openapi.yml Raw ↑

Other APIs NeuVector publishes across the network.

NeuVector Admission API
NeuVector Apikey API
NeuVector Authentication API
NeuVector Compliance API
NeuVector compliance profile. The payload body is the content of the compliance profile yaml file. API
NeuVector compliance profile. The payload body is the content of the vulnerability profile yaml file. API
NeuVector Controller API
NeuVector DLP API
NeuVector Enforcer API
NeuVector EULA API
NeuVector Federation API
NeuVector File API