Lexicon Garden

com.atproto.sync.getHostStatus

Returns information about a specified upstream host, as consumed by the server. Implemented by relays.

Repository @atproto-lexicons.bsky.social did:plc:6msi3pj7krzih5qxqtryxlzw namespace authority
Details · query
Kindquery
Authoritysync.atproto.com
Indexed
Compare Edit in builder → Fork →
cid bafyreiazetpylsjgp5qfnu6qfb6ahthgjw7spbcl7hpyiz3srl7wnebdsq

Checks

Valid
  • unlimited-string defs.main.parameters.properties.hostnameNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.hostnameNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Returns information about a specified upstream host, as consumed by the server. Implemented by relays.",
      "errors": [
        {
          "name": "HostNotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "accountCount": {
              "description": "Number of accounts on the server which are associated with the upstream host. Note that the upstream may actually have more accounts.",
              "type": "integer"
            },
            "hostname": {
              "type": "string"
            },
            "seq": {
              "description": "Recent repo stream event sequence number. May be delayed from actual stream processing (eg, persisted cursor not in-memory cursor).",
              "type": "integer"
            },
            "status": {
              "ref": "com.atproto.sync.defs#hostStatus",
              "type": "ref"
            }
          },
          "required": [
            "hostname"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "hostname": {
            "description": "Hostname of the host (eg, PDS or relay) being queried.",
            "type": "string"
          }
        },
        "required": [
          "hostname"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "com.atproto.sync.getHostStatus",
  "lexicon": 1
}