A newer version is available. For the latest information, see the
current release documentation.
Set proxy settings
editSet proxy settings
editOverwrites the proxy settings. All unspecified fields are deleted.
Request
editPUT /api/v1/platform/infrastructure/proxies/settings
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
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
-
Returns the updated settings
Headers
-
x-cloud-resource-created
(string
) - The date-time when the resource was created (ISO format relative to UTC)
-
x-cloud-resource-last-modified
(string
) - The date-time when the resource was last modified (ISO format relative to UTC)
-
x-cloud-resource-version
(string
) - The resource version, which is used to avoid update conflicts with concurrent operations
-
-
409
-
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
-
-
449
-
Elevated permissions are required. (code:
root.unauthorized.rbac.elevated_permissions_required
)Headers
-
x-cloud-error-codes
(string
; allowed values: [root.unauthorized.rbac.elevated_permissions_required
]) - The error codes associated with the response
-
Request example
editcurl -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 } '