pub.chive.admin.cancelBackfill Documentation (EN)

main procedure

Cancel a running backfill operation

Input

Encodingapplication/json

id string Required

Operation ID to cancel

Output

Encodingapplication/json

success boolean Required

Whether the operation was cancelled

Errors

AuthenticationRequired

AdminRequired

InvalidRequest

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": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Operation ID to cancel"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "AdminRequired"
    },
    {
      "name": "InvalidRequest"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "success"
      ],
      "properties": {
        "success": {
          "type": "boolean",
          "description": "Whether the operation was cancelled"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Cancel a running backfill operation"
}