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

The Apikey API from NeuVector — 2 operation(s) for apikey.

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

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

This API exposes 4 operations across 2 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.

4 operations 2 paths 7 schemas 1 DELETE2 GET1 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 Apikey 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 4

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

Apikey 4
GET
/v1/api_key
Gets a list of apikeys
→ 200
POST
/v1/api_key
Creates an apikey
1 param → 200
GET
/v1/api_key/{accesskey}
Gets an apikey
1 param → 200
DELETE
/v1/api_key/{accesskey}
Delete apikey
1 param → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are RESTApikey (10 properties), RESTApikeyCreation (6 properties), RESTApikeysData (3 properties), RESTApikeyGenerated (2 properties). Each schema is shown below with its type and property counts.

RESTApikeyData
object
1 property 1 required
RESTApikey
object
10 properties 3 required
RESTApikeysData
object
3 properties 3 required
RESTApikeyCreationData
object
1 property 1 required
RESTApikeyGeneratedData
object
1 property 1 required
RESTApikeyCreation
object
6 properties 3 required
RESTApikeyGenerated
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neuvector-apikey-api-openapi.yml Raw ↑

Other APIs NeuVector publishes across the network.

NeuVector Admission 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
NeuVector File API