Skip to main content
POST
Start dry-run

Authorizations

Authorization
string
header
required

Bearer API Key. For example, "Bearer {Tenant API Key}"

Headers

Authorization
string
required

Bearer API Key. For example, "Bearer {Tenant API Key}"

Content-Type
string

application/json

Body

application/json
integrationId
string<uuid>
required

The integration whose assets the check runs against.

check
object
required

The check to dry-run. May be an unsaved edit; customCheckId identifies it in the results.

Response

Dry-run accepted and started

dryRunId
string<uuid>
required
status
enum<string>
required
Available options:
RUNNING
pollUrl
string
required

Path to poll for this dry-run's status.

Example:

"/v1/tenant/custom-check-dry-runs/2ea262bd-aa14-48c2-81ce-fa783cca7227"