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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
NeuVector

NeuVector Scan API

Operations about Scan

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 40 operations across 26 paths, and defines 63 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/.

40 operations 26 paths 63 schemas 4 DELETE20 GET5 PATCH11 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
Contact
support@neuvector.com
License
Apache 2.0
Resource Areas
1

Authentication & Security 2

NeuVector Scan 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 40

Across 26 paths, the API surfaces 40 operations — 4 DELETE, 20 GET, 5 PATCH, 11 POST. Each is listed below with its method, path, parameters, and response codes.

Scan 40

Operations about Scan

GET
/v1/scan/scanner
Get scanner list
→ 200
GET
/v1/scan/config
Retrieve scan configuration, including global auto-scan settings and fine-grained controls for workloads and hosts.
→ 200
PATCH
/v1/scan/config
Auto-scan can be configured either globally or with fine-grained control for workloads and hosts. If any of the detailed control fields (enableautoscanworkload, enableautoscanhost) is explicitly prov…
body → 200
POST
/v1/scan/hosts/scan_report
Get hosts scan report
body → 200
GET
/v1/scan/host/{id}
Get host scan report
1 param → 200
POST
/v1/scan/host/{id}
Start host scan
1 param → 200
GET
/v1/scan/image
Get runtime scan summary by workload's images
→ 200
GET
/v1/scan/image/{id}
Get runtime scan report by workload's image ID
1 param → 200
GET
/v1/scan/platform
Show scan platform summary
→ 200
GET
/v1/scan/platform/platform
Show scan platform report
→ 200
POST
/v1/scan/platform/platform
Request scan platform
→ 200
GET
/v1/scan/registry
Get a list of registries
1 param → 200
POST
/v1/scan/registry
Create a registry
body → 200
POST
/v2/scan/registry
Create a registry
body → 200
GET
/v1/scan/registry/{name}
Show registry
1 param → 200
PATCH
/v1/scan/registry/{name}
Update registry
1 param body → 200
DELETE
/v1/scan/registry/{name}
Delete registry
1 param → 200
PATCH
/v2/scan/registry/{name}
Update registry
1 param body → 200
GET
/v1/scan/registry/{name}/images
Show registry image summary
1 param → 200
GET
/v1/scan/registry/{name}/image/{id}
Get registry image scan report
2 params → 200
GET
/v1/scan/registry/{name}/layers/{id}
Show registry layers report
2 params → 200
POST
/v1/scan/registry/{name}/scan
Start a registry scan
1 param → 200
DELETE
/v1/scan/registry/{name}/scan
Stop registry scan
1 param → 200
POST
/v1/scan/repository
Scan repository
body → 200
GET
/v1/scan/status
Scan status
→ 200
GET
/v1/scan/cache_stat/{id}
Get scanner cache statistic data
1 param → 200
GET
/v1/scan/cache_data/{id}
Get scanner cache index data
1 param → 200
GET
/v1/scan/workload/{id}
Get container scan report
1 param → 200
POST
/v1/scan/workload/{id}
Start container scan
1 param → 200
POST
/v1/scan/workloads/scan_report
Get containers scan report
body → 200
GET
/v1/scan/sigstore/root_of_trust
Get all sigstore roots of trust
→ 200
POST
/v1/scan/sigstore/root_of_trust
Create new sigstore root of trust
body → 200
GET
/v1/scan/sigstore/root_of_trust/{root_name}
Get single sigstore root of trust by name
1 param → 200
PATCH
/v1/scan/sigstore/root_of_trust/{root_name}
Update single sigstore root of trust by name
1 param body → 200
DELETE
/v1/scan/sigstore/root_of_trust/{root_name}
Delete single sigstore root of trust by name
1 param → 200
GET
/v1/scan/sigstore/root_of_trust/{root_name}/verifier
Get all sigstore verifiers for given sigstore root of trust
1 param → 200
POST
/v1/scan/sigstore/root_of_trust/{root_name}/verifier
Create new sigstore verifier for given sigstore root of trust
1 param body → 200
GET
/v1/scan/sigstore/root_of_trust/{root_name}/verifier/{verifier_name}
Get sigstore verifier by name under given sigstore root of trust
2 params → 200
PATCH
/v1/scan/sigstore/root_of_trust/{root_name}/verifier/{verifier_name}
Update sigstore verifier by name under given sigstore root of trust
2 params body → 200
DELETE
/v1/scan/sigstore/root_of_trust/{root_name}/verifier/{verifier_name}
Delete sigstore verifier by name under given sigstore root of trust
2 params → 200

Schemas 63

