com.atproto.server.describeServer

Domain Index: atproto.com

Crawl History

#main - query

Describes the server's account creation requirements and capabilities. Implemented by PDS.

Query Parameters

No fields defined

Response Body

Content Type: application/json

Data Fields

Name Type Details
availableUserDomains array (required)

List of domain suffixes that can be used in account handles.

UNHANDLED IN ARRAYS: string

contact ref

Contact information

Reference: #contact

did string (required)

Syntax Format: did

inviteCodeRequired boolean

If true, an invite code must be supplied to create an account on this instance.
links ref

URLs of service policy documents.

Reference: #links

phoneVerificationRequired boolean

If true, a phone verification token must be supplied to create an account on this instance.

Errors

No error types defined

#links - object

Data Fields

Name Type Details
privacyPolicy string

Syntax Format: uri

termsOfService string

Syntax Format: uri

#contact - object

Data Fields

Name Type Details
email string