---
title: "Get a volume"
method: GET
path: "/volumes/{volume_id}"
tags: ["General APIs with JWT"]
---

# Get a volume

`GET /volumes/{volume_id}`

Endpoint to get a volume.

## Path parameters

- `volume_id` string, uuid, required

## Response `200`

Volume retrieved successfully

- VolumeResponse
  - `id` string, uuid, required
  - `name` string, required
  - `description` string, nullable
  - `created_at` string, required
  - `updated_at` string, required
  - `pod` Pod
    - `id` string, uuid
    - `created_at` string, date-time
    - `updated_at` string, date-time, nullable
    - `executor_id` string, uuid, required
    - `pod_name` string
    - `user_id` string, uuid, required
    - `template_id` string, uuid, nullable, required
    - `volume_id` string, uuid, nullable, required
    - `container_name` string
    - `volume_name` string
    - `local_volume_path` string, nullable
    - `ports_mapping` union
      - object
      - string
    - `ssh_connect_cmd` string
    - `gpu_name` string
    - `gpu_count` string
    - `cpu_name` string
    - `cpu_count` integer
    - `ram_total` integer
    - `volume_limit_gb` integer, nullable
    - `storage_limit_gb` integer, nullable
    - `status` 'PENDING' | 'RUNNING' | 'STOPPED' | 'FAILED' | 'DELETING' | 'STOP_PENDING' | 'START_PENDING' | 'CREATION_FAILED' | 'BROKEN' | 'REBOOT_PENDING' | 'REBOOT_FAILED'
    - `retries` integer, nullable, required
    - `user_public_key` string, nullable
    - `skip_add_agent_ssh_key` boolean, nullable
    - `removal_scheduled_at` string, date-time, nullable
    - `termination_hours` integer, nullable
    - `is_manual_rental` boolean, nullable
    - `cluster_id` string, uuid, nullable
    - `cluster_node_index` integer, nullable
    - `cluster_wireguard_conf` string, nullable
    - `cluster_ssh_private_key` string, nullable
    - `cluster_ssh_authorized_key` string, nullable
    - `enable_jupyter` boolean, nullable
    - `enable_volume_encryption` boolean, nullable
    - `volume_encryption_status` 'ENABLED' | 'UNSUPPORTED_IMAGE' | 'DISABLED' | 'FAILED'
    - `jupyter_installation_status` 'INSTALLING' | 'SUCCESS' | 'FAILED'
    - `jupyter_url` string, nullable
    - `jupyter_installation_started_at` string, date-time, nullable
    - `price` number, nullable
    - `discord_channel_id` string, nullable
    - `dockerfile_content` string, nullable
    - `is_favorite` boolean, nullable
  - `current_size_bytes` integer, nullable
  - `current_file_count` integer, nullable
  - `current_size_gb` number, nullable
  - `current_size_mb` number, nullable
  - `last_metrics_update` string, nullable

## Other responses

- `403` — Volume features not enabled for this user
- `404` — Volume not found
- `422` — Validation Error
- `500` — Internal server error

---

[API](https://skmtc.dev/lium/apis/lium-backend-api.md) · [All operations](https://skmtc.dev/lium/apis/lium-backend-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lium/lium-backend-api/revisions/57db0a9348db/schema)