Sign in

v1

latestOpenAPI 3.0.32026-07-22238629559.2 KB
PoliciesV2Service

Get remediation policies

Returns the remediation policies bundle for the deployment plus the state_version required to apply changes. System-managed policies are not included.

get/api/policies/v2/deployments/{deploymentId}/remediation-policies

Path parameters

deploymentIdinteger required

The unique numerical identifier for the deployment.

Example:1234

Response

OK

state_versionstring

A content-only fingerprint of the bundle. It changes only when the bundle's content changes. Send it as the If-Match header on PUT.

Example response

{
  "bundle": {
    "deployment_slug": "my-org",
    "policies": [
      {
        "slug": "block-high-confidence-criticals",
        "name": "Block high-confidence criticals",
        "active": true,
        "filters": {
          "mode": "all",
          "conditions": [
            {
              "type": "severity",
              "values": [
                "critical",
                "high"
              ],
              "mode": "any"
            }
          ]
        },
        "actions": [
          {
            "type": "block"
          }
        ]
      }
    ]
  },
  "state_version": "d4c3b2a1"
}