Cloud Cost Budget Groups

Manage Budget Groups and receive alerts when your costs exceed (or are forecasted to exceed) your configured budget group.

Fetch Budget group details

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

Securityx-api-key

Request

path Parameters

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 group by it's identifier

get/ccm/api/budgetGroups/{id}

Request samples

curl
Java
Go

Response samples

400
500
default

application/json

{"status": "SUCCESS",
"code": "DEFAULT_ERROR_CODE",
"message": "string",
"correlationId": "string",
"errors": [{"fieldId": "string",
"error": "string"
}
]
}

Update an existing budget group

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

Securityx-api-key

Request

path Parameters

required

string

Unique identifier for the budget group

query Parameters

accountIdentifier

required

string

Account Identifier for the Entity.

Request Body schema: application/json
required

The Budget object

uuid	string
accountId	string
name	string [ 1 .. 80 ] characters
	object (BudgetMonthlyBreakdown) The budget monthly breakdown of a Yearly Budget
period	string Enum: "DAILY" "WEEKLY" "MONTHLY" "QUARTERLY" "YEARLY"
budgetGroupAmount	number <double>
actualCost	number <double>
forecastCost	number <double>
lastMonthCost	number <double>
	Array of objects (AlertThreshold)
	Array of objects (BudgetGroupChildEntityDTO)
parentBudgetGroupId	string
cascadeType	string Enum: "EQUAL" "PROPORTIONAL" "NO_CASCADE"
startTime	integer <int64>
endTime	integer <int64>
createdAt	integer <int64>
lastUpdatedAt	integer <int64>
	object

Responses

400

Bad Request

500

Internal server error

default

Returns a generic string message when the operation is successful

put/ccm/api/budgetGroups/{id}

Request samples

Payload
curl
Java
Go

application/json

{"uuid": "string",
"accountId": "string",
"name": "string",
"budgetGroupMonthlyBreakdown": {"budgetBreakdown": "YEARLY",
"budgetMonthlyAmount": [{"time": 0,
"value": 0
}
],
"actualMonthlyCost": [0
],
"forecastMonthlyCost": [0
],
"yearlyLastPeriodCost": [0
],
"forecastCostConfigured": true
},
"period": "DAILY",
"budgetGroupAmount": 0,
"actualCost": 0,
"forecastCost": 0,
"lastMonthCost": 0,
"alertThresholds": [{"percentage": 0,
"basedOn": "ACTUAL_COST",
"emailAddresses": ["string"
],
"userGroupIds": ["string"
],
"slackWebhooks": ["string"
],
"alertsSent": 0,
"crossedAt": 0
}
],
"childEntities": [{"id": "string",
"proportion": 0,
"isBudgetGroup": true,
"budgetGroup": true
}
],
"parentBudgetGroupId": "string",
"cascadeType": "EQUAL",
"startTime": 0,
"endTime": 0,
"createdAt": 0,
"lastUpdatedAt": 0,
"budgetGroupHistory": {"property1": {"time": 0,
"endTime": 0,
"actualCost": 0,
"forecastCost": 0,
"budgeted": 0,
"budgetVariance": 0,
"budgetVariancePercentage": 0
},
"property2": {"time": 0,
"endTime": 0,
"actualCost": 0,
"forecastCost": 0,
"budgeted": 0,
"budgetVariance": 0,
"budgetVariancePercentage": 0
}
}
}

Response samples

400
500
default

application/json

{"status": "SUCCESS",
"code": "DEFAULT_ERROR_CODE",
"message": "string",
"correlationId": "string",
"errors": [{"fieldId": "string",
"error": "string"
}
]
}

Delete a budget group

Delete a Cloud Cost Budget group for the given Budget group ID.

Securityx-api-key

Request

path Parameters

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 boolean whether the operation was successful

delete/ccm/api/budgetGroups/{id}

Request samples

curl
Java
Go

Response samples

400
500
default

application/json

{"status": "SUCCESS",
"code": "DEFAULT_ERROR_CODE",
"message": "string",
"correlationId": "string",
"errors": [{"fieldId": "string",
"error": "string"
}
]
}

Get aggregated amount for given budget groups/budgets

Returns list of value dataPoints specifying aggregated amount

Securityx-api-key

Request

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
areChildEntitiesBudgets required	boolean

Request Body schema: application/json
required

List of child budgets/budget groups

Array

string

Responses

400

Bad Request

500

Internal server error

default

Returns list of value dataPoints specifying aggregated amount

post/ccm/api/budgetGroups/aggregatedAmount

Request samples

Payload
curl
Java
Go

application/json

["string"
]

Response samples

400
500
default

application/json

{"status": "SUCCESS",
"code": "DEFAULT_ERROR_CODE",
"message": "string",
"correlationId": "string",
"errors": [{"fieldId": "string",
"error": "string"
}
]
}

Get list of budget and budget group summaries

Returns list of budgetSummary

Securityx-api-key

