List Suppression Rules

GET 
/code/api/v1/suppressions

Every suppression rule has a type indicating scope (aka suppression type) and details on the scope. Resources answering the scope of the suppression will not return an error on a misconfigured resource and will appear as "suppressed". The possible suppression scopes are: Policy - The entire policy is turned off. Account - Resources in specific accounts or repositories are suppressed. Tags - Resource with specific set tags are suppressed. Resources- Resource by specific IDs are suppressed.

Request

Responses

200

Returns all the suppressions

application/json

Schema

Schema

• Array [
anyOf

AccountsSuppression

accountIds string[]required

suppressionType stringrequired

Possible values: [Accounts]

PolicySuppression

suppressionType stringrequired

Possible values: [Policy]

TagsSuppression

suppressionType stringrequired

Possible values: [Tags]

tags object[]required

Array [

key stringrequired

value stringrequired

]

TagsSuppressionData

comment stringrequired

creationDate string

id stringrequired

policyId stringrequired

suppressionType stringrequired

Possible values: [Tags]

tags object[]required

Array [

key stringrequired

value stringrequired

]

ResourcesSuppressionLegacy

resources object[]required

Array [

accountId stringrequired

resourceId stringrequired

]

suppressionType stringrequired

Possible values: [Resources]

policyId stringrequired
comment stringrequired
creationDate string
id stringrequired
• ]

Example (from schema)

[
  {
    "policyId": "string",
    "comment": "string",
    "creationDate": "string",
    "id": "string",
    "accountIds": [
      "string"
    ],
    "suppressionType": "Accounts"
  }
]

Example 1

[
  {
    "comment": "Policy is irrelevant.",
    "creationDate": "2020-10-15T12:46:49.592Z",
    "id": "2684013d-43d0-401d-9bf2-74dc4df76386",
    "policyId": "BC_GCP_LOGGING_1",
    "suppressionType": "Policy"
  },
  {
    "comment": "Ignored.",
    "creationDate": "2021-01-08T23:00:47.674Z",
    "id": "e1272e30-e231-4beb-b960-1bcb24c2834d",
    "policyId": "BC_GCP_GCS_2",
    "suppressionType": "Tags",
    "tags": [
      {
        "key": "team",
        "value": "knights"
      }
    ]
  },
  {
    "accountIds": null,
    "comment": "No justification comment provided.",
    "creationDate": "2020-12-24T13:22:20.086Z",
    "id": "13a5befb-ccaf-4bf8-83af-b1d8fd5c89f6",
    "policyId": "BC_AZR_STORAGE_1",
    "suppressionType": "Accounts"
  },
  {
    "comment": "Dev env resources.",
    "creationDate": "2020-09-18T08:09:25.803Z",
    "id": "b48476c4-062a-4091-a48d-040c14d7e809",
    "policyId": "acme_AWS_1600118884127",
    "resources": {
      "resourceId": "/terraform/aws/ec2.tf:aws_instance.web_host"
    },
    "suppressionType": "Resources"
  }
]

Loading...