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 Registry API

Container registry scanning.

ARMO Registry API is one of 8 APIs that ARMO publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 1 path, and defines 2 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.

3 operations 1 paths 2 schemas 1 DELETE1 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 Registry 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 3

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

Registry 3

Container registry scanning.

POST
/registry/scan
Issue a registry scan or set scheduler
issueRegistryScan body → 200401
PUT
/registry/scan
Update the registry scan cron job
updateRegistryScan body → 200401
DELETE
/registry/scan
Delete the registry scan cron job
deleteRegistryScan → 200401

Schemas 2

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

Error
object
2 properties
GenericResponse
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

armosec-registry-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 Runtime API
ARMO Security Risks API
ARMO Vulnerabilities API