Update Fleet Server host by ID

PUT /api/fleet/fleet_server_hosts/{itemId}

Headers

kbn-xsrf string Required

Kibana's anti Cross-Site Request Forgery token. Can be any string value.

Path parameters

itemId string Required

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

Body

host_urls array[string]
is_default boolean
is_internal boolean
name string
proxy_id string | null

The ID of the proxy to use for this fleet server host. See the proxies API for more information.

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
  
  host_urls array[string] Required
  
  id string Required
  
  is_default boolean Required
  
  is_internal boolean
  
  is_preconfigured boolean Required
  
  name string
  
  proxy_id string
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/fleet_server_hosts/{itemId}

curl \
 -X PUT https://localhost:5601/api/fleet/fleet_server_hosts/{itemId} \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31" \
 -H "kbn-xsrf: string"

Request examples

# Headers
kbn-xsrf: string

# Payload
{
  "host_urls": [
    "string"
  ],
  "is_default": true,
  "is_internal": true,
  "name": "string",
  "proxy_id": "string"
}

Response examples (200)

{
  "item": {
    "host_urls": [
      "string"
    ],
    "id": "string",
    "is_default": true,
    "is_internal": true,
    "is_preconfigured": true,
    "name": "string",
    "proxy_id": "string"
  }
}

Response examples (400)

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