Workspaces Support

Archive a workspace to cold storage, or retry a failed archive

Block the workspace (status ARCHIVED) and queue the job that moves its data to S3. Live billing (deal, Stripe subscription, add-ons) is cancelled first, now and with no refund, when cancel_billing is true; without it, live billing refuses the request. Refused unless the workspace is eligible. Admin only.

post/support/workspaces/{workspace_id}/archive

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/support/workspaces/{workspace_id}/archive
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

workspace_idinteger required

Id of the workspace to work with

Example:4

Request body

storage_class'GLACIER_IR' | 'DEEP_ARCHIVE' required

S3 storage classes an archive may use (S3 StorageClass values).

reasonstring nullable

Optional reason recorded with the archive (for support).

confirm_namestring required

The workspace name, typed to confirm (case-sensitive).

cancel_billingboolean

Confirms that archiving cancels the workspace's live deal, Stripe subscription and add-ons now, with no refund. Required when any of them is live.

Example request

{
  "storage_class": "GLACIER_IR",
  "reason": "Dormant since 2025-03",
  "confirm_name": "Acme Analytics"
}

Response

Archive or restore run queued

Changes

No recorded changes to this operation across all 3 revisions of this API.