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.

« Get allocator settings Set allocator settings »

› › › ›

Update allocator settings

edit

Update allocator settings

edit

Applies the provided settings as a patch - fields not referenced in this update will not be altered.

Request

edit

PATCH /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 update

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')
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 -XPATCH {{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/settings \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "capacity" : 0
}
'

« Get allocator settings Set allocator settings »