Create a Protection Policy.

post

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

Create the Protection Policy and returns the newly created policy object.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to create a Protection Policy.

backupPolicy

object | null

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.

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 replication, archival and cloud spin targets of Protection Policy.

retryOptions

object | null

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

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

201Success

defaultError