Rule Enforcement

This contains APIs related to Rule Enforcement

Add a new rule Enforcement

post

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

Body

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

404

Not Found

500

Internal server error

default

Returns newly created rule enforcement.

post/governance/enforcement

POST /gateway/ccm/api/governance/enforcement?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Content-Type: application/json
Accept: */*
Content-Length: 582

{
  "ruleEnforcement": {
    "uuid": "text",
    "accountId": "text",
    "name": "text",
    "description": "text",
    "tags": [
      "text"
    ],
    "orgIdentifier": "text",
    "projectIdentifier": "text",
    "cloudProvider": "AWS",
    "ruleIds": [
      "text"
    ],
    "ruleSetIDs": [
      "text"
    ],
    "executionSchedule": "text",
    "executionTimezone": "text",
    "targetAccounts": [
      "text"
    ],
    "targetRegions": [
      "text"
    ],
    "isDryRun": true,
    "deleted": true,
    "runCount": 1,
    "isEnabled": true,
    "createdAt": 1,
    "lastUpdatedAt": 1,
    "createdBy": {
      "uuid": "text",
      "name": "text",
      "email": "text",
      "externalUserId": "text"
    },
    "lastUpdatedBy": {
      "uuid": "text",
      "name": "text",
      "email": "text",
      "externalUserId": "text"
    }
  }
}

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

Update a Rule enforcement

put

Update a Rule enforcement

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

Body

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

404

Not Found

500

Internal server error

default

Updated Rule enforcement.

application/json

put/governance/enforcement

PUT /gateway/ccm/api/governance/enforcement?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Content-Type: application/json
Accept: */*
Content-Length: 582

{
  "ruleEnforcement": {
    "uuid": "text",
    "accountId": "text",
    "name": "text",
    "description": "text",
    "tags": [
      "text"
    ],
    "orgIdentifier": "text",
    "projectIdentifier": "text",
    "cloudProvider": "AWS",
    "ruleIds": [
      "text"
    ],
    "ruleSetIDs": [
      "text"
    ],
    "executionSchedule": "text",
    "executionTimezone": "text",
    "targetAccounts": [
      "text"
    ],
    "targetRegions": [
      "text"
    ],
    "isDryRun": true,
    "deleted": true,
    "runCount": 1,
    "isEnabled": true,
    "createdAt": 1,
    "lastUpdatedAt": 1,
    "createdBy": {
      "uuid": "text",
      "name": "text",
      "email": "text",
      "externalUserId": "text"
    },
    "lastUpdatedBy": {
      "uuid": "text",
      "name": "text",
      "email": "text",
      "externalUserId": "text"
    }
  }
}

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

Delete a rule enforcement

delete

Delete a Rule enforcement for the given a ID.

Path parameters

enforcementIDstringRequired

Unique identifier for the rule enforcement

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

404

Not Found

500

Internal server error

default

A boolean whether the delete was successful or not

application/json

delete/governance/enforcement/{enforcementID}

DELETE /gateway/ccm/api/governance/enforcement/{enforcementID}?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Accept: */*

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

Fetch Rule Enforcements for given RuleIds/RuleSetIds

post

Fetch Rule Enforcements for given RuleIds/RuleSetIds

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

Body

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

404

Not Found

500

Internal server error

default

Returns List of Rule Enforcements wrt given RuleIds/RuleSetIds

application/json

post/governance/enforcement/count

POST /gateway/ccm/api/governance/enforcement/count?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "enforcementCount": {
    "accountId": "text",
    "ruleIds": [
      "text"
    ],
    "ruleSetIds": [
      "text"
    ]
  }
}

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

Get Rule Enforcement details for given Enforcement Id

get

Get Rule Enforcement details

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

enforcementIdstringOptional

Enforcement Id

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

404

Enforcement not found

application/json

500

Internal server error

default

Returns Enforcement details

application/json

get/governance/enforcement/details

GET /gateway/ccm/api/governance/enforcement/details?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Accept: */*

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

Get Rule Enforcement savings for given Enforcement Id

post

Get Rule Enforcement savings

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

enforcementIdstringOptional

Enforcement Id

Bodyobject · CCMTimeFilter[]

Time

operatorstring · enumOptional

List of all possible Operators

Possible values:

timestampinteger · int64Optional

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

404

Not Found

500

Internal server error

default

Returns Enforcement savings

application/json

post/governance/enforcement/savings

POST /gateway/ccm/api/governance/enforcement/savings?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Content-Type: application/json
Accept: */*
Content-Length: 37

[
  {
    "operator": "NOT_IN",
    "timestamp": 1
  }
]

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

Deprecated

Fetch Rule Enforcements for account

get

Fetch Rule Enforcement

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

searchKeystringOptional

pageinteger · int32Optional

Page number

Example: 0

pageSizeinteger · int32Optional

Number of items per page

Example: 20

sortTypestring · enumOptionalPossible values:

sortOrderstring · enumOptionalPossible values:

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

404

Not Found

500

Internal server error

default

Returns List of rules Enforcement

application/json

get/governance/enforcement/list

GET /gateway/ccm/api/governance/enforcement/list?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Accept: */*

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

Fetch Rule Enforcements for account with filters

post

Fetch Rule Enforcements for account with filters

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

Body

This has the query to list the RuleEnforcement

ruleIdsstring[]Optional

ruleIds

isDryRunbooleanOptional

isDryRun

searchKeystringOptional

searchKey

targetAccountsstring[]Optional

targetAccounts

targetRegionsstring[]Optional

targetRegions

isEnabledbooleanOptional

isEnabled

sortTypestring · enumOptional

ruleEnforcementSortType

Possible values:

sortOrderstring · enumOptional

sortOrder

Possible values:

pageNumberinteger · int32Optional

pageNumber

pageSizeinteger · int32Optional

pageSize

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

404

Not Found

500

Internal server error

default

Returns List of rules Enforcement

application/json

post/governance/enforcement/list

POST /gateway/ccm/api/governance/enforcement/list?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Content-Type: application/json
Accept: */*
Content-Length: 193

{
  "ruleIds": [
    "text"
  ],
  "isDryRun": true,
  "searchKey": "text",
  "targetAccounts": [
    "text"
  ],
  "targetRegions": [
    "text"
  ],
  "isEnabled": true,
  "sortType": "NAME",
  "sortOrder": "ASCENDING",
  "pageNumber": 1,
  "pageSize": 1
}

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

Enable/Disable a Rule Enforcement for given Enforcement Id

put

Toggle a Rule Enforcement

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

enforcementIdstringOptional

Enforcement Id

enableEnforcementbooleanOptional

Enable Enforcement

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

404

Not Found

500

Internal server error

default

True/false if Rule Enforcement successfully toggled

application/json

put/governance/enforcement/toggle

PUT /gateway/ccm/api/governance/enforcement/toggle?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Accept: */*

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