Sign in

v1

latestOpenAPI 3.0.02026-07-17181627.7 KB
agents

Get an existing Agent

get/agents/{id}

Response

Agent object

idstring uuid required

Unique identifier (UUID)

namestring

A unique name label

agent_tagsobject

Orb tags field sent in by the agent when it connects group by matching against Agent tags

orb_tagsobject

Orb tags field defined through the API or UI

ts_createdstring date-time

Timestamp of creation

agent_metadataobject

JSON object sent in by the agent representing its Capabilities

statestring

Current connection status of the agent, one of 'new', 'online', 'offline', 'stale', 'removed'

last_hb_dataobject

JSON object sent in by the agent as its last heartbeat

ts_last_hbstring date-time

A time stamp of the last heartbeat that was received

keystring uuid

Agent key is a secret key that is generated at agent creation for authentication purposes

channel_idstring uuid

Communication channel ID (UUIDv4), unique to this agent and created at agent creation

Example response

{
  "name": "my-agent1",
  "agent_tags": {
    "region": "eu",
    "node_type": "dns"
  },
  "orb_tags": {
    "region": "eu",
    "node_type": "dns"
  },
  "agent_metadata": {
    "region": "eu",
    "node_type": "dns"
  },
  "state": "online"
}