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

Operations about Vulnerability management

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

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

This API exposes 6 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 2.0, at version 5.6.0.

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

6 operations 4 paths 7 schemas 1 DELETE2 GET2 PATCH1 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 Vulnerability 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 6

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

Vulnerability 6

Operations about Vulnerability management

GET
/v1/vulnerability/profile
Get vulnerability profile list
→ 200
GET
/v1/vulnerability/profile/{name}
Get vulnerability profile detail
1 param → 200
PATCH
/v1/vulnerability/profile/{name}
Configure vulnerability profile
2 params → 200
POST
/v1/vulnerability/profile/{name}/entry
Create the vulnerability profile entry
2 params → 200
PATCH
/v1/vulnerability/profile/{name}/entry/{id}
Configure vulnerability profile entry
3 params → 200
DELETE
/v1/vulnerability/profile/{name}/entry/{id}
Delete vulnerability profile entry
2 params → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are RESTVulnerabilityProfileEntry (6 properties), RESTVulnerabilityProfile (3 properties), RESTVulnerabilityProfileConfig (2 properties), RESTVulnerabilityProfileEntryConfigData (1 property). Each schema is shown below with its type and property counts.

RESTVulnerabilityProfilesData
object
1 property 1 required
RESTVulnerabilityProfileData
object
1 property 1 required
RESTVulnerabilityProfileConfigData
object
1 property 1 required
RESTVulnerabilityProfileEntry
object
6 properties 6 required
RESTVulnerabilityProfileEntryConfigData
object
1 property 1 required
RESTVulnerabilityProfileConfig
object
2 properties 1 required
RESTVulnerabilityProfile
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neuvector-vulnerability-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 Container API
NeuVector Controller API
NeuVector DLP API
NeuVector Enforcer API
NeuVector EULA API
NeuVector Federation API