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

ARMO Vulnerabilities API

Image and workload vulnerability scanning and results.

ARMO Vulnerabilities API is one of 8 APIs that ARMO 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 12 operations across 9 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.armosec.io/api/v1, https://api.us.armosec.io/api/v1.

12 operations 9 paths 4 schemas 1 DELETE1 GET9 POST1 PUT

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
Contact
Resource Areas
1

Authentication & Security 1

ARMO 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 — Account access key (Agent Access Key) generated in ARMO Platform under Settings, sent in the X-API-KEY header.

Paths & Operations 12

Across 9 paths, the API surfaces 12 operations — 1 DELETE, 1 GET, 9 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Vulnerabilities 12

Image and workload vulnerability scanning and results.

POST
/vulnerability/scan
Issue a vulnerability scan
issueVulnerabilityScan body → 200401
POST
/vulnerability/scanResults/summary
Get vulnerability scan summary
getVulnerabilityScanSummary body → 200401
POST
/vulnerability/scanResults/details
Get vulnerability scan details
getVulnerabilityScanDetails body → 200401
POST
/vulnerability/severity
Get vulnerability severity roll-up
getVulnerabilitySeverity body → 200401
POST
/vulnerability/topVulnerabilities
Get top vulnerabilities
getTopVulnerabilities body → 200401
POST
/vulnerabilities/list
List vulnerabilities
listVulnerabilities body → 200401
POST
/vulnerabilities/components/list
List vulnerabilities by component
listVulnerabilitiesByComponent body → 200401
POST
/vulnerabilities/images/list
List vulnerabilities by image
listVulnerabilitiesByImage body → 200401
GET
/vulnerability/exception
List vulnerability exceptions
listVulnerabilityExceptions → 200401
POST
/vulnerability/exception
Create a vulnerability exception
createVulnerabilityException body → 200401
PUT
/vulnerability/exception
Update a vulnerability exception
updateVulnerabilityException body → 200401
DELETE
/vulnerability/exception
Delete a vulnerability exception
deleteVulnerabilityException → 200401

Schemas 4

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

GenericResponse
object
ListQuery
object
ARMO's list endpoints accept a common query body with pagination, sorting, and field filters. Exact filter keys vary per resource.
5 properties
Error
object
2 properties
ListResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

armosec-vulnerabilities-api-openapi.yml Raw ↑

Other APIs ARMO publishes across the network.

ARMO Access Keys API
ARMO Clusters API
ARMO Integrations API
ARMO Posture API
ARMO Registry API
ARMO Runtime API
ARMO Security Risks API