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

Registry scans and Git repository posture.

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

Tagged areas include Registry & Repository. 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 4 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.

2 operations 2 paths 4 schemas 2 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 Registry & Repository 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 2

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

Registry & Repository 2

Registry scans and Git repository posture.

POST
/registry/scan
Schedule a registry scan
scheduleRegistryScan body → 200401
POST
/repositoryPosture/failedControls
Get repository failed controls
getRepositoryFailedControls body → 200401

Schemas 4

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

RegistryScanRequest
object
3 properties
ScanAccepted
object
2 properties
ListRequest
object
Query body used across ARMO list endpoints.
4 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubescape-registry-repository-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 Posture & Compliance API
Kubescape Runtime Security API
Kubescape Vulnerabilities API