Skip to main content
PATCH
Update a durable snapshot

Authorizations

Authorization
string
header
required

API Key or Access Token, always sent as Authorization: Bearer <token>. The gateway recognizes the token type automatically.

Path Parameters

snapshot_id
string<uuid>
required

Body

application/json

Omitted fields remain unchanged. Metadata replaces the entire map.

name
string

Customer-defined name. Leading and trailing whitespace is removed; whitespace-only names become empty. Non-empty names are unique within the organization across all IDCs; conflicts return 409 Resource.AlreadyExists. Creation failure clears the name. Use an empty string to clear it.

Maximum string length: 255
metadata
object

Customer-defined key/value pairs. Use an empty object to clear them.

Response

Durable snapshot metadata was updated successfully.

request_id
string
required
data
object
required