Accept a pairing request
POST /admin/federation/peers/{id}/accept
Accepts a pairing request: marks the peer connected on your side,
then sends the other instance a signed reply (a confirm) so it can
do the same.
Your side is connected before the reply goes out and stays connected
if sending fails; the error is then in the response’s notes. As
shipped, the reply doesn’t get through to another Artist Alley
instance (see POST /federation/peers/handshake), so its row can
stay pending_outbound. A 200 doesn’t mean both sides are
connected.
Only a row in pending_inbound can be accepted. For any other row,
or if your instance’s federation key isn’t available, nothing
changes and you still get 200 with the row as it was, so check
status. An unknown id gets 404.
Pairing shares nothing by itself; content reaches a peer only once
you share it. Needs the system.admin capability.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Responses
Section titled “ Responses ”The row as it is after the attempt. Read status and notes to see what happened.
An instance in your peer list, and where pairing with it stands. Pairing shares nothing by itself: content reaches a peer only once you share it with that peer.
object
The instance’s address, such as https://peer.example, with no path or trailing slash.
The instance’s Ed25519 public key, PEM-encoded. A row you created by
asking to pair holds the placeholder PENDING-HANDSHAKE-RESPONSE
instead; only a confirm from that instance replaces it with a real
key.
A label you can set. Nothing in this release acts on it.
A label you can set. Nothing in this release acts on it, so it doesn’t decide whether what you send this peer is encrypted.
When off, no new activity is queued for this peer, it isn’t asked for suggestions and it isn’t in your public list, whatever its status.
Where pairing stands on your side: pending_outbound (you asked to
pair), pending_inbound (it asked and waits for your approval) or
connected. It’s your instance’s own record, not a sign that the
other instance is reachable or has connected too. Activity is queued
only for peers that are connected and enabled.
When this row was created. It doesn’t change when the pair connects.
The user who added this peer or asked to pair; 0 when the row came from the other instance’s request.
Not recorded in this release, so it’s left out.
Free text you can edit. Pairing adds a dated line here when sending a request or reply fails.
Whether this peer appears in your public GET /federation/peers/visible list, which anyone can read. Off by
default. It’s listed only while it’s also connected and enabled.
Not filled in by this release: always 0001-01-01T00:00:00Z.
Not filled in by this release: always 0001-01-01T00:00:00Z.
Malformed request
object
Human-readable error summary
Example
the request could not be completedAuthentication required, missing, or invalid
object
Human-readable error summary
Example
the request could not be completedExample
{ "error": "authentication required: sign in and retry with a valid session or API token"}Authenticated but missing required capabilities
object
Human-readable error summary
Example
the request could not be completedResource not found
object
Human-readable error summary
Example
the request could not be completed