Update filtered group of proxies

edit

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

Update filtered group of proxies

edit

Update the settings for a filtered group of proxies.

Request

edit

PUT /api/v1/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}

Path parameters

edit

Name	Type	Required	Description
`proxies_filtered_group_id`	`string`	Y	"The identifier for the filtered group of proxies

Query parameters

edit

Name	Type	Required	Description
`version`	`string`	N	Checks for conflicts against the metadata version, then returns the value in the `x-cloud-resource-version` header.

Request body

edit

(ProxiesFilteredGroup) (required) Data for the filtered group of proxies to update

Responses

edit

200

(ProxiesFilteredGroup)

Returns the created or updated filtered group of proxies

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

400

(BasicFailedReply)

The provided identifier doesn't match the identifier in the object. (code: proxies.proxies_filtered_group_id_conflict)

Headers

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

409

(BasicFailedReply)

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

Headers

x-cloud-error-codes (string; allowed values: [proxies.proxies_filtered_group_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 -XPUT https://{{hostname}}/api/v1/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id} \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "expected_proxies_count" : 0,
   "filters" : [
      {
         "key" : "string",
         "value" : "string"
      }
   ],
   "id" : "string"
}
'

« Get filtered group of proxies Get health for a filtered group of proxies »