Cloud Cost Recommendations

Recommendations for workloads and node pools.

Return void

Mark recommendation as applied/open

Securityx-api-key

Request

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
recommendationId required	string
state required	string Enum: "OPEN" "APPLIED" "IGNORED"

Responses

400

Bad Request

500

Internal server error

default

Returns void.

post/ccm/api/recommendation/overview/change-state

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"
}
]
}

Return the number of Recommendations

Returns the total number of Cloud Cost Recommendations based on the specified filters.

Securityx-api-key

Request

query Parameters

accountIdentifier

required

string

Account Identifier for the Entity.

Request Body schema: application/json
required

CCM Recommendations filter body.

	object (K8sRecommendationFilterProperties) Properties of the K8sRecommendation Filter defined in Harness
	object (AwsRecommendationFilterProperties) AWS specific properties for recommendation filters
	object (AzureRecommendationFilterProperties) Azure specific properties for recommendation filters
	object (ContainerRecommendationFilterProperties) Container specific properties for recommendation filters
	object (GovernanceRecommendationFilterProperties) Governance specific properties for recommendation filters
	object (BaseRecommendationFilterProperties) Base properties for recommendation filters
	Array of objects (QLCEViewFilterWrapper) Get Recommendations for a perspective
minSaving	number <double> Fetch recommendations with Saving more than minSaving
minCost	number <double> Fetch recommendations with Cost more than minCost
daysBack	integer <int64> Fetch recommendations generated in last daysBack days
offset	integer <int64> Query Offset
limit	integer <int64> Query Limit
childRecommendation	boolean toggle childRecommendation value
includeIgnoredRecommendation	boolean toggle includeIgnoredRecommendation value
parentRecommendation	boolean toggle parentRecommendation value
	Array of objects (CCMTagDTO) Get recommendations for resources having particular tags
	Array of objects (CCMCostCategoryDTO) Get recommendations for resources in particular cost bucket of given cost category
	object Filter tags as a key-value pair.
filterType	string Value: "CCMRecommendation"

Responses

400

Bad Request

500

Internal server error

default

Returns the count of all Recommendations available.

post/ccm/api/recommendation/overview/count

Request samples

Payload
curl
Java
Go

application/json

{"k8sRecommendationFilterPropertiesDTO": {"ids": ["string"
],
"names": ["string"
],
"namespaces": ["string"
],
"clusterNames": ["string"
],
"resourceTypes": ["WORKLOAD"
],
"recommendationStates": ["OPEN"
],
"cloudProvider": ["AWS"
],
"regions": ["string"
]
},
"awsRecommendationFilterPropertiesDTO": {"instanceType": ["string"
]
},
"azureRecommendationFilterProperties": {"instanceType": ["string"
],
"resourceGroup": ["string"
]
},
"containerRecommendationFilterPropertiesDTO": {"k8sClusterName": ["string"
],
"k8sNamespace": ["string"
],
"ecsClusterName": ["string"
],
"ecsLaunchType": ["string"
]
},
"governanceRecommendationFilterPropertiesDTO": {"governanceRuleName": ["string"
]
},
"baseRecommendationFilterPropertiesDTO": {"id": ["string"
],
"cloudAccountId": ["string"
],
"cloudAccountName": ["string"
],
"resourceId": ["string"
],
"resourceName": ["string"
],
"region": ["string"
],
"resourceType": ["WORKLOAD"
],
"recommendationState": ["OPEN"
],
"cloudProvider": ["AWS"
]
},
"perspectiveFilters": [{"idFilter": {"field": {"fieldId": "string",
"fieldName": "string",
"identifier": "CLUSTER",
"identifierName": "string"
},
"operator": "NOT_IN",
"values": ["string"
]
},
"timeFilter": {"field": {"fieldId": "string",
"fieldName": "string",
"identifier": "CLUSTER",
"identifierName": "string"
},
"operator": "AFTER",
"value": 0
},
"timeRangeTypeFilter": "LAST_MONTH",
"viewMetadataFilter": {"viewId": "string",
"isPreview": true,
"preview": true
},
"ruleFilter": {"conditions": [{"field": {"fieldId": "string",
"fieldName": "string",
"identifier": "CLUSTER",
"identifierName": "string"
},
"operator": "NOT_IN",
"values": ["string"
]
}
]
}
}
],
"minSaving": 0,
"minCost": 0,
"daysBack": 0,
"offset": 0,
"limit": 0,
"childRecommendation": true,
"includeIgnoredRecommendation": true,
"parentRecommendation": true,
"tagDTOs": [{"key": "string",
"value": "string"
}
],
"costCategoryDTOs": [{"costCategory": "string",
"costBucket": "string"
}
],
"tags": {"property1": "string",
"property2": "string"
},
"filterType": "CCMRecommendation"
}

