pub.chive.admin.triggerBackfill

lexicons.governance.chive.pub

Documentation

Trigger a backfill operation by type

main procedure

Trigger a backfill operation by type

Input

Encodingapplication/json
batchSize integer Optional

Batch size for fullReindex type

did stringdid Optional

DID for didSync type

pdsUrl string Optional

PDS URL for pdsScan type

type string Required

Backfill operation type to trigger

uri stringat-uri Optional

Eprint URI for citationExtraction type

Output

Encodingapplication/json

Errors

AuthenticationRequired
AdminRequired
InvalidBackfillType
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://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "description": "Trigger a backfill operation by type",
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "AdminRequired"
    },
    {
      "name": "InvalidBackfillType"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "batchSize": {
          "description": "Batch size for fullReindex type",
          "type": "integer"
        },
        "did": {
          "description": "DID for didSync type",
          "format": "did",
          "type": "string"
        },
        "pdsUrl": {
          "description": "PDS URL for pdsScan type",
          "type": "string"
        },
        "type": {
          "description": "Backfill operation type to trigger",
          "knownValues": [
            "pdsScan",
            "freshnessScan",
            "citationExtraction",
            "fullReindex",
            "governanceSync",
            "didSync"
          ],
          "type": "string"
        },
        "uri": {
          "description": "Eprint URI for citationExtraction type",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "operation": {
          "description": "The started backfill operation",
          "ref": "#backfillOperation",
          "type": "ref"
        }
      },
      "required": [
        "operation"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}
backfillOperation object

A backfill operation record

Properties

id string Required

Operation ID

recordsProcessed integer Required

Number of records processed so far

startedAt string datetime Required

Operation start time

status string Required

Operation status

Known values: running, completed, failed, cancelled
type string Required

Backfill operation type

View raw schema 
{
  "description": "A backfill operation record",
  "properties": {
    "id": {
      "description": "Operation ID",
      "type": "string"
    },
    "recordsProcessed": {
      "description": "Number of records processed so far",
      "type": "integer"
    },
    "startedAt": {
      "description": "Operation start time",
      "format": "datetime",
      "type": "string"
    },
    "status": {
      "description": "Operation status",
      "knownValues": [
        "running",
        "completed",
        "failed",
        "cancelled"
      ],
      "type": "string"
    },
    "type": {
      "description": "Backfill operation type",
      "type": "string"
    }
  },
  "required": [
    "id",
    "type",
    "status",
    "startedAt",
    "recordsProcessed"
  ],
  "type": "object"
}

Lexicon Garden

@