Sign in

v1

latestOpenAPI 3.0.32026-07-22238629559.2 KB
PoliciesV2Service

Preview a remediation policies apply

Validates a candidate remediation policies bundle and returns the diff a strict apply would produce, without changing anything. The response includes the state_version the diff was computed against; send that exact value as If-Match on the follow-up PUT to guarantee you apply the diff you previewed.

post/api/policies/v2/deployments/{deploymentId}/remediation-policies:dryRun

Path parameters

deploymentIdinteger required

The unique numerical identifier for the deployment.

Example:1234

Request body

Example request

{
  "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"
          }
        ]
      }
    ]
  }
}

Response

OK

state_versionstring

The state_version the diff was computed against. Send this exact value as the If-Match header on the follow-up PUT.

Example response

{
  "creates": [
    {
      "kind": "RemediationPolicy",
      "key": {
        "slug": "block-high-confidence-criticals"
      },
      "before": {
        "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"
          }
        ]
      },
      "after": {
        "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"
          }
        ]
      }
    }
  ],
  "updates": [
    {
      "kind": "RemediationPolicy",
      "key": {
        "slug": "block-high-confidence-criticals"
      },
      "before": {
        "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"
          }
        ]
      },
      "after": {
        "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"
          }
        ]
      }
    }
  ],
  "deletes": [
    {
      "kind": "RemediationPolicy",
      "key": {
        "slug": "block-high-confidence-criticals"
      },
      "before": {
        "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"
          }
        ]
      },
      "after": {
        "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",
  "validation_errors": [
    {
      "code": "UNSUPPORTED_ACTION_TYPE"
    }
  ]
}