Update settings

PUT /api/fleet/settings

application/json; Elastic-Api-Version=2023-10-31

Body

additional_yaml_config string
delete_unenrolled_agents object

Additional properties are allowed.
Hide delete_unenrolled_agents attributes Show delete_unenrolled_agents attributes object
- enabled boolean
- is_preconfigured boolean
fleet_server_hosts array[string]

Protocol and path must be the same for each URL
has_seen_add_data_notice boolean

Responses

200 application/json; Elastic-Api-Version=2023-10-31

OK
Hide response attribute Show response attribute object
- item object Required
  
  Additional properties are allowed.
  
  Hide item attributes Show item attributes object
  
  delete_unenrolled_agents object
  
  Additional properties are allowed.
  
  Hide delete_unenrolled_agents attributes Show delete_unenrolled_agents attributes object
  
  enabled boolean
  
  is_preconfigured boolean
  
  fleet_server_hosts array[string] Required Deprecated
  
  has_seen_add_data_notice boolean
  
  id string Required
  
  prerelease_integrations_enabled boolean
400 application/json; Elastic-Api-Version=2023-10-31

Generic Error
Hide response attributes Show response attributes object
- error string
- message string
- statusCode number

PUT /api/fleet/settings

curl \
 -X PUT https://localhost:5601/api/fleet/settings \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31"

Request examples

{
  "additional_yaml_config": "string",
  "delete_unenrolled_agents": {
    "enabled": true,
    "is_preconfigured": true
  },
  "fleet_server_hosts": [
    "string"
  ],
  "has_seen_add_data_notice": true
}

Response examples (200)

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

Response examples (400)

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