Import a Collection Zip
POST
/v1/group/import
const url = 'https://example.com/api/v1/group/import';const form = new FormData();form.append('file', 'file');
const options = {method: 'POST', headers: {Authorization: '<Authorization>'}};
options.body = form;
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/group/import \ --header 'Authorization: <Authorization>' \ --header 'Content-Type: multipart/form-data' \ --form file=@fileUploads 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.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ” Media type multipart/form-data
object
file
required
Export zip
string format: binary
Responses
Section titled “ Responses ”Accepted
Media type application/json
object
artifactPath
string
createdAt
string
error
string
groupId
string
id
string
kind
Kind is “export” for server-produced backup artifacts, “import” for user-uploaded restore zips. The lifecycle fields below behave the same for both.
string
progress
integer
sizeBytes
integer
status
string
updatedAt
string
Example generated
{ "artifactPath": "example", "createdAt": "example", "error": "example", "groupId": "example", "id": "example", "kind": "example", "progress": 1, "sizeBytes": 1, "status": "example", "updatedAt": "example"}