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

Operations about Service

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

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

Service 6

Operations about Service

GET
/v1/service
Get a list of services
→ 200
POST
/v1/service
Create service
1 param → 200
GET
/v1/service/{name}
Show service
1 param → 200
PATCH
/v1/service/config
Configure service
1 param → 200
PATCH
/v1/service/config/network
Configure services in batch
1 param → 200
PATCH
/v1/service/config/profile
Configure services in batch
1 param → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are RESTWorkloadBrief (29 properties), RESTService (16 properties), RESTPolicyRule (15 properties), RESTScanBrief (9 properties). Each schema is shown below with its type and property counts.

RESTServiceConfig
object
6 properties 3 required
RESTServiceBatchConfigData
object
1 property 1 required
RESTServicesData
object
1 property 1 required
RESTPolicyRule
object
15 properties 15 required
RESTIPPort
object
2 properties 2 required
RESTScanBrief
object
9 properties 9 required
RESTWorkloadBrief
object
29 properties 25 required
RESTServiceData
object
1 property 1 required
RESTResponseRule
object
9 properties 9 required
RESTCLUSEventCondition
object
2 properties
RESTServiceConfigData
object
1 property 1 required
RESTService
object
16 properties 13 required
RESTServiceBatchConfig
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neuvector-service-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