Cloud Cost Budgets

Manage Budgets and receive alerts when your costs exceed (or are forecasted to exceed) your budget.

Clone a budget

Clone a Cloud Cost Budget using the given Budget ID.

SecurityApiKey
Request
path Parameters
id
required
string

Unique identifier for the budget

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

cloneName
required
string

Name of the new budget

Responses
400

Bad Request

500

Internal server error

default

Returns the identifier string of the new Budget created using clone operation

post/ccm/api/budgets/{id}
Request samples
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Create a Budget

Create a Budget to set and receive alerts when your costs exceed (or are forecasted to exceed) your budget amount.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema: application/json

Budget definition

uuid
string
accountId
required
string
name
required
string [ 1 .. 80 ] characters
object (BudgetScope)

The scope in which the Budget was created

type
string

Whether the Budget is based on a specified amount or based on previous month's actual spend

Enum: "SPECIFIED_AMOUNT" "PREVIOUS_MONTH_SPEND" "PREVIOUS_PERIOD_SPEND"
budgetAmount
number <double>
period
string
Enum: "DAILY" "WEEKLY" "MONTHLY" "QUARTERLY" "YEARLY"
growthRate
number <double>
actualCost
number <double>
forecastCost
number <double>
lastMonthCost
number <double>
Array of objects (AlertThreshold)
emailAddresses
Array of strings
userGroupIds
Array of strings
notifyOnSlack
boolean
isNgBudget
boolean
startTime
integer <int64>
endTime
integer <int64>
createdAt
integer <int64>
lastUpdatedAt
integer <int64>
ngBudget
boolean
Responses
400

Bad Request

500

Internal server error

default

Returns the ID string of the new Budget created

post/ccm/api/budgets
Request samples
application/json
{
  • "uuid": "string",
  • "accountId": "string",
  • "name": "string",
  • "scope": {
    },
  • "type": "SPECIFIED_AMOUNT",
  • "budgetAmount": 0,
  • "period": "DAILY",
  • "growthRate": 0,
  • "actualCost": 0,
  • "forecastCost": 0,
  • "lastMonthCost": 0,
  • "alertThresholds": [
    ],
  • "emailAddresses": [
    ],
  • "userGroupIds": [
    ],
  • "notifyOnSlack": true,
  • "isNgBudget": true,
  • "startTime": 0,
  • "endTime": 0,
  • "createdAt": 0,
  • "lastUpdatedAt": 0,
  • "ngBudget": true
}
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Delete a budget

Delete a Cloud Cost Budget for the given Budget ID.

SecurityApiKey
Request
path Parameters
id
required
string

Unique identifier for the budget

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

Returns a text message whether the operation was successful

delete/ccm/api/budgets/{id}
Request samples
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Fetch Budget details

Fetch details of a Cloud Cost Budget for the given Budget ID.

SecurityApiKey
Request
path Parameters
id
required
string

Unique identifier for the budget

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

Get a Budget by it's identifier

get/ccm/api/budgets/{id}
Request samples
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Fetch the cost details of a Budget

Fetch the cost details of a Cloud Cost Budget for the given Budget ID.

SecurityApiKey
Request
path Parameters
id
required
string

Unique identifier for the Budget

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

Returns the cost data of a Budget

get/ccm/api/budgets/{id}/costDetails
Request samples
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

List all the Budgets

List all the Cloud Cost Budgets.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

Returns the list of all Budgets

get/ccm/api/budgets
Request samples
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

List all the Budgets associated with a Perspective

List all the Cloud Cost Budgets associated for the given Perspective ID.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

perspectiveId
required
string

Unique identifier for the Perspective

Responses
400

Bad Request

500

Internal server error

default

Returns the list of Budgets

get/ccm/api/budgets/perspectiveBudgets
Request samples
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Update an existing budget

Update an existing Cloud Cost Budget for the given Budget ID.

SecurityApiKey
Request
path Parameters
id
required
string

Unique identifier for the budget

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema: application/json

The Budget object

uuid
string
accountId
required
string
name
required
string [ 1 .. 80 ] characters
object (BudgetScope)

The scope in which the Budget was created

type
string

Whether the Budget is based on a specified amount or based on previous month's actual spend

Enum: "SPECIFIED_AMOUNT" "PREVIOUS_MONTH_SPEND" "PREVIOUS_PERIOD_SPEND"
budgetAmount
number <double>
period
string
Enum: "DAILY" "WEEKLY" "MONTHLY" "QUARTERLY" "YEARLY"
growthRate
number <double>
actualCost
number <double>
forecastCost
number <double>
lastMonthCost
number <double>
Array of objects (AlertThreshold)
emailAddresses
Array of strings
userGroupIds
Array of strings
notifyOnSlack
boolean
isNgBudget
boolean
startTime
integer <int64>
endTime
integer <int64>
createdAt
integer <int64>
lastUpdatedAt
integer <int64>
ngBudget
boolean
Responses
400

Bad Request

500

Internal server error

default

Returns a generic string message when the operation is successful

put/ccm/api/budgets/{id}
Request samples
application/json
{
  • "uuid": "string",
  • "accountId": "string",
  • "name": "string",
  • "scope": {
    },
  • "type": "SPECIFIED_AMOUNT",
  • "budgetAmount": 0,
  • "period": "DAILY",
  • "growthRate": 0,
  • "actualCost": 0,
  • "forecastCost": 0,
  • "lastMonthCost": 0,
  • "alertThresholds": [
    ],
  • "emailAddresses": [
    ],
  • "userGroupIds": [
    ],
  • "notifyOnSlack": true,
  • "isNgBudget": true,
  • "startTime": 0,
  • "endTime": 0,
  • "createdAt": 0,
  • "lastUpdatedAt": 0,
  • "ngBudget": true
}
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}