Skip to content
deedglassdocs

Show a connector's decoder

GET
/v1/connectors/{id}/decoder
curl --request GET \
  --url 'http://127.0.0.1:8080/v1/connectors/example/decoder?recent=10' \
  --header 'Authorization: Bearer <token>' \
  --header 'Deedglass-Version: 2026-10-01'

What the decoder reads from this connector’s database (S20): its slot, status and health, the WAL positions and lag, the watched tables, the frame counters per class and the most recent frames (?recent=N, 0 to 50, default 10; no row images). A witnessed connector that no runner has picked up yet shows pending. A connector that isn’t witnessed is 409 witness_not_configured. A viewer+ Console session or an org admin key; agent keys get 403 insufficient_scope.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

The connector’s id (con_…) or its name.

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.

Query Parameters

Section titled “Query Parameters”
recent
integer
default: 10 <= 50

Responses

Section titled “Responses”

200

Section titled “200”

The decoder.

Media typeapplication/json

A connector’s decoder (S20): what Deedglass reads from the database’s change stream. The decoder never decides a verdict; S21 turns bound frames into L2 verdicts.

object
object
required
string
Allowed values: decoder
connector
required
string
/^con_[0-7][0-9a-hjkmnp-tv-z]{25}$/
name
required
string
slot
required
string
publication
required
string
status
required
string
Allowed values: pending connecting running degraded waiting halted dropped disabled
health
required
string
Allowed values: healthy pending connecting degraded waiting halted dropped disabled
reason
required

Why the status is what it is: lag_high, restart_retained, stalled, publication_changed, timeline_changed, peek_slow (degraded); slot_invalidated, slot_missing, publication_missing, publication_invalid, malformed_evidence, session_settings_changed, ledger_function_changed, system_changed, wal_level, not_replication, slot_conflict (halted); held_elsewhere (waiting); credentials_missing, unreachable (connecting); dropped, not_witnessed, connector_deleted, slot_orphaned.

string | null
detail
required
object
key
additional properties
any
since
required
string format: date-time
transport
required
string
Allowed values: peek
server
required
object
version
required
string | null
system_id
required
string | null
timeline
required
integer | null
positions
required
object
checkpoint_lsn
required
string | null
confirmed_flush_lsn
required
string | null
restart_lsn
required
string | null
current_wal_lsn
required
string | null
lag
required
object
bytes
required

From the slot’s confirmed position to the server’s.

integer | null
seconds
required

Since the decoder last read everything flushed.

number | null
retained_bytes
required

WAL the slot keeps on the database (from restart_lsn).

integer | null
wal_status
required
string | null
watching
required
Array<string>
last_commit
required
object
lsn
required
string
at
required
string | null format: date-time
last_heartbeat_at
required
string | null format: date-time
frames
required

Frames stored, per class.

object
key
additional properties
integer
recent
required
Array<object>
object
commit_lsn
required
string | null
class
required
string
Allowed values: bound unattributed forged_marker forged_marker_nontx marker_count marker_mismatch foreign_ledger publication_gap missing
action
required
string | null
counts
required
object
key
additional properties
object
insert
integer
update
integer
delete
integer
truncate
integer
flags
required
Array<string>
at
required
string format: date-time
updated_at
required
string format: date-time
Example
{
  "object": "decoder",
  "name": "postgres",
  "slot": "deedglass_01j9zq7c4m8x2v6t0r3n5k1h7d",
  "publication": "deedglass_pub",
  "status": "pending",
  "health": "healthy",
  "transport": "peek",
  "server": {
    "version": "18.6"
  },
  "positions": {
    "checkpoint_lsn": "0/3E65050"
  },
  "wal_status": "reserved",
  "recent": [
    {
      "class": "bound"
    }
  ]
}

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.

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.