Cancel a replay

POST

/v1/replays/{id}/cancel

const url = 'http://127.0.0.1:8080/v1/replays/example/cancel';
const options = {
  method: 'POST',
  headers: {'Deedglass-Version': '2026-10-01', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://127.0.0.1:8080/v1/replays/example/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Deedglass-Version: 2026-10-01'

Cancels a queued or running replay (S27): its status is cancelled at once, and a runner working on it stops after its current batch. It keeps no partial result. A replay that already finished (succeeded, failed or cancelled) is 409 conflict. No body. An admin+ Console session (with the Deedglass-CSRF header) or an org admin key (admin scope); agent keys get 403 insufficient_scope.

Authorizations

bearerAuth
sessionCookie

Parameters

Path Parameters

required

string

The replay id (rpl_…).

Header Parameters

Deedglass-Version

string

/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/

The API version (YYYY-MM-DD). Leave it out to use your org’s pinned version (public routes use the latest). An unknown version is 400 api_version_invalid.

Deedglass-CSRF

string

Needed when the request uses a Console session (it changes state); without it the answer is 403 csrf_failed. Not sent with an API key.

Idempotency-Key

string

>= 1 characters <= 255 characters

1 to 255 printable ASCII characters. A retry with the same key and body returns the stored response with Deedglass-Idempotent-Replayed: true for 24 hours.

Responses

200

The replay, cancelled.

application/json

A replay job (S27): what it replays, its progress and, once status is succeeded, its result (summary through elapsed_ms; transitions and rule_changes are absent when there are none). elapsed_ms is not part of result_digest.

object

object

required

string

Allowed value: replay

required

string

/^rpl_[0-7][0-9a-hjkmnp-tv-z]{25}$/

status

required

string

Allowed values: queued running succeeded failed cancelled

purpose

required

string

Allowed values: manual suggestion

candidate

required

The version replayed.

object

policy

The policy id (pol_…).

string

name

required

string

version

required

The version number (0 for a draft).

integer

version_id

The version id (pv_…). Absent for a draft.

string

version_hash

required

“sha256:” + lowercase hex of SHA-256.

string

/^sha256:[0-9a-f]{64}$/

source_hash

A draft’s source hash. Absent for a stored version.

string

/^sha256:[0-9a-f]{64}$/

baseline

required

What the candidate is compared with: the decisions recorded at the time (recorded), or another version of the same policy evaluated over the same inputs (version).

object

type

required

string

Allowed values: recorded version

version

required

The baseline version number; 0 for recorded.

integer

version_id

version only (pv_…).

string

version_hash

version only.

string

/^sha256:[0-9a-f]{64}$/

window

required

object

from

required

string format: date-time

required

string format: date-time

progress

required

object

processed

required

integer

total

required

The actions in the window

integer | null

percent

required

Processed / total

integer

<= 100

requested_by

required

Who asked for it.

object

type

required

string

Allowed values: user api_key system

required

usr_…, key_…, or deedglass for the system.

string

attempts

required

Runs started. A runner that lost its lease starts again from zero.

integer

created_at

required

string format: date-time

started_at

required

string | null format: date-time

finished_at

required

string | null format: date-time

error

required

A failed replay’s cause.

object

code

required

string

Allowed values: candidate_invalid replay_too_large replay_window_invalid internal_error

message

required

string

summary

actions = evaluated + unknown and evaluated = unchanged + changed + rule_changed.

object

actions

required

integer

evaluated

required

integer

unchanged

required

integer

changed

required

The decision would differ.

integer

rule_changed

required

The same decision

integer

unknown

required

Counted but not evaluated (see unknown); never guessed.

integer

transitions

Array<object>

Every action whose decision would change from from (the baseline) to to (the candidate). The full Transition schema is in openapi.yaml.

object

rule_changes

Array<object>

The same decision, reached by a different rule. The full RuleChange schema is in openapi.yaml.

object

unknown

Actions a replay counted but couldn’t evaluate, by reason.

object

input_pruned

required

Retention removed the stored decision input.

integer

input_missing

required

Recorded before decision inputs were stored.

integer

input_version_unsupported

required

A stored input in a newer format.

integer

input_unreadable

required

A stored input that doesn’t decode.

integer

evaluation_time_limit

required

The evaluation hit its time limit.

integer

sqlguard

The sqlguard versions recorded with the decisions, next to the current one. SQL facts are computed again at replay, so a difference is shown, never hidden.

object

recorded

required

Array<string>

current

required

string

result_digest

The same inputs, candidate, baseline and sqlguard version give the same digest.

string

/^sha256:[0-9a-f]{64}$/

elapsed_ms

integer

Examples

cancelled

Cancelled while running

{
  "object": "replay",
  "id": "rpl_01m42vm8k2r4t6w8y0b2d4f6h8",
  "status": "cancelled",
  "purpose": "manual",
  "candidate": {
    "policy": "pol_01m42v9q4bjwfqmk8bd58vzkdh",
    "name": "acme-sim",
    "version": 3,
    "version_id": "pv_01m42vcmkk193cy009pdzt4c6s",
    "version_hash": "sha256:3d09f641a6d5f6962ef719d05a59c6cea0362d950ea6f920418b01125b6bbb7b"
  },
  "baseline": {
    "type": "version",
    "version_id": "pv_01m42va0ryp515cvtem633vqng",
    "version": 2,
    "version_hash": "sha256:5b1c0e7a9d3f2468ace0b2d4f6a8c0e2b4d6f8a0c2e4a6b8d0f2a4c6e8b0d2f4"
  },
  "window": {
    "from": "2026-09-04T00:00:00Z",
    "to": "2026-10-04T00:00:00Z"
  },
  "progress": {
    "processed": 2000,
    "total": 6012,
    "percent": 33
  },
  "requested_by": {
    "type": "user",
    "id": "usr_01m42v9p7c3e5g7j9m1q3s5v7x"
  },
  "attempts": 1,
  "created_at": "2026-10-04T07:10:02.118204Z",
  "started_at": "2026-10-04T07:10:02.121930Z",
  "finished_at": "2026-10-04T07:10:02.164518Z",
  "error": null
}

Headers

Deedglass-Request-Id

string

/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/

This request’s id. Quote it to support; it matches error.request_id.

Deedglass-Version

string

The API version this response follows.

Deedglass-Idempotent-Replayed

string

Allowed values: true

Present, and true, when the response is a stored one replayed for an Idempotency-Key.

409

The replay already finished.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error policy_error rate_limit_error api_error

code

required

string

Allowed values: invalid_api_key api_key_revoked api_key_expired agent_suspended agent_stopped org_stopped insufficient_scope policy_denied approval_required approval_expired budget_exceeded intent_required intent_invalid intent_replay tool_unknown connector_unavailable upstream_error timeout rate_limited idempotency_conflict validation_failed not_found conflict internal_error authentication_required method_not_allowed request_too_large unsupported_media_type invalid_json api_version_invalid idempotency_key_invalid idempotency_key_in_use service_unavailable session_expired csrf_failed insufficient_role login_link_invalid login_code_invalid last_owner policy_unavailable policy_invalid credentials_missing destination_blocked vault_unavailable upstream_auth_failed upstream_not_found upstream_rate_limited response_too_large statement_refused row_limit_exceeded database_role_unsafe database_not_ready witness_not_configured approval_decided already_countersigned approver_not_eligible self_approval approval_needs_person context_changed approval_unsatisfiable approval_link_invalid approval_link_review_only approver_unmapped stripe_live_key_refused stripe_livemode_detected upstream_approval_pending schedule_needs_approval action_executing from_denied undo_unavailable undo_plan_stale already_undone undo_conflict replay_too_large replay_window_invalid suggestion_stale shadow_slot_taken suggestion_decided observe_not_enabled pro_required

message

required

One or more calm sentences with the next step.

string

param

required

The request field, query parameter or header the error is about.

string | null

request_id

required

string

/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/

doc_url

required

string format: uri

diagnostics

On policy_invalid only. Each problem with its line, code and hint.

Array<object>

One finding about a policy file, with its position and the next step. Codes are stable and listed in docs/POLICY_ERRORS.md. In the policy_invalid error envelope each diagnostic also carries object: policy_diagnostic. The full PolicyDiagnostic schema is in openapi.yaml.

object

action

One agent action. Its sections mirror the deed’s. status is the one field an agent needs; state is the exact lifecycle state (docs/GATE.md). The Gate’s own responses (POST /v1/actions and its result report) add execution.result and witness.reasons; lists leave both out. The full Action schema is in openapi.yaml.

object

checks

On undo_unavailable only. Every check of the undo, each with its fix. Additive (S23).

Array<object>

One of the twelve safety checks (S23 §3.3). Available means no check failed. The full UndoCheck schema is in openapi.yaml.

object

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "conflict",
    "message": "This replay already finished, so it can't be cancelled. Start a new one to replay again.",
    "param": null,
    "request_id": "req_01m42vm9n4q6s8v0x2z4b6d8f0",
    "doc_url": "https://docs.deedglass.com/errors/conflict"
  }
}

Headers

Deedglass-Request-Id

string

/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/

This request’s id. Quote it to support; it matches error.request_id.

default

An error. Every error has this envelope; doc_url explains the code.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error policy_error rate_limit_error api_error

code

required

string

message

required

One or more calm sentences with the next step.

string

param

required

The request field, query parameter or header the error is about.

string | null

request_id

required

string

/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/

doc_url

required

string format: uri

diagnostics

On policy_invalid only. Each problem with its line, code and hint.

Array<object>

object

action

object

checks

On undo_unavailable only. Every check of the undo, each with its fix. Additive (S23).

Array<object>

One of the twelve safety checks (S23 §3.3). Available means no check failed. The full UndoCheck schema is in openapi.yaml.

object

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "not_found",
    "message": "There's no endpoint at GET /v1/helth. Did you mean /v1/health?",
    "param": null,
    "request_id": "req_01j9zr3m5k8q2w7x4t6v0b1c9d",
    "doc_url": "https://docs.deedglass.com/errors/not_found"
  }
}

Headers

Deedglass-Request-Id

string

/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/

This request’s id. Quote it to support; it matches error.request_id.

Deedglass-Version

string

The API version this response follows.