Update multiple runs of one or more objects.

put

https://helios.cohesity.com/v2/mcm/data-protect/objects/runs/metadata

Update metadata of multiple runs of one or more objects. Currently we support enabling the legal hold on the runs as the action in this put request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Specifies the parameters to update the legal hold and other (future) parameters of one or more runs of one or more objects.

Specifies the params for updating one or more runs of one or more objects.

environment

string

enum

Specifies the environment.

legalHold

string | null

enum

Specifies whether to retain the snapshot for legal purpose. If set to 'enable', the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. This field can be set only by a User having Data Security Role. If set to 'release', the snapshots under legal hold will be released.

Allowed:

retention

object | null

Specifies the Retention period of snapshot in days, months or years to retain copied Snapshots on the target.

targetObjectRuns

array of objects

An array of objects. Each containing object id and the run start time that we want to target.

targetObjectRuns

timeRange

object

Specifies the time ranges in usecs. The start time in microseconds of the range between which the runs must be updated. The end time in microseconds of the range between which the runs must be updated. End time cannot be a future date i.e. since legal hold can be executed on a run that is already completed, we cannot enforce a rule that says to put a run that will be completed in the future in legal hold.

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