Group

Start a Collection Export

Changed on

Creates a pending export row and enqueues the build job. Poll the listing endpoint or watch the WebSocket for completion.

post/v1/group/exports

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Response

Accepted

artifactPathstring
createdAtstring
errorstring
groupIdstring
idstring
kindstring

Kind is "export" for server-produced backup artifacts, "import" for user-uploaded restore zips. The lifecycle fields below behave the same for both.

progressinteger
sizeBytesinteger
statusstring
updatedAtstring

Changes