Headers

• elastic-api-version string

  The version of the API to use

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

Query parameters

• page number

  Default value is 1.

• perPage number

  Default value is 20.

• kuery string

Responses

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

  • items array[object] Required
    Hide items attributes Show items 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.

  • list array[object] Required Deprecated
    Hide list attributes Show list 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.

  • page number Required
  • perPage number Required
  • total number Required
• 400 application/json; Elastic-Api-Version=2023-10-31
  Hide response attributes Show response attributes object

  • error string
  • message string Required
  • statusCode number