Skip to content

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.

id
required
string format: uuid

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
id
required
string format: uuid
directory_url
required
string
operator_name
required
string
operator_public_key
required

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.

string
operator_fingerprint
required

The fingerprint the directory reported for its key when you subscribed. Your instance doesn’t check it against operator_public_key.

string
operator_contact
string
subscribed_at
required
string format: date-time
subscribed_by_user_ref
required
integer format: int64
enabled
required
boolean
last_polled_at
string format: date-time
nullable
last_poll_status
required

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.

string
Allowed values: never_polled ok unreachable signature_failed malformed spec_version_mismatch
last_poll_error
required

What went wrong in the most recent poll. Empty when it succeeded or there hasn’t been one.

string
poll_interval_seconds
required

How often the background poller refreshes this directory, in seconds. New subscriptions get 21600 (six hours), and the API can’t change it.

integer
notes
required
string
publish_status

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.

string
Allowed values: not_published pending_dns pending_register listed failed
publish_pending_token
string
publish_token_expires_at
string format: date-time
nullable
publish_record_name
string
publish_record_value
string
publish_listing_id
string
publish_last_attempt_at
string format: date-time
nullable
publish_last_error

Why the last attempt to list your instance didn’t go through. Cleared when you request a new challenge or the listing succeeds.

string
publish_display_name
string
publish_region
string
publish_description
string
publish_tags
Array<string>

Malformed request

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Your instance has no base URL, or the directory couldn’t be reached or didn’t issue a challenge. error says which.

object
error
required

Human-readable error summary

string
Example
the request could not be completed