- Home
- Resources
- ControlPlanesResource
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
Response Body
media type |
data type |
description |
application/json |
ApiCommand
(JSON) |
The command that generates the script |
POST /controlPlanes/commands/generateExternalVaultSetup
Launches the Generate Vault Setup Command command
Response Body
media type |
data type |
description |
application/json |
ApiCommand
(JSON) |
The command that generates and downloads the script |
POST /controlPlanes/commands/installControlPlane
Launches the install control plane command.
Response Body
media type |
data type |
description |
application/json |
ApiCommand
(JSON) |
The command that install a control plane. |
POST /controlPlanes/fetchResources/manifest.json
Fetches the manifest.json under the specified remote repo.
Request Body
media type |
data type |
description |
application/json |
ApiRemoteRepoUrl
(JSON) |
the remote repo url. |
Response Body
media type |
data type |
description |
application/json |
StreamingOutput
(JSON) |
the content of the manifest.json |
POST /controlPlanes/fetchResources/{commandId}/logContent
Fetches the log content for the specific command.
Request Parameters
name |
type |
description |
default |
commandId |
path |
the command id |
n/a |
Response Body
media type |
data type |
description |
text/plain |
object
|
the log content. |
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 |
Response Body
media type |
data type |
description |
application/json |
ApiCommand
(JSON) |
The command that uninstalls the control plane. |
POST /controlPlanes/{controlPlaneUuid}/commands/updateControlPlaneValuesYaml
Launches update the values.yaml from the control plane with the given uuid
This updates the content of values.yaml.merged in the CM database.
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 |
ApiCommand
(JSON) |
The command that updates the current values.yaml.merged from 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 |
Response Body
media type |
data type |
description |
application/json |
ApiCommand
(JSON) |
The command that upgrades the control plane. |