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

Operations about Policy

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

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

Policy 7

Operations about Policy

GET
/v1/policy/rule
Get a list of policy rules
1 param → 200
PATCH
/v1/policy/rule
Policy rule action
2 params → 200
DELETE
/v1/policy/rule
Delete all policy rules
1 param → 200
GET
/v1/policy/rule/{id}
Show policy rule
1 param → 200400404
PATCH
/v1/policy/rule/{id}
Update policy rule
2 params → 200
DELETE
/v1/policy/rule/{id}
Delete policy rule
1 param → 200
POST
/v1/policy/rules/promote
Promote policy
1 param → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are RESTPolicyRule (15 properties), RESTPolicyRuleConfig (10 properties), RESTImportTask (8 properties), RESTError (5 properties). Each schema is shown below with its type and property counts.

RESTPwdProfileBasic
object
5 properties 5 required
RESTPolicyRuleConfig
object
10 properties 2 required
RESTPolicyRuleInsert
object
2 properties 1 required
RESTPolicyRuleData
object
1 property 1 required
RESTPolicyRulesData
object
1 property 1 required
RESTError
object
5 properties 3 required
RESTPolicyRuleActionData
object
4 properties
RESTPolicyRule
object
15 properties 15 required
RESTPolicyRuleMove
object
2 properties 1 required
RESTPolicyPromoteRequestData
object
1 property 1 required
RESTImportTaskData
object
1 property 1 required
RESTPolicyPromoteRequest
object
1 property 1 required
RESTImportTask
object
8 properties 3 required
RESTPolicyRuleConfigData
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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