Skip to content

RelayProblem

The problem of a relay operation that breaks a rule (422, /api/v1/problems/invalid-relay); reason says which. Another 422 (a malformed request) has none.

object
type
required

A URI that identifies the problem type, stable for clients to branch on. It is about:blank when the problem means no more than its HTTP status.

string format: uri-reference
title
required

A short summary of the problem type, localized from Accept-Language.

string
status
required

The HTTP status code.

integer
>= 400 <= 599
detail

An explanation of this occurrence, localized from Accept-Language.

string
request_id

The request ID (the X-Request-Id response header), for reporting the problem.

string
field

The member of the request that a 422 is about, by its name in the request: a property of the JSON body by its path (display_name, fields[].name, poll.options[1]), a form field, a query parameter, or a header (Idempotency-Key). detail then says what is wrong with its value without naming it, for the client to show beside that field. Absent when the problem is not about one member.

string
reason

Why a relay operation is refused. url: not an https URL of at most 2048 bytes. exists: a relay with the URL is registered. domain_suspended: a domain action suspends its server. not_actor: the URL of a litepub relay serves no actor with an inbox. state: the relay is not in a state that allows it (joining a pending or accepted relay, leaving or deleting one that is not).

string
Allowed values: url exists domain_suspended not_actor state

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"request_id": "example",
"field": "example",
"reason": "url"
}

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

Analytics on this site