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.
Start maintenance modeedit
Starts maintenance mode on the allocator.
Requestedit
POST /api/v1/platform/infrastructure/allocators/{allocator_id}/maintenance-mode/_start
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The allocator identifier. |
Responsesedit
-
202
-
(
EmptyResponse
) The start maintenance mode command was issued successfully -
403
-
(
BasicFailedReply
) 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
-
(
BasicFailedReply
) 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
-
(
BasicFailedReply
) 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 -XPOST https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/maintenance-mode/_start \ -H "Authorization: ApiKey $ECE_API_KEY"