Update a Fleet Server host

Base URL: https://{kibana_url}

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

Auth

Update a Fleet Server host by ID.

Required privileges

Privileges fleet-settings-all

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 · min length: 0 required: The ID of the Fleet Server host

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

allow_edit string[] · max items: 100
host_urls string[] · min items: 1 · max items: 10
is_default boolean
is_internal boolean
name string · min length: 0
proxy_id string · min length: 0 · default: null nullable
secrets object
ssl object nullable

Responses

Successful response

application/json

item object required

Bad Request

application/json

404

Not Found

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Update a Fleet Server host

Console Kibana Dev Tools

PUT kbn:/api/fleet/fleet_server_hosts/ITEM_ID
{
  "host_urls": [
    "https://updated-fleet-server.example.com:8220"
  ],
  "is_default": false,
  "name": "Updated Fleet Server"
}

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 '{
    "host_urls": [
      "https://updated-fleet-server.example.com:8220"
    ],
    "is_default": false,
    "name": "Updated Fleet Server"
  }'

Generated from the API spec

Response

The updated Fleet Server host

{
  "item": {
    "host_urls": [
      "https://updated-fleet-server.example.com:8220"
    ],
    "id": "fleet-server-host-id-1",
    "is_default": false,
    "is_preconfigured": false,
    "name": "Updated Fleet Server"
  }
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}

{
  "error": "Not Found",
  "message": "Fleet server fleet-server-host-id-1 not found",
  "statusCode": 404
}

Required privileges

Path parameters

Header parameters

Request body { }

Responses

Request body