Update an object snapshot.

put

https://helios.cohesity.com/v2/data-protect/objects/{id}/snapshots/{snapshotId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Specifies the id of the Object.

snapshotId

string

required

Specifies the id of the snapshot.
Note: 1. If the snapshotid of one of the apps is specified, it applies for all the databases in the Protection Run.
2. In case of volume based jobs, please specify the snapshotid of the source not the database. if source snapshot is specified, applied to source snapshot. if database snapshotid is specified in case of volume based jobs, then it is applicable for host's snapshot.

Body Params

Specifies the parameters update an object snapshot.

setLegalHold

boolean | null

Whether to set the snapshot on legal hold. If set to true, the run cannot be deleted during the retention period.

dataLockType

string | null

enum

Specifies the snapshot data lock type.

Allowed:

expiryTimeSecs

int64 | null

Specifies the expiry time of the snapshot in Unix timestamp epoch in seconds.

Headers

accessClusterId

int64

This field uniquely represents a Cohesity Cluster and is used for making on-prem calls from Helios.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError