Skip to content

Get an Export

GET
/v1/group/exports/{id}
curl --request GET \
--url https://example.com/api/v1/group/exports/example \
--header 'Authorization: <Authorization>'
id
required
string

Export ID

OK

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"
}