com.atproto.sync Lexicon#

Definitions related to cross-server sync in ATP.


com.atproto.sync.getRepo#

{
  "lexicon": 1,
  "id": "com.atproto.sync.getRepo",
  "defs": {
    "main": {
      "type": "query",
      "description": "Gets the repo state.",
      "parameters": {
        "type": "params",
        "required": [
          "did"
        ],
        "properties": {
          "did": {
            "type": "string",
            "description": "The DID of the repo."
          },
          "from": {
            "type": "string",
            "description": "A past commit CID."
          }
        }
      },
      "output": {
        "encoding": "application/cbor"
      }
    }
  }
}

com.atproto.sync.getRoot#

{
  "lexicon": 1,
  "id": "com.atproto.sync.getRoot",
  "defs": {
    "main": {
      "type": "query",
      "description": "Gets the current root CID of a repo.",
      "parameters": {
        "type": "params",
        "required": [
          "did"
        ],
        "properties": {
          "did": {
            "type": "string",
            "description": "The DID of the repo."
          }
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": [
            "root"
          ],
          "properties": {
            "root": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

com.atproto.sync.updateRepo#

{
  "lexicon": 1,
  "id": "com.atproto.sync.updateRepo",
  "defs": {
    "main": {
      "type": "procedure",
      "description": "Writes commits to a repo.",
      "parameters": {
        "type": "params",
        "required": [
          "did"
        ],
        "properties": {
          "did": {
            "type": "string",
            "description": "The DID of the repo."
          }
        }
      },
      "input": {
        "encoding": "application/cbor"
      }
    }
  }
}

See what's next.Join the private beta.

The AT Protocol will launch soon.
Join the waitlist to try the beta before it's publicly available.

Join the waitlist