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 authorization

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
enabled boolean required
is_preconfigured boolean required
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
action_secret_storage_requirements_met boolean
delete_unenrolled_agents object
enabled boolean required
is_preconfigured boolean required
download_source_auth_secret_storage_requirements_met boolean
has_seen_add_data_notice boolean
id string
ilm_migration_status object
logs enum nullable
Values: success null
metrics enum nullable
Values: success null
synthetics enum nullable
Values: success null
integration_knowledge_enabled boolean
otlp_output_requirements_met boolean
output_secret_storage_requirements_met boolean
preconfigured_fields enum[] · max items: 1
Values: fleet_server_hosts
prerelease_integrations_enabled boolean
secret_storage_requirements_met boolean
ssl_secret_storage_requirements_met boolean
use_space_awareness_migration_started_at string nullable
use_space_awareness_migration_status enum
Values: pending success error
version string

Bad Request

application/json
attributes object required
error string
errorType string
message string required
statusCode number

Not Found

application/json
message string required
Base URL
https://{kibana_url}