Update a Protection Group.

put

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

Privileges: PROTECTION_MODIFY

Update the specified Protection Group.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Specifies the id of the Protection Group.

Body Params

Specifies the parameters to update a Protection Group.

abortInBlackouts

boolean | null

Specifies whether currently executing jobs should abort if a blackout period specified by a policy starts. Available only if the selected policy has at least one blackout period. Default value is false. This field should not be set to true if 'pauseInBlackouts' is set to true.

advancedConfigs

array of objects | null

Specifies the advanced configuration for a protection job.

advancedConfigs

alertPolicy

object

Specifies a policy for alerting users of the status of a Protection Group.

description

string | null

Specifies a description of the Protection Group.

endTimeUsecs

int64 | null

Specifies the end time in micro seconds for this Protection Group. If this is not specified, the Protection Group won't be ended.

environment

string | null

enum

required

Specifies the environment type of the Protection Group.

isPaused

boolean | null

Specifies if the the Protection Group is paused. New runs are not scheduled for the paused Protection Groups. Active run if any is not impacted.

lastModifiedTimestampUsecs

int64 | null

Specifies the last time this protection group 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 protection group 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 Group.

pauseInBlackouts

boolean | null

Specifies whether currently executing jobs should be paused if a blackout period specified by a policy starts. Available only if the selected policy has at least one blackout period. Default value is false. This field should not be set to true if 'abortInBlackouts' is sent as true.

pausedNote

string | null

A note from the current user explaining the reason for pausing future runs, if applicable.

policyId

string | null

required

Specifies the unique id of the Protection Policy associated with the Protection Group. The Policy provides retry settings Protection Schedules, Priority, SLA, etc.

priority

string | null

enum

Specifies the priority of the Protection Group.

Allowed:

qosPolicy

string | null

enum

Specifies whether the Protection Group will be written to HDD or SSD.

Allowed:

sla

array of objects | null

Specifies the SLA parameters for this Protection Group.

sla

startTime

object

Specifies the time of day. Used for scheduling purposes.

storageDomainId

int64 | null

Specifies the Storage Domain (View Box) ID where this Protection Group writes data.

acropolisParams

object

Specifies the parameters which are related to Acropolis Protection Groups.

adParams

object

Specifies the parameters which are specific to Active directory related Protection Groups.

awsParams

object

Specifies the parameters which are specific to AWS related Protection Groups.

azureParams

object

Specifies the parameters which are specific to Azure related Protection Groups.

cassandraParams

object

Specifies the source specific parameters for this Protection Group.

couchbaseParams

object

Specifies the source specific parameters for this Protection Group.

db2Params

object

Specifies parameters related to the DB2 Protection job.

elastifileParams

object | null

Specifies the parameters which are specific to Elastifile related Protection Groups.

exchangeParams

object

Specifies the parameters which are specific to Exchange related Protection Groups.

experimentalAdapterParams

object

Specifies parameters related to the Experimental Adapter Protection job.

flashbladeParams

object | null

Specifies the parameters which are specific to Flashblade related Protection Groups.

gcpParams

object

Specifies the parameters which are specific to GCP related Protection Groups.

genericNasParams

object

Specifies the extra parameters which are specific to NAS related Protection Groups.

googleWorkspaceParams

object

Specifies the parameters which are specific to Google Workspace related Protection Groups.

gpfsParams

object | null

Specifies the parameters which are specific to GPFS related Protection Groups.

hbaseParams

object

Specifies the source specific parameters for this Protection Group.

hdfsParams

object

Specifies the parameters for HDFS Protection Group.

hiveParams

object

Specifies the source specific parameters for this Protection Group.

hypervParams

object

Specifies the common parameters which are specific to HyperV related protection.

ibmFlashSystemParams

object | null

Specifies the parameters which are specific to IBM Flash System related Protection Groups.

isilonParams

object | null

Specifies the parameters which are specific to Isilon related Protection Groups.

kubernetesParams

object

Specifies the parameters which are related to Kubernetes Protection Groups.

kvmParams

object | null

Specifies the parameters which are specific to Kvm related Protection Groups.

mongodbOpsParams

object

Specifies parameters related to the Mongodb Physical Protection job.

mongodbParams

object

Specifies the source specific parameters for this Protection Group.

mssqlParams

object

Specifies the parameters specific to MSSQL Protection Group.

netappParams

object | null

Specifies the parameters which are specific to Netapp related Protection Groups.

nimbleParams

object | null

Specifies the parameters which are specific to Nimble related Protection Groups.

office365Params

object

Specifies the parameters which are specific to Office 365 related Protection Groups.

oracleParams

object

Specifies the parameters to create Oracle Protection Group.

physicalParams

object

Specifies the parameters specific to Physical Protection Group.

pureParams

object | null

Specifies the parameters which are specific to Pure related Protection Groups.

remoteAdapterParams

object | null

Specifies the parameters which are specific to Remote Adapter related Protection Groups.

s3CompatibleParams

object

Specifies the parameters which are specific to S3 Compatible related Protection Groups.

sapHanaParams

object

Specifies parameters related to the SAP HANA Protection job.

sfdcParams

object

Specifies the parameters to create SFDC Protection Group.

udaParams

object

Specifies parameters related to the Universal Data Adapter Protection job.

viewParams

object | null

Specifies the parameters which are specific to view related Protection Groups.

vmwareParams

object

Specifies the params for Continuous Data Protection.

Responses

200Success

defaultError