Get a decrypted uninstall token

Base URL: https://{kibana_url}

GET /api/fleet/uninstall_tokens/{uninstallTokenId}
GET /s/{space_id}/api/fleet/uninstall_tokens/{uninstallTokenId}

Auth

Get one decrypted uninstall token by its ID.

Required authorization

Privileges fleet-agents-all

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.
uninstallTokenId string · min length: 0 required: The ID of the uninstall token

Responses

Successful response

application/json

item object required

Bad Request

application/json

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

404

Not Found

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/uninstall_tokens/UNINSTALL_TOKEN_ID

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

Decrypted uninstall token for an agent policy

{
  "item": {
    "created_at": "2024-01-01T00:00:00.000Z",
    "id": "token-id-1",
    "namespaces": [
      "default"
    ],
    "policy_id": "policy-id-1",
    "policy_name": "Default policy",
    "token": "CKHJsJcBqNwIRcRBNDaE"
  }
}

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

{
  "error": "Not Found",
  "message": "Uninstall Token not found with ID token-id-1",
  "statusCode": 404
}