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

KSPM posture and compliance framework results.

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

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

This API exposes 10 operations across 7 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.

10 operations 7 paths 4 schemas 1 DELETE1 GET7 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 Posture 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 10

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

Posture 10

KSPM posture and compliance framework results.

POST
/posture/frameworks
Get posture scan summary per framework
getPostureFrameworks body → 200401
POST
/posture/controls
Get posture control results
getPostureControls body → 200401
POST
/posture/controls/sections
Get framework sections
getPostureControlSections body → 200401
POST
/posture/resources
Get resources affected by posture issues
getPostureResources body → 200401
GET
/posture/exception
List posture exceptions
listPostureExceptions → 200401
POST
/posture/exception
Create a posture exception
createPostureException body → 200401
PUT
/posture/exception
Update a posture exception
updatePostureException body → 200401
DELETE
/posture/exception
Delete a posture exception
deletePostureException → 200401
POST
/repositoryPosture/repositories
Get repository (IaC) posture summary by repository
getRepositoryPostureRepositories body → 200401
POST
/repositoryPosture/failedControls
Get failed controls summary for repository posture
getRepositoryPostureFailedControls body → 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-posture-api-openapi.yml Raw ↑

Other APIs ARMO publishes across the network.

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