Response samples

400
500
default

application/json

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

Return the list of filter values for the Recommendations

Returns the list of filter values for all the specified filters.

Securityx-api-key

Request

query Parameters

accountIdentifier

required

string

Account Identifier for the Entity.

Request Body schema: application/json
required

Recommendation Filter Values Body.

columns	Array of strings
	object (CCMRecommendationFilterProperties) Properties of the CCMRecommendation Filter defined in Harness

Responses

400

Bad Request

500

Internal server error

default

Returns the values available for a filter.

post/ccm/api/recommendation/overview/filter-values

Request samples

Payload
curl
Java
Go

application/json

{"columns": ["string"
],
"filter": {"k8sRecommendationFilterPropertiesDTO": {"ids": ["string"
],
"names": ["string"
],
"namespaces": ["string"
],
"clusterNames": ["string"
],
"resourceTypes": ["WORKLOAD"
],
"recommendationStates": ["OPEN"
],
"cloudProvider": ["AWS"
],
"regions": ["string"
]
},
"awsRecommendationFilterPropertiesDTO": {"instanceType": ["string"
]
},
"azureRecommendationFilterProperties": {"instanceType": ["string"
],
"resourceGroup": ["string"
]
},
"containerRecommendationFilterPropertiesDTO": {"k8sClusterName": ["string"
],
"k8sNamespace": ["string"
],
"ecsClusterName": ["string"
],
"ecsLaunchType": ["string"
]
},
"governanceRecommendationFilterPropertiesDTO": {"governanceRuleName": ["string"
]
},
"baseRecommendationFilterPropertiesDTO": {"id": ["string"
],
"cloudAccountId": ["string"
],
"cloudAccountName": ["string"
],
"resourceId": ["string"
],
"resourceName": ["string"
],
"region": ["string"
],
"resourceType": ["WORKLOAD"
],
"recommendationState": ["OPEN"
],
"cloudProvider": ["AWS"
]
},
"perspectiveFilters": [{"idFilter": {"field": {"fieldId": "string",
"fieldName": "string",
"identifier": "CLUSTER",
"identifierName": "string"
},
"operator": "NOT_IN",
"values": ["string"
]
},
"timeFilter": {"field": {"fieldId": "string",
"fieldName": "string",
"identifier": "CLUSTER",
"identifierName": "string"
},
"operator": "AFTER",
"value": 0
},
"timeRangeTypeFilter": "LAST_MONTH",
"viewMetadataFilter": {"viewId": "string",
"isPreview": true,
"preview": true
},
"ruleFilter": {"conditions": [{"field": {"fieldId": null,
"fieldName": null,
"identifier": null,
"identifierName": null
},
"operator": "NOT_IN",
"values": [null
]
}
]
}
}
],
"minSaving": 0,
"minCost": 0,
"daysBack": 0,
"offset": 0,
"limit": 0,
"childRecommendation": true,
"includeIgnoredRecommendation": true,
"parentRecommendation": true,
"tagDTOs": [{"key": "string",
"value": "string"
}
],
"costCategoryDTOs": [{"costCategory": "string",
"costBucket": "string"
}
],
"tags": {"property1": "string",
"property2": "string"
},
"filterType": "CCMRecommendation"
}
}

Response samples

400
500
default

application/json

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

Return the list of Recommendations

Returns the list of Cloud Cost Recommendations for the specified filters.

Securityx-api-key

Request

query Parameters

accountIdentifier

required

string

Account Identifier for the Entity.

Request Body schema: application/json
required

CCM Recommendations filter body.

	object (K8sRecommendationFilterProperties) Properties of the K8sRecommendation Filter defined in Harness
	object (AwsRecommendationFilterProperties) AWS specific properties for recommendation filters
	object (AzureRecommendationFilterProperties) Azure specific properties for recommendation filters
	object (ContainerRecommendationFilterProperties) Container specific properties for recommendation filters
	object (GovernanceRecommendationFilterProperties) Governance specific properties for recommendation filters
	object (BaseRecommendationFilterProperties) Base properties for recommendation filters
	Array of objects (QLCEViewFilterWrapper) Get Recommendations for a perspective