Request

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
budgetGroupId	string
showAllEntities required	boolean
budgetGroupSortType	string Budget Group List Sort Type Enum: "BUDGET_GROUP_AMOUNT" "BUDGET_GROUP_NAME" "BUDGET_GROUP_ACTUAL_COST" "BUDGET_GROUP_FORECASTED_COST"
sortOrder	string Budget Group List Sort Order Enum: "ASCENDING" "DESCENDING"

Responses

400

Bad Request

500

Internal server error

default

Returns list of value dataPoints specifying cost

get/ccm/api/budgetGroups/summary

Request samples

curl
Java
Go

Response samples

400
500
default

application/json

{"status": "SUCCESS",
"code": "DEFAULT_ERROR_CODE",
"message": "string",
"correlationId": "string",
"errors": [{"fieldId": "string",
"error": "string"
}
]
}

List all the Budget groups

List all the Cloud Cost Budget Groups for an account.

Securityx-api-key

Request

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
budgetGroupSortType	string Budget Group List Sort Type Enum: "BUDGET_GROUP_AMOUNT" "BUDGET_GROUP_NAME" "BUDGET_GROUP_ACTUAL_COST" "BUDGET_GROUP_FORECASTED_COST"
sortOrder	string Budget Group List Sort Order Enum: "ASCENDING" "DESCENDING"

Responses

400

Bad Request

500

Internal server error

default

Returns the list of all Budget groups

get/ccm/api/budgetGroups

Request samples

curl
Java
Go

Response samples

400
500
default

application/json

{"status": "SUCCESS",
"code": "DEFAULT_ERROR_CODE",
"message": "string",
"correlationId": "string",
"errors": [{"fieldId": "string",
"error": "string"
}
]
}

Create a Budget Group

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

Securityx-api-key

Request

query Parameters

accountIdentifier

required

string

Account Identifier for the Entity.

Request Body schema: application/json
required

Budget Group definition

uuid	string
accountId	string
name	string [ 1 .. 80 ] characters
	object (BudgetMonthlyBreakdown) The budget monthly breakdown of a Yearly Budget
period	string Enum: "DAILY" "WEEKLY" "MONTHLY" "QUARTERLY" "YEARLY"
budgetGroupAmount	number <double>
actualCost	number <double>
forecastCost	number <double>
lastMonthCost	number <double>
	Array of objects (AlertThreshold)
	Array of objects (BudgetGroupChildEntityDTO)
parentBudgetGroupId	string
cascadeType	string Enum: "EQUAL" "PROPORTIONAL" "NO_CASCADE"
startTime	integer <int64>
endTime	integer <int64>
createdAt	integer <int64>
lastUpdatedAt	integer <int64>
	object

Responses

400

Bad Request

500

Internal server error

default

Returns the ID string of the new Budget group created

post/ccm/api/budgetGroups

Request samples

Payload
curl
Java
Go

application/json

{"uuid": "string",
"accountId": "string",
"name": "string",
"budgetGroupMonthlyBreakdown": {"budgetBreakdown": "YEARLY",
"budgetMonthlyAmount": [{"time": 0,
"value": 0
}
],
"actualMonthlyCost": [0
],
"forecastMonthlyCost": [0
],
"yearlyLastPeriodCost": [0
],
"forecastCostConfigured": true
},
"period": "DAILY",
"budgetGroupAmount": 0,
"actualCost": 0,
"forecastCost": 0,
"lastMonthCost": 0,
"alertThresholds": [{"percentage": 0,
"basedOn": "ACTUAL_COST",
"emailAddresses": ["string"
],
"userGroupIds": ["string"
],
"slackWebhooks": ["string"
],
"alertsSent": 0,
"crossedAt": 0
}
],
"childEntities": [{"id": "string",
"proportion": 0,
"isBudgetGroup": true,
"budgetGroup": true
}
],
"parentBudgetGroupId": "string",
"cascadeType": "EQUAL",
"startTime": 0,
"endTime": 0,
"createdAt": 0,
"lastUpdatedAt": 0,
"budgetGroupHistory": {"property1": {"time": 0,
"endTime": 0,
"actualCost": 0,
"forecastCost": 0,
"budgeted": 0,
"budgetVariance": 0,
"budgetVariancePercentage": 0
},
"property2": {"time": 0,
"endTime": 0,
"actualCost": 0,
"forecastCost": 0,
"budgeted": 0,
"budgetVariance": 0,
"budgetVariancePercentage": 0
}
}
}

Response samples

400
500
default

application/json

{"status": "SUCCESS",
"code": "DEFAULT_ERROR_CODE",
"message": "string",
"correlationId": "string",
"errors": [{"fieldId": "string",
"error": "string"
}
]
}

➔ Next to Cloud Cost Budgets

Cloud Cost Budget Groups

Fetch Budget group details

path Parameters

query Parameters

Update an existing budget group

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Delete a budget group

path Parameters

query Parameters

Get aggregated amount for given budget groups/budgets

query Parameters

Request Body schema: application/jsonrequired

Get list of budget and budget group summaries

query Parameters

List all the Budget groups

query Parameters

Create a Budget Group

query Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required