Skip to content

Submit /v1/register with the previously-issued token

POST
/admin/federation/directories/{id}/publish/register

Persists the operator-supplied display_name + region + description + tags, then POSTs /v1/register with the pending token. Caller MUST have completed the DNS step. On success flips status to listed; on failure stays pending_dns so the operator can retry once DNS propagates.

id
required
string format: uuid

Operator-chosen entry metadata for /v1/register. Saved on the directory row so it pre-fills the form next time.

object
display_name
required
string
>= 1 characters <= 200 characters
region
string
<= 100 characters
description
string
<= 2000 characters
tags
Array<string>
<= 20 items

Result of the register call.

One subscribed federation directory. Pairing alone shares no content; directories are discovery aids per docs/spec/federation-directory/v1.md.

object
id
required
string format: uuid
directory_url
required
string
operator_name
required
string
operator_public_key
required

PEM-wrapped Ed25519 directory operator pubkey (pinned at subscribe time).

string
operator_fingerprint
required
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
string
Allowed values: never_polled ok unreachable signature_failed malformed spec_version_mismatch
last_poll_error
required
string
poll_interval_seconds
required
integer
notes
required
string
publish_status
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
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