Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/neuvector-scan-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
description: Secure Docker and Kubernetes based container deployments with the NeuVector run-time security solution.
version: 5.6.0
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
title: NeuVector Scan API
contact:
email: support@neuvector.com
servers:
- url: https://localhost:10443/
tags:
- name: Scan
description: Operations about Scan
paths:
/v1/scan/scanner:
get:
tags:
- Scan
summary: Get scanner list
security:
- ApiKeyAuth: []
- TokenAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTScannerData'
/v1/scan/config:
get:
tags:
- Scan
summary: Retrieve scan configuration, including global auto-scan settings and fine-grained controls for workloads and hosts.
security:
- ApiKeyAuth: []
- TokenAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTScanConfigResp'
patch:
tags:
- Scan
summary: Auto-scan can be configured either globally or with fine-grained control for workloads and hosts. If any of the detailed control fields (enable_auto_scan_workload, enable_auto_scan_host) is explicitly provided, its value takes precedence and overrides the auto-scan setting.
security:
- ApiKeyAuth: []
- TokenAuth: []
responses:
'200':
description: Success
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RESTScanConfigData'
description: Scan configure data
required: true
/v1/scan/hosts/scan_report:
post:
tags:
- Scan
summary: Get hosts scan report
security:
- ApiKeyAuth: []
- TokenAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTAssetScanReportData'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RESTAssetsScanReportQuery'
description: Filter data
required: true
/v1/scan/host/{id}:
get:
tags:
- Scan
summary: Get host scan report
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: id
description: Host ID
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTScanReportData'
post:
tags:
- Scan
summary: Start host scan
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: id
description: Host ID
required: true
schema:
type: string
responses:
'200':
description: Success
/v1/scan/image:
get:
tags:
- Scan
summary: Get runtime scan summary by workload's images
security:
- ApiKeyAuth: []
- TokenAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTScanImageSummaryData'
/v1/scan/image/{id}:
get:
tags:
- Scan
summary: Get runtime scan report by workload's image ID
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: id
description: Image id
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTScanReportData'
/v1/scan/platform:
get:
tags:
- Scan
summary: Show scan platform summary
security:
- ApiKeyAuth: []
- TokenAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTScanPlatformSummaryData'
/v1/scan/platform/platform:
get:
tags:
- Scan
summary: Show scan platform report
security:
- ApiKeyAuth: []
- TokenAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTScanReportData'
post:
tags:
- Scan
summary: Request scan platform
security:
- ApiKeyAuth: []
- TokenAuth: []
responses:
'200':
description: Success
/v1/scan/registry:
get:
tags:
- Scan
summary: Get a list of registries
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: query
name: scope
required: false
description: When set to fed, returned fed registries. When set to local, returned local-defined registries. If there is no query string 'scope', all registries will be returned.
schema:
type: string
enum:
- fed
- local
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTRegistrySummaryListData'
post:
tags:
- Scan
summary: Create a registry
security:
- ApiKeyAuth: []
- TokenAuth: []
responses:
'200':
description: Success
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RESTRegistryConfigData'
description: Registry data
required: true
/v2/scan/registry:
post:
tags:
- Scan
summary: Create a registry
security:
- ApiKeyAuth: []
- TokenAuth: []
responses:
'200':
description: Success
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RESTRegistryConfigDataV2'
description: Registry data
required: true
/v1/scan/registry/{name}:
get:
tags:
- Scan
summary: Show registry
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: name
description: Name of the registry
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTRegistrySummaryData'
patch:
tags:
- Scan
summary: Update registry
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: name
description: Name of the registry
required: true
schema:
type: string
responses:
'200':
description: Success
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RESTRegistryConfigData'
description: Registry data
required: true
delete:
tags:
- Scan
summary: Delete registry
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: name
description: Name of the registry
required: true
schema:
type: string
responses:
'200':
description: Success
/v2/scan/registry/{name}:
patch:
tags:
- Scan
summary: Update registry
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: name
description: Name of the registry
required: true
schema:
type: string
responses:
'200':
description: Success
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RESTRegistryConfigDataV2'
description: Registry data
required: true
/v1/scan/registry/{name}/images:
get:
tags:
- Scan
summary: Show registry image summary
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: name
description: Name of the registry
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTRegistryImageSummaryData'
/v1/scan/registry/{name}/image/{id}:
get:
tags:
- Scan
summary: Get registry image scan report
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: name
description: Name of the registry
required: true
schema:
type: string
- in: path
name: id
description: Image ID
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTScanReportData'
/v1/scan/registry/{name}/layers/{id}:
get:
tags:
- Scan
summary: Show registry layers report
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: name
description: Name of the registry
required: true
schema:
type: string
- in: path
name: id
description: Layer ID
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTScanLayersReportData'
/v1/scan/registry/{name}/scan:
post:
tags:
- Scan
summary: Start a registry scan
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: name
description: Name of the registry
required: true
schema:
type: string
responses:
'200':
description: Success
delete:
tags:
- Scan
summary: Stop registry scan
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: name
description: Name of the registry
required: true
schema:
type: string
responses:
'200':
description: Success
/v1/scan/repository:
post:
tags:
- Scan
summary: Scan repository
security:
- ApiKeyAuth: []
- TokenAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTScanRepoReportData'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RESTScanRepoReqData'
description: Repository data
required: true
/v1/scan/status:
get:
tags:
- Scan
summary: Scan status
security:
- ApiKeyAuth: []
- TokenAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTScanStatusData'
/v1/scan/cache_stat/{id}:
get:
tags:
- Scan
summary: Get scanner cache statistic data
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: id
description: Scanner ID
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTScanCacheStat'
/v1/scan/cache_data/{id}:
get:
tags:
- Scan
summary: Get scanner cache index data
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: id
description: Scanner ID
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTScanCacheData'
/v1/scan/workload/{id}:
get:
tags:
- Scan
summary: Get container scan report
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: id
description: Workload ID
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTScanReportData'
post:
tags:
- Scan
summary: Start container scan
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: id
description: Workload ID
required: true
schema:
type: string
responses:
'200':
description: Success
/v1/scan/workloads/scan_report:
post:
tags:
- Scan
summary: Get containers scan report
security:
- ApiKeyAuth: []
- TokenAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RESTAssetScanReportData'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RESTAssetsScanReportQuery'
description: Filter data
required: true
/v1/scan/sigstore/root_of_trust:
get:
tags:
- Scan
summary: Get all sigstore roots of trust
security:
- ApiKeyAuth: []
- TokenAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/REST_SigstoreRootOfTrustCollection'
post:
tags:
- Scan
summary: Create new sigstore root of trust
security:
- ApiKeyAuth: []
- TokenAuth: []
responses:
'200':
description: Success
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/REST_SigstoreRootOfTrust_POST'
description: Root of Trust Data
required: true
/v1/scan/sigstore/root_of_trust/{root_name}:
get:
tags:
- Scan
summary: Get single sigstore root of trust by name
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: root_name
description: Root Of Trust Name
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/REST_SigstoreRootOfTrust_GET'
patch:
tags:
- Scan
summary: Update single sigstore root of trust by name
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: root_name
description: Root Of Trust Name
required: true
schema:
type: string
responses:
'200':
description: Success
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/REST_SigstoreRootOfTrust_PATCH'
description: Root of Trust Data
required: true
delete:
tags:
- Scan
summary: Delete single sigstore root of trust by name
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: root_name
description: Root Of Trust Name
required: true
schema:
type: string
responses:
'200':
description: Success
/v1/scan/sigstore/root_of_trust/{root_name}/verifier:
get:
tags:
- Scan
summary: Get all sigstore verifiers for given sigstore root of trust
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: root_name
description: Root Of Trust Name
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/REST_SigstoreVerifierCollection'
post:
tags:
- Scan
summary: Create new sigstore verifier for given sigstore root of trust
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: root_name
description: Root Of Trust Name
required: true
schema:
type: string
responses:
'200':
description: Success
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/REST_SigstoreVerifier'
description: Root of Trust Data
required: true
/v1/scan/sigstore/root_of_trust/{root_name}/verifier/{verifier_name}:
get:
tags:
- Scan
summary: Get sigstore verifier by name under given sigstore root of trust
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: root_name
description: Root Of Trust Name
required: true
schema:
type: string
- in: path
name: verifier_name
description: Verifier Name
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/REST_SigstoreVerifier'
patch:
tags:
- Scan
summary: Update sigstore verifier by name under given sigstore root of trust
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: root_name
description: Root Of Trust Name
required: true
schema:
type: string
- in: path
name: verifier_name
description: Verifier Name
required: true
schema:
type: string
responses:
'200':
description: Success
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/REST_SigstoreVerifier_PATCH'
description: Verifier patch data
required: true
delete:
tags:
- Scan
summary: Delete sigstore verifier by name under given sigstore root of trust
security:
- ApiKeyAuth: []
- TokenAuth: []
parameters:
- in: path
name: root_name
description: Root Of Trust Name
required: true
schema:
type: string
- in: path
name: verifier_name
description: Verifier Name
required: true
schema:
type: string
responses:
'200':
description: Success
components:
schemas:
RESTScanReportData:
type: object
required:
- report
properties:
report:
$ref: '#/components/schemas/RESTScanReport'
RESTScanner:
type: object
required:
- id
- cvedb_version
- cvedb_create_time
- server
- port
properties:
id:
type: string
example: github
cvedb_version:
type: string
example: '1.011'
cvedb_create_time:
type: string
format: date-time
example: 2018-06-20 19:00:53+00:00
server:
type: string
example: 10.1.5.1
port:
type: integer
format: uint16
example: 51764
RESTScanCacheStat:
type: object
required:
- record_count
- record_total_size
- cache_misses
- cache_hits
properties:
record_count:
type: integer
format: uint64
example: 0
record_total_size:
type: integer
format: uint64
example: 0
cache_misses:
type: integer
format: uint64
example: 0
cache_hits:
type: integer
format: uint64
example: 0
RESTRegistryConfigData:
type: object
required:
- config
properties:
config:
$ref: '#/components/schemas/RESTRegistryConfig'
RESTAWSAccountKey:
type: object
required:
- id
- region
properties:
id:
type: string
example: '349695068245'
access_key_id:
type: string
example: NSKN3KM0OSN854MZ2LOV90S7DFVCL6
secret_access_key:
type: string
example: E7B0OS/N3KMVCL6KNMZ2+LOV90S7854NSD84P0BF
region:
type: string
example: us-east-1
RESTAssetsScanReportQuery:
type: object
properties:
show_accepted:
type: boolean
max_cve_records:
type: integer
cursor:
$ref: '#/components/schemas/RESTScanReportCursor'
view_pod:
type: string
vul_score_filter:
$ref: '#/components/schemas/RESTVulScoreFilter'
filters:
type: array
items:
$ref: '#/components/schemas/RESTAssetsScanReportFilter'
RESTVulnerability:
type: object
required:
- name
- score
- severity
- vectors
- description
- file_name
- package_name
- package_version
- fixed_version
- link
- score_v3
- vectors_v3
- published_timestamp
- last_modified_timestamp
- feed_rating
- in_base_image
properties:
name:
type: string
example: CVE-2015-8356
score:
type: number
format: float32
example: 7.2
severity:
type: string
example: High
vectors:
type: string
example: ''
description:
type: string
example: The setup_env function in group.c in sshd in OpenSSH allows local users to gain privileges.
file_name:
type: string
example: usr/lib/python3.9
package_name:
type: string
example: openssh
package_version:
type: string
example: 7.2_p2-r0
fixed_version:
type: string
example: 1:7.2p2-3
link:
type: string
example: https://security-tracker.debian.org/tracker/CVE-2015-8356
score_v3:
type: number
format: float32
example: 7.3
vectors_v3:
type: string
example: ''
published_timestamp:
type: integer
format: int64
example: 1516561260
last_modified_timestamp:
type: integer
format: int64
example: 1516561253
cpes:
type: array
items:
type: string
example: ''
cves:
type: array
items:
type: string
example: ''
feed_rating:
type: string
example: ''
in_base_image:
type: boolean
example: true
tags:
type: array
items:
type: string
example: ''
REST_SigstoreRootOfTrustCollection:
type: array
items:
$ref: '#/components/schemas/REST_SigstoreRootOfTrust_GET'
RESTRegistrySummaryListData:
type: object
required:
- summarys
properties:
summarys:
type: array
items:
$ref: '#/components/schemas/RESTRegistrySummary'
RESTScanRepoReport:
type: object
required:
- image_id
- registry
- repository
- tag
- digest
- size
- author
- base_os
- created_at
- cvedb_version
- cvedb_create_time
- layers
- vulnerabilities
- modules
- envs
- labels
properties:
verdict:
type: string
example: ''
image_id:
type: string
example: d572b7ee3511b21a2b78b8915bc03c5786ad01949704c1418624224c4cae2c5f
registry:
type: string
example: https://registry.hub.docker.com/
repository:
type: string
example: alpine
tag:
type: string
example: latest
digest:
type: string
example: bd8ffa77cf1c910b7a90935ca4828472e1c3e303e7cd5260f13d1e09995f173a
size:
type: integer
format: int64
example: 1
author:
type: string
example: ''
base_os:
type: string
example: ubuntu:16.04
created_at:
type: string
format: date-time
example: 2018-01-21 19:00:53+00:00
cvedb_version:
type: string
example: '1.00'
cvedb_create_time:
type: string
format: date-time
example: 2018-06-20 19:00:53+00:00
layers:
type: array
items:
$ref: '#/components/schemas/RESTScanLayer'
vulnerabilities:
type: array
items:
$ref: '#/components/schemas/RESTVulnerability'
modules:
type: array
items:
$ref: '#/components/schemas/RESTScanModule'
envs:
type: array
items:
type: string
example:
- PATH=/usr/local/sbin
- GOSU_VERSION=1.12
- REDIS_VERSION=6.0.2
labels:
type: object
description: map key is string type
additionalProperties:
type: string
example:
label1: value1
label2: value2
RESTRegistryImageSummary:
type: object
required:
- domain
- repository
- tag
- image_id
- digest
- size
- author
- run_as_root
- envs
- labels
- layers
- status
- high
- medium
- result
- scanned_timestamp
- scanned_at
- created_at
- base_os
- scanner_version
properties:
domain:
type: string
example: ''
repository:
type: string
example: alpine
tag:
type: string
example: latest
image_id:
type: string
example: d572b7ee3511b21a2b78b8915bc03c5786ad01949704c1418624224c4cae2c5f
digest:
type: string
example: bd8ffa77cf1c910b7a90935ca4828472e1c3e303e7cd5260f13d1e09995f173a
size:
type: integer
format: int64
example: 1
author:
type: string
example: ''
run_as_root:
type: boolean
example: true
envs:
type: array
items:
type: string
example:
- PATH=/usr/local/sbin
- GOSU_VERSION=1.12
- REDIS_VERSION=6.0.2
labels:
type: object
description: map key is string type
additionalProperties:
type: string
example:
label1: value1
label2: value2
layers:
type: array
items:
type: string
example:
- layer_1
- layer_2
status:
type: string
example: scheduled
high:
type: integer
example: 0
medium:
type: integer
example: 0
result:
type: string
example: success
scanned_timestamp:
type: integer
format: int64
example: 1516561253
scanned_at:
type: string
format: date-time
example: 2018-01-21 19:00:53+00:00
created_at:
type: string
format: date-time
example: 2018-01-21 19:00:53+00:00
base_os:
type: string
example: ubuntu:16.04
scanner_version:
type: string
example: '1.011'
cvedb_create_time:
type: string
format: date-time
example: 2018-06-20 19:00:53+00:00
RESTScanReport:
type: object
required:
- vulnerabilities
properties:
vulnerabilities:
type: array
items:
$ref: '#/components/schemas/RESTVulnerability'
modules:
type: array
items:
$ref: '#/components/schemas/RESTScanModule'
checks:
type: array
items:
$ref: '#/components/schemas/RESTBenchItem'
secrets:
type: array
items:
$ref: '#/components/schemas/RESTScanSecret'
setid_perms:
type: array
items:
$ref: '#/components/schemas/RESTScanSetIdPerm'
envs:
type: array
items:
type: string
example:
- PATH=/usr/local/sbin
- GOSU_VERSION=1.12
- REDIS_VERSION=6.0.2
labels:
type: object
description: map key is string type
additionalProperties:
type: string
example:
label1: value1
label2: value2
cmds:
type: array
items:
type: string
example: ''
RESTScanCacheRecord:
type: object
required:
- layer_id
- size
- reference_count
- last_referred
properties:
layer_id:
type: string
example: ''
size:
type: integer
format: uint64
example: 0
reference_count:
type: integer
format: uint32
example: 0
last_referred:
type: string
format: date-time
example: '2022-03-17T17:31:55.832768041Z'
RESTScanSchedule:
type: object
required:
- schedule
- interval
properties:
schedule:
type: string
example: manual
interval:
type: integer
example: 5
RESTRegistryConfigScan:
type: object
properties:
rescan_after_db_update:
type: boolean
example: false
scan_layers:
type: boolean
example: false
repo_limit:
type: integer
example: 1
tag_limit:
type: integer
example: 1
schedule:
$ref: '#/components/schemas/RESTScanSchedule'
ignore_proxy:
type: boolean
example: false
RESTRegistryConfigV2:
type: object
required:
- name
- registry_type
properties:
name:
type: string
example: myregistry
registry_type:
type: string
example: Docker Registry
registry:
type: string
example: https://registry.hub.docker.com/
domains:
type: array
items:
type: string
example: ''
filters:
type: array
items:
type: string
example: neuvector/*:*
auth:
$ref: '#/components/schemas/RESTRegi
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/neuvector/refs/heads/main/openapi/neuvector-scan-api-openapi.yml