v1

latestOpenAPI 3.0.02026-07-17181627.7 KB
agent_groups

Validate an Agent Group configuration without saving it

post/agent_groups/validate

Request body

namestring required

A unique name label

descriptionstring

User description of this Agent Group

tagsobject required

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

Example request

{
  "name": "eu-agents",
  "description": "An example agent group representing european dns nodes",
  "tags": {
    "region": "eu",
    "node_type": "dns"
  }
}

Response

Agent Group object

namestring

A unique name label

tagsobject

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

Example response

{
  "name": "eu-agents",
  "tags": {
    "region": "eu",
    "node_type": "dns"
  }
}