Update a proxy

Base URL: https://{kibana_url}

PUT /api/fleet/proxies/{itemId}

Auth

Update a proxy by ID.

Required privileges

Privileges fleet-settings-all

Path parameters

itemId string required: The ID of the proxy

Header parameters

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

Request body

certificate string · default: null nullable
certificate_authorities string · default: null nullable
certificate_key string · default: null nullable
name string
proxy_headers map string to boolean | number | string nullable
url string

Responses

Successful response

application/json

item object required

Bad Request

application/json

404

Not Found

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Update a Fleet proxy

Console Kibana Dev Tools

PUT kbn:/api/fleet/proxies/ITEM_ID
{
  "name": "Updated proxy",
  "url": "http://updated-proxy.example.com:3128"
}

Generated from the API spec

curl Shell

curl -X PUT "${KIBANA_URL}/api/fleet/proxies/${ITEM_ID}" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated proxy",
    "url": "http://updated-proxy.example.com:3128"
  }'

Generated from the API spec

Response

The updated Fleet proxy

{
  "item": {
    "id": "proxy-id-1",
    "is_preconfigured": false,
    "name": "Updated proxy",
    "url": "http://updated-proxy.example.com:3128"
  }
}

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

{
  "error": "Not Found",
  "message": "Proxy proxy-id-1 not found",
  "statusCode": 404
}

Required privileges

Path parameters

Header parameters

Request body { }

Responses

Request body