Bulk unenroll agents

Base URL: https://{kibana_url}

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

Auth

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: Kibana's anti Cross-Site Request Forgery token. Can be any string value.

Request body

agents union string | string[] required
force boolean: Unenrolls hosted agents too
includeInactive boolean: When passing agents by KQL query, unenrolls inactive agents too
revoke boolean: Revokes API keys of agents

Responses

application/json

actionId string

Generic Error

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/fleet/agents/bulk_unenroll
{
  "agents": "string"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/agents/bulk_unenroll" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "agents": "string"
  }'

Generated from the API spec

Response

{
  "actionId": "string"
}

Generated from the API spec

{
  "error": "string",
  "message": "string",
  "statusCode": 0
}

Generated from the API spec

Path parameters

Header parameters

Request body { }

Responses

Request body