Cloud Accounts

Contents

Cloud Accounts

A cloud account stores the credentials needed to access a cloud provider. A cloud account allows the platform to commission and control servers on behalf of the user.

List Cloud Accounts

GET /v3/settings/cloud_accounts

Lists the cloud accounts of the customer.

Inputs

None

Returns

An array of cloud accounts of the following format:

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.

Back to top

Show Cloud Account

GET /v3/settings/cloud_accounts/:id

Shows information about a specific cloud account.

Inputs

None

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.

Back to top

Create Cloud Account

POST /v3/settings/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.

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.

Back to top

Update Cloud Account

PUT /v3/settings/cloud_accounts/:id

Modifies information about a specific cloud account.

Inputs

Field Type Description
name String The logical name for the cloud account.
credentials String Credentials of the cloud account. Only applicable if the subscription of the cloud account is standalone.

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.

Back to top

Delete Cloud Account

DELETE /v3/settings/cloud_accounts/:id

Deletes a specific cloud account.

Inputs

Field Type Description
force Boolean Flag indicating whether the cloud account must be destroyed even if it is not destroyable.

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.

Back to top

List policy assignments by cloud account

GET /v3/settings/cloud_accounts/:cloud_account_id/policy_assignments

Shows information about policy assignments applied in a cloud account, given its id.

Inputs

None

Returns

An array of policy assignments, with the following fields:

Field Type Description Deprecation notices Notes
id String Identifier of the policy assignment.    
name String Logical name of the policy assignment.    
description String Description of the policy definition.    
definition_id String Identifier of the policy definition which the policy assignment belongs.    
remote_id String Identifier of the assignment on the cloud provider.    
state String State of the assignment. It can be one of these values: start, applying, applied, decommissioning, application_error, decommission_error, end.    
cloud_account_id String Identifier of the cloud account where the assignment belongs.    
parameter_values Object An object with the parameters of the policy definition of the policy assignment with the values given to each one of them.    
reseller_applied Boolean Flag indicating if the assignment was assigned by the admin customer of the reseller of the customer of the user (true) or by the customer (false)    
label_ids String List of ids corresponding to the labels the policy assignment has assigned.    
resource_type String An identifier for the type of resource, specifically "policy assignment".    

Back to top