v12

latestOpenAPI 3.0.3raw.githubusercontent.com2026-06-1811583196.1 KB
Snapshots

Rename snapshot

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

patch/api/v1/snapshots/{id}/rename

Path parameters

idinteger required

Snapshot ID

Headers

X-Project-IDstring uuid required

Project ID. Required for all mutating operations (create, delete, power actions, resize).

Request body

namestring required

New snapshot display name

Response

Snapshot renamed

successboolean

Example response

{
  "data": {
    "status": "active"
  }
}