minSaving	number <double> Fetch recommendations with Saving more than minSaving
minCost	number <double> Fetch recommendations with Cost more than minCost
daysBack	integer <int64> Fetch recommendations generated in last daysBack days
offset	integer <int64> Query Offset
limit	integer <int64> Query Limit
childRecommendation	boolean toggle childRecommendation value
includeIgnoredRecommendation	boolean toggle includeIgnoredRecommendation value
parentRecommendation	boolean toggle parentRecommendation value
	Array of objects (CCMTagDTO) Get recommendations for resources having particular tags
	Array of objects (CCMCostCategoryDTO) Get recommendations for resources in particular cost bucket of given cost category
	object Filter tags as a key-value pair.
filterType	string Value: "CCMRecommendation"

Responses

400

Bad Request

500

Internal server error

default

Returns the list of Recommendations available.

post/ccm/api/recommendation/overview/list

Request samples

Payload
curl
Java
Go

application/json

{"k8sRecommendationFilterPropertiesDTO": {"ids": ["string"
],
"names": ["string"
],
"namespaces": ["string"
],
"clusterNames": ["string"
],
"resourceTypes": ["WORKLOAD"
],
"recommendationStates": ["OPEN"
],
"cloudProvider": ["AWS"
],
"regions": ["string"
]
},
"awsRecommendationFilterPropertiesDTO": {"instanceType": ["string"
]
},
"azureRecommendationFilterProperties": {"instanceType": ["string"
],
"resourceGroup": ["string"
]
},
"containerRecommendationFilterPropertiesDTO": {"k8sClusterName": ["string"
],
"k8sNamespace": ["string"
],
"ecsClusterName": ["string"
],
"ecsLaunchType": ["string"
]
},
"governanceRecommendationFilterPropertiesDTO": {"governanceRuleName": ["string"
]
},
"baseRecommendationFilterPropertiesDTO": {"id": ["string"
],
"cloudAccountId": ["string"
],
"cloudAccountName": ["string"
],
"resourceId": ["string"
],
"resourceName": ["string"
],
"region": ["string"
],
"resourceType": ["WORKLOAD"
],
"recommendationState": ["OPEN"
],
"cloudProvider": ["AWS"
]
},
"perspectiveFilters": [{"idFilter": {"field": {"fieldId": "string",
"fieldName": "string",
"identifier": "CLUSTER",
"identifierName": "string"
},
"operator": "NOT_IN",
"values": ["string"
]
},
"timeFilter": {"field": {"fieldId": "string",
"fieldName": "string",
"identifier": "CLUSTER",
"identifierName": "string"
},
"operator": "AFTER",
"value": 0
},
"timeRangeTypeFilter": "LAST_MONTH",
"viewMetadataFilter": {"viewId": "string",
"isPreview": true,
"preview": true
},
"ruleFilter": {"conditions": [{"field": {"fieldId": "string",
"fieldName": "string",
"identifier": "CLUSTER",
"identifierName": "string"
},
"operator": "NOT_IN",
"values": ["string"
]
}
]
}
}
],
"minSaving": 0,
"minCost": 0,
"daysBack": 0,
"offset": 0,
"limit": 0,
"childRecommendation": true,
"includeIgnoredRecommendation": true,
"parentRecommendation": true,
"tagDTOs": [{"key": "string",
"value": "string"
}
],
"costCategoryDTOs": [{"costCategory": "string",
"costBucket": "string"
}
],
"tags": {"property1": "string",
"property2": "string"
},
"filterType": "CCMRecommendation"
}

Response samples

400
500
default

application/json

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

Return boolean

Override savings for recommendation

Securityx-api-key

Request

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
recommendationId required	string
overriddenSavings required	number <double>

Responses

400

Bad Request

500

Internal server error

default

Returns boolean

put/ccm/api/recommendation/overview/override-savings

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"
}
]
}

Return Recommendations statistics Grouped on Resource Type

Returns the Cloud Cost Recommendations statistics for the specified filters Grouped on Resource Type.

Securityx-api-key

Request

query Parameters

accountIdentifier

required

string

Account Identifier for the Entity.

Request Body schema: application/json
required

CCM Recommendations filter body.

	object (K8sRecommendationFilterProperties) Properties of the K8sRecommendation Filter defined in Harness
	object (AwsRecommendationFilterProperties) AWS specific properties for recommendation filters
	object (AzureRecommendationFilterProperties) Azure specific properties for recommendation filters
	object (ContainerRecommendationFilterProperties) Container specific properties for recommendation filters
	object (GovernanceRecommendationFilterProperties) Governance specific properties for recommendation filters
	object (BaseRecommendationFilterProperties) Base properties for recommendation filters
	Array of objects (QLCEViewFilterWrapper) Get Recommendations for a perspective
