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
Start maintenance mode of a constructor. It will stop constructing new plans while continuing with on-going ones.
Requestedit
POST /api/v1/platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_start
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The identifier of the constructor to put into maintenance mode. |
Responsesedit
-
202 -
(
EmptyResponse) The start maintenance mode command was issued successfully -
403 -
(
BasicFailedReply) The start maintenance mode command was prohibited for the given constructor. -
404 -
(
BasicFailedReply) The constructor specified by {constructor_id} cannot be found (code: 'constructors.constructor_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 exampleedit
curl -XPOST {{hostname}}/api/v1/platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_start \
-u $CLOUD_USER:$CLOUD_KEY