Get all enforcement rules

GET 
/code/api/v1/enforcement-rules

This API is used to fetch an array of all your existing Enforcement rules. The response includes details of the rule and the behavior threshold configured to each Code category Prisma Cloud Application Security scans (IaC, Secrets, Images, Open source)

Request

Responses

200

Get list of enforcement rules for a specific customer

application/json

Schema

Schema

accountsNotInMainRule object[]required
Array [
accountId stringrequired
accountName stringrequired
]
rules object[]required
Array [
codeCategories objectrequired
IAC objectrequired
commentsBotThreshold RuleThreshold (string)required
Possible values: [OFF, INFO, LOW, MEDIUM, HIGH, CRITICAL]
hardFailThreshold RuleThreshold (string)required
Possible values: [OFF, INFO, LOW, MEDIUM, HIGH, CRITICAL]
softFailThreshold RuleThreshold (string)required
Possible values: [OFF, INFO, LOW, MEDIUM, HIGH, CRITICAL]
IMAGES objectrequired
commentsBotThreshold RuleThreshold (string)required
Possible values: [OFF, INFO, LOW, MEDIUM, HIGH, CRITICAL]
hardFailThreshold RuleThreshold (string)required
Possible values: [OFF, INFO, LOW, MEDIUM, HIGH, CRITICAL]
softFailThreshold RuleThreshold (string)required
Possible values: [OFF, INFO, LOW, MEDIUM, HIGH, CRITICAL]
OPEN_SOURCE objectrequired
commentsBotThreshold RuleThreshold (string)required
Possible values: [OFF, INFO, LOW, MEDIUM, HIGH, CRITICAL]
hardFailThreshold RuleThreshold (string)required
Possible values: [OFF, INFO, LOW, MEDIUM, HIGH, CRITICAL]
softFailThreshold RuleThreshold (string)required
Possible values: [OFF, INFO, LOW, MEDIUM, HIGH, CRITICAL]
SECRETS objectrequired
commentsBotThreshold RuleThreshold (string)required
Possible values: [OFF, INFO, LOW, MEDIUM, HIGH, CRITICAL]
hardFailThreshold RuleThreshold (string)required
Possible values: [OFF, INFO, LOW, MEDIUM, HIGH, CRITICAL]
softFailThreshold RuleThreshold (string)required
Possible values: [OFF, INFO, LOW, MEDIUM, HIGH, CRITICAL]
SUPPLY_CHAIN objectrequired
commentsBotThreshold RuleThreshold (string)required
Possible values: [OFF, INFO, LOW, MEDIUM, HIGH, CRITICAL]
hardFailThreshold RuleThreshold (string)required
Possible values: [OFF, INFO, LOW, MEDIUM, HIGH, CRITICAL]
softFailThreshold RuleThreshold (string)required
Possible values: [OFF, INFO, LOW, MEDIUM, HIGH, CRITICAL]
createdBy stringrequired
creationDate stringrequired
editable booleanrequired
id stringrequired
mainRule booleanrequired
name stringrequired
repositories object[]required
Array [
accountId stringrequired
accountName stringrequired
]
]

Example (from schema)

{
  "accountsNotInMainRule": [
    {
      "accountId": "string",
      "accountName": "string"
    }
  ],
  "rules": [
    {
      "codeCategories": {
        "IAC": {
          "commentsBotThreshold": "OFF",
          "hardFailThreshold": "OFF",
          "softFailThreshold": "OFF"
        },
        "IMAGES": {
          "commentsBotThreshold": "OFF",
          "hardFailThreshold": "OFF",
          "softFailThreshold": "OFF"
        },
        "OPEN_SOURCE": {
          "commentsBotThreshold": "OFF",
          "hardFailThreshold": "OFF",
          "softFailThreshold": "OFF"
        },
        "SECRETS": {
          "commentsBotThreshold": "OFF",
          "hardFailThreshold": "OFF",
          "softFailThreshold": "OFF"
        },
        "SUPPLY_CHAIN": {
          "commentsBotThreshold": "OFF",
          "hardFailThreshold": "OFF",
          "softFailThreshold": "OFF"
        }
      },
      "createdBy": "string",
      "creationDate": "string",
      "editable": true,
      "id": "string",
      "mainRule": true,
      "name": "string",
      "repositories": [
        {
          "accountId": "string",
          "accountName": "string"
        }
      ]
    }
  ]
}

Loading...