Get constructor

GET /platform/infrastructure/constructors/{constructor_id}

Retrieves a constructor by id.

Path parameters

Responses

  • 200

    The information for the constructor specified by {constructor_id}.

    Hide response attributes Show response attributes object
    • status object Required

      The health status of the constructor.

      Additional properties are allowed.

      Hide status attributes Show status attributes object
      • connected boolean Required

        Whether the constructor is connected

      • maintenance_mode boolean Required

        Whether the constructor is in maintenance mode

    • constructor_id string Required

      Identifier for this constructor
  • 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
GET /platform/infrastructure/constructors/{constructor_id} 
curl \
 --request GET 'https://{{hostname}}/api/v1/platform/infrastructure/constructors/{constructor_id}'
Response examples (200) 
{
  "status": {
    "connected": true,
    "maintenance_mode": true
  },
  "constructor_id": "string"
}
Response examples (404) 
# Headers
x-cloud-error-codes: constructors.constructor_not_found

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