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.

Specifies the request to create or 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 | null

Specifies the alerting policy for this 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. [Internal/JPMC-only] This field is mandatory only if the iris backend feature flag (FLAGS_MakePausedNoteMandatory) is enabled. For JPMC, both the backend gflag (FLAGS_MakePausedNoteMandatory) and the UI feature flag (pauseNoteForceEnabled) must be enabled for this field to be mandatory. For all other customers, the field remains optional and the feature flag is not enabled by default. If any customer wants this feature, they must contact support for enablement.

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 | null

Specifies the start time for this Protection Group. If no start time is specified, the start time will default to 2am. This field is only used if the policy has a daily or monthly schedule.

storageDomainId

int64 | null

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

acropolisParams

object | null

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

adParams

object | null

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

awsParams

object | null

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

azureParams

object | null

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

cassandraParams

object | null

Specifies the parameters which are specific to Cassandra Protection Groups.

couchbaseParams

object | null

Specifies the parameters which are specific to Couchbase Protection Groups

db2Params

object | null

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

elastifileParams

object | null

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

exchangeParams

object | null

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

experimentalAdapterParams

object | null

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

flashbladeParams

object | null

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

gcpParams

object | null

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

genericNasParams

object | null

Specifies the parameters which are specific to Generic Nas related Protection Groups.

googleWorkspaceParams

object | null

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 | null

Specifies the parameters which are specific to HBase Protection Groups.

hdfsParams

object | null

Specifies the parameters which are specific to HDFS Protection Groups.

hiveParams

object | null

Specifies the parameters which are specific to Hive Protection Groups.

hypervParams

object | null

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

ibmFlashSystemParams

object | null

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

isilonParams

object | null

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

kubernetesParams

object | null

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

kvmParams

object | null

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

mongodbOpsParams

object | null

Specifies the parameters which are specific to MongoDB Physical related Protection Groups.

mongodbParams

object | null

Specifies the parameters which are specific to MongoDB Protection Groups.

mssqlParams

object | null

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.

nutanixFSParams

object | null

Specifies the parameters which are specific to Nutanix FS related Protection Groups.

office365Params

object | null

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

oracleParams

object | null

Specifies the parameters which are specific to Oracle Protection Group.

physicalParams

object | null

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

pineconeParams

object | null

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

postgresParams

object | null

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

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 | null

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

sapHanaParams

object | null

Specifies the parameters which are specific to SAP HANA related Protection Groups.

sfdcParams

object | null

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

udaParams

object | null

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

viewParams

object | null

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

vmwareParams

object | null

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

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError