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
editStart maintenance mode of a constructor. It will stop constructing new plans while continuing with on-going ones.
Request
editPOST /api/v1/platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_start
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the constructor |
Responses
edit-
202 -
(
EmptyResponse) The start maintenance mode command was issued successfully -
403 -
(
BasicFailedReply) The start maintenance mode command was prohibited for the given constructor. (code:constructors.command_prohibited)Headers
-
x-cloud-error-codes(string; allowed values: [constructors.command_prohibited]) - The error codes associated with the response
-
-
404 -
(
BasicFailedReply) The constructor specified by {constructor_id} cannot be found. (code:constructors.constructor_not_found)Headers
-
x-cloud-error-codes(string; allowed values: [constructors.constructor_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
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request example
editcurl -XPOST https://{{hostname}}/api/v1/platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_start \
-H "Authorization: ApiKey $ECE_API_KEY"