Cloudability Workload Planning API End Points

Workload Planning API end points can be used to create, manage your workloads, add resources and update Workload Planning Preferences.

Use Cases

1. Creating a workload
2. Uploading multiple resources for a given workload
3. Generating a recommendation and saving a recommendation
4. Exporting workload to csv
5. Duplicating workload
6. Deleting workload

Creating a workload and getting a workload ID

You will need to define your workload preferences and common information as a start.

Once validated, you will get the workload ID that will be required as a parameter for the next APIs.

curl -X 'POST' \ 'https://api.cloudability.com/v3/workload' \
-u '<Token Generated>' \
-H 'Content-Type: application/json' \
-d @- << EOF
		

[
  {
    "name": "Workload A",
    "description": "Cost estimate",
    "group": "string",
    "csp": [
  {
    "vendor": "AWS",
    "region": "us-east-1",
    "leaseType": "COMMITTED",
    "computeOffering": "COMPUTE",
    "commitmentTerm": "1 YEAR",
    "paymentOptions": "NO UPFRONT",
    "discountEnabled": true,
    "upliftEnabled": false,
    "discountDesc": "additional custom discount",
    "discountPercent": 5,
    "sudEnabled": false
  },
  {
    "vendor": "AZURE",
    "region": "us-east",
    "leaseType": "COMMITTED",
    "computeOffering": "RESERVED_INSTANCES",
    "commitmentTerm": "1 YEAR",
    "paymentOptions": "NO UPFRONT",
    "discountEnabled": false,
    "upliftEnabled": false,
    "discountDesc": "",
    "discountPercent": 0,
    "sudEnabled": false
  },
  {
    "vendor": "GCP",
    "region": "asia-southeast1",
    "leaseType": "COMMITTED",
    "computeOffering": "null",
    "commitmentTerm": "1 YEAR",
    "paymentOptions": "NO UPFRONT",
    "discountEnabled": true,
    "upliftEnabled": false,
    "discountDesc": "",
    "discountPercent": 0,
    "sudEnabled": false
  },
  ]
    "status": "IN PROGRESS",
    "preferredCsp": "AWS"
  },
  }

Response Object

curl-X'GET'\
'https://api.cloudability.com/v3/workload/static-data' \ 
-u '<Token Generated>'

Uploading multiple resources for a given workload

We currently only support the JSON format to upload multiple resources / requirements for your workload.

A. Download an example of file (template) or the list of existing resources

Example Request

curl -X 'GET' \
'https://api.cloudability.com/v3/workload/{download-type}/{format}/export/{workload-id}' \
-H 'accept: application/hal+json' \
-u '<Token Generated>'

B. Description of required keys for each service type

Virtual Machine

curl -X 'GET' \ 
'https://api.cloudability.com/v3/workload/managed-database/instance/{vendor}/{region}' \ 
-H 'accept: */*'

curl -X 'GET' \ 
'https://api.cloudability.com/v3/workload/storage/instance/{vendor}?serviceType=block' \ 
-u '<Token Generated>'

Managed Database

curl -X 'GET' \ 
'https://api.cloudability.com/v3/workload/storage/instance/{vendor}?serviceType=blob' \ 
-u '<Token Generated>

Additional Storage

curl -X 'GET' \ 
'https://api.cloudability.com/v3/workload/storage/instance/{vendor}?serviceType=block' \ 
-u '<Token Generated>'

Object Storage

curl -X 'GET' \ 
'https://api.cloudability.com/v3/workload/storage/instance/{vendor}?serviceType=blob' \ 
-u '<Token Generated>'

Load Balancer

Other

C. Importing the file to add resources

Example Request

curl -X 'POST' \
'https://api.cloudability.com/v3/workload/bulk-upload/{upload-type}{workload-id}' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'Resource file=@template.json;type=application/json' \
-u '<Token Generated>'

D. Getting the resources in error post upload

Example Request

curl -X 'GET' \
'https://api.cloudability.com/v3/workload/errors/export/{workload-id}' \
-H 'accept: application/json' \
-u '<Token Generated>'

Getting information about the added resources

The GET API below will provide the list of all resources that were recently added, resource ID and additional configuration details.

curl -X 'GET' \ 
' https://api.cloudability.com/v3/workload/{workload-id}/resource' \ 
-H 'accept: application/json' \

Generating Recommendations

