Get agent setup info

Base URL: https://{kibana_url}

GET /api/fleet/agents/setup
GET /s/{space_id}/api/fleet/agents/setup

Auth

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.

Responses

application/json

isReady boolean required
missing_optional_features enum[] required: Values: encrypted_saved_object_encryption_key_required
missing_requirements enum[] required: Values: tls_required api_keys fleet_admin_user fleet_server
package_verification_key_id string

Generic Error

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/agents/setup

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/fleet/agents/setup" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{
  "isReady": false,
  "missing_optional_features": [
    "encrypted_saved_object_encryption_key_required"
  ],
  "missing_requirements": [
    "tls_required"
  ],
  "package_verification_key_id": "string"
}

Generated from the API spec

{
  "error": "string",
  "message": "string",
  "statusCode": 0
}

Generated from the API spec