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

Kubescape Vulnerabilities API

Image and workload vulnerability scanning and results.

Kubescape Vulnerabilities API is one of 7 APIs that Kubescape publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Vulnerabilities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 6 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.armosec.io/api/v1.

6 operations 6 paths 5 schemas 6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.armosec.io/api/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Kubescape Vulnerabilities API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — Agent Access Key generated in ARMO Platform under Settings Agent Access Keys, sent in the X-API-KEY request header.

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 6 POST. Each is listed below with its method, path, parameters, and response codes.

Vulnerabilities 6

Image and workload vulnerability scanning and results.

POST
/vulnerability/scan
Initiate a vulnerability scan
startVulnerabilityScan body → 200401
POST
/vulnerability/scanResults/summary
Get vulnerability scan summaries
getVulnerabilityScanSummary body → 200401
POST
/vulnerability/scanResults/details
Get detailed CVE listings
getVulnerabilityScanDetails body → 200401
POST
/vulnerability/severity
Get latest scan severity metrics
getVulnerabilitySeverity body → 200401
POST
/vulnerabilities/list
List vulnerabilities
listVulnerabilities body → 200401
POST
/images/list
List scanned images
listImages body → 200401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Vulnerability (6 properties), ListRequest (4 properties), ScanRequest (3 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Vulnerability
object
6 properties
ScanRequest
object
3 properties
ScanAccepted
object
2 properties
ListRequest
object
Query body used across ARMO list endpoints.
4 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubescape-vulnerabilities-api-openapi.yml Raw ↑

Other APIs Kubescape publishes across the network.

Kubescape In-Cluster Component API (Open Source)
Kubescape Access Keys API
Kubescape Network Policies API
Kubescape Posture & Compliance API
Kubescape Registry & Repository API
Kubescape Runtime Security API