Update a proxy

Base URL: https://{kibana_url}

PUT /api/fleet/proxies/{itemId}

Update a proxy by ID.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Header parameters

Request body

Responses

Successful response

application/json

Bad Request

application/json

404

Not Found

application/json

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 authorization

Authentication

Path parameters

Header parameters

Request body { }

Responses

Request body