Update a Protection Policy.

put

https://helios.cohesity.com/v2/mcm/data-protect/policies/{id}

Specifies the request to update the existing Protection Policy. On successful update, returns the updated policy object.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Specifies a unique id of the Protection Policy to update.

Body Params

Request to update a Protection Policy.

Specifies the request parameters to cretae a policy.

backupPolicy

object | null

Specifies the backup schedule of a Protection Policy.

blackoutWindow

array of objects | null

List of Blackout Windows. If specified, this field defines blackout periods when new Group Runs are not started. If a Group Run has been scheduled but not yet executed and the blackout period starts, the behavior depends on the policy field AbortInBlackoutPeriod.

Blackout Window

cascadedTargetsConfig

array of objects

Specifies the configuration for cascaded replications. Using cascaded replication, replication cluster(Rx) can further replicate and archive the snapshot copies to further targets. Its recommended to create cascaded configuration where protection group will be created.

cascadedTargetsConfig

clusterIdentifier

string | null

^([0-9]+:[0-9]+)$

Specifies the cluster to which this policy belongs.
This required is only for type OnPremPolicy. The format is clusterId:clusterIncarnationId.

dataLock

string | null

enum

This field is now deprecated. Please use the DataLockConfig in the backup retention.

Allowed:

description

string | null

Specifies the description of the Protection Policy.

enableSmartLocalRetentionAdjustment

boolean | null

Specifies whether smart local retention adjustment is enabled or not. If enabled, local retention would be extended upon failure of any outgoing replications or archivals. Later, if manual intervention causes the failed copies to succeed, retention would automatically be reduced. This is only applicable for Helios OnPrem policies.

extendedRetention

array of objects | null

Specifies additional retention policies that should be applied to the backup snapshots. A backup snapshot will be retained up to a time that is the maximum of all retention policies that are applicable to it.

Extended Retention

isCBSEnabled

boolean | null

Specifies true if Calender Based Schedule is supported by client. Default value is assumed as false for this feature.

name

string | null

required

Specifies the name of the Protection Policy.

remoteTargetPolicy

object | null

Specifies the remote, archival or cloudSpin targets where the snapshot is backed up. This only applies to OnPrem policy created from Helios. Does not apply to DMaaS policies.

retryOptions

object | null

Specifies the retry options of a Protection Policy.

type

string | null

enum

required

Specifies the type of the Protection Policy to be created on Helios.

Allowed:

version

int32 | null

Specifies the current policy verison. Policy version is incremented for optionally supporting new features and differentialting across releases.

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