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

Operations about Group

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

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

This API exposes 5 operations across 2 paths, and defines 16 schemas. It is described by OpenAPI 2.0, at version 5.6.0.

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

5 operations 2 paths 16 schemas 1 DELETE2 GET1 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 Group 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 5

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

Group 5

Operations about Group

GET
/v1/group
Get a list of groups
1 param → 200
POST
/v1/group
Create group
1 param → 200400
GET
/v1/group/{name}
Show group
1 param → 200
PATCH
/v1/group/{name}
Update group
2 params → 200
DELETE
/v1/group/{name}
Delete group
1 param → 200

Schemas 16

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

RESTPwdProfileBasic
object
5 properties 5 required
RESTGroup
object
13 properties 12 required
RESTGroupData
object
1 property 1 required
RESTError
object
5 properties 3 required
RESTGroupDetail
object
18 properties 17 required
RESTPolicyRule
object
15 properties 15 required
RESTScanBrief
object
9 properties 9 required
RESTCriteriaEntry
object
3 properties 3 required
RESTWorkloadBrief
object
29 properties 25 required
RESTResponseRule
object
9 properties 9 required
RESTImportTaskData
object
1 property 1 required
RESTCLUSEventCondition
object
2 properties
RESTImportTask
object
8 properties 3 required
RESTGroupConfig
object
3 properties 2 required
RESTGroupsData
object
1 property 1 required
RESTGroupConfigData
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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