Get an enrollment API key

Server: https://{kibana_url}

GET /api/fleet/enrollment_api_keys/{keyId}

Api key auth Basic auth

Get an enrollment API key by ID.

[Required authorization] Route required privileges: fleet-agents-all OR fleet-setup.

Path Parameters

keyId string required: The ID of the enrollment API key

Responses

Successful response

application/json

Bad Request

application/json

404

Not Found

application/json

Examples

An enrollment API key

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET /api/fleet/enrollment_api_keys/{keyId}

curl Shell

curl -X GET "https://{kibana_url}/api/fleet/enrollment_api_keys/{keyId}"

Response

{
  "item": {
    "active": true,
    "api_key": "api-key-value-1",
    "api_key_id": "api-key-id-1",
    "created_at": "2024-01-01T00:00:00.000Z",
    "id": "key-id-1",
    "name": "Default policy enrollment key",
    "policy_id": "policy-id-1"
  }
}

{
  "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
}