List the federation inbox
GET /admin/federation/inbox
Lists federation activities that other instances delivered to yours, newest first, with what your instance did with each one.
A row starts pending and the inbox dispatcher then marks it
processed, rejected (with a reject_reason) or failed.
processed doesn’t mean anything changed: only likes and comments
are applied today, and every other type, aa:Share included, is
marked processed without being acted on.
Only deliveries that passed the inbox’s checks are stored. One
refused on arrival, for example for a bad signature, an unknown or
disconnected peer, or an object that isn’t on your instance, never
gets a row; most such refusals are recorded in the audit log as
federation.activity.rejected, and the sending instance’s outbox
usually shows them as failed.
Inbox rows can’t be retried. A sender that delivers the same activity again gets an OK, and the existing row is left as it was, so a failed row isn’t run again.
Filters combine, and since is a lower bound on when a row was
received. Paging and limit work as in GET /admin/federation/outbox.
As shipped, this endpoint doesn’t check who is calling: any request that reaches the API gets the list, whether or not it’s signed in.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”Responses
Section titled “ Responses ”Inbox rows matching the filter.
object
One activity a peer delivered to your inbox, and how your instance handled it. Delivering the same activity again doesn’t add a row or change this one.
object
The activity’s ID. Each one appears in the inbox once.
The user on the peer the activity says sent it. That user’s own signature isn’t verified yet; only the instance’s HTTP signature is.
The activity’s type, such as Like, Create or aa:Share.
The kind of object on your instance the activity is about. Left out when it doesn’t name one.
The key ID of the delivery’s HTTP signature, which was checked against the key saved for the peer.
Why the row was rejected, as one of the protocol’s reject reasons, such as unknown_object or encryption_required. Set only when status is rejected.
How many times the dispatcher has tried to handle the row, the last try included. A row is marked failed after five tries that fail, or at once if it can’t be handled at all.
What went wrong on the last try. Cleared when the row is processed.
Meant to link the local activity created when this was applied. Nothing sets it yet, so it’s always left out.
Pass this as cursor to get the next page. It’s included whenever the page is full.
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 completed