Update a Protection Policy.

put

https://cluster.ip.address/v2/data-protect/policies/{id}

Privileges: PROTECTION_POLICY_MODIFY

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.

backupPolicy

object

required

Specifies the backup schedule and retentions 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

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.

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.

lastModificationTimeUsecs

int64 | null

Specifies the last time this Policy was updated. If this is passed into a PUT request, then the backend will validate that the timestamp passed in matches the time that the policy was actually last modified. If the two timestamps do not match, then the request will be rejected with a stale error.

name

string | null

required

Specifies the name of the Protection Policy.

remoteTargetPolicy

object

Specifies the replication, archival and cloud spin targets of Protection Policy.

retryOptions

object

Retry Options of a Protection Policy when a Protection Group run fails.

rpoPolicySettings

object

Specifies all the additional settings that are applicable only to an RPO policy. This can include storage domain, settings of different environments, etc.

skipIntervalMins

int32 | null

Specifies the period of time before skipping the execution of new group Runs if an existing queued group Run of the same Protection group has not started. For example if this field is set to 30 minutes and a group Run is scheduled to start at 5:00 AM every day but does not start due to conflicts (such as too many groups are running). If the new group Run does not start by 5:30AM, the Cohesity Cluster will skip the new group Run. If the original group Run completes before 5:30AM the next day, a new group Run is created and starts executing. This field is optional.

version

int32 | null

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

templateId

string | null

Specifies the parent policy template id to which the policy is linked to.

Responses

200Success

defaultError