Set allocator settingsedit
Overwrites the allocator settings with the specified settings. WARNING: Any unspecified fields are deleted.
Requestedit
PUT /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 apply
Responsesedit
-
200 -
Returns the updated settings for the specified allocator
-
404 -
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 -
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 -XPUT https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/settings \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
"capacity" : 0
}
'