Skip to content

Get this instance's federation identity

GET
/federation/instance

Returns this instance’s federation public key and its fingerprint, with the base URL and site name it identifies itself by. Anyone can call it, without signing in.

Use it to check a key with another instance’s admin: compare public_key_pem or fingerprint with what the other side has saved for you. Pairing and delivery don’t fetch this document; they use the key carried in a handshake or the one saved for each peer.

instance_url and display_name are read from the site settings on every request, but the handshake keeps the values it read when the app started. After changing the base URL or site name, restart the app.

This instance’s federation identity.

This instance’s public federation identity: its key, and the base URL and site name it gives other instances.

object
instance_url
required

The base URL from this instance’s site settings, as entered. Empty until an admin sets it.

string
display_name
required

The site name from this instance’s settings.

string
public_key_pem
required

This instance’s Ed25519 public key, PEM-encoded. It signs this instance’s handshakes and its requests to peers’ inboxes.

string
fingerprint
required

Lowercase hex SHA-256 of the 32-byte key, short enough for two admins to read to each other.

string
protocol_version
required

Always aa-fed/v1. Handshake envelopes carry a different identifier, aa-handshake/v1.

string

This instance’s federation key isn’t available because it couldn’t be loaded when the app started, for example without a master key. It stays unavailable until the app restarts with the key in place.

object
error
required

Human-readable error summary

string
Example
the request could not be completed