pub.chive.admin.triggerBackfill

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 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did",
          "description": "DID for didSync type"
        },
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "Eprint URI for citationExtraction type"
        },
        "type": {
          "type": "string",
          "description": "Backfill operation type to trigger",
          "knownValues": [
            "pdsScan",
            "freshnessScan",
            "citationExtraction",
            "fullReindex",
            "governanceSync",
            "didSync"
          ]
        },
        "pdsUrl": {
          "type": "string",
          "description": "PDS URL for pdsScan type"
        },
        "batchSize": {
          "type": "integer",
          "description": "Batch size for fullReindex type"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "AdminRequired"
    },
    {
      "name": "InvalidBackfillType"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "operation"
      ],
      "properties": {
        "operation": {
          "ref": "#backfillOperation",
          "type": "ref",
          "description": "The started backfill operation"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Trigger a backfill operation by type"
}
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 
{
  "type": "object",
  "required": [
    "id",
    "type",
    "status",
    "startedAt",
    "recordsProcessed"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Operation ID"
    },
    "type": {
      "type": "string",
      "description": "Backfill operation type"
    },
    "status": {
      "type": "string",
      "description": "Operation status",
      "knownValues": [
        "running",
        "completed",
        "failed",
        "cancelled"
      ]
    },
    "startedAt": {
      "type": "string",
      "format": "datetime",
      "description": "Operation start time"
    },
    "recordsProcessed": {
      "type": "integer",
      "description": "Number of records processed so far"
    }
  },
  "description": "A backfill operation record"
}

Lexicon Garden

@