Data sync

Paginated streamable export of some or all of a deployment's data.

Call this endpoint repeatedly, passing the opaque pagination.nextCursor from each response back in the next request as cursor. Omit cursor on the first call.

To do a one time data sync, keep fetching pages until reaching an upToDate page. For a continuous streaming export, continue fetching pages periodically. It's recommended to sleep between upToDate pages to reduce overhead.

The caller must have the deployment:data:view permission.

post/data/sync

Request

Base URL: https://happy-animal-123.convex.cloud/api/v1
URL: https://happy-animal-123.convex.cloud/api/v1/data/sync
Auth: one of:
- API key in header Authorization
- API key in header Authorization
- API key in header Authorization
- API key in header Authorization

Request body

cursorstring nullable

Opaque cursor returned by a previous call. Omit to start from scratch.

Example request

{
  "selection": {
    "_other": "excluded",
    "": {
      "_other": "excluded",
      "posts": {
        "_other": "included"
      },
      "users": {
        "_other": "included",
        "ssn": "excluded"
      }
    }
  }
}

Response

syncIdstring required

Unique id of the sync, assigned on the first page and stable across the sync's lifetime. Identifies this sync in /data/list_active_syncs.

Changes

No recorded changes to this operation across all 1 revision of this API.