Cloudability Vendor Credentials End Points (IBM)

Edit online

Summary

This end point is used to manage credentials within Cloudability that support the integration and ingestion of data from public cloud vendors. This includes tasks such as initial setup, listing out current credentials and deleting deprecated credentials.

  • This end point does not support filtering and sorting.

End Point Particulars

end point : /v3/vendors/ibm/accounts for RESTful CRUD interactions

end point : /v3/vendors/ibm/accounts?viewId=0

end point : /v3/vendors/ibm/accounts/<account_id>?include=permissions&viewId=0

end point : /v3/vendors/ibm/accounts/<account_id>

end point : /v3/vendors/ibm/accounts/<account_id>?viewId=0

end point : / v3/vendors/ibm/accounts/<account_id>/verification? include=permissions,associatedAccounts&viewId=0

end point : /v3/vendors/ibm/accounts/<account_id>/terraform-template

end point : /v3/vendors/ibm/accounts/<account_id>/archive?viewId=0

end point : /v3/vendors/ibm/permissions/accounts/<account_id>

end point : /v3/vendors/ibm/accounts?include=permissions&viewId=0

The Credential Object

vendorAccountID (string) - account id of IBM cloud

region (string) - region of the account

enterpriseID (string) - enterprise id of the IBM account

bucketName (string) - name of the bucket present in the IBM account

bucketRegion - region of bucket present in IBM account

storageInstantName - instance name of storage

costReportName - manifest file name

costPrefix - path of the manifest file

Example Requests

Note:

To ensure the API returns all accounts with these credential requests, add viewId=0 as a URL parameter. This will ensure any default view on your user account isn't applied.

Create Master Payer

end point 
/v3/vendors/ibm/accounts?viewId=0
curl -X POST 'https://api.cloudability.com/v3/vendors/ibm/accounts?viewId=0\\
-H 'Content-Type: application/json' \\
-u ‘[auth_token]:’ \\
-d @- << EOF
{
   "vendorAccountId": "1234567",
   "region": "us-east",
   "enterpriseId": "6dd1xxxx109xxxx1be976xxxxd6d62df",
   "ibmCostReportSpec": {
   	"bucketName": "daily-cost-exports-enterprise",
   	"bucketRegion": "us-east",
       "storageInstanceName": "Cloud Object Storage-InEnterpriseAccount",
       "costReportName": "manifest",
       "costPrefix": "IBMCloud-Billing-Reports"
},
      "type": "ibm_role"
}

Upon successful creation the API will return the credentials object.

Update Master Payer

end point /v3/vendors/ibm/accounts/<account_id>?include=permissions&viewId=0
 curl -X PUT 'https://api.cloudability.com/v3/vendors/ibm/accounts/<account_id>?viewId=0\\
-H 'Content-Type: application/json' \\
-u ‘[auth_token]:’ \\
-d @- << EOF
{
   "vendorAccountId": "1234567",
   "region": "us-east",
   "enterpriseId": "6dd1xxxx109xxxx1be976xxxxd6d62df",
   "ibmCostReportSpec": {
   	"bucketName": "daily-cost-exports-enterprise",
   	"bucketRegion": "us-east",
       "storageInstanceName": "Cloud Object Storage-InEnterpriseAccount",
       "costReportName": "manifest",
       "costPrefix": "IBMCloud-Billing-Reports"
},
      "type": "ibm_role"
}

Retrieve Account

end point 
/v3/vendors/ibm/accounts/<account_id>?viewId=0
curl
'https://api.cloudability.com/v3/vendors/ibm/accounts/<account_id>’\\
-u ‘[auth_token]:’

Delete Credential for Account

end point 
/v3/vendors/ibm/accounts/<account_id>?viewId=0
curl
'https://api.cloudability.com/v3/vendors/ibm/accounts/<account_id>?viewId=0\\
-u ‘[auth_token]:’

Verify Credential for Account

end point 
v3/vendors/ibm/accounts/<account_id>/verification?include=permissions,associatedAccounts&viewId=0
curl --X POST
'https://api.cloudability.com/v3/vendors/ibm/accounts/<account_id>/verification?include=permissions,associatedAccounts&viewId=0’\\
-u ‘[auth_token]:’

Get Terraform Template for Account

end point 
/v3/vendors/ibm/accounts/<account_id>/terraform-template
 curl
'https://api.cloudability.com/v3/vendors/ibm/<account_id>/terraform-template’\\
-u ‘[auth_token]:’

Archive Account

end point 
/v3/vendors/ibm/accounts/<account_id>/archive?viewId=0
 curl --X POST
'https://api.cloudability.com/v3/vendors/ibm/accounts/<account_id>archive?viewId=0’\\
-u ‘[auth_token]:’

Get Permissions for Account

end point 
/v3/vendors/ibm/permissions/accounts/<account_id>
 curl --X POST
'https://api.cloudability.com/v3/vendors/ibm/permissions/accounts/<account_id>’
\\
-u ‘[auth_token]:’

Get Account Details

end point 
/v3/vendors/ibm/accounts?include=permissions&viewId=0
curl --X POST
'https://api.cloudability.com/v3/vendors/ibm/<account?include=permissions&viewId=0’\\
-u ‘[auth_token]:’