v1

latestOpenAPI 3.0.02026-07-17181627.7 KB

agent_groups

Update an existing Agent Group

put/agent_groups/{id}

Request body

namestring

A unique name label

descriptionstring

User description of this Agent Group

tagsobject

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

idstring uuid required

Unique identifier (UUID)

namestring

A unique name label

descriptionstring

User description of this Agent Group

tagsobject

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

ts_createdstring date-time

Timestamp of creation

Example response

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