# 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/generateCleanupDocker

Launches the Generate Docker Cleanup Script Command

Request Body
media type | data type | description
--- | --- | ---
application/json | ApiGenerateCleanupDockerArgs (JSON) | Arguments for the Command

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiCommand (JSON) | The command that generates the cleanup script

### 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/generateExternalVaultSetup

Launches the Generate Vault Setup Command command

Request Body
media type | data type | description
--- | --- | ---
application/json | ApiGenerateExternalVaultSetupArgs (JSON) | Arguments for the 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.

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/commands/installEmbeddedControlPlane

Brings up a control plane on embedded kubernetes. At its core, this command launches the FirstRun command on the Containerized Cluster.

Request Body
media type | data type | description
--- | --- | ---
application/json | ApiInstallEmbeddedControlPlaneArgs (JSON) | The arguments for Ek8s control plane installation

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiCommand (JSON) | The First Run command

### POST /controlPlanes/commands/upgradeEmbeddedControlPlane

Upgrade a Containerized Cluster, including upgrading the control plane running on embedded kubernetes.

Request Body
media type | data type | description
--- | --- | ---
application/json | ApiUpgradeEmbeddedControlPlaneArgs (JSON) | The arguments for Ek8s control plane upgrade

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiCommand (JSON) | The Upgrade Cluster command

### 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

### GET /controlPlanes/{controlPlaneUuid}/getTaggedCluster

The cluster with tags matching this control plane's UUID, if any

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 | ApiCluster (JSON) | The cluster attached to this control plane

### DELETE /controlPlanes/{controlPlaneUuid}/tags

Remove the tags associated with the control plane

Request Parameters
name | type | description | default
--- | --- | --- | ---
controlPlaneUuid | path | The uuid of the control plane. | n/a

Request Body
media type | data type | description
--- | --- | ---
application/json | array of ApiEntityTag (JSON) | A list of tags to remove from the control plane

Response Body
media type | data type | description
--- | --- | ---
application/json | array of ApiEntityTag (JSON) | A list of tags that were removed from the control plane

### GET /controlPlanes/{controlPlaneUuid}/tags

Returns the tags associated with this control plane.

Request Parameters
name | type | description | default
--- | --- | --- | ---
controlPlaneUuid | path | The uuid of the control plane. | n/a
limit | query | Number of tags | 10
offset | query | Index of the first tag to retrieve | 0

Response Body
media type | data type | description
--- | --- | ---
application/json | array of ApiEntityTag (JSON) | A list of tags associated with the control plane

### PUT /controlPlanes/{controlPlaneUuid}/tags

Attach tags to the control plane.

Request Parameters
name | type | description | default
--- | --- | --- | ---
controlPlaneUuid | path | The uuid of the control plane. | n/a

Request Body
media type | data type | description
--- | --- | ---
application/json | array of ApiEntityTag (JSON) | List of tags to add to the control plane

Response Body
media type | data type | description
--- | --- | ---
application/json | array of ApiEntityTag (JSON) | A list of tags that were added to the control plane

### 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/copyImagesInFeatures

Launches the command to copy images for one or more features (a comma separated list).

Request Parameters
name | type | description | default
--- | --- | --- | ---
controlPlaneUuid | path |  | n/a

Request Body
media type | data type | description
--- | --- | ---
application/json | ApiCopyImagesInFeaturesArgs (JSON) | Arguments for the Command

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiCommand (JSON) | The command that does the copying.

### 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/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

Request Body
media type | data type | description
--- | --- | ---
application/json | ApiUpdateControlPlaneValuesYamlArgs (JSON) | Arguments for the Command

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

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.