Platform - Constructors

Get constructors

Retrieves an overview of all constructors in an ECE installation.

Request

GET /api/v1/platform/infrastructure/constructors

Responses

200
(ConstructorOverview) An overview of all constructors.
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/platform/infrastructure/constructors \
-u $CLOUD_USER:$CLOUD_KEY

Get constructor

Retrieves a constructor by id.

Request

GET /api/v1/platform/infrastructure/constructors/{constructor_id}

Path parameters

Name Type Required Description

constructor_id

string

Y

Identifier for the constructor

Responses

200
(ConstructorInfo) The information for the constructor specified by {constructor_id}.
404
(BasicFailedReply) The constructor specified by {constructor_id} cannot be found (code: 'constructors.constructor_not_found')
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/platform/infrastructure/constructors/{constructor_id} \
-u $CLOUD_USER:$CLOUD_KEY

Resynchronize constructor

Immediately resynchronizes the search index and cache for the selected constructor.

Request

POST /api/v1/platform/infrastructure/constructors/{constructor_id}/_resync

Path parameters

Name Type Required Description

constructor_id

string

Y

The identifier for the constructor

Responses

200
(EmptyResponse) The constructor resync operation executed successfully
449
(BasicFailedReply) elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')
500
(BasicFailedReply) The constructor resync operation failed for allocator {constructor_id} (code: 'constructors.resync_failed')
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/platform/infrastructure/constructors/{constructor_id}/_resync \
-u $CLOUD_USER:$CLOUD_KEY

Start maintenance mode

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

Request

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

Path parameters

Name Type Required Description

constructor_id

string

Y

The identifier of the constructor to put into maintenance mode.

Responses

202
(EmptyResponse) The start maintenance mode command was issued successfully
403
(BasicFailedReply) The start maintenance mode command was prohibited for the given constructor.
404
(BasicFailedReply) The constructor specified by {constructor_id} cannot be found (code: 'constructors.constructor_not_found')
449
(BasicFailedReply) elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_start \
-u $CLOUD_USER:$CLOUD_KEY

Stop maintenance mode

Stop maintenance mode of a constructor. It will resume the construction of submitted plans.

Request

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

Path parameters

Name Type Required Description

constructor_id

string

Y

The identifier of the constructor to get out of maintenance mode.

Responses

202
(EmptyResponse) The stop maintenance mode command was issued successfully
403
(BasicFailedReply) The stop maintenance mode command was prohibited for the given constructor.
404
(BasicFailedReply) The constructor specified by {constructor_id} cannot be found (code: 'constructors.constructor_not_found')
449
(BasicFailedReply) elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_stop \
-u $CLOUD_USER:$CLOUD_KEY