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 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 |
Allocator identifier |
Responses
edit-
202
-
(
EmptyResponse
) The start maintenance mode command was issued successfully -
403
-
(
BasicFailedReply
) The start maintenance mode command was prohibited for the given cluster. -
404
-
(
BasicFailedReply
) The allocator specified by {allocator_id} cannot be found (code: 'allocators.allocator_not_found') -
449
-
(
BasicFailedReply
) elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request example
editcurl -XPOST {{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/maintenance-mode/_start \ -u $CLOUD_USER:$CLOUD_KEY