minSaving	number <double> Fetch recommendations with Saving more than minSaving
minCost	number <double> Fetch recommendations with Cost more than minCost
daysBack	integer <int64> Fetch recommendations generated in last daysBack days
offset	integer <int64> Query Offset
limit	integer <int64> Query Limit
childRecommendation	boolean toggle childRecommendation value
includeIgnoredRecommendation	boolean toggle includeIgnoredRecommendation value
parentRecommendation	boolean toggle parentRecommendation value
	Array of objects (CCMTagDTO) Get recommendations for resources having particular tags
	Array of objects (CCMCostCategoryDTO) Get recommendations for resources in particular cost bucket of given cost category
	object Filter tags as a key-value pair.
filterType	string Value: "CCMRecommendation"

Responses

400

Bad Request

500

Internal server error

default

Returns the statistics of all Recommendations available Grouped on Resource Type.

post/ccm/api/recommendation/overview/resource-type/stats

Request samples

Payload
curl
Java
Go

application/json

{"k8sRecommendationFilterPropertiesDTO": {"ids": ["string"
],
"names": ["string"
],
"namespaces": ["string"
],
"clusterNames": ["string"
],
"resourceTypes": ["WORKLOAD"
],
"recommendationStates": ["OPEN"
],
"cloudProvider": ["AWS"
],
"regions": ["string"
]
},
"awsRecommendationFilterPropertiesDTO": {"instanceType": ["string"
]
},
"azureRecommendationFilterProperties": {"instanceType": ["string"
],
"resourceGroup": ["string"
]
},
"containerRecommendationFilterPropertiesDTO": {"k8sClusterName": ["string"
],
"k8sNamespace": ["string"
],
"ecsClusterName": ["string"
],
"ecsLaunchType": ["string"
]
},
"governanceRecommendationFilterPropertiesDTO": {"governanceRuleName": ["string"
]
},
"baseRecommendationFilterPropertiesDTO": {"id": ["string"
],
"cloudAccountId": ["string"
],
"cloudAccountName": ["string"
],
"resourceId": ["string"
],
"resourceName": ["string"
],
"region": ["string"
],
"resourceType": ["WORKLOAD"
],
"recommendationState": ["OPEN"
],
"cloudProvider": ["AWS"
]
},
"perspectiveFilters": [{"idFilter": {"field": {"fieldId": "string",
"fieldName": "string",
"identifier": "CLUSTER",
"identifierName": "string"
},
"operator": "NOT_IN",
"values": ["string"
]
},
"timeFilter": {"field": {"fieldId": "string",
"fieldName": "string",
"identifier": "CLUSTER",
"identifierName": "string"
},
"operator": "AFTER",
"value": 0
},
"timeRangeTypeFilter": "LAST_MONTH",
"viewMetadataFilter": {"viewId": "string",
"isPreview": true,
"preview": true
},
"ruleFilter": {"conditions": [{"field": {"fieldId": "string",
"fieldName": "string",
"identifier": "CLUSTER",
"identifierName": "string"
},
"operator": "NOT_IN",
"values": ["string"
]
}
]
}
}
],
"minSaving": 0,
"minCost": 0,
"daysBack": 0,
"offset": 0,
"limit": 0,
"childRecommendation": true,
"includeIgnoredRecommendation": true,
"parentRecommendation": true,
"tagDTOs": [{"key": "string",
"value": "string"
}
],
"costCategoryDTOs": [{"costCategory": "string",
"costBucket": "string"
}
],
"tags": {"property1": "string",
"property2": "string"
},
"filterType": "CCMRecommendation"
}

Response samples

400
500
default

application/json

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

Return Recommendations statistics

Returns the Cloud Cost Recommendations statistics for the specified filters.

Securityx-api-key

Request

query Parameters

accountIdentifier

required

string

Account Identifier for the Entity.

Request Body schema: application/json
required

