Create a service token

Base URL: https://{kibana_url}

POST /api/fleet/service_tokens
POST /s/{space_id}/api/fleet/service_tokens

Auth

Create a Fleet Server service token. The token is used to enroll Fleet Server instances with Kibana.

Required authorization

Privileges fleet-agents-all

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

remote boolean · default: false

Responses

Successful response

application/json

name string required
value string required

Bad Request

application/json

attributes object required
error string
errorType string
message string required
statusCode number

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Generate a service token for a remote Fleet Server

Console Kibana Dev Tools

POST kbn:/api/fleet/service_tokens
{
  "remote": true
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/service_tokens" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "remote": true
  }'

Generated from the API spec

Response

The generated Fleet Server service token

{
  "name": "elastic/fleet-server/token-1234567890",
  "value": "AAEAAWVsYXN0aWMvZmxlZXQtc2VydmVyL3Rva2VuLTEyMzQ1Njc4OTA6QUJDREVGR0hJSktMTU5P"
}

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

Required authorization

Path parameters

Header parameters

Request body { }

Responses

Request body