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 Access Keys API

Agent access keys and exception policies.

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

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

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

3 operations 2 paths 2 schemas 1 DELETE1 GET1 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 Access Keys 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 3

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

Access Keys 3

Agent access keys and exception policies.

GET
/authentication/accessKeys
List agent access keys
listAccessKeys → 200401
POST
/authentication/accessKeys
Create an agent access key
createAccessKey body → 200401
DELETE
/authentication/accessKeys/{guid}
Revoke an agent access key
deleteAccessKey 1 param → 200401

Schemas 2

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

AccessKey
object
3 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubescape-access-keys-api-openapi.yml Raw ↑

Other APIs Kubescape publishes across the network.

Kubescape In-Cluster Component API (Open Source)
Kubescape Network Policies API
Kubescape Posture & Compliance API
Kubescape Registry & Repository API
Kubescape Runtime Security API
Kubescape Vulnerabilities API