Get enrollment API keys

Server: https://{kibana_url}

GET /api/fleet/enrollment_api_keys

Api key auth Basic auth

List all enrollment API keys.

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

Query Parameters

Responses

Successful response

application/json

Bad Request

application/json

Examples

List of enrollment API keys

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET /api/fleet/enrollment_api_keys

curl Shell

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

Response

{
  "items": [
    {
      "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"
    }
  ],
  "list": [
    {
      "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"
    }
  ],
  "page": 1,
  "perPage": 20,
  "total": 1
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}

Query Parameters { page , perPage , kuery , }

Responses

Query Parameters