Create an enrollment API key

Base URL: https://{kibana_url}

POST /api/fleet/enrollment_api_keys

Create an enrollment API key for a given agent policy.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Header parameters

Request body

Responses

Successful response

application/json

Bad Request

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Create an enrollment API key for an agent policy

Console Kibana Dev Tools

POST kbn:/api/fleet/enrollment_api_keys
{
  "expiration": "2025-01-01T00:00:00.000Z",
  "name": "My enrollment key",
  "policy_id": "policy-id-1"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/enrollment_api_keys" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "expiration": "2025-01-01T00:00:00.000Z",
    "name": "My enrollment key",
    "policy_id": "policy-id-1"
  }'

Generated from the API spec

Response

The created enrollment API key

{
  "action": "created",
  "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": "My enrollment key",
    "policy_id": "policy-id-1"
  }
}

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

Required authorization

Authentication

Header parameters

Request body { }

Responses

Request body