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 settings Platform - Configuration - Instances - CRUD »

› › › ›

Set allocator settings

edit

Set allocator settings

edit

Overwrites the allocator settings with the specified settings. WARNING: Any unspecified fields are deleted.

Request

edit

PUT /api/v1/platform/infrastructure/allocators/{allocator_id}/settings

Path parameters

edit

Name	Type	Required	Description
`allocator_id`	`string`	Y	The allocator identifier.

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

(AllocatorSettings) (required) The allocator settings to apply

Responses

edit

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 example

edit

curl -XPUT https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/settings \
-H "Authorization: ApiKey $ECE_API_KEY" \
-d '
{
   "capacity" : 0
}
'

« Update allocator settings Platform - Configuration - Instances - CRUD »