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

Framework, control, and resource posture results.

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

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

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

4 operations 4 paths 5 schemas 4 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 Posture & Compliance 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 4

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

Posture & Compliance 4

Framework, control, and resource posture results.

POST
/posture/frameworks
Get framework scan summaries
getPostureFrameworks body → 200401
POST
/posture/controls
Get control run results
getPostureControls body → 200401
POST
/posture/controls/sections
Get framework subsection summaries
getPostureControlSections body → 200401
POST
/posture/resources
List affected resources
getPostureResources body → 200401

Schemas 5

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

AffectedResource
object
5 properties
ListRequest
object
Query body used across ARMO list endpoints.
4 properties
FrameworkSummary
object
4 properties
ControlResult
object
5 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubescape-posture-compliance-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 Registry & Repository API
Kubescape Runtime Security API
Kubescape Vulnerabilities API