Update settings

PUT /api/fleet/settings
Api key auth

[Required authorization] Route required privileges: fleet-settings-all.

Headers

  • kbn-xsrf string Required

    A required header to protect against CSRF attacks

application/json

Body

  • additional_yaml_config string
  • delete_unenrolled_agents object

    Additional properties are NOT allowed.

    Hide delete_unenrolled_agents attributes Show delete_unenrolled_agents attributes object
    • enabled boolean Required
    • is_preconfigured boolean Required
  • has_seen_add_data_notice boolean
  • kibana_ca_sha256 string
  • kibana_urls array[string(uri)]
  • prerelease_integrations_enabled boolean

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • item object Required

      Additional properties are NOT allowed.

      Hide item attributes Show item attributes object
      • delete_unenrolled_agents object

        Additional properties are NOT allowed.

        Hide delete_unenrolled_agents attributes Show delete_unenrolled_agents attributes object
        • enabled boolean Required
        • is_preconfigured boolean Required
      • has_seen_add_data_notice boolean
      • id string Required
      • output_secret_storage_requirements_met boolean
      • preconfigured_fields array[string]

        Value is fleet_server_hosts.

      • prerelease_integrations_enabled boolean
      • secret_storage_requirements_met boolean
      • use_space_awareness_migration_started_at string | null
      • use_space_awareness_migration_status string

        Values are pending, success, or error.

      • version string
  • 400 application/json
    Hide response attributes Show response attributes object
    • error string
    • errorType string
    • message string Required
    • statusCode number
  • 404 application/json
    Hide response attribute Show response attribute object
    • message string Required
PUT /api/fleet/settings 
curl \ --request PUT 'https://<KIBANA_URL>/api/fleet/settings' \ --header "Authorization: $API_KEY" \ --header "Content-Type: application/json" \ --header "kbn-xsrf: true" \ --data '{"additional_yaml_config":"string","delete_unenrolled_agents":{"enabled":true,"is_preconfigured":true},"has_seen_add_data_notice":true,"kibana_ca_sha256":"string","kibana_urls":["https://example.com"],"prerelease_integrations_enabled":true}'