Cloud Accounts
Contents
Cloud Accounts
A cloud account stores the credentials needed to use a cloud provider services. A cloud account allows the platform to commission and manage servers and VPCs on behalf of a customer's users.
List cloud accounts
GET /v3/admin/customers/:customer_id/cloud_accounts
It lists the cloud accounts available for a customer.
Inputs
None
Returns
An array of cloud accounts, each with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the cloud account. |
| cloud_provider_id | String | Identifier of the cloud provider. |
| subscription_id | String | Identifier of the subscription. |
| name | String | The logical name for the cloud account. |
| remote_id | String | Identifier of the cloud account on Connect / APS / CBC Hub. |
| destroyable | Boolean | Flag to indicate whether the cloud account can be destroyed or not. |
| resource_type | String | An identifier for the type of resource, specifically "cloud_account". |
| supports_importing | Boolean | Flag to indicate whether this cloud account supports importing servers. |
| supports_importing_vpcs | Boolean | Flag to indicate whether this cloud account supports importing VPCs. |
| supports_importing_floating_ips | Boolean | Flag to indicate whether this cloud account supports importing floating IPs. |
| supports_importing_volumes | Boolean | Flag to indicate whether this cloud account supports importing volumes. |
| supports_importing_policies | Boolean | Flag to indicate whether this cloud account supports importing policies. |
| supports_importing_kubernetes_clusters | Boolean | Flag to indicate whether this cloud account supports importing kubernetes clusters. |
Show cloud account
GET /v3/admin/cloud_accounts/:id
It shows information about a cloud account.
Inputs
None
Returns
A cloud account with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the cloud account. |
| cloud_provider_id | String | Identifier of the cloud provider. |
| subscription_id | String | Identifier of the subscription. |
| name | String | The logical name for the cloud account. |
| remote_id | String | Identifier of the cloud account on Connect / APS / CBC Hub. |
| destroyable | Boolean | Flag to indicate whether the cloud account can be destroyed or not. |
| resource_type | String | An identifier for the type of resource, specifically "cloud_account". |
| supports_importing | Boolean | Flag to indicate whether this cloud account supports importing servers. |
| supports_importing_vpcs | Boolean | Flag to indicate whether this cloud account supports importing VPCs. |
| supports_importing_floating_ips | Boolean | Flag to indicate whether this cloud account supports importing floating IPs. |
| supports_importing_volumes | Boolean | Flag to indicate whether this cloud account supports importing volumes. |
| supports_importing_policies | Boolean | Flag to indicate whether this cloud account supports importing policies. |
| supports_importing_kubernetes_clusters | Boolean | Flag to indicate whether this cloud account supports importing kubernetes clusters. |
Create cloud account by customer
POST /v3/admin/customers/:customer_id/cloud_accounts
It creates a cloud account for a customer. Deprecation warning: This route is deprecated and will be removed on API v4
Inputs
| Field | Type | Description | Required |
|---|---|---|---|
| cloud_provider_id | String | Identifier of the cloud provider. | Yes |
| credentials | Object | An object or dictionary with the credentials of the cloud account. It must have a property for every credential required by the cloud provider. | Yes |
| name | String | The logical name for the cloud account. | Yes |
| remote_id | String | Identifier of the cloud account on Connect / APS / CBC Hub. | No |
| validate_master_account | Boolean | Flag to indicate whether it is necessary to validate credentials in the master account. | No |
Returns
cloud account with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the cloud account. |
| cloud_provider_id | String | Identifier of the cloud provider. |
| subscription_id | String | Identifier of the subscription. |
| name | String | The logical name for the cloud account. |
| remote_id | String | Identifier of the cloud account on Connect / APS / CBC Hub. |
| destroyable | Boolean | Flag to indicate whether the cloud account can be destroyed or not. |
| resource_type | String | An identifier for the type of resource, specifically "cloud_account". |
| supports_importing | Boolean | Flag to indicate whether this cloud account supports importing servers. |
| supports_importing_vpcs | Boolean | Flag to indicate whether this cloud account supports importing VPCs. |
| supports_importing_floating_ips | Boolean | Flag to indicate whether this cloud account supports importing floating IPs. |
| supports_importing_volumes | Boolean | Flag to indicate whether this cloud account supports importing volumes. |
| supports_importing_policies | Boolean | Flag to indicate whether this cloud account supports importing policies. |
| supports_importing_kubernetes_clusters | Boolean | Flag to indicate whether this cloud account supports importing kubernetes clusters. |
Create Cloud Account by subscription
POST /v3/admin/subscriptions/:subscription_id/cloud_accounts
Creates a cloud account.
Inputs
| Field | Type | Description | |
|---|---|---|---|
| name | String | The logical name for the cloud account. | |
| credentials | String | Credentials of the cloud account. | |
| cloud_provider_id | String | Identifier of the cloud account. | |
| remote_id | String | Identifier of the cloud account on Connect / APS / CBC Hub. | No |
Returns
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the cloud account. |
| cloud_provider_id | String | Identifier of the cloud provider. |
| subscription_id | String | Identifier of the subscription. |
| name | String | The logical name for the cloud account. |
| remote_id | String | Identifier of the cloud account on Connect / APS / CBC Hub. |
| destroyable | Boolean | Flag to indicate whether the cloud account can be destroyed or not. |
| resource_type | String | An identifier for the type of resource, specifically "cloud_account". |
| supports_importing | Boolean | Flag to indicate whether this cloud account supports importing servers. |
| supports_importing_vpcs | Boolean | Flag to indicate whether this cloud account supports importing VPCs. |
| supports_importing_floating_ips | Boolean | Flag to indicate whether this cloud account supports importing floating IPs. |
| supports_importing_volumes | Boolean | Flag to indicate whether this cloud account supports importing volumes. |
| supports_importing_policies | Boolean | Flag to indicate whether this cloud account supports importing policies. |
| supports_importing_kubernetes_clusters | Boolean | Flag to indicate whether this cloud account supports importing kubernetes clusters. |
Update cloud account
PUT /v3/admin/cloud_accounts/:id
It updates the name and/or credentials of a cloud account.
Inputs
| Field | Type | Description | Required |
|---|---|---|---|
| credentials | Object | An object or dictionary with the credentials of the cloud account. It must have a property for every credential required by the cloud provider. | No |
| name | String | The logical name for the cloud account. | No |
| validate_master_account | Boolean | Flag to indicate whether it is necessary to validate credentials in the master account. | No |
Returns
A cloud account with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the cloud account. |
| cloud_provider_id | String | Identifier of the cloud provider. |
| subscription_id | String | Identifier of the subscription. |
| name | String | The logical name for the cloud account. |
| remote_id | String | Identifier of the cloud account on Connect / APS / CBC Hub. |
| destroyable | Boolean | Flag to indicate whether the cloud account can be destroyed or not. |
| resource_type | String | An identifier for the type of resource, specifically "cloud_account". |
| supports_importing | Boolean | Flag to indicate whether this cloud account supports importing servers. |
| supports_importing_vpcs | Boolean | Flag to indicate whether this cloud account supports importing VPCs. |
| supports_importing_floating_ips | Boolean | Flag to indicate whether this cloud account supports importing floating IPs. |
| supports_importing_volumes | Boolean | Flag to indicate whether this cloud account supports importing volumes. |
| supports_importing_policies | Boolean | Flag to indicate whether this cloud account supports importing policies. |
| supports_importing_kubernetes_clusters | Boolean | Flag to indicate whether this cloud account supports importing kubernetes clusters. |
Destroy cloud account
DELETE /v3/admin/cloud_accounts/:id
It deletes a cloud account from the platform. As a result of this API request, servers, VPCs and other resources deployed with or imported from the cloud account will cease to be represented on the platform API and UI. A cloud account cannot be destroyed if it has some associated resources in the platform unless the flag ‘force' set to true in the request. In the case this flag set to true, deletions are only on the platform, not on the cloud provider.
Inputs
| Field | Type | Description | Required |
|---|---|---|---|
| force | Boolean | Flag to indicate whether the cloud account is forced to be destroyed even it has associated resources. (Deletion only on the platform, not on the cloud provider) | No |
Returns
None