com.atproto.sync.getRepoStatus Documentation (EN)

main query

Get the hosting status for a repository, on this server. Expected to be implemented by PDS and Relay.

Parameters

did string did Required

The DID of the repo.

Output

Encodingapplication/json

active boolean Required

No description available.

did stringdid Required

A decentralized identifier (DID).

rev stringtid Optional

Optional field, the current rev of the repo, if active=true

status string Optional

If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.

Known values: takendown, suspended, deleted, deactivated, desynchronized, throttled

Errors

RepoNotFound

Try It

Direct PDS XRPC methods (com.atproto.*) are disabled in Try It for security reasons.

These methods interact directly with Personal Data Servers and require careful handling. Use a dedicated client or CLI tool instead.

View raw schema

{
  "description": "Get the hosting status for a repository, on this server. Expected to be implemented by PDS and Relay.",
  "errors": [
    {
      "name": "RepoNotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "active": {
          "type": "boolean"
        },
        "did": {
          "format": "did",
          "type": "string"
        },
        "rev": {
          "description": "Optional field, the current rev of the repo, if active=true",
          "format": "tid",
          "type": "string"
        },
        "status": {
          "description": "If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.",
          "knownValues": [
            "takendown",
            "suspended",
            "deleted",
            "deactivated",
            "desynchronized",
            "throttled"
          ],
          "type": "string"
        }
      },
      "required": [
        "did",
        "active"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "did": {
        "description": "The DID of the repo.",
        "format": "did",
        "type": "string"
      }
    },
    "required": [
      "did"
    ],
    "type": "params"
  },
  "type": "query"
}