IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Start maintenance mode
editStart maintenance mode
editStarts maintenance mode on the allocator.
Request
editPOST /api/v1/platform/infrastructure/allocators/{allocator_id}/maintenance-mode/_start
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The allocator identifier. |
Responses
edit-
202
-
The start maintenance mode command was issued successfully
-
403
-
The start maintenance mode command was prohibited for the given allocator. (code:
root.unauthorized.rbac
)Headers
-
x-cloud-error-codes
(string
; allowed values: [root.unauthorized.rbac
]) - The error codes associated with the response
-
-
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 -XPOST https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/maintenance-mode/_start \ -H "Authorization: ApiKey $ECE_API_KEY"