Skip to content

Cancel all queued outbox rows for a peer

POST
/admin/federation/peers/{id}/cancel-pending

Defederation-cascade hook. Marks every queued federation_outbox row for the peer as status=cancelled

  • last_error=‘peer defederation cascade’ in ONE transaction. Emits a SINGLE federation.peer.cascade_cancelled audit event carrying the total cancellation count — NOT N audit events per the design proposal §7.4 single-audit invariant.

Caller MUST also disable the peer separately (this endpoint does NOT alter the federation_peers row) — cancelling queued rows on an active peer would just race the new ones the dispatcher enqueues. The admin UI sequences disable → cancel-pending in one click.

id
required
string format: uuid

Cascade complete; count of cancelled rows in body.

object
peer_id
required
string format: uuid
cancelled_count
required

Number of outbox rows transitioned from queued to cancelled.

integer

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Peer not found.

object
error
required

Human-readable error summary

string
Example
the request could not be completed