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

Operations about System

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

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

This API exposes 11 operations across 8 paths, and defines 52 schemas. It is described by OpenAPI 2.0, at version 5.6.0.

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

11 operations 8 paths 52 schemas 1 DELETE5 GET3 PATCH2 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 System 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 11

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

System 11

Operations about System

GET
/v1/system/summary
System summary
→ 200
GET
/v1/system/config
System get configure
1 param → 200
PATCH
/v1/system/config
System configure
1 param → 200
GET
/v2/system/config
Get system configuration (starting from 5.0, rest client should call this api.)
1 param → 200
PATCH
/v2/system/config
System configure (starting from 5.0, rest client should call this api.)
1 param → 200
GET
/v1/system/alerts
System alerts
→ 200
POST
/v1/system/config/webhook
Create system webhook
1 param → 200
PATCH
/v1/system/config/webhook/{name}
Configure system webhook
3 params → 200
DELETE
/v1/system/config/webhook/{name}
Delete system webhook
2 params → 200
POST
/v1/system/request
System request
1 param → 200
GET
/v1/system/score/metrics
Get system score metrics data
→ 200

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are RESTSystemConfig (40 properties), RESTSystemConfigConfig (31 properties), RESTSystemSummary (16 properties), RESTExposedEndpoint (15 properties). Each schema is shown below with its type and property counts.

RESTSystemConfigConfig
object
31 properties
RESTSystemConfigAutoscale
object
3 properties 3 required
RESTSysNetConfigConfig
object
5 properties
RESTSysAtmoConfigConfig
object
4 properties
RESTExposedEndpoint
object
15 properties
RESTConversationReportEntry
object
9 properties
RESTSystemConfigTls
object
2 properties
RESTSystemConfigProxyV2
object
6 properties 4 required
RESTSystemConfigSyslogCfgV2
object
11 properties
RESTSystemConfigConfigDataV2
object
it leverages RESTSystemConfigConfigData in apis.go
4 properties
RESTSystemConfigMiscCfgV2
object
6 properties
RESTSystemConfigAuthCfgV2
object
3 properties
RESTSystemConfigIBMSAV2
object
4 properties 4 required
RESTSystemConfig
object
40 properties 37 required
RESTSystemConfigNetSvcV2
object
5 properties 5 required
RESTSecurityScores
object
11 properties
RESTSystemRequestData
object
1 property 1 required
RESTSystemConfigAutoscaleConfig
object
3 properties
RESTSystemConfigConfigData
object
it leverages RESTSystemConfigConfigData in apis.go
4 properties
RESTSystemWebhookConfigData
object
1 property 1 required
RESTUnquarReq
object
2 properties
RESTSystemConfigSvcCfgV2
object
2 properties
RESTSystemConfigProxyCfgV2
object
6 properties
RESTNvAlert
object
2 properties
RESTNvAlertGroup
object
2 properties
RESTSystemConfigNewSvcV2
object
2 properties 2 required
RESTSystemConfigMiscV2
object
9 properties 7 required
RESTFedSystemConfigConfig
object
1 property
RESTComplianceProfileEntry
object
2 properties 2 required
RESTSystemConfigAuthV2
object
3 properties 3 required
RESTSystemConfigDataV2
object
2 properties
RESTUpgradeInfo
object
3 properties
RESTNvAlerts
object
3 properties
RESTScoreMetricsData
object
4 properties
RESTSystemConfigModeAutoV2
object
4 properties 4 required
RESTWebhook
object
6 properties 6 required
RESTFedSystemConfig
object
1 property 1 required
RESTProxy
object
Define proxy settings.
3 properties 2 required
RESTSystemRequest
object
3 properties
RESTProxyConfig
object
Define proxy settings, similar to RESTProxy, but allow users to perform partial update on RESTProxy. When both exist, this config will take precedence over RES…
3 properties 2 required
RESTSystemConfigV2
object
11 properties 10 required
RESTSystemConfigData
object
2 properties
RESTSystemConfigConfigV2
object
10 properties
RESTSystemConfigIBMSAVCfg2
object
2 properties
RESTComplianceProfileConfig
object
3 properties 1 required
RESTRemoteRepo_GitHubConfig
object
6 properties 6 required
RESTCheckUpgradeInfo
object
2 properties
RESTNvAcceptableAlerts
object
7 properties
RESTSystemSummary
object
16 properties 16 required
RESTSystemSummaryData
object
1 property 1 required
RESTSystemConfigSyslogV2
object
11 properties 11 required
RESTRemoteRepository
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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