Preview what defederation will cascade

GET

/admin/federation/peers/{id}/defederation-preview

• Local development behind nginx (port 8088 by default)

Backs the cascade-preview modal per the 1.22.C design proposal §8.5. Returns:

• total_active_shares + per-object-kind breakdown
• pending_handshakes (handshakes in flight that would be cancelled)
• cached_suggestions (peer-of-peer suggestions contributed by this peer that would be dropped)
• peer summary (display_name + URL for the modal header) Gated on system.admin.

Authorizations

• cookieAuth
• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Cascade impact summary.

Cascade-preview summary returned by GET /admin/federation/peers/{id}/defederation-preview per the 1.22.C design proposal §8.5. The admin UI renders this in the confirm-defederation modal so the operator sees exact impact before clicking through.

object

peer_id

required

string format: uuid

peer_display_name

required

string

peer_url

required

string

total_active_shares

required

Sum across all object kinds. The cascade emits one aa:Unshare per row (best-effort delivery via the outbox) before deleting the peer.

integer format: int64

shares_by_kind

required

Per-object-kind breakdown so the modal renders “12 posts, 23 collections, 8 assets, …”. Keys are from the federation.ShareObjectKind closed catalogue; kinds with zero active shares may be omitted.

object

key

additional properties

integer format: int64

pending_handshakes

required

Number of pending_outbound + pending_inbound rows for this peer.

integer

cached_suggestions

required

Federation_peer_suggestions rows sourced from this peer that would be dropped.

integer

401

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"
}

403

Authenticated but missing required capabilities

object

error

required

Human-readable error summary

string

Example

the request could not be completed

404

Resource not found

object

error

required

Human-readable error summary

string

Example

the request could not be completed