Start a Collection Export
POST
/v1/group/exports
const url = 'https://example.com/api/v1/group/exports';const options = {method: 'POST', headers: {Authorization: '<Authorization>'}};
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/exports \ --header 'Authorization: <Authorization>'Creates a pending export row and enqueues the build job. Poll the listing endpoint or watch the WebSocket for completion.
Authorizations
Section titled “Authorizations ”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"}