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

Account API access key management.

ARMO Access Keys API is one of 8 APIs that ARMO 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 5 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.

5 operations 2 paths 3 schemas 1 DELETE2 GET1 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 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 — Account access key (Agent Access Key) generated in ARMO Platform under Settings, sent in the X-API-KEY header.

Paths & Operations 5

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

Access Keys 5

Account API access key management.

GET
/authentication/accessKeys
List access keys
listAccessKeys → 200401
POST
/authentication/accessKeys
Create an access key
createAccessKey body → 200401
PUT
/authentication/accessKeys
Update an access key
updateAccessKey body → 200401
GET
/authentication/accessKeys/{guid}
Get an access key by GUID
getAccessKey 1 param → 200401404
DELETE
/authentication/accessKeys/{guid}
Delete an access key
deleteAccessKey 1 param → 200401404

Schemas 3

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

GenericResponse
object
Error
object
2 properties
ListResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs ARMO publishes across the network.

ARMO Clusters API
ARMO Integrations API
ARMO Posture API
ARMO Registry API
ARMO Runtime API
ARMO Security Risks API
ARMO Vulnerabilities API