Update Fleet Server host by ID

Base URL: https://{kibana_url}

PUT /api/fleet/fleet_server_hosts/{itemId}
PUT /s/{space_id}/api/fleet/fleet_server_hosts/{itemId}

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.
itemId string required

Header parameters

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

Request body

host_urls string[]
is_default boolean
is_internal boolean
name string
proxy_id string nullable: The ID of the proxy to use for this fleet server host. See the proxies API for more information.

Responses

OK

application/json

item object required

Generic Error

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT kbn:/api/fleet/fleet_server_hosts/ITEM_ID
{}

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

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

Generated from the API spec

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

Generated from the API spec