Update settings

Base URL: https://{kibana_url}

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

Auth

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.

Request body

additional_yaml_config string
delete_unenrolled_agents object
fleet_server_hosts string[]: Protocol and path must be the same for each URL
has_seen_add_data_notice boolean

Responses

application/json

item object required

Generic Error

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT kbn:/api/fleet/settings
{}

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

{
  "item": {
    "delete_unenrolled_agents": {
      "enabled": false,
      "is_preconfigured": false
    },
    "fleet_server_hosts": [
      "string"
    ],
    "has_seen_add_data_notice": false,
    "id": "string",
    "prerelease_integrations_enabled": false
  }
}

Generated from the API spec

{
  "error": "string",
  "message": "string",
  "statusCode": 0
}

Generated from the API spec

Path parameters

Request body { }

Responses

Request body