Rule

This contains APIs related to Rule Management

Delete a rule

Delete a Rule for the given a ID.

SecurityApiKey
Request
path Parameters
ruleID
required
string

Unique identifier for the rule

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

A boolean whether the delete was successful or not

delete/ccm/api/governance/rule/{ruleID}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Enqueues job for execution

Enqueues job for execution.

SecurityApiKey
Request
query Parameters
accountIdentifier
string

Account Identifier for the Entity.

Request Body schema: application/json

Request body for queuing the governance job

ruleEnforcementId
string
roleArn
string
externalId
string
ruleCloudProviderType
string
Value: "AWS"
ruleId
string
policy
string
targetAccountId
string
targetRegion
string
isDryRun
boolean
isOOTB
boolean
Responses
400

Bad Request

500

Internal server error

default

Returns success when job is enqueued

post/ccm/api/governance/enqueue
Request samples
application/json
{
  • "ruleEnforcementId": "string",
  • "roleArn": "string",
  • "externalId": "string",
  • "ruleCloudProviderType": "AWS",
  • "ruleId": "string",
  • "policy": "string",
  • "targetAccountId": "string",
  • "targetRegion": "string",
  • "isDryRun": true,
  • "isOOTB": true
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Fetch rules for account

Fetch rules

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema: application/json

Request body containing rule object

object (RuleRequest)

This has the query to list the policies

Responses
400

Bad Request

500

Internal server error

default

Returns List of rules

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

Get Schema for entity

Get Schema for entity

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string
projectIdentifier
string
orgIdentifier
string
entityType
string
Enum: "CreatePR" "MergePR" "Projects" "Pipelines" "PipelineSteps" "Http" "Email" "JiraCreate" "JiraUpdate" "JiraApproval" "HarnessApproval" "CustomApproval" "Barrier" "Queue" "FlagConfiguration" "ShellScript" "K8sCanaryDeploy" "K8sApply" "K8sBlueGreenDeploy" "K8sRollingDeploy" "K8sRollingRollback" "K8sScale" "K8sDelete" "K8sBGSwapServices" "K8sCanaryDelete" "TerraformApply" "TerraformPlan" "TerraformDestroy" "TerraformRollback" "HelmDeploy" "HelmRollback" "Connectors" "Secrets" "Files" "Service" "Environment" "EnvironmentGroup" "InputSets" "CvConfig" "Verify" "Delegates" "DelegateConfigurations" "CvVerificationJob" "IntegrationStage" "IntegrationSteps" "SecurityStage" "SecuritySteps" "CvKubernetesActivitySource" "DeploymentSteps" "DeploymentStage" "ApprovalStage" "PipelineStage" "FeatureFlagStage" "Template" "TemplateStage" "CustomDeployment" "Triggers" "MonitoredService" "GitRepositories" "FeatureFlags" "ServiceNowApproval" "ServiceNowCreate" "ServiceNowUpdate" "ServiceNowImportSet" "GovernancePolicies" "Policy" "Run" "RunTests" "Plugin" "RestoreCacheGCS" "RestoreCacheS3" "SaveCacheGCS" "SaveCacheS3" "Security" "AquaTrivy" "AWSECR" "Bandit" "BlackDuck" "Brakeman" "Burp" "Checkmarx" "Clair" "DataTheorem" "DockerContentTrust" "External" "FortifyOnDemand" "Grype" "JfrogXray" "Mend" "Metasploit" "Nessus" "NexusIQ" "Nikto" "Nmap" "Openvas" "Owasp" "PrismaCloud" "Prowler" "Qualys" "Reapsaw" "ShiftLeft" "Sniper" "Snyk" "Sonarqube" "Sysdig" "Tenable" "Veracode" "Zap" "GitClone" "ArtifactoryUpload" "GCSUpload" "S3Upload" "BuildAndPushGCR" "BuildAndPushECR" "BuildAndPushDockerRegistry" "CreateStack" "DeleteStack" "ServerlessAwsLambdaDeploy" "ServerlessAwsLambdaRollback" "CustomStage" "RollbackStack" "Infrastructure" "Command" "StrategyNode" "AzureSlotDeployment" "AzureTrafficShift" "FetchInstanceScript" "AzureSwapSlot" "AzureWebAppRollback" "JenkinsBuild" "EcsRollingDeploy" "EcsRollingRollback" "EcsCanaryDeploy" "EcsCanaryDelete" "AzureCreateARMResource" "BuildAndPushACR" "AzureCreateBPResource" "AzureARMRollback" "Background" "Wait" "ArtifactSource" "EcsBlueGreenCreateService" "EcsBlueGreenSwapTargetGroups" "EcsBlueGreenRollback" "ShellScriptProvision" "Freeze" "GitOpsUpdateReleaseRepo" "GitOpsFetchLinkedApps" "EcsRunTask" "Chaos" "ElastigroupDeploy" "ElastigroupRollback" "Action" "ElastigroupSetup" "Bitrise" "TerragruntPlan" "TerragruntApply" "TerragruntDestroy" "TerragruntRollback" "IACMStage" "IACMStep" "IACM" "Container" "IACMTerraformPlan" "IACMTemplate" "ElastigroupBGStageSetup" "ElastigroupSwapRoute" "AsgCanaryDeploy" "AsgCanaryDelete" "SwapRoutes" "SwapRollback" "AppResize" "AppRollback" "CanaryAppSetup" "BGAppSetup" "BasicAppSetup" "TanzuCommand" "AsgRollingDeploy" "AsgRollingRollback" "GovernanceRuleAWS"
Request Body schema: application/json
string
Enum: "account" "org" "project" "unknown"
Responses
400

Bad Request

500

Internal server error

default

Schema

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

Update a Rule

Update a Rule

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema: application/json

Request body containing rule object

object (Rule)

This object will contain the complete definition of a Cloud Cost Policies

Responses
400

Bad Request

500

Internal server error

default

update an existing Rule

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