Update a Fleet Server host

PUT /api/fleet/fleet_server_hosts/{itemId}
Api key auth Basic auth

Update a Fleet Server host by ID.

[Required authorization] Route required privileges: fleet-settings-all.

Headers

  • kbn-xsrf string Required

    A required header to protect against CSRF attacks

Path parameters

  • itemId string Required
application/json

Body

  • host_urls array[string]

    At least 1 element.

  • is_default boolean
  • is_internal boolean
  • name string
  • proxy_id string | null Required
  • secrets object

    Additional properties are NOT allowed.

    Hide secrets attribute Show secrets attribute object
  • ssl object | null

    Additional properties are NOT allowed.

    Hide ssl attributes Show ssl attributes object | null
    • certificate string
    • certificate_authorities array[string]
    • client_auth string

      Values are optional, required, or none.

    • es_certificate string
    • es_certificate_authorities array[string]
    • es_key string
    • key string

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • item object Required

      Additional properties are NOT allowed.

      Hide item attributes Show item attributes object
      • host_urls array[string] Required

        At least 1 element.

      • id string Required
      • is_default boolean

        Default value is false.

      • is_internal boolean
      • is_preconfigured boolean

        Default value is false.

      • name string Required
      • proxy_id string | null
      • secrets object

        Additional properties are NOT allowed.

        Hide secrets attribute Show secrets attribute object
      • ssl object | null

        Additional properties are NOT allowed.

        Hide ssl attributes Show ssl attributes object | null
        • certificate string
        • certificate_authorities array[string]
        • client_auth string

          Values are optional, required, or none.

        • es_certificate string
        • es_certificate_authorities array[string]
        • es_key string
        • key string
  • 400 application/json
    Hide response attributes Show response attributes object
    • error string
    • errorType string
    • message string Required
    • statusCode number
PUT /api/fleet/fleet_server_hosts/{itemId} 
curl \
 --request PUT 'http://localhost:5601/api/fleet/fleet_server_hosts/{itemId}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '{"host_urls":["string"],"is_default":true,"is_internal":true,"name":"string","proxy_id":"string","secrets":{"ssl":{"es_key":{"id":"string"},"key":{"id":"string"}}},"ssl":{"certificate":"string","certificate_authorities":["string"],"client_auth":"optional","es_certificate":"string","es_certificate_authorities":["string"],"es_key":"string","key":"string"}}'