com.atproto.server.describeServer

GET 
com.atproto.server.describeServer

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

Request

Responses

200

OK

application/json

Schema

Schema

inviteCodeRequired boolean

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

phoneVerificationRequired boolean

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

availableUserDomains string[]required

links

object

privacyPolicy uri

termsOfService uri

contact

object

email string
did didrequired

Example (from schema)

{
  "inviteCodeRequired": true,
  "phoneVerificationRequired": true,
  "availableUserDomains": [
    "string"
  ],
  "links": {
    "privacyPolicy": "string",
    "termsOfService": "string"
  },
  "contact": {
    "email": "string"
  },
  "did": "string"
}

400

Bad Request

application/json

Schema

Schema

error stringrequired

Possible values: [InvalidRequest]

message stringrequired

Example (from schema)

{
  "error": "InvalidRequest",
  "message": "string"
}

Loading...