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

Operations about Server

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

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

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

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

7 operations 4 paths 21 schemas 1 DELETE3 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 Server 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 7

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

Server 7

Operations about Server

GET
/v1/server
Get a list of servers
→ 200
POST
/v1/server
Create server
1 param → 200
GET
/v1/server/{name}
Show server
1 param → 200
PATCH
/v1/server/{name}
Update server
2 params → 200
DELETE
/v1/server/{name}
Delete the server
1 param → 200
PATCH
/v1/server/{name}/role/{role}
Update server role groups
3 params → 200
GET
/v1/server/{name}/user
Show server user list
1 param → 200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are RESTUser (20 properties), RESTServerLDAP (14 properties), RESTServerLDAPConfig (14 properties), RESTServerSAMLConfig (13 properties). Each schema is shown below with its type and property counts.

RESTServerData
object
1 property 1 required
RESTServerOIDCConfig
object
10 properties 5 required
RESTServer
object
5 properties 2 required
RESTServerConfig
object
4 properties 1 required
RESTPermitsAssigned
object
2 properties
RESTMappableRoles
object
3 properties 3 required
RESTServerOIDC
object
13 properties 9 required
RESTServerSAMLConfig
object
13 properties 3 required
RESTServerSAML
object
12 properties 5 required
RESTServerLDAP
object
14 properties 11 required
RESTServerRoleGroupsConfig
object
3 properties 3 required
RESTServerConfigData
object
1 property 1 required
RESTUser
object
20 properties 15 required
RESTServerLDAPConfig
object
14 properties
RESTRemoteRolePermits
object
4 properties 1 required
RESTServersData
object
2 properties 1 required
RESTX509CertInfo
object
4 properties
RESTServerRoleGroupsConfigData
object
1 property 1 required
RESTRolePermission
object
3 properties 3 required
GroupRoleMapping
object
3 properties 2 required
RESTUsersData
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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