Rotate an uninstall token

Base URL: https://{kibana_url}

POST /api/fleet/uninstall_tokens/{agentPolicyId}/rotate

Auth

Rotate the uninstall token for an agent policy. Only applicable to policies with tamper protection enabled.

Required privileges

Privileges fleet-agents-all

Path parameters

agentPolicyId string · max length: 255 required: The ID of the agent policy whose uninstall token should be rotated

Header parameters

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

Responses

Successful response

application/json

message string required

Bad Request

application/json

Not Found

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/fleet/uninstall_tokens/AGENT_POLICY_ID/rotate

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/uninstall_tokens/${AGENT_POLICY_ID}/rotate" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

Uninstall token rotated successfully for the given agent policy

{
  "message": "Uninstall token rotated successfully."
}

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

{
  "error": "Not Found",
  "message": "Agent policy not found with id policy-id-1",
  "statusCode": 404
}