---
title: "Rename snapshot"
method: PATCH
path: "/api/v1/snapshots/{id}/rename"
tags: ["Snapshots"]
---

# Rename snapshot

`PATCH /api/v1/snapshots/{id}/rename`

Rename a snapshot. Updates the display name only — does not affect the underlying disk image.

## Path parameters

- `id` integer, required

## Headers

- `X-Project-ID` string, uuid, required

## Request body

- RenameSnapshotRequest
  - `name` string, required — New snapshot display name

## Response `200`

Snapshot renamed

- object
  - `success` boolean
  - `data` Snapshot
    - `id` integer, required — Snapshot ID
    - `account_id` string, uuid — Account that owns the snapshot
    - `project_id` string, uuid — Project the snapshot belongs to
    - `created_by` string — User ID that created the snapshot
    - `type` 'vm' | 'volume', required — Snapshot source type
    - `name` string, required — Snapshot display name
    - `size` string — Current snapshot size
    - `target_size` string — Provisioned size of the source disk at snapshot time
    - `status` '' | 'active' — Indicates whether the source VM or volume is currently running on this snapshot: - `active` — this snapshot is **in use**. The source VM/volume has been reverted to it and is running on it now. Deleting an active snapshot is blocked. - `""` (empty) — this snapshot is saved but **not in use**. The source has not been reverted to it (or has been reverted to a different snapshot since). Only one snapshot per source can be `active` at a time. Calling [Restore Snapshot](#tag/Snapshots/operation/restoreSnapshot) flips that snapshot to `active` and clears the previous active one.
    - `product_vm` string, uuid — Source VM UUID (when `type` is `vm`)
    - `price_per_hour` string — Hourly storage cost in USD
    - `created_at` string, date-time

## Other responses

- `400` — Invalid request parameters
- `404` — Resource not found

## Changes

- **2026-05-08** `64c270db1c2e` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/rafftechnologies/apis/raff-api/changes/api/v1/snapshots/:id/rename/patch.md)

---

[API](https://skmtc.dev/rafftechnologies/apis/raff-api.md) · [All operations](https://skmtc.dev/rafftechnologies/apis/raff-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rafftechnologies/raff-api/revisions/2f4df56be77c/schema)