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
(AllocatorSettings
) (required) The allocator settings to update
Responsesedit
-
200
-
(
AllocatorSettings
) The allocator settings successfully updated. -
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 exampleedit
curl -XPATCH {{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/settings \ -u $CLOUD_USER:$CLOUD_KEY \ -H 'Content-Type: application/json' \ -d ' { "capacity" : 0 } '