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.

name

string | null

required

Specifies the name of the Protection Policy.

type

string | null

enum

required

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

Allowed:

clusterIdentifier

string | null

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

backupPolicy

object | null

Specifies the backup schedule and retentions of a Protection Policy.

description

string | null

Specifies the description of the 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

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

remoteTargetPolicy

object | null

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

retryOptions

object | null

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

dataLock

string | null

enum

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

Allowed:

version

int32 | null

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

isCBSEnabled

boolean | null

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

Responses

200Success

defaultError