Workspace data exports
Request a copy of everything you can see in a workspace, as password-protected ZIP files, and download or delete it.
A workspace data export holds everything in the workspace that the person who asks for it can see in the dashboard, from its first day: settings, members, benefits, custom policies, allow and block lists, imports, evaluations, outcomes, webhooks and the audit trail, with every key and secret masked. An export the owner requests also holds usage, subscription and billing; an admin's never does. It's built in the background into ZIP files protected by a password you choose, and stays available until its expires_at. It's free.
It's the same export as the dashboard's, in Workspace settings → Data & privacy, and its requester also gets the email with its download link. To export only evaluations, use exports.
A workspace data export holds only what its requester can see, so it needs a person: the workspace owner or an admin, signed in with OAuth. An API key or machine client gets MEMBER_SIGN_IN_REQUIRED (403).
Examples on this page use a server client signed in with OAuth:
import { AbuseZero } from "abusezero/server";
const abusezero = new AbuseZero({
accessToken: process.env.ABUSEZERO_ACCESS_TOKEN!,
workspace: "95082035373438252677",
outage: "throw",
});The password
You set the password for the export's ZIP files when you request it. It opens every file of that export, every time, until the export expires. A password that's too short gets EXPORT_PASSWORD_TOO_SHORT, and the message gives the minimum length. AbuseZero keeps it only until the export is ready, can't recover it and never shows it again, so store it as you would an API key, for example in your secret store or an environment file only the right people can read. If it's lost, request a new export.
The workspace export status object
{
"object": "workspace_export_status",
"export": {
"id": "73492810562018437529",
"state": "complete",
"requested_by_you": true,
"requested_at": "2026-11-10T12:00:00.000Z",
"completed_at": "2026-11-10T12:04:00.000Z",
"expires_at": "2026-11-17T12:04:00.000Z",
"parts": 1,
"bytes": 1048576,
"can_delete": true
},
"next_allowed_at": null
}| Field | Type | Description |
|---|---|---|
object | "workspace_export_status" | The object type. |
export | object or null | The workspace's latest export, or null when there's none. |
export.id | string | The export ID. |
export.state | building, complete, expired, failed or deleted | building is still being built. complete is ready to download. |
export.requested_by_you | boolean | Whether the signed-in person requested it. Only they can download it. |
export.requested_at, export.completed_at, export.expires_at | string or null | When it was requested, finished and stops being available. |
export.parts, export.bytes | integer or null | How many ZIP files it has, and their total size. |
export.can_delete | boolean | Whether you can delete it: the owner deletes any export, an admin only their own. |
next_allowed_at | string or null | When the workspace can request its next export, or null when it can now. |
Request a workspace data export
| Method | Path | Scope | Idempotency-Key |
|---|---|---|---|
POST | /v1/workspace-exports | operations:general | Required |
Also available as abusezero workspace-exports create in the AbuseZero CLI, abusezero_request_workspace_export on the AbuseZero MCP server and requestWorkspaceExport() in the AbuseZero Node.js SDK.
Request body
| Field | Type | Required | Limits | Description |
|---|---|---|---|---|
password | string | Yes | Up to 256 characters | The password for the export's ZIP files. See The password. |
encryption | standard or aes256 | No | Default standard | standard opens with the tools built into Windows and macOS, and keeps casual readers out. aes256 is strong, and needs an archive app that supports AES-256. |
Example
const status = await abusezero.requestWorkspaceExport({ password: process.env.EXPORT_PASSWORD!, encryption: "aes256" }, "workspace-export-2026-11-10");Response
Returns 202 with the status. export.state is building. Retrieve the status until it's complete.
Errors
| Code | Status | Meaning |
|---|---|---|
EXPORT_PASSWORD_TOO_SHORT | 422 | The password is too short. The message gives the minimum length. |
EXPORT_LIMIT | 429 | The workspace, or you, requested as many exports as the limits allow. A workspace's weekly limit counts every export its owner and admins request, and then only the owner can request more. Each person also has a daily limit across their workspaces. The message says when to try again. |
PERMISSION_REQUIRED | 403 | The signed-in member isn't the workspace owner or an admin. |
MEMBER_SIGN_IN_REQUIRED | 403 | The request used an API key or machine client. |
Retrieve the workspace export status
| Method | Path | Scope | Idempotency-Key |
|---|---|---|---|
GET | /v1/workspace-exports | operations:general | Not used |
Also available as abusezero workspace-exports get in the AbuseZero CLI, abusezero_get_workspace_export on the AbuseZero MCP server and workspaceExport() in the AbuseZero Node.js SDK.
Returns 200 with the status.
Download a workspace data export
Returns a link to each of the export's ZIP files. Only the person who requested the export gets them, while they're still the owner or an admin. Each link works for 5 minutes while that person's sign-in is valid, and anyone who has it can use it until then, so don't share or log it. Ask again for new ones. Each file downloaded is recorded in the audit trail.
| Method | Path | Scope | Idempotency-Key |
|---|---|---|---|
GET | /v1/workspace-exports/{id}/download | operations:general | Not used |
Also available as abusezero workspace-exports download in the AbuseZero CLI, abusezero_get_workspace_export_download on the AbuseZero MCP server and workspaceExportDownload() in the AbuseZero Node.js SDK.
Example
import { writeFile } from "node:fs/promises";
const { parts } = await abusezero.workspaceExportDownload("73492810562018437529");
for (const part of parts) {
const response = await fetch(part.url);
await writeFile(part.file_name, Buffer.from(await response.arrayBuffer()));
}Response
Returns 200.
{
"object": "workspace_export_download",
"id": "73492810562018437529",
"expires_at": "2026-11-17T12:04:00.000Z",
"links_expire_at": "2026-11-10T12:10:00.000Z",
"parts": [
{ "part": 1, "bytes": 1048576, "file_name": "abusezero-acme-analytics-export.zip", "url": "https://api.abusezero.com/api/transfers/file?grant=…" }
]
}Errors
| Code | Status | Meaning |
|---|---|---|
EXPORT_NOT_READY | 409 | The export is still building. |
EXPORT_NOT_FOUND | 404 | The export expired, was deleted, failed or was requested by someone else. |
Delete a workspace data export
Ends the export and removes its files for good. Its emailed link stops working. Deleting an export doesn't give back a request under the limits.
| Method | Path | Scope | Idempotency-Key |
|---|---|---|---|
DELETE | /v1/workspace-exports/{id} | operations:general | Required |
Also available as abusezero workspace-exports delete in the AbuseZero CLI, abusezero_delete_workspace_export on the AbuseZero MCP server and deleteWorkspaceExport() in the AbuseZero Node.js SDK.
Returns 200 with the status. An export you can't delete returns EXPORT_NOT_FOUND (404).
How is this guide?
Last updated on