Start maintenance mode

edit

Start maintenance mode

edit

Start maintenance mode of a constructor. It will stop constructing new plans while continuing with on-going ones.

Request

edit

POST /api/v1/platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_start

Path parameters

edit

Name	Type	Required	Description
`constructor_id`	`string`	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

Request example

edit

curl -XPOST https://{{hostname}}/api/v1/platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_start \
-H "Authorization: ApiKey $ECE_API_KEY"

« Set constructor logging settings Stop maintenance mode »