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

Spaces method and path for this operation:

put /s/{space_id}/api/fleet/proxies/{itemId}

Refer to Spaces for more information.

Update a proxy 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

  • certificate string | null Required
  • certificate_authorities string | null Required
  • certificate_key string | null Required
  • name string
  • proxy_headers object | null
  • url string

Responses

  • 200 application/json

    Successful response

    Hide response attribute Show response attribute object
    • item object Required

      Additional properties are NOT allowed.

      Hide item attributes Show item attributes object
      • certificate string | null
      • certificate_authorities string | null
      • certificate_key string | null
      • id string Required
      • is_preconfigured boolean

        Default value is false.

      • name string Required
      • proxy_headers object | null
      • url string Required
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • attributes Required
    • error string
    • errorType string
    • message string Required
    • statusCode number
  • 404 application/json

    Not Found

PUT /api/fleet/proxies/{itemId} 
curl \
 --request PUT 'https://localhost:5601/api/fleet/proxies/{itemId}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '{"name":"Updated proxy","url":"http://updated-proxy.example.com:3128"}'
Request example
Update a Fleet proxy 
{
  "name": "Updated proxy",
  "url": "http://updated-proxy.example.com:3128"
}
Response examples (200)
The updated Fleet proxy 
{
  "item": {
    "id": "proxy-id-1",
    "is_preconfigured": false,
    "name": "Updated proxy",
    "url": "http://updated-proxy.example.com:3128"
  }
}
Response examples (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}
Response examples (404)
No proxy was found with the given ID 
{
  "error": "Not Found",
  "message": "Proxy proxy-id-1 not found",
  "statusCode": 404
}