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 »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.1] ›RESTful API ›API reference ›Platform - Allocators

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

integer

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) The allocator settings successfully changed.

404

(BasicFailedReply) The {allocator_id} can't be found. (code: 'allocators.allocator_not_found')

449

(BasicFailedReply) Elevated permissions are required. (code: '"root.needs_elevated_permissions"')

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
curl -XPUT {{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/settings \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "capacity" : 0
}
'
« Update allocator settings Platform - Configuration - Instances - CRUD »