Get metadata for latest uninstall tokens

Base URL: https://{kibana_url}

GET /api/fleet/uninstall_tokens

Auth

List the metadata for the latest uninstall tokens per agent policy.

Required authorization

Privileges fleet-agents-all

Query parameters

policyId string · max length: 50: Partial match filtering for policy IDs
search string · max length: 50: Partial match filtering for uninstall token values
perPage number · min: 5: The number of items to return
page number · min: 1: Page number

Responses

Successful response

application/json

items object[] · max items: 10000 required
page number required
perPage number required
total number required

Bad Request

application/json

attributes object required
error string
errorType string
message string required
statusCode number

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/uninstall_tokens

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/fleet/uninstall_tokens" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

List of uninstall token metadata for agent policies

{
  "items": [
    {
      "created_at": "2024-01-01T00:00:00.000Z",
      "id": "token-id-1",
      "namespaces": [
        "default"
      ],
      "policy_id": "policy-id-1",
      "policy_name": "Default policy"
    },
    {
      "created_at": "2024-01-02T00:00:00.000Z",
      "id": "token-id-2",
      "namespaces": [
        "production"
      ],
      "policy_id": "policy-id-2",
      "policy_name": "Production policy"
    }
  ],
  "page": 1,
  "perPage": 20,
  "total": 2
}

{
  "error": "Bad Request",
  "message": "Query parameters \u0060policyId\u0060 and \u0060search\u0060 cannot be used at the same time.",
  "statusCode": 400
}