Workspace: export
Everything this workspace holds, as one unencrypted zip streamed and never stored: the control-plane document, every identity’s export zip, and an index
Section titled “Everything this workspace holds, as one unencrypted zip streamed and never stored: the control-plane document, every identity’s export zip, and an index”GET /v1/workspace/export · operation exportWorkspace
Requires the batondeck:workspace:admin permission (action export:read).
Requires a step-up: MFA enrolled and re-authenticated within 15 minutes. Not reachable with an API key — a key has no session and so can never step up.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
acknowledge |
query | string | Must be “unencrypted”: This file is not encrypted. Anyone who gets it can read your contact list and all your conversations and files. It holds no keys, so it cannot be used to speak as you. Keep it where you keep private documents, and delete it once it has been imported. |
Responses
| Status | Meaning |
|---|---|
| 200 | Everything this workspace holds, as one unencrypted zip streamed and never stored: the control-plane document, every identity’s export zip, and an index |
| 400 | The arguments did not validate. |
| 401 | No portal session, and no live API key. |
| 403 | The policy refused, or the request was cross-site. |
| 404 | No such resource, or none this session may see. |
curl -X GET 'https://api.batondeck.com/v1/workspace/export' \ -H "Authorization: Bearer $BATONDECK_API_KEY"