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 Compliance API

Operations about Compliance

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

Tagged areas include Compliance. 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 7 paths, and defines 15 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 7 paths 15 schemas 1 DELETE6 GET3 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 Compliance 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 7 paths, the API surfaces 12 operations — 1 DELETE, 6 GET, 3 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Compliance 12

Operations about Compliance

GET
/v1/bench/host/{id}/docker
Docker bench
1 param → 200
POST
/v1/bench/host/{id}/docker
Docker bench run
1 param → 200
GET
/v1/bench/host/{id}/kubernetes
Kubernetes bench
1 param → 200
POST
/v1/bench/host/{id}/kubernetes
Kubernetes bench run
1 param → 200
GET
/v1/compliance/profile
Get compliance profile list
→ 200
GET
/v1/compliance/profile/{name}
Get compliance profile detail
1 param → 200
PATCH
/v1/compliance/profile/{name}
Configure compliance profile
2 params → 200
PATCH
/v1/compliance/profile/{name}/entry/{check}
Configure compliance profile entry
3 params → 200
DELETE
/v1/compliance/profile/{name}/entry/{check}
Delete compliance profile entry
2 params → 200
GET
/v1/custom_check
Get custom check scripts of all groups
→ 200
GET
/v1/custom_check/{group}
GET custom check scripts of the specified group
1 param → 200
PATCH
/v1/custom_check/{group}
Update custom check scripts of the specified group
2 params → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are RESTBenchItem (11 properties), RESTCustomChecks (4 properties), RESTComplianceProfile (4 properties), RESTBenchReport (4 properties). Each schema is shown below with its type and property counts.

RESTComplianceProfileEntryConfigData
object
1 property 1 required
RESTCustomCheck
object
2 properties 2 required
RESTBenchItem
object
11 properties 11 required
RESTComplianceProfileConfig
object
3 properties 1 required
RESTCustomCheckData
object
1 property 1 required
RESTCustomCheckConfig
object
3 properties 3 required
RESTCustomCheckListData
object
1 property 1 required
RESTComplianceProfileConfigData
object
1 property 1 required
RESTCustomCheckConfigData
object
1 property 1 required
RESTComplianceProfileData
object
1 property 1 required
RESTComplianceProfilesData
object
1 property 1 required
RESTCustomChecks
object
4 properties 2 required
RESTComplianceProfile
object
4 properties 3 required
RESTComplianceProfileEntry
object
2 properties 2 required
RESTBenchReport
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neuvector-compliance-api-openapi.yml Raw ↑

Other APIs NeuVector publishes across the network.

NeuVector Admission API
NeuVector Apikey API
NeuVector Authentication 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 Container API
NeuVector Controller API
NeuVector DLP API
NeuVector Enforcer API
NeuVector EULA API
NeuVector Federation API
NeuVector File API