CSE Templates
Contents
CSE Templates
CSE templates represent templates which specify a set of different resources with a format and syntax specific to a cloud provider that can be deployed on the cloud provider.
List CSE templates
GET /v2/cse/templates
This action returns information about all the templates inside a customer.
Inputs
None
Returns
An array of CSE templates, ordered from less to most recent, with the following fields:
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the CSE template. | ||
| name | String | Logical name of the CSE template. | ||
| definition | String | Definition of the resources a template declares to be deployed. | ||
| parameters | Object | An object defining the parameters the template will use to set values to it. Each element has a definition of the parameter with certain information to describe the parameter. This is generated from the definition of the template. | ||
| syntax | String | Syntax of the template. Specifically, "Mock", "ARM" or "AWS". | ||
| global | Boolean | Flag indicating if the CSE template is global for all users to use it. | ||
| label_ids | String | List of ids corresponding to the labels the cse template has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "cse_template". |
Show CSE template
GET /v2/cse/templates/:id
This action returns information about the CSE template identified by the given id.
Inputs
None
Returns
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the CSE template. | ||
| name | String | Logical name of the CSE template. | ||
| definition | String | Definition of the resources a template declares to be deployed. | ||
| parameters | Object | An object defining the parameters the template will use to set values to it. Each element has a definition of the parameter with certain information to describe the parameter. This is generated from the definition of the template. | ||
| syntax | String | Syntax of the template. Specifically, "Mock", "ARM" or "AWS". | ||
| global | Boolean | Flag indicating if the CSE template is global for all users to use it. | ||
| label_ids | String | List of ids corresponding to the labels the cse template has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "cse_template". |
Create CSE template
POST /v2/cse/templates/
This action creates a new CSE template.
Inputs
| Field | Type | Description | Required |
|---|---|---|---|
| name | String | Logical name of the CSE template. | Yes |
| syntax | String | Syntax of the template. Specifically, "Mock", "ARM" or "AWS". | Yes |
| definition | String | Definition of the resources a template declares to be deployed. | Yes |
| label_ids | Array of strings | List of ids corresponding to the labels to assign to the CSE template. | No |
Returns
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the CSE template. | ||
| name | String | Logical name of the CSE template. | ||
| definition | String | Definition of the resources a template declares to be deployed. | ||
| parameters | Object | An object defining the parameters the template will use to set values to it. Each element has a definition of the parameter with certain information to describe the parameter. This is generated from the definition of the template. | ||
| syntax | String | Syntax of the template. Specifically, "Mock", "ARM" or "AWS". | ||
| global | Boolean | Flag indicating if the CSE template is global for all users to use it. | ||
| label_ids | String | List of ids corresponding to the labels the cse template has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "cse_template". |
Update CSE template
PUT /v2/cse/templates/:id
This action modifies the CSE template with the given parameters.
Inputs
| Field | Type | Description | Required |
|---|---|---|---|
| name | String | Logical name of the CSE template. | No |
Returns
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the CSE template. | ||
| name | String | Logical name of the CSE template. | ||
| definition | String | Definition of the resources a template declares to be deployed. | ||
| parameters | Object | An object defining the parameters the template will use to set values to it. Each element has a definition of the parameter with certain information to describe the parameter. This is generated from the definition of the template. | ||
| syntax | String | Syntax of the template. Specifically, "Mock", "ARM" or "AWS". | ||
| global | Boolean | Flag indicating if the CSE template is global for all users to use it. | ||
| label_ids | String | List of ids corresponding to the labels the cse template has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "cse_template". |
Delete CSE template
DELETE /v2/cse/templates/:id
This action deletes the CSE template with the given id. The CSE template must be not in use to be able to be destroyed.
Inputs
None
Returns
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the CSE template. | ||
| name | String | Logical name of the CSE template. | ||
| definition | String | Definition of the resources a template declares to be deployed. | ||
| parameters | Object | An object defining the parameters the template will use to set values to it. Each element has a definition of the parameter with certain information to describe the parameter. This is generated from the definition of the template. | ||
| syntax | String | Syntax of the template. Specifically, "Mock", "ARM" or "AWS". | ||
| global | Boolean | Flag indicating if the CSE template is global for all users to use it. | ||
| label_ids | String | List of ids corresponding to the labels the cse template has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "cse_template". |
Get CSE deployments of a CSE template
GET /v2/cse/templates/:template_id/deployments
This action returns the CSE deployments that use the CSE template identified by the given template_id.
Inputs
None
Returns
An array of CSE deployments, 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". |