Create a Protection Policy.

post

https://cluster.ip.address/irisservices/api/v1/public/protectionPolicies

Privileges: PROTECTION_POLICY_MODIFY

Returns the created Protection Policy.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to create a Protection Policy.

Specifies information about a Protection Policy.

backupRunTimeouts

array of objects | null

Backup Run timeouts after which a run will get cancelled.

backupRunTimeouts

blackoutPeriods

array of objects | null

Array of QuietTime Periods.

If specified, this field defines black periods when new Job Runs
are not started. If a Job Run has been scheduled but not yet
executed and the QuietTime period starts, the behavior depends on
the policy field AbortInBlackoutPeriod.

blackoutPeriods

cdpSchedulingPolicy

object | null

Specifies the CDP backup schedule of a Protection Job and how long
log files captured by this schedule are retained on the
Cohesity Cluster.

cloudDeployPolicies

array of objects | null

Array of Cloud Deploy Policies.

Specifies settings for copying Snapshots to Cloud.
CloudDeploy target where backup snapshots may be converted and stored.
It also defines the retention of copied Snapshots on the Cloud.

cloudDeployPolicies

datalockConfig

object | null

Specifies WORM retention type for the incremental/full snapshots. When a
WORM retention type is specified, the snapshots of the Protection Groups
using this policy will be kept for the last N days as specified in the
duration of the datalock. During that time, the snapshots cannot be
deleted.

datalockConfigCdp

object | null

Specifies WORM retention type for the CDP snapshots. When a WORM retention
type is specified, the snapshots of the Protection Groups using this
policy will be kept for the last N days as specified in the duration of
the datalock. During that time, the snapshots cannot be deleted.

datalockConfigLog

object | null

Specifies WORM retention type for the log snapshots. When a WORM retention
type is specified, the snapshots of the Protection Groups using this
policy will be kept for the last N days as specified in the duration of
the datalock. During that time, the snapshots cannot be deleted.

datalockConfigSystem

object | null

Specifies WORM retention type for the BMR snapshots. When a WORM retention
type is specified, the snapshots of the Protection Groups using this
policy will be kept for the last N days as specified in the duration of
the datalock. During that time, the snapshots cannot be deleted.

daysToKeep

int64 | null

Specifies how many days to retain Snapshots on the Cohesity Cluster.

daysToKeepLog

int64 | null

Specifies the number of days to retain log run if Log Schedule exists.

daysToKeepSystem

int64 | null

Specifies the number of days to retain system backups made for bare metal
recovery. This field is applicable if systemSchedulingPolicy is specified.

description

string | null

Description of the Protection Policy.

extendedRetentionPolicies

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.

extendedRetentionPolicies

fullSchedulingPolicy

object | null

Specifies the Full (no CBT) backup schedule of a Protection Job and
how long Snapshots captured by this schedule are retained on the
Cohesity Cluster.

incrementalSchedulingPolicy

object | null

Specifies the CBT-based backup schedule of a Protection Job and
how long Snapshots captured by this schedule are
retained on the Cohesity Cluster.

logSchedulingPolicy

object | null

Specifies the Log backup schedule of a Protection Job and how long
log files captured by this schedule are retained on the
Cohesity Cluster.

name

string | null

Specifies the name of the Protection Policy.

numLinkedPolicies

int64 | null

Species the number of policies linked to a global policy.

numSecsToKeep

int64 | null

Specifies the number of mins/hours/days in seconds to retain
CDP backups if CDP schedule exists.

parentPolicyId

string | null

Specifies the parent global policy Id. This must be specified when
creating a policy from global policy template.

retentionPeriod

object | null

RetentionPeriod is the policy retention re-expressed in the unit
requested via ProtectionPolicyQueryParams.DurationUnitParam. The
populated value carries both Unit (Days or Minutes, echoing the
requested unit) and Duration (whole-number count in that unit), so
when unit=Minutes Duration is the value of DaysToKeep multiplied by
1440 (minutes per day). Read-only and populated only on GET; omitted
when DaysToKeep is unset or no unit was requested. DaysToKeep above
is the source of truth and remains in days regardless of the
requested unit.

retentionPeriodCdp

object | null

RetentionPeriodCdp is the CDP retention re-expressed in the unit
requested via ProtectionPolicyQueryParams.DurationUnitParam. The
populated value carries both Unit (Days or Minutes) and Duration; it
is derived from NumSecsToKeep (seconds), floored to whole minutes
(NumSecsToKeep / 60) when unit=Minutes and to whole days
(NumSecsToKeep / 86400) when unit=Days. Read-only and populated only
on GET; omitted when NumSecsToKeep is unset or no unit was
requested. NumSecsToKeep above remains in seconds.

retentionPeriodLog

object | null

RetentionPeriodLog is the log retention re-expressed in the unit
requested via ProtectionPolicyQueryParams.DurationUnitParam. The
populated value carries both Unit (Days or Minutes) and Duration, so
when unit=Minutes Duration is DaysToKeepLog multiplied by 1440.
Read-only and populated only on GET; omitted when DaysToKeepLog is
unset or no unit was requested. DaysToKeepLog above remains in days.

retentionPeriodSystem

object | null

RetentionPeriodSystem is the system-backup retention re-expressed in
the unit requested via
ProtectionPolicyQueryParams.DurationUnitParam. The populated value
carries both Unit (Days or Minutes) and Duration, so when
unit=Minutes Duration is DaysToKeepSystem multiplied by 1440.
Read-only and populated only on GET; omitted when DaysToKeepSystem
is unset or no unit was requested. DaysToKeepSystem above remains in
days.

retries

int32 | null

Specifies the number of times to retry capturing Snapshots before
the Job Run fails.

retryIntervalMins

int32 | null

Specifies the number of minutes before retrying a failed Protection Job.

rpoPolicySettings

object | null

Specifies the RPO Policy related settings.

skipIntervalMins

int32 | null

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

snapshotArchivalCopyPolicies

array of objects | null

Array of External Targets.

Specifies settings for copying Snapshots to Archival External Targets
(such as AWS or Tape).
It also defines the retention of copied Snapshots on an External Targets
such as AWS and Tape.

snapshotArchivalCopyPolicies

snapshotReplicationCopyPolicies

array of objects | null

Array of Remote Clusters.

Specifies settings for copying Snapshots to Remote Clusters.
It also defines the retention of copied Snapshots on a Remote Cluster.

snapshotReplicationCopyPolicies

storageArraySnapshotSchedulingPolicy

object | null

Specifies the storage array snapshot backup schedule of a Protection
Job and how long snapshot captured by this schedule are retained on the
Storage Array.

systemSchedulingPolicy

object | null

Specifies the system backup schedule for agents running on servers to run
low frequency backup jobs. Images created as part of the backup can be
used to perform a "bare metal" recovery.

type

string | null

enum

Specifies the type of the protection policy.
'kRegular' means a regular Protection Policy.
'kRPO' means an RPO Protection Policy.

Allowed:

wormRetentionType

string | null

enum

Specifies WORM retention type for the snapshots. When a WORM retention
type is specified, the snapshots of the Protection Jobs using this policy
will be kept until the maximum of the snapshot retention time. During
that time, the snapshots cannot be deleted.
This field is deprecated. Use DataLockConfig for incremental runs,
DataLockConfigLog for log runs, DataLockConfigSystem for BMR runs, and
DataLockConfig in extended retention and for copy targets config.
deprecated: true
'kNone' implies there is no WORM retention set.
'kCompliance' implies WORM retention is set for compliance reason.
'kAdministrative' implies WORM retention is set for administrative purposes.

Allowed:

Responses

201Success

defaultError