Subscription APIs
These APIs are used to perform the following tasks:
Fetching List of Azure Subscriptions from CCKM
Use the get /v1/cckm/azure/subscriptions
API to retrieve the list of Azure subscriptions from CCKM. The results can be filtered using the query parameters.
Syntax
Request Parameter
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
Request Query Parameters
Parameter | Type | Description |
---|---|---|
id | string | ID of the subscription. |
skip | integer | Number of records to skip. For example, if "skip":5 is specified, the first five records will not be displayed in the output. |
limit | integer | Numbers of records to display. For example, if "limit":10 is specified, then the next 10 records (after skipping the number of records specified in the skip parameter ) will be displayed in the output. |
Example Request
Example Response
The sample output displays the list of the Azure subscription available on CCKM.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.
Retrieving List of Subscriptions from Azure
Use the post /v1/cckm/azure/get-subscriptions
API to get the list of subscriptions from Azure based on the connection.
Syntax
Request Parameters
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
connection | string | Name or ID of the connection based on which subscriptions are fetched. |
Example Request
Example Response
The sample output displays the list of subscription from Azure based on the connection (azure-connection
).
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.
Viewing Details of Azure Subscriptions
Use the get /v1/cckm/azure/subscriptions/{id}
API to view the details of a particular subscription.
Syntax
Here, {id}
represents the subscription ID.
Request Parameter
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
Example Request
Example Response
The sample output shows the details corresponding to the subscription ID (484f861a-81cc-4d5a-b92d-61bbcfe3fd96
).
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.