Get settings

Base URL: https://{kibana_url}

GET /api/fleet/settings
GET /s/{space_id}/api/fleet/settings

Refer to Spaces for more information.

Get the global Fleet settings.

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>

Responses

Successful response

application/json

Bad Request

application/json

Not Found

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/settings

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

The current Fleet settings

{
  "item": {
    "delete_unenrolled_agents": {
      "enabled": false,
      "is_preconfigured": false
    },
    "has_seen_add_data_notice": true,
    "id": "fleet-default-settings",
    "otlp_output_requirements_met": true,
    "output_secret_storage_requirements_met": true,
    "prerelease_integrations_enabled": false,
    "secret_storage_requirements_met": true,
    "version": "WzEsMV0="
  }
}

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

{
  "error": "Not Found",
  "message": "Settings not found",
  "statusCode": 404
}