Update a Protection Group.

put

https://helios.cohesity.com/v2/data-protect/protection-groups/{id}

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.

name

string | null

required

Specifies the name of the Protection Group.

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:

storageDomainId

int64 | null

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

description

string | null

Specifies a description of the Protection Group.

startTime

object | null

Specifies the time of day. Used for scheduling purposes.

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.

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.

alertPolicy

object | null

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

sla

array of objects | null

Specifies the SLA parameters for this Protection Group.

sla

qosPolicy

string | null

enum

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

Allowed:

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.

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.

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.

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.

advancedConfigs

array of objects | null

Specifies the advanced configuration for a protection job.

advancedConfigs

vmwareParams

object | null

Specifies the params for Continuous Data Protection.

acropolisParams

object | null

Specifies the parameters which are related to Acropolis Protection Groups.

kubernetesParams

object | null

Specifies the parameters which are related to Kubernetes Protection Groups.

mssqlParams

object | null

Specifies the parameters specific to MSSQL Protection Group.

oracleParams

object | null

Specifies the parameters to create Oracle Protection Group.

viewParams

object | null

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

pureParams

object | null

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

ibmFlashSystemParams

object | null

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

nimbleParams

object | null

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

hypervParams

object | null

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

awsParams

object | null

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

azureParams

object | null

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

gcpParams

object | null

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

kvmParams

object | null

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

physicalParams

object | null

Specifies the parameters specific to Physical Protection Group.

adParams

object | null

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

office365Params

object | null

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

netappParams

object | null

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

nutanixFSParams

object | null

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

genericNasParams

object | null

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

isilonParams

object | null

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

flashbladeParams

object | null

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

gpfsParams

object | null

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

couchbaseParams

object | null