Get an enrollment API key

Base URL
https://{kibana_url}
  • GET /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

keyId string required

The ID of the enrollment API key

Responses

Successful response

application/json
item object required
active boolean required

When false, the enrollment API key is revoked and cannot be used for enrolling Elastic Agents.

api_key string required

The enrollment API key (token) used for enrolling Elastic Agents.

api_key_id string required

The ID of the API key in the Security API.

created_at string required
expire_at string

The expiration date of the enrollment token as an ISO 8601 date string. Absent when the token never expires.

hidden boolean
id string required
name string

The name of the enrollment API key.

policy_id string

The ID of the agent policy the Elastic Agent will be enrolled in.

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}