Skip to content

AdminRelayList

The relays, in registration order.

object
items
required
Array<object>

A relay that the instance joins or joined.

object
id
required

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
protocol
required

How a relay is joined. mastodon: at its inbox, by a Follow of the Public collection. litepub: at its actor, by a Follow of the actor.

string
Allowed values: mastodon litepub
url
required

The URL it was registered with, its inbox or its actor.

string
inbox_url
required

Where the public posts are delivered.

string
receive
required

Whether the public posts it relays are taken in; false only sends.

boolean
state
required

Where the membership of a relay stands. pending: the Follow is sent and not answered. accepted: public posts go to the relay and, with receive, come from it. rejected: the relay rejected the Follow or ended the membership. left: the instance sent the Undo of its Follow.

string
Allowed values: pending accepted rejected left
state_changed_at
required
string format: date-time
actor_uri

The relay’s actor, which accepted the Follow; omitted unless accepted.

string
taken_last_day
required

The activities it brought in during the last 24 hours that were taken in.

integer
dropped_last_day
required

The activities it brought in during the last 24 hours that were dropped over the hourly limit (relay_max_activities_per_hour).

integer
domain_suspended
required

Whether a domain action suspends its server: nothing goes to it or comes from it while it does, whatever state says.

boolean
created_at
required
string format: date-time

Example generated

{
"items": [
{
"id": "01890a5d-ac96-774b-bcce-b302099a8057",
"protocol": "mastodon",
"url": "example",
"inbox_url": "example",
"receive": true,
"state": "pending",
"state_changed_at": "2026-04-15T12:00:00Z",
"actor_uri": "example",
"taken_last_day": 1,
"dropped_last_day": 1,
"domain_suspended": true,
"created_at": "2026-04-15T12:00:00Z"
}
]
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site