---
title: "Read retained checkpoint and freeze state"
method: GET
path: "/v1/workloads/{id}/freeze"
tags: ["Workloads"]
---

# Read retained checkpoint and freeze state

`GET /v1/workloads/{id}/freeze`

## Request

- Base URL: `/` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/v1/workloads/{id}/freeze`
- Auth: HTTP bearer

Read retained freeze state for a workload on your account. Retained storage is not separately metered and no storage charge is reported.

## Path parameters

- `id` string, required

## Response `200`

Read retained checkpoint and freeze state

- WorkloadFreeze: Saved checkpoint files and verified compute cleanup. Freeze and resume do not restore arbitrary process memory. The customer command must load its checkpoint.
  - `id` string, required
  - `workload_id` string, required
  - `stage_id` string, required
  - `manifest_id` string
  - `reason` string
  - `generation` integer, required
  - `state` 'requested' | 'releasing' | 'frozen' | 'resuming' | 'resumed' | 'failed', required
  - `requested_at` string, date-time, required
  - `frozen_at` string, date-time, nullable, required
  - `retained_bytes` integer, required
  - `storage_charge_micros` integer, nullable, required: Null while retained storage is not separately metered. Do not infer a zero charge.
  - `storage_billing_status` 'retained_storage_not_separately_metered', required

## Other responses

- `default`: Authentication, disabled feature, invalid input, missing pool or host, rate limits, and transient failures apply.

---

[API](https://skmtc.dev/nodus-compute/apis/nodus-infrastructure-execution-api.md) - [All operations](https://skmtc.dev/nodus-compute/apis/nodus-infrastructure-execution-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nodus-compute/apis/nodus-infrastructure-execution-api/revisions/a59210899d95?raw)