Subscriptions
Contents
Subscriptions
A subscription represents an agreement with one or more cloud providers to use one or more cloud platforms or services.
List subscriptions
GET /v3/settings/subscriptions
It lists the subscriptions belonging to the customer using the API.
Inputs
None
Returns
An array of subscriptions, each with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the subscription. |
| name | String | Logical name of the subscription. |
| cloud_provider_ids | Array of Strings | Identifiers of the cloud providers allowed for this subscription. |
| remote_id | String | Identifier of the subscription on Connect / APS / CBC Hub. |
| state | String | State of the subscription. Specifically, can be one of the following: discovering, discovery_error, operational. |
| standalone | Boolean | Flag to indicate whether this subscription is standalone (true) or integrated (false). |
| counters | Hash | Hash containing number of resources deployed on the cloud accounts of the subscription, by type. |
| destroyable | Boolean | Flag to indicate whether this subscription can be destroyed or not. |
| resource_type | String | An identifier for the type of resource, specifically "subscription". |
Show subscription
GET /v3/settings/subscriptions/:id
It shows information about a subscription of the customer using the API.
Inputs
None
Returns
A subscription with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the subscription. |
| name | String | Logical name of the subscription. |
| cloud_provider_ids | Array of Strings | Identifiers of the cloud providers allowed for this subscription. |
| remote_id | String | Identifier of the subscription on Connect / APS / CBC Hub. |
| state | String | State of the subscription. Specifically, can be one of the following: discovering, discovery_error, operational. |
| standalone | Boolean | Flag to indicate whether this subscription is standalone (true) or integrated (false). |
| counters | Hash | Hash containing number of resources deployed on the cloud accounts of the subscription, by type. |
| destroyable | Boolean | Flag to indicate whether this subscription can be destroyed or not. |
| resource_type | String | An identifier for the type of resource, specifically "subscription". |
Discover subscription
PUT /v3/settings/subscriptions/:id/discover
It starts the execution of a cloud account discovery for the subscription.
Inputs
None
Returns
A subscription with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the subscription. |
| name | String | Logical name of the subscription. |
| cloud_provider_ids | Array of Strings | Identifiers of the cloud providers allowed for this subscription. |
| remote_id | String | Identifier of the subscription on Connect / APS / CBC Hub. |
| state | String | State of the subscription. Specifically, can be one of the following: discovering, discovery_error, operational. |
| standalone | Boolean | Flag to indicate whether this subscription is standalone (true) or integrated (false). |
| counters | Hash | Hash containing number of resources deployed on the cloud accounts of the subscription, by type. |
| destroyable | Boolean | Flag to indicate whether this subscription can be destroyed or not. |
| resource_type | String | An identifier for the type of resource, specifically "subscription". |