Skip to main content
POST
Preview a detection policy apply
This endpoint is in beta. It may still change before it reaches general availability.

Authorizations

Authorization
string
header
required

Get access to data with your API token. Example header:

Authorization: Bearer 2991e2fb4b540fe75b8f90677b0b892b6314e4961cb001fe6eb452eee248a628

The token can be provisioned from the Tokens section in your Settings, and requires explicitly enabling Web API access.

Path Parameters

deploymentId
integer<int64>
required

The unique numerical identifier for the deployment.

Example:

1234

product
string
required

The product the candidate bundle applies to. One of: code, secrets.

Example:

"code"

Body

application/json
bundle
Detection Policy Bundle · object
required

The candidate bundle to diff against the current state.

Response

200 - application/json

OK

creates
object[]

Exceptions that the apply would create.

updates
object[]

The detection policy and exceptions that the apply would update.

deletes
object[]

Exceptions that the apply would delete.

state_version
string

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

Example:

"a1b2c3d4"

validation_errors
object[]

Validation problems with the candidate bundle. When non-empty, the diff fields are empty and a strict apply would be rejected.