Headers
-
elastic-api-version string
The version of the API to use
Value is
2023-10-31. Default value is2023-10-31. -
A required header to protect against CSRF attacks
Body
-
batchSize number
-
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
POST /api/fleet/agents/bulk_unenroll
curl \
-X POST https://localhost:5601/api/fleet/agents/bulk_unenroll \
-H "Content-Type: application/json; Elastic-Api-Version=2023-10-31" \
-H "elastic-api-version: 2023-10-31" \
-H "kbn-xsrf: true"
Request examples
# Headers
elastic-api-version: 2023-10-31
kbn-xsrf: true
# Payload
{
"agents": [
"string"
],
"batchSize": 42.0,
"force": true,
"includeInactive": true,
"revoke": true
}
Response examples (200)
{
"actionId": "string"
}
Response examples (400)
{
"error": "string",
"message": "string",
"statusCode": 42.0
}