Cloud Cost Cost Categories

Allows you to categorize based on business requirements and get a contextual view of your expenses.

Fetch details of a Cost category

Fetch details of a Cost category for the given Cost category ID.

Securityx-api-key
Request
path Parameters
id
required
string
query Parameters
accountIdentifier
string
Responses
400

Bad Request

500

Internal server error

default

Returns a Cost category object with all the cost and shared buckets, returns null if no Cost category exists for that particular identifier

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

Delete a Cost category

Delete a Cost category for the given Cost category ID.

Securityx-api-key
Request
path Parameters
id
required
string
query Parameters
accountIdentifier
required
string
Responses
400

Bad Request

500

Internal server error

default

A string text message whether the delete was successful or not. If the cost category is used in the perspective, the deletion will fail and it will send you the IDs of all the linked perspectives

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

Return details of all the Cost categories

Return details of all the Cost categories for the given account ID.

Securityx-api-key
Request
query Parameters
accountIdentifier
string
searchKey
string
sortType
string
Enum: "NAME" "LAST_EDIT"
sortOrder
string
Enum: "ASCENDING" "DESCENDING"
limit
integer <int32>
offset
integer <int32>
Responses
400

Bad Request

500

Internal server error

default

Returns a List of Cost Categories

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

Update a Cost category

Update a Cost category. It accepts a BusinessMapping object and upserts it using the uuid mentioned in the definition.

Securityx-api-key
Request
query Parameters
accountIdentifier
string
Request Body schema: application/json
uuid
string
name
required
string [ 1 .. 32 ] characters
accountId
string
Array of objects (CostTarget)
Array of objects (SharedCost)
object (UnallocatedCost)
dataSources
Array of strings
Items Enum: "CLUSTER" "AWS" "GCP" "AZURE" "COMMON" "CUSTOM" "BUSINESS_MAPPING" "LABEL"
createdAt
integer <int64>
lastUpdatedAt
integer <int64>
object (EmbeddedUser)
object (EmbeddedUser)
Responses
400

Bad Request

500

Internal server error

default

Successfully updated the Business Mapping

put/ccm/api/business-mapping
Request samples
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "accountId": "string",
  • "costTargets": [
    ],
  • "sharedCosts": [
    ],
  • "unallocatedCost": {
    },
  • "dataSources": [
    ],
  • "createdAt": 0,
  • "lastUpdatedAt": 0,
  • "createdBy": {
    },
  • "lastUpdatedBy": {
    }
}
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Create Cost category

Create Cost category that allows you to categorize based on business requirements and get a contextual view of your expenses

Securityx-api-key
Request
query Parameters
accountIdentifier
string
Request Body schema: application/json
uuid
string
name
required
string [ 1 .. 32 ] characters
accountId
string
Array of objects (CostTarget)
Array of objects (SharedCost)
object (UnallocatedCost)
dataSources
Array of strings
Items Enum: "CLUSTER" "AWS" "GCP" "AZURE" "COMMON" "CUSTOM" "BUSINESS_MAPPING" "LABEL"
createdAt
integer <int64>
lastUpdatedAt
integer <int64>
object (EmbeddedUser)
object (EmbeddedUser)
Responses
400

Bad Request

500

Internal server error

default

Returns a created Cost category object with all the cost and shared buckets

post/ccm/api/business-mapping
Request samples
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "accountId": "string",
  • "costTargets": [
    ],
  • "sharedCosts": [
    ],
  • "unallocatedCost": {
    },
  • "dataSources": [
    ],
  • "createdAt": 0,
  • "lastUpdatedAt": 0,
  • "createdBy": {
    },
  • "lastUpdatedBy": {
    }
}
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}