How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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 3.2.0, at version 5.6.0.

Requests are made against a single 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 3.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
body → 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.)
body → 200
GET
/v1/system/alerts
System alerts
→ 200
POST
/v1/system/config/webhook
Create system webhook
body → 200
PATCH
/v1/system/config/webhook/{name}
Configure system webhook
2 params body → 200
DELETE
/v1/system/config/webhook/{name}
Delete system webhook
2 params → 200
POST
/v1/system/request
System request
body → 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.

RESTNvAlerts
object
3 properties
RESTSystemRequestData
object
1 property 1 required
RESTNvAcceptableAlerts
object
7 properties
RESTCheckUpgradeInfo
object
2 properties
RESTSystemConfigNetSvcV2
object
5 properties 5 required
RESTNvAlert
object
2 properties
RESTRemoteRepository
object
5 properties 3 required
RESTSystemConfigDataV2
object
2 properties
RESTProxy
object
Define proxy settings.
3 properties 2 required
RESTSysAtmoConfigConfig
object
4 properties
RESTUpgradeInfo
object
3 properties
RESTSystemConfigModeAutoV2
object
4 properties 4 required
RESTSystemConfigProxyV2
object
6 properties 4 required
RESTScoreMetricsData
object
4 properties
RESTSystemConfigAuthCfgV2
object
3 properties
RESTFedSystemConfigConfig
object
1 property
RESTSystemConfigAuthV2
object
3 properties 3 required
RESTSystemConfigIBMSAV2
object
4 properties 4 required
RESTExposedEndpoint
object
15 properties
RESTSystemConfigConfigDataV2
object
it leverages RESTSystemConfigConfigData in apis.go
4 properties
RESTSecurityScores
object
11 properties
RESTSystemConfigTls
object
2 properties
RESTSystemConfig
object
40 properties 37 required
RESTSystemConfigConfig
object
31 properties
RESTSystemConfigData
object
2 properties
RESTSystemConfigAutoscaleConfig
object
3 properties
RESTRemoteRepo_GitHubConfig
object
6 properties 6 required
RESTComplianceProfileConfig
object
3 properties 1 required
RESTSysNetConfigConfig
object
5 properties
RESTSystemConfigV2
object
11 properties 10 required
RESTSystemSummary
object
16 properties 16 required
RESTSystemConfigMiscCfgV2
object
6 properties
RESTNvAlertGroup
object
2 properties
RESTSystemConfigProxyCfgV2
object
6 properties
RESTSystemConfigNewSvcV2
object
2 properties 2 required
RESTSystemConfigAutoscale
object
3 properties 3 required
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
RESTSystemConfigSyslogCfgV2
object
11 properties
RESTComplianceProfileEntry
object
2 properties 2 required
RESTSystemConfigSvcCfgV2
object
2 properties
RESTSystemSummaryData
object
1 property 1 required
RESTUnquarReq
object
2 properties
RESTSystemWebhookConfigData
object
1 property 1 required
RESTFedSystemConfig
object
1 property 1 required
RESTConversationReportEntry
object
9 properties
RESTWebhook
object
6 properties 6 required
RESTSystemConfigConfigV2
object
10 properties
RESTSystemConfigMiscV2
object
9 properties 7 required
RESTSystemRequest
object
3 properties
RESTSystemConfigSyslogV2
object
11 properties 11 required
RESTSystemConfigConfigData
object
it leverages RESTSystemConfigConfigData in apis.go
4 properties
RESTSystemConfigIBMSAVCfg2
object
2 properties

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
Where this information came from

This is an independent, third-party profile of NeuVector System API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.