Cloud Cost Budgets

This contains APIs related to Cloud Cost Budgets

Get the cost details associated with a Budget

Get the cost details associated with a Cloud Cost Budget identifier

Request
Security:
ApiKey (readwrite)
path Parameters
id
required
string

The identifier of 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
curl -i -X GET \
  'https://app.harness.io/gateway/ccm/api/budgets/:id/costDetails?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get a Budget

Get a Cloud Cost Budget by an identifier

Request
Security:
ApiKey (readwrite)
path Parameters
id
required
string

The identifier of an existing 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
curl -i -X GET \
  'https://app.harness.io/gateway/ccm/api/budgets/:id?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Update an existing Budget

Update an existing Budget using the identifier passed as a path param

Request
Security:
ApiKey (readwrite)
path Parameters
id
required
string

The identifier of an existing Budget

query Parameters
accountIdentifier
required
string

Account Identifier for the entity

Request Body schema: application/json

The Budget object as a request body

uuid
string
accountId
string
name
string
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
startTime
integer <int64>
endTime
integer <int64>
createdAt
integer <int64>
lastUpdatedAt
integer <int64>
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,
  • "startTime": 0,
  • "endTime": 0,
  • "createdAt": 0,
  • "lastUpdatedAt": 0
}
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Clone an existing Budget

Clone an existing Budget using an existing Budget identifier

Request
Security:
ApiKey (readwrite)
path Parameters
id
required
string

The identifier of the Budget

query Parameters
accountIdentifier
required
string

Account Identifier for the entity

cloneName
required
string

The name of the new Budget created after cloning operation

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
curl -i -X POST \
  'https://app.harness.io/gateway/ccm/api/budgets/:id?accountIdentifier=string&cloneName=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Delete an existing Budget

Delete an existing Cloud Cost Budget by identifier

Request
Security:
ApiKey (readwrite)
path Parameters
id
required
string

The identifier of 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
curl -i -X DELETE \
  'https://app.harness.io/gateway/ccm/api/budgets/:id?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
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 with a Cloud Cost Perspective identifier

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the entity

perspectiveId
required
string

The identifier of an existing Perspective

Responses
400

Bad Request

500

Internal server error

default

Returns the list of Budgets

get/ccm/api/budgets/perspectiveBudgets
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ccm/api/budgets/perspectiveBudgets?accountIdentifier=string&perspectiveId=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
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

Request
Security:
ApiKey (readwrite)
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
curl -i -X GET \
  'https://app.harness.io/gateway/ccm/api/budgets?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Create a Budget

Creates a Budget from the Budget object passed as a request body

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the entity

Request Body schema: application/json

The Budget definition

uuid
string
accountId
string
name
string
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
startTime
integer <int64>
endTime
integer <int64>
createdAt
integer <int64>
lastUpdatedAt
integer <int64>
Responses
400

Bad Request

500

Internal server error

default

Returns the identifier 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,
  • "startTime": 0,
  • "endTime": 0,
  • "createdAt": 0,
  • "lastUpdatedAt": 0
}
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}