CSE Deployments
Contents
CSE Deployments
CSE deployments represent sets of different resources with a format and syntax specific to a cloud provider that a user can deploy on the cloud provider.
List CSE deployments
GET /v3/cse/deployments
This action returns information about all the cse deployments inside a customer.
Inputs
None
Returns
An array of CSE deployments, ordered from less to most recent, with the following fields:
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the CSE deployment. | ||
| name | String | Logical name of the CSE deployment. | ||
| template_id | String | Identifier of the CSE template which the CSE deployment belongs. | ||
| remote_id | String | Identifier of the deployment on the cloud provider. | ||
| state | String | State of the deployment. It can be one of these values: start, deploying, deployed, decommissioning, deploy_error, decommission_error, end. | ||
| cloud_account_id | String | Identifier of the cloud account where the deployment belongs. | ||
| realm_id | String | Identifier of the realm in which the CSE deployment is. | ||
| label_ids | String | List of ids corresponding to the labels the cse deployment has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "cse_deployment". |
Show CSE deployment
GET /v3/cse/deployments/:id
This action returns information about the CSE deployment identified by the given id.
Inputs
None
Returns
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the CSE deployment. | ||
| name | String | Logical name of the CSE deployment. | ||
| template_id | String | Identifier of the CSE template which the CSE deployment belongs. | ||
| remote_id | String | Identifier of the deployment on the cloud provider. | ||
| state | String | State of the deployment. It can be one of these values: start, deploying, deployed, decommissioning, deploy_error, decommission_error, end. | ||
| cloud_account_id | String | Identifier of the cloud account where the deployment belongs. | ||
| realm_id | String | Identifier of the realm in which the CSE deployment is. | ||
| parameter_values | Object | An object with the parameters of the CSE template of the CSE template with the values given to each one of them. | ||
| outputs | Object | An object with the outputs produced by the deployment of the CSE deployment in the cloud provider. | ||
| label_ids | String | List of ids corresponding to the labels the cse deployment has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "cse_deployment". |
Create CSE deployment
POST /v3/cse/templates/:template_id/deployments
This action creates a new CSE deployment.
Inputs
| Field | Type | Description | Required | Notes |
|---|---|---|---|---|
| name | String | Logical name of the CSE deployment. | Yes | |
| parameter_values | Object | Parameters of the templates with the specific values. | Yes | |
| template_id | String | Definition of the resources a template declares to be deployed. | Yes | |
| cloud_account_id | String | Identifier of the cloud account where the deployment belongs. | Yes | |
| is_stackset | Boolean | Flag indicating whether this CSE will be deployed in more than one realm. | No | This flag only applies for AWS cloud provider, on other cloud providers, this option is ignored. |
| realm_id | String | Identifier of the realm where the deployment is deployed | No | Only used if realm_ids is not provided. |
| realm_ids | String | List of identifiers of the realms where the deployment is deployed. | Yes* | Must be provided if realm_id is not provided. This parameter only applies for AWS cloud provider, on other cloud providers, only the first realm is taken into account to deploy the CSE template. |
| label_ids | Array of strings | List of ids corresponding to the labels to assign to the CSE deployment. | No |
Returns
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the CSE deployment. | ||
| name | String | Logical name of the CSE deployment. | ||
| template_id | String | Identifier of the CSE template which the CSE deployment belongs. | ||
| remote_id | String | Identifier of the deployment on the cloud provider. | ||
| state | String | State of the deployment. It can be one of these values: start, deploying, deployed, decommissioning, deploy_error, decommission_error, end. | ||
| cloud_account_id | String | Identifier of the cloud account where the deployment belongs. | ||
| realm_id | String | Identifier of the realm in which the CSE deployment is. | ||
| parameter_values | Object | An object with the parameters of the CSE template of the CSE template with the values given to each one of them. | ||
| outputs | Object | An object with the outputs produced by the deployment of the CSE deployment in the cloud provider. | ||
| label_ids | String | List of ids corresponding to the labels the cse deployment has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "cse_deployment". |
Update CSE deployment
PUT /v3/cse/deployments/:id
This action modifies the CSE deployment with the given parameters.
Inputs
| Field | Type | Description | Required |
|---|---|---|---|
| name | String | Logical name of the CSE deployment. | No |
Returns
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the CSE deployment. | ||
| name | String | Logical name of the CSE deployment. | ||
| template_id | String | Identifier of the CSE template which the CSE deployment belongs. | ||
| remote_id | String | Identifier of the deployment on the cloud provider. | ||
| state | String | State of the deployment. It can be one of these values: start, deploying, deployed, decommissioning, deploy_error, decommission_error, end. | ||
| cloud_account_id | String | Identifier of the cloud account where the deployment belongs. | ||
| realm_id | String | Identifier of the realm in which the CSE deployment is. | ||
| parameter_values | Object | An object with the parameters of the CSE template of the CSE template with the values given to each one of them. | ||
| outputs | Object | An object with the outputs produced by the deployment of the CSE deployment in the cloud provider. | ||
| label_ids | String | List of ids corresponding to the labels the cse deployment has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "cse_deployment". |
Delete CSE deployment
DELETE /v3/cse/deployments/:id
This action deletes the CSE deployment with the given id. The CSE deployment must be decommissionable.
Inputs
None
Returns
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the CSE deployment. | ||
| name | String | Logical name of the CSE deployment. | ||
| template_id | String | Identifier of the CSE template which the CSE deployment belongs. | ||
| remote_id | String | Identifier of the deployment on the cloud provider. | ||
| state | String | State of the deployment. It can be one of these values: start, deploying, deployed, decommissioning, deploy_error, decommission_error, end. | ||
| cloud_account_id | String | Identifier of the cloud account where the deployment belongs. | ||
| realm_id | String | Identifier of the realm in which the CSE deployment is. | ||
| parameter_values | Object | An object with the parameters of the CSE template of the CSE template with the values given to each one of them. | ||
| outputs | Object | An object with the outputs produced by the deployment of the CSE deployment in the cloud provider. | ||
| label_ids | String | List of ids corresponding to the labels the cse deployment has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "cse_deployment". |