Update settings

Server: https://{kibana_url}

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

Api key auth

Refer to Spaces for more information.

Update the global Fleet settings.

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

Request

Responses

Successful response

application/json

Bad Request

application/json

Not Found

application/json

Examples

Update Fleet settings to enable pre-release integrations

Request Console 1 / 2 languages

Console Kibana Dev Tools

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

curl Shell

curl -X PUT "https://{kibana_url}/api/fleet/settings" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "prerelease_integrations_enabled": true
}'

Response

{
  "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
}

Request { additional_yaml_config , delete_unenrolled_agents , has_seen_add_data_notice , integration_knowledge_enabled , kibana_ca_sha256 , kibana_urls , prerelease_integrations_enabled , }

Responses

Request