Update proxy settings

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Update proxy settings

edit

Applies the settings as a patch. Only the fields that are referenced in the update are changed.

Request

edit

PATCH /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 repository configuration (returned in 'x-cloud-resource-version' of the GET request)

Request body

edit

(string) (required) A JSON to merge with the existing settings

Responses

edit

200

(ProxiesSettings)

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

(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

449

(BasicFailedReply)

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

edit

curl -XPATCH https://{{hostname}}/api/v1/platform/infrastructure/proxies/settings \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json'

« Get proxies settings Set proxy settings »