Get All Rules

GET {{cb_url}}/containers/v1/orgs/{{cb_org_key}}/guardrails/management/rules

This request returns the list of misconfiguration types (rules) that can be added to a policy.

RBAC Permissions Required

API Documentation

Response Schema

{
  "rules": {
    "rule_id1": {
      "rule_id": "<uuid>",
      "name": "<string>",
      "description": "<string>",
      "risk": "<string>",
      "supported_actions": [
        "<string>"
      ],
      "preset_support": {
        "is_required": <boolean>,
        "default_settings": {
          "name": "<string>",
          "security_settings": [
            {
              "path": "<string>",
              "action": "<string>",
              "value": {
                "nullable": true,
                "description": "<string>"
              }
            },
            {
              "path": "<string>",
              "action": "<string>",
              "value": {
                "nullable": <boolean>,
                "description": "<string>"
              }
            }
          ]
        },
        "security_settings": [
          {
            "path": "<string>",
            "supported_actions": [
              "<string>"
            ]
          },
          {
            "path": "<string>",
            "supported_actions": [
              "<string>"
            ]
          }
        ]
      },
      "presets": [
        {
          "id": "<string>",
          "name": "<string>",
          "rule_id": "<string>",
          "policies": [
            {
              "policy_id": "<uuid>",
              "policy_name": "<string>"
            },
            {
              "policy_id": "<uuid>",
              "policy_name": "<string>"
            }
          ],
          "security_settings": [
            {
              "path": "<string>",
              "action": "<string>",
              "value": {
                "nullable": <boolean>,
                "description": "<string>"
              }
            },
            {
              "path": "<string>",
              "action": "<string>",
              "value": {
                "nullable": <boolean>,
                "description": "<string>"
              }
            }
          ]
        }
      ],
      "category": "Workload Security",
      "policies": [
        {
          "policy_id": "<uuid>",
          "policy_name": "<string>"
        }
      ],
      "templates": [
        {
          "template_id": "<uuid>",
          "template_name": "<string>"
        }
      ],
      "custom_rules_metadata": {
        "kinds": [
          "<string>"
        ],
        "creator": "<string>",
        "created_on": <number>,
        "created_on_iso": "<string>",
        "type": "advanced",
        "mapl_rule": {
          "aliquipdc": "<string>",
          "mollit_": "<string>"
        }
      }
    }
  }
}

HEADERS

RESPONSES

status: OK

{"rules":{"09c851ee-46f8-4d18-847f-c0df4446472c":{"rule_id":"09c851ee-46f8-4d18-847f-c0df4446472c","name":"Demo Rule  01","description":"Creating a junk rule","risk":null,"category":"Container Images","supported_actions":["block","alert"],"preset_support":null,"presets":null,"policies":[],"templates":[],"custom_rule_metadata":{"mapl_rule":{"ruleID":"09c851ee-46f8-4d18-847f-c0df4446472c","sender":{},"receiver":{},"resource":{},"conditions":{"conditionsTree":{"OR":[{"ANY":{"parentJsonpathAttribute":"jsonpath:$.containers[:]","returnValueJsonpath":{"criticalVulnerabilities":"jsonpath:$RELATIVE.scanData.vulnerabilitiesBySeverity.critical","highVulnerabilities":"jsonpath:$RELATIVE.scanData.vulnerabilitiesBySeverity.high","image":"jsonpath:$RELATIVE.Container.image.full_tag"},"condition":{"OR":[{"condition":{"attribute":"jsonpath:$RELATIVE.imageVulnerabilitiesSummary.vulnerabilitiesSummary.critical.amount","method":"GT","value":"0"}},{"condition":{"attribute":"jsonpath:$RELATIVE.imageVulnerabilitiesSummary.vulnerabilitiesSummary.high.amount","method":"GT","value":"0"}}]}}},{"ANY":{"parentJsonpathAttribute":"jsonpath:$.initContainers[:]","returnValueJsonpath":{"criticalVulnerabilities":"jsonpath:$RELATIVE.scanData.vulnerabilitiesBySeverity.critical","highVulnerabilities":"jsonpath:$RELATIVE.scanData.vulnerabilitiesBySeverity.high","image":"jsonpath:$RELATIVE.Container.image.full_tag"},"condition":{"OR":[{"condition":{"attribute":"jsonpath:$RELATIVE.imageVulnerabilitiesSummary.vulnerabilitiesSummary.critical.amount","method":"GT","value":"0"}},{"condition":{"attribute":"jsonpath:$RELATIVE.imageVulnerabilitiesSummary.vulnerabilitiesSummary.high.amount","method":"GT","value":"0"}}]}}},{"ANY":{"parentJsonpathAttribute":"jsonpath:$.ephemeralContainers[:]","returnValueJsonpath":{"criticalVulnerabilities":"jsonpath:$RELATIVE.scanData.vulnerabilitiesBySeverity.critical","highVulnerabilities":"jsonpath:$RELATIVE.scanData.vulnerabilitiesBySeverity.high","image":"jsonpath:$RELATIVE.Container.image.full_tag"},"condition":{"OR":[{"condition":{"attribute":"jsonpath:$RELATIVE.imageVulnerabilitiesSummary.vulnerabilitiesSummary.critical.amount","method":"GT","value":"0"}},{"condition":{"attribute":"jsonpath:$RELATIVE.imageVulnerabilitiesSummary.vulnerabilitiesSummary.high.amount","method":"GT","value":"0"}}]}}}]}},"metadata":{"description":"Demonstration Rule","initial-type":"critical-vulnerabilities","name":"Demo Rule  01"}},"kinds":[],"type":"image-scanning","creator":"demouser@demoorg.com","created_on":1683746762769,"created_on_iso":"2023-05-10T19:26:02.769Z"}}}}