---
title: "Cold archive eligibility and progress"
method: GET
path: "/support/workspaces/{workspace_id}/archive"
tags: ["Workspaces Support"]
---

# Cold archive eligibility and progress

`GET /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`

Whether the workspace may be archived now (and the rule that refuses it), the billing an archive cancels first, the physical size estimate, the storage classes and the archive ledger.

## Path parameters

- `workspace_id` integer, required: Id of the workspace to work with

## Response `200`

Cold archive eligibility, size estimate and progress

- ArchiveInfo
  - `eligible` boolean, required
  - `block_code` string, nullable
  - `block_reason` string, nullable
  - `billing_to_end` string[]
  - `estimate_bytes` integer, nullable
  - `default_storage_class` 'GLACIER_IR' | 'DEEP_ARCHIVE', required: S3 storage classes an archive may use (S3 ``StorageClass`` values).
  - `storage_classes` StorageClass[], required
  - `ledger` LedgerView
    - `archive_id` string, nullable
    - `state` string, nullable
    - `op` string, nullable
    - `step` string, nullable
    - `storage_class` string, nullable
    - `by` integer, nullable
    - `reason` string, nullable
    - `started_at` string, nullable
    - `heartbeat` string, nullable
    - `completed_at` string, nullable
    - `error` string, nullable
    - `files` integer, nullable
    - `bytes_physical` integer, nullable
    - `bytes_orphan` integer, nullable
    - `bytes_done` integer, nullable
    - `thaw_requested_at` string, nullable
    - `s3_delete_after` string, nullable
    - `s3_deleted` boolean, nullable
    - `prior_status` string, nullable
    - `chunks_done` integer
    - `chunks_total` integer
    - `stalled` boolean
    - `restorable` boolean
  - `cost_estimates` CostEstimate[], nullable
    - `storage_class` 'GLACIER_IR' | 'DEEP_ARCHIVE', required: S3 storage classes an archive may use (S3 ``StorageClass`` values).
    - `efs_gb_month_usd` number, required
    - `archive_gb_month_usd` number, required
    - `retrieval_gb_usd` number, required
    - `stored_gb` number, required
    - `efs_monthly_usd` number, required
    - `archive_monthly_usd` number, required
    - `monthly_saving_usd` number, required
    - `yearly_saving_usd` number, required
    - `min_storage_days` integer, required
    - `min_charge_usd` number, required
    - `restore_cost_usd` number, required
    - `thaw_hours` integer, required
    - `restore_hours` number, required
  - `restore_estimate` CostEstimate
    - `storage_class` 'GLACIER_IR' | 'DEEP_ARCHIVE', required: S3 storage classes an archive may use (S3 ``StorageClass`` values).
    - `efs_gb_month_usd` number, required
    - `archive_gb_month_usd` number, required
    - `retrieval_gb_usd` number, required
    - `stored_gb` number, required
    - `efs_monthly_usd` number, required
    - `archive_monthly_usd` number, required
    - `monthly_saving_usd` number, required
    - `yearly_saving_usd` number, required
    - `min_storage_days` integer, required
    - `min_charge_usd` number, required
    - `restore_cost_usd` number, required
    - `thaw_hours` integer, required
    - `restore_hours` number, required
  - `price_region` string, required
  - `prices_as_of` string, required

## Other responses

- `400`: Bad Request
- `401`: Authorization error
- `403`: Request forbidden -- authorization will not help

---

[API](https://skmtc.dev/mammoth/apis/mammoth-analytics.md) · [All operations](https://skmtc.dev/mammoth/apis/mammoth-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/mammoth/apis/mammoth-analytics/revisions/4b2c943a00dc?raw)