ControlPlanesResource Resource

GET /controlPlanes

Current Control Planes

Response Body
media type data type description
application/json ApiControlPlaneList (JSON) Detailed description of the current control planes.

GET /controlPlanes/{controlPlaneUuid}

The control plane with the given id

Request Parameters
name type description default
controlPlaneUuid path The universally unique id of the control plane n/a
Response Body
media type data type description
application/json ApiControlPlane (JSON) Detailed description of the control plane.

POST /controlPlanes/commands/generateCopyDocker

Launches the Generate Copy Docker Script Command

Request Body
media type data type description
application/json ApiGenerateCopyDockerArgs (JSON) Arguments for the Command
Response Body
media type data type description
application/json ApiCommand (JSON) The command that generates the script

POST /controlPlanes/commands/installControlPlane

Launches the install control plane command.

Request Body
media type data type description
application/json ApiInstallControlPlaneArgs (JSON) Arguments for the Command
Response Body
media type data type description
application/json ApiCommand (JSON) The command that install a control plane.

POST /controlPlanes/fetchResources/logContent

Fetches the log content for the specific command.

Request Parameters
name type description default
commandId form the command id n/a
Response Body
media type data type description
text/plain (custom) the log content.

POST /controlPlanes/fetchResources/manifest.json

Fetches the manifest.json under the specified remote repo.

Request Parameters
name type description default
remoteRepoUrl form the remote repo url. n/a
Response Body
media type data type description
application/json object (JSON) the content of the manifest.json

POST /controlPlanes/{controlPlaneUuid}/commands/uninstallControlPlane

Launches Uninstall Command on the control plane with the given uuid

Request Parameters
name type description default
controlPlaneUuid path The universally unique id of the control plane n/a
Request Body
media type data type description
application/json ApiUninstallControlPlaneArgs (JSON) Arguments for the Command
Response Body
media type data type description
application/json ApiCommand (JSON) The command that uninstalls the control plane.

POST /controlPlanes/{controlPlaneUuid}/commands/upgradeControlPlane

Launches the Upgrade Command on the control plane with the given uuid

Request Parameters
name type description default
controlPlaneUuid path The universally unique id of the control plane n/a
Request Body
media type data type description
application/json ApiUpgradeControlPlaneArgs (JSON) Arguments for the Command
Response Body
media type data type description
application/json ApiCommand (JSON) The command that upgrades the control plane.