com.atproto.sync.listHosts Documentation (EN)

main query

Enumerates upstream hosts (eg, PDS or relay instances) that this service consumes from. Implemented by relays.

Parameters

cursor string Optional

No description available.

limit integer Optional

No description available.

Output

Encodingapplication/json

cursor string Optional

No description available.

hosts array Required

Sort order is not formally specified. Recommended order is by time host was first seen by the server, with oldest first.

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": [
        "hosts"
      ],
      "properties": {
        "hosts": {
          "type": "array",
          "items": {
            "ref": "#host",
            "type": "ref"
          },
          "description": "Sort order is not formally specified. Recommended order is by time host was first seen by the server, with oldest first."
        },
        "cursor": {
          "type": "string"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "limit": {
        "type": "integer",
        "default": 200,
        "maximum": 1000,
        "minimum": 1
      },
      "cursor": {
        "type": "string"
      }
    }
  },
  "description": "Enumerates upstream hosts (eg, PDS or relay instances) that this service consumes from. Implemented by relays."
}

host object

No description available.

Properties

accountCount integer Optional

No description available.

hostname string Required

hostname of server; not a URL (no scheme)

seq integer Optional

Recent repo stream event sequence number. May be delayed from actual stream processing (eg, persisted cursor not in-memory cursor).

status ref com.atproto.sync.defs#hostStatus Optional

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "hostname"
  ],
  "properties": {
    "seq": {
      "type": "integer",
      "description": "Recent repo stream event sequence number. May be delayed from actual stream processing (eg, persisted cursor not in-memory cursor)."
    },
    "status": {
      "ref": "com.atproto.sync.defs#hostStatus",
      "type": "ref"
    },
    "hostname": {
      "type": "string",
      "description": "hostname of server; not a URL (no scheme)"
    },
    "accountCount": {
      "type": "integer"
    }
  }
}