It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Update allocator settingsedit
Applies the settings as a patch. Only the fields that are referenced in the update are altered.
Requestedit
PATCH /api/v1/platform/infrastructure/allocators/{allocator_id}/settings
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The allocator identifier. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
Checks for conflicts against the metadata version, then returns the value in the |
Request bodyedit
(string
) (required) The allocator settings to update
Responsesedit
-
200
-
(
AllocatorSettings
) Returns the updated settings for the specified allocator -
404
-
(
BasicFailedReply
) The allocator specified by {allocator_id} cannot be found. (code:allocators.allocator_not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [allocators.allocator_not_found
]) - 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 exampleedit
curl -XPATCH https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/settings \ -H "Authorization: ApiKey $ECE_API_KEY" \ -H 'Content-Type: application/json'