Get an enrollment API key

Base URL: https://{kibana_url}

GET /api/fleet/enrollment_api_keys/{keyId}
GET /s/{space_id}/api/fleet/enrollment_api_keys/{keyId}

Auth

Get an enrollment API key by ID.

Required authorization

Privileges fleet-agents-all or fleet-setup

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.
keyId string · min length: 0 required: The ID of the enrollment API key

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/enrollment_api_keys/KEY_ID

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

An enrollment API key

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