Bulk update agent tags

Base URL: https://{kibana_url}

POST /api/fleet/agents/bulk_update_agent_tags
POST /s/{space_id}/api/fleet/agents/bulk_update_agent_tags

Auth

Add or remove tags across multiple agents.

Required privileges

Privileges fleet-agents-all

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

agents union string[] | string required
batchSize number
dryRun boolean
includeInactive boolean · default: false
tagsToAdd string[] · max items: 10
tagsToRemove string[] · max items: 10

Responses

Successful response

application/json

Any of:

actionId string required

Bad Request

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Add and remove tags across multiple agents

Console Kibana Dev Tools

POST kbn:/api/fleet/agents/bulk_update_agent_tags
{
  "agents": [
    "agent-id-1",
    "agent-id-2"
  ],
  "tagsToAdd": [
    "production"
  ],
  "tagsToRemove": [
    "staging"
  ]
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/agents/bulk_update_agent_tags" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "agents": [
      "agent-id-1",
      "agent-id-2"
    ],
    "tagsToAdd": [
      "production"
    ],
    "tagsToRemove": [
      "staging"
    ]
  }'

Generated from the API spec

Response

Bulk action result

{
  "actionId": "action-id-1"
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}