ARMO Clusters API
Connected clusters and workloads.
ARMO Clusters API is one of 8 APIs that ARMO publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Clusters. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 2 operations across 2 paths, and defines 3 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
ARMO Clusters 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 2
Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.
Connected clusters and workloads.
Schemas 3
The contract defines 3 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.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from ARMO 7
Other APIs ARMO publishes across the network.