Humanitec Agents API is one of 45 APIs that Humanitec publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.
This API exposes
7 operations
across 4 paths,
and defines 6 schemas.
It is described by OpenAPI 3.0.0, at version 0.28.24.
Requests are made against a single base URL, https://api.humanitec.io/.
7 operations4 paths6 schemas2 DELETE2 GET1 PATCH2 POST
Metadata
The identity and technical contract details declared by the specification.
Across 4 paths, the API surfaces 7 operations — 2 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Agents 7
An object containing the details of an Agent.
POST
/orgs/{orgId}/agents
Register a new Agent under an Organization.
createAgent1 parambody→ 200400409
GET
/orgs/{orgId}/agents
List all the agents in an Organization.
listAgents2 params→ 200
DELETE
/orgs/{orgId}/agents/{agentId}
Delete an Agent (and its keys) stored under an Organization.
deleteAgent2 params→ 204404
PATCH
/orgs/{orgId}/agents/{agentId}
Update the description of an Agent.
patchAgent2 paramsbody→ 200400404
GET
/orgs/{orgId}/agents/{agentId}/keys
List all the keys registered under an Agent in an Organization.
listKeysInAgent2 params→ 200404
POST
/orgs/{orgId}/agents/{agentId}/keys
Register a new Key under an Agent in an Organization.
createKey2 paramsbody→ 200400404409
DELETE
/orgs/{orgId}/agents/{agentId}/keys/{fingerprint}
Delete a key registered under a Agent.
deleteKeyInAgent3 params→ 204404
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Key (6 properties), Agent (4 properties), AgentCreateBody (3 properties), HumanitecErrorResponse (3 properties). Each schema is shown below with its type and property counts.
KeyCreateBody
object
1 property1 required
HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties2 required
AgentPatchBody
object
An object containing data to update the description field of an Agent.
1 property1 required
Key
object
An object containing the details of a Key.
6 properties6 required
AgentCreateBody
object
An object containing data needed to register an Agent.
3 properties2 required
Agent
object
An object containing the details of an Agent.
4 properties3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
