pub.chive.admin.listPDSes

lexicons.governance.chive.pub

Documentation

List known PDSes and their statistics

main query

List known PDSes and their statistics

Parameters

limit integer Optional

Maximum number of results

Output

Encodingapplication/json

Errors

AuthenticationRequired
AdminRequired
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Maximum number of results
View raw schema 
{
  "description": "List known PDSes and their statistics",
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "AdminRequired"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "stats": {
          "description": "PDS statistics",
          "ref": "#pdsStats",
          "type": "ref"
        }
      },
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "limit": {
        "default": 50,
        "description": "Maximum number of results",
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      }
    },
    "type": "params"
  },
  "type": "query"
}
pdsInfo object

Information about a single PDS

Properties

consecutiveErrors integer Optional

Consecutive error count

errorCount integer Optional

Total errors encountered

lastScan string datetime Optional

Last scan timestamp

recordCount integer Optional

Number of indexed records

status string Required

Health status

Known values: healthy, unhealthy, unknown
url string Required

PDS URL

View raw schema 
{
  "description": "Information about a single PDS",
  "properties": {
    "consecutiveErrors": {
      "description": "Consecutive error count",
      "type": "integer"
    },
    "errorCount": {
      "description": "Total errors encountered",
      "type": "integer"
    },
    "lastScan": {
      "description": "Last scan timestamp",
      "format": "datetime",
      "type": "string"
    },
    "recordCount": {
      "description": "Number of indexed records",
      "type": "integer"
    },
    "status": {
      "description": "Health status",
      "knownValues": [
        "healthy",
        "unhealthy",
        "unknown"
      ],
      "type": "string"
    },
    "url": {
      "description": "PDS URL",
      "type": "string"
    }
  },
  "required": [
    "url",
    "status"
  ],
  "type": "object"
}
pdsStats object

PDS registry statistics

Properties

healthy integer Optional

Number of healthy PDSes

items array of ref#pdsInfo Required

Individual PDS entries

total integer Required

Total known PDSes

unhealthy integer Optional

Number of unhealthy PDSes

withRecords integer Optional

PDSes with indexed records

View raw schema 
{
  "description": "PDS registry statistics",
  "properties": {
    "healthy": {
      "description": "Number of healthy PDSes",
      "type": "integer"
    },
    "items": {
      "description": "Individual PDS entries",
      "items": {
        "ref": "#pdsInfo",
        "type": "ref"
      },
      "type": "array"
    },
    "total": {
      "description": "Total known PDSes",
      "type": "integer"
    },
    "unhealthy": {
      "description": "Number of unhealthy PDSes",
      "type": "integer"
    },
    "withRecords": {
      "description": "PDSes with indexed records",
      "type": "integer"
    }
  },
  "required": [
    "total",
    "items"
  ],
  "type": "object"
}

Lexicon Garden

@