Get a DNS challenge from a directory
POST /admin/federation/directories/{id}/publish/challenge
Asks the directory for a DNS challenge, the first of two steps in getting your instance listed there so other instances can find it.
The directory wants proof that you control your instance’s domain,
in the form of a DNS TXT record. This call asks the directory for a
challenge for your instance’s base URL, saves its reply on the
subscription and sets publish_status to pending_dns.
Next, add a TXT record named publish_record_name with the value
publish_record_value to your DNS, then call POST /admin/federation/directories/{id}/publish/register before
publish_token_expires_at. The directory decides how long the
challenge lasts.
Set your instance’s base URL first, in the admin pages under System
configuration, Site. Without it you get 503. You also get 503, with
the reason, if the directory can’t be reached or doesn’t issue a
challenge. Needs the system.admin capability.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Responses
Section titled “ Responses ”The subscription, with the DNS record to add in publish_record_name and publish_record_value.
One directory your instance subscribes to: the operator key saved when you subscribed, how the last poll went and, if you’ve asked to be listed there, where your instance’s listing stands.
object
The directory operator’s Ed25519 public key in PEM, as the directory reported it when you subscribed. Polls accept only listings signed with this key.
The fingerprint the directory reported for its key when you subscribed. Your instance doesn’t check it against operator_public_key.
How the most recent poll went: ok, or why it failed. unreachable covers connection errors and any HTTP status other than 200, and signature_failed means the listing’s signature didn’t verify against operator_public_key. It’s never_polled until the first poll.
What went wrong in the most recent poll. Empty when it succeeded or there hasn’t been one.
How often the background poller refreshes this directory, in seconds. New subscriptions get 21600 (six hours), and the API can’t change it.
Where your instance’s listing in this directory stands, as your instance last recorded it: not_published until you request a challenge, then pending_dns, then listed or failed. It isn’t checked against the directory, so it can still say listed after the directory removes the listing. pending_register isn’t used.
Why the last attempt to list your instance didn’t go through. Cleared when you request a new challenge or the listing succeeds.
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 completedResource not found
object
Human-readable error summary
Example
the request could not be completedYour instance has no base URL, or the directory couldn’t be reached or didn’t issue a challenge. error says which.
object
Human-readable error summary
Example
the request could not be completed