« Update proxy settings Get proxy »
Elastic Docs ›Elastic Cloud Enterprise Reference [3.7] ›RESTful API ›API reference ›Platform - proxies

Set proxy settings

edit

Set proxy settings

edit

This endpoint is deprecated and scheduled to be removed in the next major version.

Overwrites the proxy settings. All unspecified fields are deleted.

Request

edit

PUT /api/v1/platform/infrastructure/proxies/settings

Query parameters

edit
Name Type Required Description

version

string

N

If specified, checks for conflicts against the version of the settings (returned in 'x-cloud-resource-version' of the GET request)

Request body

edit

(ProxiesSettings) (required) The proxy settings to apply

Responses

edit
200

(ProxiesSettings)

Returns the updated settings

409

(BasicFailedReply)

There is a version conflict. (code: proxies.version_conflict)

Headers

x-cloud-error-codes (string; allowed values: [proxies.version_conflict])
The error codes associated with the response

Request example

edit
curl -XPUT https://{{hostname}}/api/v1/platform/infrastructure/proxies/settings \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "expected_proxies_count" : 0,
   "http_settings" : {
      "cookie_secret" : "string",
      "dashboards_base_url" : "string",
      "disconnected_cutoff" : 0,
      "minimum_proxy_services" : 0,
      "sso_settings" : {
         "cookie_name" : "string",
         "default_redirect_path" : "string",
         "dont_log_requests" : true,
         "maintenance_bypass_cookie_name" : "string",
         "max_age" : 0,
         "sso_secret" : "string"
      },
      "user_cookie_key" : "string"
   },
   "signature_secret" : "string",
   "signature_valid_for_millis" : 0
}
'
« Update proxy settings Get proxy »