Get an enrollment API key Beta

GET /api/fleet/enrollment_api_keys/{keyId}

Get an enrollment API key by ID.

Headers

  • elastic-api-version string

    The version of the API to use

    Value is 2023-10-31. Default value is 2023-10-31.

Responses

  • 200 application/json; Elastic-Api-Version=2023-10-31
    Hide response attribute Show response attribute object
    • item object Required

      Additional properties are NOT allowed.

      Hide item attributes Show item attributes object
      • 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
      • 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.
  • 400 application/json; Elastic-Api-Version=2023-10-31
    Hide response attributes Show response attributes object
GET /api/fleet/enrollment_api_keys/{keyId} 
curl \
 -X GET https://localhost:5601/api/fleet/enrollment_api_keys/{keyId} \
 -H "elastic-api-version: 2023-10-31"
Response examples (200) 
{
  "item": {
    "active": true,
    "api_key": "string",
    "api_key_id": "string",
    "created_at": "string",
    "id": "string",
    "name": "string",
    "policy_id": "string"
  }
}
Response examples (400) 
{
  "error": "string",
  "message": "string",
  "statusCode": 42.0
}