Governance Overview

This contains APIs related to CCM Governance Overview Page

Return day wise total evaluations.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

cloudProvider
Array of strings

Cloud Provider

Items Enum: "AWS" "AZURE" "GCP"
Request Body schema: application/json

Request body with time filters

Array
operator
string

List of all possible Operators

Enum: "NOT_IN" "IN" "EQUALS" "NOT_NULL" "NULL" "LIKE" "GREATER_THAN" "LESS_THAN" "GREATER_THAN_EQUALS_TO" "LESS_THAN_EQUALS_TO" "AFTER" "BEFORE"
timestamp
integer <int64>
Responses
400

Bad Request

500

Internal server error

default

Return day wise total evaluations.

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

Return rule execution Cost Details Deprecated

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

Return rule Details

get/ccm/api/governance/overview/executionCostDetails
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Return rule execution Details Deprecated

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema: application/json
required

Request body containing CreateRuleExecutionFilterDTO object

object (RuleExecutionFilter)

This has the query to list the RuleExecution

Responses
400

Bad Request

500

Internal server error

default

Return rule Details

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

Return monthly realised SavingsDeprecated

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema: application/json
required

Request body containing CreateRuleExecutionFilterDTO object

object (RuleExecutionFilter)

This has the query to list the RuleExecution

Responses
400

Bad Request

500

Internal server error

default

Return monthly realised Savings

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

Return top resource type executionsDeprecated

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema: application/json
required

Request body containing CreateRuleExecutionFilterDTO object

object (RuleExecutionFilter)

This has the query to list the RuleExecution

Responses
400

Bad Request

500

Internal server error

default

Return top resource type executions

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

Return total number of active enforcements.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

cloudProvider
Array of strings

Cloud Provider

Items Enum: "AWS" "AZURE" "GCP"
Responses
400

Bad Request

500

Internal server error

default

Return total number of active enforcements.

get/ccm/api/governance/overview/totalActiveEnforcements
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Return total number of evaluations.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

cloudProvider
Array of strings

Cloud Provider

Items Enum: "AWS" "AZURE" "GCP"
Responses
400

Bad Request

500

Internal server error

default

Return total number of evaluations.

get/ccm/api/governance/overview/totalEvaluations
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Return total realised Savings.Deprecated

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

Return total realised Savings.

get/ccm/api/governance/overview/totalRealisedSavings
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Return total realised Savings.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

cloudProvider
Array of strings

Cloud Provider

Items Enum: "AWS" "AZURE" "GCP"
Request Body schema: application/json

Request body with time filters

Array
operator
string

List of all possible Operators

Enum: "NOT_IN" "IN" "EQUALS" "NOT_NULL" "NULL" "LIKE" "GREATER_THAN" "LESS_THAN" "GREATER_THAN_EQUALS_TO" "LESS_THAN_EQUALS_TO" "AFTER" "BEFORE"
timestamp
integer <int64>
Responses
400

Bad Request

500

Internal server error

default

Return total realised Savings.

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

Return total realised Savings grouped by cloud provider/resource type.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

cloudProvider
Array of strings

Cloud Provider

Items Enum: "AWS" "AZURE" "GCP"
groupedByResources
boolean

Set to true to group by resource type and false to group by cloud provider

Responses
400

Bad Request

500

Internal server error

default

Return total realised Savings grouped by cloud provider/resource type.

get/ccm/api/governance/overview/totalRealisedSavingsGrouped
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Return total number of rules & enforcementsDeprecated

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

Return total number of rules & enforcements

get/ccm/api/governance/overview/totalRulesEnforcements
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}