Start maintenance mode

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

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

Path parameters

Responses

  • 202

    The start maintenance mode command was issued successfully

    Additional properties are allowed.
  • 403

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

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is constructors.command_prohibited.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
  • 404

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

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is constructors.constructor_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
POST /platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_start 
curl \
 -X POST https://{{hostname}}/api/v1/platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_start
Response examples (202) 
{}
Response examples (403) 
# Headers
x-cloud-error-codes: constructors.command_prohibited

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (404) 
# Headers
x-cloud-error-codes: constructors.constructor_not_found

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