IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Update allocator settings
editUpdate allocator settings
editApplies the settings as a patch. Only the fields that are referenced in the update are altered.
Request
editPATCH /api/v1/platform/infrastructure/allocators/{allocator_id}/settings
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The allocator identifier. |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
Checks for conflicts against the metadata version, then returns the value in the |
Request body
edit(string
) (required) The allocator settings to update
Responses
edit-
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 example
editcurl -XPATCH https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/settings \ -H "Authorization: ApiKey $ECE_API_KEY" \ -H 'Content-Type: application/json'