Update settings

Base URL: https://{kibana_url}

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

Auth

Update the global Fleet settings.

Required privileges

Privileges fleet-settings-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

additional_yaml_config string deprecated
delete_unenrolled_agents object
has_seen_add_data_notice boolean deprecated
integration_knowledge_enabled boolean
kibana_ca_sha256 string deprecated
kibana_urls string[] · format: uri · max items: 10 deprecated
prerelease_integrations_enabled boolean

Responses

Successful response

application/json

item object required

Bad Request

application/json

Not Found

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Update Fleet settings to enable pre-release integrations

Console Kibana Dev Tools

PUT kbn:/api/fleet/settings
{
  "prerelease_integrations_enabled": true
}

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

The updated 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": true,
    "secret_storage_requirements_met": true,
    "version": "WzIsMV0="
  }
}

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

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