Group

Import a Collection Zip

Changed on

Uploads a collection-export zip and enqueues the import job. The destination group must be empty. Returns the tracked import row so clients can poll for progress.

post/v1/group/import

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

Request body multipart/form-data

filestring binary required

Export zip

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