pub.chive.sync.registerPDS Documentation (EN)

main procedure

Input

Encodingapplication/json

pdsUrl stringuri Required

PDS endpoint URL to register

Output

Encodingapplication/json

message string Optional

Human-readable status message

pdsUrl stringuri Required

The registered PDS URL

registered boolean Required

Whether the PDS was registered

status string Required

Registration status

Known values: pending, already_exists, scanned

Errors

InvalidRequest

ServiceUnavailable

Try It

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

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "pdsUrl"
      ],
      "properties": {
        "pdsUrl": {
          "type": "string",
          "format": "uri",
          "description": "PDS endpoint URL to register"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "InvalidRequest"
    },
    {
      "name": "ServiceUnavailable"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "pdsUrl",
        "registered",
        "status"
      ],
      "properties": {
        "pdsUrl": {
          "type": "string",
          "format": "uri",
          "description": "The registered PDS URL"
        },
        "status": {
          "type": "string",
          "description": "Registration status",
          "knownValues": [
            "pending",
            "already_exists",
            "scanned"
          ]
        },
        "message": {
          "type": "string",
          "description": "Human-readable status message"
        },
        "registered": {
          "type": "boolean",
          "description": "Whether the PDS was registered"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Register a PDS for scanning to ensure records from non-relay PDSes can be discovered and indexed"
}