Skip to main content
POST
Reverse a rule run

Authorizations

Authorization
string
header
required

Path Parameters

project_id
string
required

Project friendly ID (e.g. prj_AbCd1234567890Ef).

rule_id
string
required

Rule friendly ID.

id
string
required

Run friendly ID (e.g. rrun_AbCd1234567890Ef).

Response

200

id
string

Run friendly ID (e.g. rrun_AbCd1234567890Ef).

rule_id
string
state
enum<string>
Available options:
running,
completed,
failed,
superseded,
reversing,
reversed,
reversal_failed
phase
enum<string> | null

Where a running run has got to. Null once it is no longer running.

Available options:
queued,
preparing,
evaluating
trigger
enum<string>

What started the run. A run you create here is on_demand.

Available options:
authoring,
ingestion,
schedule_sweep,
on_demand
range_start
string<date-time>
range_end
string<date-time>
started_at
string<date-time> | null
finished_at
string<date-time> | null
last_evaluated_at
string<date-time> | null
targets_total
integer
targets_processed
integer
passed_count
integer
alerted_count
integer
results_changed_count
integer

How many verdicts this run actually changed.

newly_alerted_count
integer
newly_cleared_count
integer
reversible
boolean

Whether this run can still be taken back.

non_reversible_reason
string | null

Why it cannot, when reversible is false.

reversal_summary
object | null

What a reversal did, once one has run, including the rows it declined to touch and why.

triggered_by
string | null

The name of the person who started it. Null for a run started by an account-scoped token, which has no person behind it.

error_message
string | null