Skip to content
deedglassdocs

Preview an undo

POST
/v1/actions/{id}/undo/preview
curl --request POST \
  --url http://127.0.0.1:8080/v1/actions/example/undo/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Deedglass-Version: 2026-10-01' \
  --data '{ "allow_triggers": true }'

Plans the undo of a Postgres write from what Postgres committed (the decoder’s row images, never the agent’s report), and runs the twelve safety checks without taking a lock. It writes nothing. available is true when no check failed; steps.data holds the first 20 steps (?steps_limit= up to 1,000); policy is a dry run for the console system agent. A signed-in admin or owner (with Deedglass-CSRF) or an org admin key; agent keys get 403 insufficient_scope. Another org’s action is 404 not_found.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

The action to undo (act_…).

Header Parameters

Section titled “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.

Query Parameters

Section titled “Query Parameters”
steps_limit
integer
>= 1 <= 1000

Steps to list

Request Body

Section titled “Request Body”
Media typeapplication/json
object
allow_triggers

Let triggers fire again (the triggers check is then a warning).

boolean
Examplegenerated
{
  "allow_triggers": true
}

Responses

Section titled “Responses”

200

Section titled “200”

The preview.

Media typeapplication/json
object
object
required
string
Allowed value: undo_preview
action
required
string
tool
required

The original action’s tool.

string
available
required

No check failed.

boolean
summary
required
string
headline
required

“301 rows in public.orders · 301 updates”

string
plan_digest
required

Sha256: of the plan; send it to POST /v1/actions/{id}/undo.

string | null
connector
required
object
id
required
string
name
required
string
type
required
string
evidence
required
object
level
required
string
verdict
required
string
xid
required
string
commit_lsn
required
string
committed_at
required
string
changes
required
integer
counts
required
object
update
required
integer
insert
required
integer
delete
required
integer
rows
required
integer
tables
required
Array<string>
steps
required
object
object
required
string
Allowed value: list
total
required
integer
has_more
required
boolean
data
required
Array<object>

One step of the plan as a person reads it: expect is the row now (what the action wrote), set what the undo writes back. A sensitive column shows as •••; NULL is null. The full UndoStep schema is in openapi.yaml.

object
checks
required
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
notes
required
Array<string>
redacted
required

Columns marked sensitive, “schema.table.column”: shown as ••• and compared by digest.

Array<string>
policy
required
object
decision
required
string
Allowed values: allow deny require_approval
rule_id
required
string | null
reason
required
string | null
undone_by
required
string | null
Example
{
  "object": "undo_preview",
  "steps": {
    "object": "list"
  },
  "policy": {
    "decision": "allow"
  }
}

Headers

Section titled “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.

default

Section titled “default”

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

Media typeapplication/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": "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

Section titled “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.