PUT /api/fleet/settings
Api key auth

Spaces method and path for this operation:

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

Refer to Spaces for more information.

Update the global Fleet settings.

[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 Deprecated
  • 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 Deprecated
  • integration_knowledge_enabled boolean
  • kibana_ca_sha256 string Deprecated
  • kibana_urls array[string(uri)] Deprecated

    Not more than 10 elements.

  • prerelease_integrations_enabled boolean

Responses

  • 200 application/json

    Successful response

    Hide response attribute Show response attribute object
    • item object Required

      Additional properties are NOT allowed.

      Hide item attributes Show item attributes object
      • action_secret_storage_requirements_met boolean
      • 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
      • download_source_auth_secret_storage_requirements_met boolean
      • has_seen_add_data_notice boolean
      • id string
      • ilm_migration_status object

        Additional properties are NOT allowed.

        Hide ilm_migration_status attributes Show ilm_migration_status attributes object
        • logs string | null

          Value is success.

        • metrics string | null

          Value is success.

        • synthetics string | null

          Value is success.

      • integration_knowledge_enabled boolean
      • output_secret_storage_requirements_met boolean
      • preconfigured_fields array[string]

        Not more than 1 element. Value is 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 | null
      • use_space_awareness_migration_status string

        Values are pending, success, or error.

      • version string
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • attributes Required
    • error string
    • errorType string
    • message string Required
    • statusCode number
  • 404 application/json

    Not Found

    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 '{"prerelease_integrations_enabled":true}'
Request example
Update Fleet settings to enable pre-release integrations 
{
  "prerelease_integrations_enabled": true
}
Response examples (200)
The updated Fleet settings 
{
  "item": {
    "delete_unenrolled_agents": {
      "enabled": false,
      "is_preconfigured": false
    },
    "has_seen_add_data_notice": true,
    "id": "fleet-default-settings",
    "output_secret_storage_requirements_met": true,
    "prerelease_integrations_enabled": true,
    "secret_storage_requirements_met": true,
    "version": "WzIsMV0="
  }
}
Response examples (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}
Response examples (404)
Fleet settings have not been initialized 
{
  "error": "Not Found",
  "message": "Settings not found",
  "statusCode": 404
}