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.

blobUploadLimit integer Optional

Maximum size of a blob that can be uploaded via com.atproto.repo.uploadBlob, in bytes.

contact ref#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 ref#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

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

contact object

No description available.

Properties

email string Optional

No description available.

View raw schema

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

links object

No description available.

Properties

privacyPolicy string uri Optional

A valid URI.

termsOfService string uri Optional

A valid URI.

View raw schema

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