You will need to run a job to generate the recommendation for your resources. The job needs to be executed once per workload, and it would need to be re-run if any requirement is updated later.

Example Request:

curl -X 'POST' \ 
'https://api.cloudability.com/v3/workload/job/{workload-ID}' \ 
-u '<Token Generated>' \ 
-d ''

Then, you can call the GET API below to check the job status and see if it was successful.

Example Request:

curl -X 'GET' \ 
'https://api.cloudability.com/v3/workload/job/status/{workload-ID}' \ 
-u '<Token Generated>' \ 
Request URL

Visualizing Recommendations

To get the recommendation for your resources, you will need to enter your workload ID and the vendor as parameters.

You will get the resource ID as well as a recommendation ID that will be used for the next step. The GET API below fives you details about all recommendations across all service types for a given CSP.

Example Request (for AWS):

curl -X 'GET' \ 
'https://api.cloudability.com/v3/workload/{workload-ID}/recommendations/aws' \
-u '<Token Generated>'

Saving Recommendations

To save each recommendation, you need to provide the resource ID, the recommendation ID, the CSP name and additional fields in the body using the PUT API call below.

For each requirement and each CSP, one recommendation should be saved. There can be a single PUT API call to save all recommendations at once.

The recommendations need to be part of array body for the PUT API call.

Whenever there is a new recommendation available, this PUT API call below needs to be updated accordingly.

Example Request:

curl -X 'PUT' \ 
'https://api.cloudability.com/v3/workload/{workload-ID}/cloud-cost' \
-u '<Token Generated>'
-H 'Content-Type: application/json' \
-d '

[
  {
    "resourceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "recommendationId": "3fa85f64-5717-4562-b3fc-2c963f66afa7",
    "serviceType": "compute",
    "csp": "AWS"
    "priceType": "ONDEMAND",
    "price": 200,
    "additionalInfo": "string"
}
]

Viewing Workload

Example Request (Workload "Summary" Tab):

curl -X 'GET' \ 
'https://api.cloudability.com/v3/workload/report/summary/{workload-id}?vendor={vendor}' \ 
-u '<Token Generated>'

Example Request (Workload "Analysis" Tab):

curl -X 'GET' \ 
'https://api.cloudability.com/v3/workload/report/analysis/{workload-id}?vendor={vendor}' \ 
-u '<Token Generated>'

Exporting Workload to CSV

Example Request

curl -X 'GET' \ 
'https://api.cloudability.com/v3/workload/report/export/{workload-id}' \
-u '<Token Generated>

Example Request

curl -X 'GET' \ 
'https://api.cloudability.com/v3/workload/report/export/{workload-id}' \
-u '<Token Generated>'

Duplicating workload

Example Request

Perform a GET request at the scorecards end point, specifying a view Id and dimension.

curl -X 'POST' \ 'https://api.cloudability.com/v3/workload/duplicate' \
-u '<Token Generated>' \
-H 'Content-Type: application/json' \
-d '{
"id": "string",
"name": "string"
}'

Deleting Workload

Example Request:

curl -X 'DELETE' \ 
'https://api.cloudability.com/v3/workload/{workload-id}' \ 
-u '<Token Generated>'

Getting the List of Workloads

Example Request:

curl -X 'GET' \ 
'https://api.cloudability.com/v3/workload?User-Type={user-type}' \ 
-u '<Token Generated>'

Updating Workload Planning Preferences

A. Current Workload Planning Preferences

Example Request:

curl -X 'GET' \ 
'https://api.cloudability.com/v3/workload/admin-preferences' \ 
-u '<Token Generated>'

Preference view feature is available to Admin users and the users who have view preferences permissions.

B. Updating Workload Planning Preferences

Example Request

curl -X 'PUT' \ 
'https://api.cloudability.com/v3/workload/admin-preferences' \ 
-u '<Token Generated>' \ 
-H 'Content-Type: application/json' \ 
-d '

'{
    "preferences": [
  { 
    "vendor": "string",
    "allowed": true,
    "onDemandEnabled": true,
    "committedEnabled": true,
    "spotEnabled": true,
    "capacityReservationEnabled": true,
    "commitmentDefaultOptionsDisabled": true,
    "computeOffering": "string",
    "commitmentTerm": "string",
    "paymentOptions": "string",
    "sudEnabled": true,
    "discountUpliftDesc": "string",
    "discountUpliftPercent": 100,
    "unusedCapacity": 100
  }
 ]
 }'
Send feed