Start maintenance mode

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

Auth

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

Path parameters

The start maintenance mode command was issued successfully

application/json

Response Type: object

The start maintenance mode command was prohibited for the given constructor. (code: constructors.command_prohibited)

application/json

The constructor specified by {constructor_id} cannot be found. (code: constructors.constructor_not_found)

application/json

Examples

Request curl 1 / 1 language

curl Shell

curl -X POST "${API_URL}/platform/infrastructure/constructors/${CONSTRUCTOR_ID}/maintenance-mode/_start" \
  -u "${USERNAME}:${PASSWORD}"

Generated from the API spec

Response

{}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec