Skip to main content

Lock/Unlock Snapshot

PUT/api/v1/nodes/{node_id}/snapshot/{snapshot_uuid}

Path parameters

  • node_idPathstringrequired

    Path parameter node_id.

  • snapshot_uuidPathstringrequired

    Path parameter snapshot_uuid.

Query parameters

  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • apikeyQuerystringrequired

    API key for authenticating the lock/unlock snapshot request

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Specifies the target location for the lock or unlock operation

    • required
    • non-empty string
    example{{location}}

Request body

application/json

object
locked_statusboolean

Indicates if the snapshot should be locked (true) or unlocked (false).

examplefalse
  • must be a boolean
  • required
resource_typestring

Specifies the type of resource to lock or unlock

examplenode
  • must be a non-empty string
  • allowed values: node, volume, snapshot

Responses

200Successful response
object
codeinteger

HTTP status code indicating the result of the lock/unlock operation

example200
  • must be a valid HTTP status code
  • must be a non-negative integer
dataobject
errorsobject
messagestring

Status message indicating the result of the lock or unlock snapshot operation

exampleSuccess
  • must be a non-empty string
  • maximum length of 255 characters