CCM Recommendations filter body.

	object (K8sRecommendationFilterProperties) Properties of the K8sRecommendation Filter defined in Harness
	object (AwsRecommendationFilterProperties) AWS specific properties for recommendation filters
	object (AzureRecommendationFilterProperties) Azure specific properties for recommendation filters
	object (ContainerRecommendationFilterProperties) Container specific properties for recommendation filters
	object (GovernanceRecommendationFilterProperties) Governance specific properties for recommendation filters
	object (BaseRecommendationFilterProperties) Base properties for recommendation filters
	Array of objects (QLCEViewFilterWrapper) Get Recommendations for a perspective
minSaving	number <double> Fetch recommendations with Saving more than minSaving
minCost	number <double> Fetch recommendations with Cost more than minCost
daysBack	integer <int64> Fetch recommendations generated in last daysBack days
offset	integer <int64> Query Offset
limit	integer <int64> Query Limit
childRecommendation	boolean toggle childRecommendation value
includeIgnoredRecommendation	boolean toggle includeIgnoredRecommendation value
parentRecommendation	boolean toggle parentRecommendation value
	Array of objects (CCMTagDTO) Get recommendations for resources having particular tags
	Array of objects (CCMCostCategoryDTO) Get recommendations for resources in particular cost bucket of given cost category
	object Filter tags as a key-value pair.
filterType	string Value: "CCMRecommendation"

Responses

400

Bad Request

500

Internal server error

default

Returns the statistics of all Recommendations available.

post/ccm/api/recommendation/overview/stats

Request samples

Payload
curl
Java
Go

application/json

{"k8sRecommendationFilterPropertiesDTO": {"ids": ["string"
],
"names": ["string"
],
"namespaces": ["string"
],
"clusterNames": ["string"
],
"resourceTypes": ["WORKLOAD"
],
"recommendationStates": ["OPEN"
],
"cloudProvider": ["AWS"
],
"regions": ["string"
]
},
"awsRecommendationFilterPropertiesDTO": {"instanceType": ["string"
]
},
"azureRecommendationFilterProperties": {"instanceType": ["string"
],
"resourceGroup": ["string"
]
},
"containerRecommendationFilterPropertiesDTO": {"k8sClusterName": ["string"
],
"k8sNamespace": ["string"
],
"ecsClusterName": ["string"
],
"ecsLaunchType": ["string"
]
},
"governanceRecommendationFilterPropertiesDTO": {"governanceRuleName": ["string"
]
},
"baseRecommendationFilterPropertiesDTO": {"id": ["string"
],
"cloudAccountId": ["string"
],
"cloudAccountName": ["string"
],
"resourceId": ["string"
],
"resourceName": ["string"
],
"region": ["string"
],
"resourceType": ["WORKLOAD"
],
"recommendationState": ["OPEN"
],
"cloudProvider": ["AWS"
]
},
"perspectiveFilters": [{"idFilter": {"field": {"fieldId": "string",
"fieldName": "string",
"identifier": "CLUSTER",
"identifierName": "string"
},
"operator": "NOT_IN",
"values": ["string"
]
},
"timeFilter": {"field": {"fieldId": "string",
"fieldName": "string",
"identifier": "CLUSTER",
"identifierName": "string"
},
"operator": "AFTER",
"value": 0
},
"timeRangeTypeFilter": "LAST_MONTH",
"viewMetadataFilter": {"viewId": "string",
"isPreview": true,
"preview": true
},
"ruleFilter": {"conditions": [{"field": {"fieldId": "string",
"fieldName": "string",
"identifier": "CLUSTER",
"identifierName": "string"
},
"operator": "NOT_IN",
"values": ["string"
]
}
]
}
}
],
"minSaving": 0,
"minCost": 0,
"daysBack": 0,
"offset": 0,
"limit": 0,
"childRecommendation": true,
"includeIgnoredRecommendation": true,
"parentRecommendation": true,
"tagDTOs": [{"key": "string",
"value": "string"
}
],
"costCategoryDTOs": [{"costCategory": "string",
"costBucket": "string"
}
],
"tags": {"property1": "string",
"property2": "string"
},
"filterType": "CCMRecommendation"
}

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 Recommendation Jira

Cloud Cost Recommendations

Return void

query Parameters

Return the number of Recommendations

query Parameters

Request Body schema: application/jsonrequired

Return the list of filter values for the Recommendations

query Parameters

Request Body schema: application/jsonrequired

Return the list of Recommendations

query Parameters

Request Body schema: application/jsonrequired

Return boolean

query Parameters

Return Recommendations statistics Grouped on Resource Type

query Parameters

Request Body schema: application/jsonrequired

Return Recommendations statistics

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

Request Body schema: application/json
required

Request Body schema: application/json
required