Skip to content

List the peers this instance shows publicly

GET
/federation/peers/visible

Lists the peers this instance shows publicly, so admins of other instances can find instances to pair with. Anyone can call it, without signing in.

A peer is listed only while it’s connected, enabled and has share_in_visible_list turned on. That setting is off by default; change it with PATCH /admin/federation/peers/{id}. Peers are sorted by address, and the fingerprint is empty if a peer’s key can’t be read.

Being listed is a hint, not an endorsement. It doesn’t pair anyone, share anything or vouch for the listed instance.

List of visible peers.

object
peers
required
Array<object>

A peer in the public list: its address, name and key. Your notes and settings for it aren’t included.

object
instance_url
required
string
display_name
required
string
instance_public_key
required
string
fingerprint
required

Lowercase hex SHA-256 of the key, worked out by this instance. Empty if the key can’t be read.

string