The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are RESTRegistrySummary (32 properties), RESTAssetScanData (26 properties), RESTRegistryConfig (23 properties), RESTRegistryImageSummary (21 properties). Each schema is shown below with its type and property counts.

RESTScanReportData
object
1 property 1 required
RESTScanner
object
5 properties 5 required
RESTScanCacheStat
object
4 properties 4 required
RESTRegistryConfigData
object
1 property 1 required
RESTAWSAccountKey
object
4 properties 2 required
RESTAssetsScanReportQuery
object
6 properties
RESTVulnerability
object
19 properties 16 required
REST_SigstoreRootOfTrustCollection
array
RESTRegistrySummaryListData
object
1 property 1 required
RESTScanRepoReport
object
17 properties 16 required
RESTRegistryImageSummary
object
21 properties 20 required
RESTScanReport
object
8 properties 1 required
RESTScanCacheRecord
object
4 properties 4 required
RESTScanSchedule
object
2 properties 2 required
RESTRegistryConfigScan
object
6 properties
RESTRegistryConfigV2
object
8 properties 2 required
RESTJfrogXray
object
4 properties 3 required
RESTScanImageSummary
object
13 properties 13 required
REST_SigstoreVerifierCollection
array
RESTBenchItem
object
11 properties 11 required
RESTScanPlatformSummary
object
12 properties 12 required
RESTScanRepoReqData
object
1 property 1 required
RESTScanReportCursor
object
5 properties
RESTScanModule
object
6 properties 3 required
RESTRegistryConfig
object
23 properties 2 required
RESTAWSAccountKeyConfig
object
4 properties
RESTAssetsScanReportFilter
object
3 properties 3 required
RESTRegistryConfigIntegrations
object
6 properties
RESTRegistrySummaryData
object
1 property 1 required
RESTRegistrySummary
object
32 properties 25 required
REST_SigstoreVerifier_PATCH
object
5 properties
REST_SigstoreRootOfTrust_PATCH
object
4 properties
RESTScanLayer
object
4 properties 4 required
RESTRegistryConfigAuth
object
6 properties
REST_SigstoreRootOfTrust_POST
object
7 properties 1 required
RESTScanSetIdPerm
object
3 properties 3 required
RESTScanLayersReportData
object
1 property 1 required
RESTScanImageSummaryData
object
1 property 1 required
REST_SigstoreRootOfTrust_GET
object
9 properties
RESTScannerData
object
1 property 1 required
RESTScanConfig
object
3 properties 1 required
RESTScanPlatformSummaryData
object
1 property 1 required
RESTScanConfigResp
object
1 property 1 required
RESTVulScoreFilter
object
3 properties 3 required
RESTScanMeta
object
6 properties 6 required
RESTScanConfigConfig
object
3 properties
REST_SigstoreVerifier
object
6 properties 2 required
RESTScanLayersReport
object
1 property 1 required
RESTJfrogXrayConfig
object
4 properties
RESTRegistryImageSummaryData
object
1 property 1 required
RESTRegistryConfigDataV2
object
1 property 1 required
RESTScanConfigData
object
1 property 1 required
RESTAssetScanReportData
object
2 properties
RESTScanStatus
object
6 properties 6 required
RESTScanCacheData
object
4 properties 4 required
RESTGCRKeyConfig
object
1 property
RESTGCRKey
object
1 property
RESTScanRepoReq
object
9 properties 6 required
RESTScanRepoReportData
object
1 property 1 required
RESTModuleCve
object
2 properties 2 required
RESTAssetScanData
object
26 properties 21 required
RESTScanSecret
object
4 properties 4 required
RESTScanStatusData
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neuvector-scan-api-openapi.yml Raw ↑

Other APIs NeuVector publishes across the network.

NeuVector Admission API
AE Profile APIs.io
NeuVector Apikey API
AE Profile APIs.io
NeuVector Authentication API
AE Profile APIs.io
NeuVector Compliance API
AE Profile APIs.io
NeuVector compliance profile. The payload body is the content of the compliance profile yaml file. API
AE Profile APIs.io
NeuVector compliance profile. The payload body is the content of the vulnerability profile yaml file. API
AE Profile APIs.io
NeuVector Container API
AE Profile APIs.io
NeuVector Controller API
AE Profile APIs.io
NeuVector DLP API
AE Profile APIs.io
NeuVector Enforcer API
AE Profile APIs.io
NeuVector EULA API
AE Profile APIs.io
NeuVector Federation API
AE Profile APIs.io
#Scans
← Back to N APIs
API Details
ID
neuvector:neuvector-scan-api
Base URL
https://localhost:10443
Docs
https://open-docs.neuvector.com/
Provider
NeuVector
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=neuvector-scan-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/neuvector-scan-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of NeuVector Scan 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.