NeuVector Scan API
Operations about Scan
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 Scan. 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 2.0, at version 5.6.0.
Requests are made against the 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.
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
GET
/v1/scan/config
Retrieve scan configuration, including global auto-scan settings and fine-grained controls for workloads and hosts.
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…
POST
/v1/scan/hosts/scan_report
Get hosts scan report
GET
/v1/scan/host/{id}
Get host scan report
POST
/v1/scan/host/{id}
Start host scan
GET
/v1/scan/image
Get runtime scan summary by workload's images
GET
/v1/scan/image/{id}
Get runtime scan report by workload's image ID
GET
/v1/scan/platform
Show scan platform summary
GET
/v1/scan/platform/platform
Show scan platform report
POST
/v1/scan/platform/platform
Request scan platform
GET
/v1/scan/registry
Get a list of registries
POST
/v1/scan/registry
Create a registry
POST
/v2/scan/registry
Create a registry
GET
/v1/scan/registry/{name}
Show registry
PATCH
/v1/scan/registry/{name}
Update registry
DELETE
/v1/scan/registry/{name}
Delete registry
PATCH
/v2/scan/registry/{name}
Update registry
GET
/v1/scan/registry/{name}/images
Show registry image summary
GET
/v1/scan/registry/{name}/image/{id}
Get registry image scan report
GET
/v1/scan/registry/{name}/layers/{id}
Show registry layers report
POST
/v1/scan/registry/{name}/scan
Start a registry scan
DELETE
/v1/scan/registry/{name}/scan
Stop registry scan
POST
/v1/scan/repository
Scan repository
GET
/v1/scan/status
Scan status
GET
/v1/scan/cache_stat/{id}
Get scanner cache statistic data
GET
/v1/scan/cache_data/{id}
Get scanner cache index data
GET
/v1/scan/workload/{id}
Get container scan report
POST
/v1/scan/workload/{id}
Start container scan
POST
/v1/scan/workloads/scan_report
Get containers scan report
GET
/v1/scan/sigstore/root_of_trust
Get all sigstore roots of trust
POST
/v1/scan/sigstore/root_of_trust
Create new sigstore root of trust
GET
/v1/scan/sigstore/root_of_trust/{root_name}
Get single sigstore root of trust by name
PATCH
/v1/scan/sigstore/root_of_trust/{root_name}
Update single sigstore root of trust by name
DELETE
/v1/scan/sigstore/root_of_trust/{root_name}
Delete single sigstore root of trust by name
GET
/v1/scan/sigstore/root_of_trust/{root_name}/verifier
Get all sigstore verifiers for given sigstore root of trust
POST
/v1/scan/sigstore/root_of_trust/{root_name}/verifier
Create new sigstore verifier for given sigstore root of trust
GET
/v1/scan/sigstore/root_of_trust/{root_name}/verifier/{verifier_name}
Get sigstore verifier by name under given sigstore root of trust
PATCH
/v1/scan/sigstore/root_of_trust/{root_name}/verifier/{verifier_name}
Update sigstore verifier by name under given sigstore root of trust
DELETE
/v1/scan/sigstore/root_of_trust/{root_name}/verifier/{verifier_name}
Delete sigstore verifier by name under given sigstore root of trust
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.
RESTScanLayersReport
object
1 property
1 required
REST_SigstoreRootOfTrust_GET
object
9 properties
RESTRegistryImageSummary
object
21 properties
20 required
RESTScanCacheData
object
4 properties
4 required
RESTScanConfigData
object
1 property
1 required
REST_SigstoreVerifier
object
6 properties
2 required
RESTJfrogXrayConfig
object
4 properties
RESTScanConfig
object
3 properties
1 required
RESTScanMeta
object
6 properties
6 required
RESTAssetScanReportData
object
2 properties
RESTScanCacheRecord
object
4 properties
4 required
RESTScanStatus
object
6 properties
6 required
RESTAssetsScanReportQuery
object
6 properties
RESTScanRepoReqData
object
1 property
1 required
RESTScanConfigResp
object
1 property
1 required
RESTModuleCve
object
2 properties
2 required
RESTScanConfigConfig
object
3 properties
RESTRegistrySummary
object
32 properties
25 required
RESTRegistryConfigIntegrations
object
6 properties
RESTScanSecret
object
4 properties
4 required
RESTAWSAccountKeyConfig
object
4 properties
RESTScanModule
object
6 properties
3 required
RESTVulScoreFilter
object
3 properties
3 required
RESTScanReport
object
8 properties
1 required
RESTScanReportCursor
object
5 properties
RESTScanImageSummary
object
13 properties
13 required
RESTScanImageSummaryData
object
1 property
1 required
REST_SigstoreRootOfTrustCollection
array
RESTAssetScanData
object
26 properties
21 required
REST_SigstoreRootOfTrust_PATCH
object
4 properties
RESTScanLayer
object
4 properties
4 required
RESTScanSchedule
object
2 properties
2 required
REST_SigstoreRootOfTrust_POST
object
7 properties
1 required
RESTBenchItem
object
11 properties
11 required
RESTAWSAccountKey
object
4 properties
2 required
RESTRegistryConfigV2
object
8 properties
2 required
RESTScanRepoReportData
object
1 property
1 required
RESTRegistryConfig
object
23 properties
2 required
RESTRegistryConfigAuth
object
6 properties
RESTRegistryConfigScan
object
6 properties
RESTScannerData
object
1 property
1 required
RESTRegistryConfigDataV2
object
1 property
1 required
RESTRegistrySummaryListData
object
1 property
1 required
REST_SigstoreVerifier_PATCH
object
5 properties
RESTJfrogXray
object
4 properties
3 required
RESTRegistryImageSummaryData
object
1 property
1 required
RESTGCRKey
object
1 property
RESTScanRepoReq
object
9 properties
6 required
RESTScanCacheStat
object
4 properties
4 required
RESTScanner
object
5 properties
5 required
RESTScanPlatformSummaryData
object
1 property
1 required
RESTScanStatusData
object
1 property
1 required
RESTScanRepoReport
object
17 properties
16 required
REST_SigstoreVerifierCollection
array
RESTScanPlatformSummary
object
12 properties
12 required
RESTRegistrySummaryData
object
1 property
1 required
RESTScanLayersReportData
object
1 property
1 required
RESTGCRKeyConfig
object
1 property
RESTRegistryConfigData
object
1 property
1 required
RESTScanReportData
object
1 property
1 required
RESTVulnerability
object
19 properties
16 required
RESTScanSetIdPerm
object
3 properties
3 required
RESTAssetsScanReportFilter
object
3 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from NeuVector 12
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
#Scan