Endpoint

/v3/snapshots/{id}/lock

POST

Lock the specified snapshot. The only modification you can make to a locked snapshot is extending its expiration time.

Parameters

Name Description Required
id The snapshot identifier. Yes

Request

Schema

{
  "description": "api_snapshot_lock",
  "type": "object",
  "properties": {
    "lock_key_ref": {
      "description": "lock_key_ref",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_snapshot_lock",
  "type": "object",
  "properties": {
    "lock_key_ref": {
      "description": "lock_key_ref",
      "type": "string"
    }
  }
}