ByCloud Docs
GuidesCLIAPISDK
patch/v1/snapshots/{snapshot_id}

Update snapshot

Update a snapshot's name, description, or metadata

Path Parameters

snapshot_id

string<uuid>required

path

Snapshot ID

Example: "550e8400-e29b-41d4-a716-446655440000"

Request Body

required

Content-Type: application/json

name

stringoptional

description

stringoptional

metadata

objectoptional

Responses

200

Snapshot updated

Content-Type: application/json

snapshot

objectoptional
400

Invalid request parameters

Content-Type: application/json

error

objectrequired
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
404

Resource not found

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X PATCH "https://api.spo1.mycloud.com/v1/snapshots/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "metadata": {
      "environment": "production",
      "team": "backend"
    }
  }'