com.atproto.server.describeServer Documentation (EN)

main query

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

Output

Encodingapplication/json

availableUserDomains array Required

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

contact refcom.atproto.server.describeServer#contact Optional

Contact information

did stringdid Required

A decentralized identifier (DID).

inviteCodeRequired boolean Optional

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

links refcom.atproto.server.describeServer#links Optional

URLs of service policy documents.

phoneVerificationRequired boolean Optional

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

Try It

Direct PDS XRPC methods (com.atproto.*) are disabled in Try It for security reasons.

These methods interact directly with Personal Data Servers and require careful handling. Use a dedicated client or CLI tool instead.

View raw schema

{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "did",
        "availableUserDomains"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did"
        },
        "links": {
          "ref": "com.atproto.server.describeServer#links",
          "type": "ref",
          "description": "URLs of service policy documents."
        },
        "contact": {
          "ref": "com.atproto.server.describeServer#contact",
          "type": "ref",
          "description": "Contact information"
        },
        "inviteCodeRequired": {
          "type": "boolean",
          "description": "If true, an invite code must be supplied to create an account on this instance."
        },
        "availableUserDomains": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "List of domain suffixes that can be used in account handles."
        },
        "phoneVerificationRequired": {
          "type": "boolean",
          "description": "If true, a phone verification token must be supplied to create an account on this instance."
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Describes the server's account creation requirements and capabilities. Implemented by PDS."
}

contact object

No description available.

Properties

email string Optional

No description available.

View raw schema

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string"
    }
  }
}

links object

No description available.

Properties

privacyPolicy string uri Optional

A valid URI.

termsOfService string uri Optional

A valid URI.

View raw schema

{
  "type": "object",
  "properties": {
    "privacyPolicy": {
      "type": "string",
      "format": "uri"
    },
    "termsOfService": {
      "type": "string",
      "format": "uri"
    }
  }
}