v1

latestOpenAPI 3.0.02026-07-17181627.7 KB
agents

Validate an Agent configuration without saving it

post/agents/validate

Request body

namestring required

A unique name label

orb_tagsobject

User defined key/values that will define the members of the group by matching against Agent tags

Example request

{
  "name": "my-agent1",
  "orb_tags": {
    "region": "eu",
    "node_type": "dns"
  }
}

Response

Agent validation object

namestring

A unique name label

orb_tagsobject

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

Example response

{
  "name": "my-agent1",
  "orb_tags": {
    "region": "eu",
    "node_type": "dns"
  }
}