Revoke or delete an enrollment API key

Auth

Revoke or delete an enrollment API key by ID. Use forceDelete=true to remove the document.

Required authorization

forceDelete boolean · default: false: When false (default), invalidate the API key and mark the token as inactive. When true, also delete the token document.
includeHidden boolean · default: false: When true, allow deletion of hidden enrollment tokens (managed/agentless policies). Defaults to false.

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

Successful response

application/json

Bad Request

application/json

404

Not Found

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

DELETE kbn:/api/fleet/enrollment_api_keys/KEY_ID

Generated from the API spec

curl Shell

curl -X DELETE "${KIBANA_URL}/api/fleet/enrollment_api_keys/${KEY_ID}" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

The enrollment API key was successfully revoked

{
  "action": "deleted"
}

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

{
  "error": "Not Found",
  "message": "EnrollmentAPIKey key-id-1 not found",
  "statusCode": 404
}