Getting StartedAPI ReferenceRecipesGitHub
API Reference

Create a Protection Group.

post
https://cluster.ip.address/v2/data-protect/protection-groups

Create a Protection Group.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Specifies the parameters to create a Protection Group.

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.

alertPolicy
object | null

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

string | null

Specifies a description of the Protection Group.

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.

string | null
enum
required

Specifies the environment type of the Protection Group.

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.

string | null
required

Specifies the name of the Protection Group.

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.

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.

string | null
enum

Specifies the priority of the Protection Group.

Allowed:
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 time of day. Used for scheduling purposes.

int64 | null

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

acropolisParams
object | null

Specifies the parameters which are related to Acropolis 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 Groups.

azureParams
object | null

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

cassandraParams
object | null

Specifies the source specific parameters for this Protection Group.

couchbaseParams
object | null

Specifies the source specific parameters for this Protection Group.

elastifileParams
object | null

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

exchangeParams
object | null

Specifies the parameters which are specific to Exchange 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 extra parameters which are specific to NAS related Protection Groups.

gpfsParams
object | null

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

hbaseParams
object | null

Specifies the source specific parameters for this Protection Group.

hdfsParams
object | null

Specifies the parameters for HDFS Protection Group.

hiveParams
object | null

Specifies the source specific parameters for this Protection Group.

hypervParams
object | null

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

isilonParams
object | null

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

kubernetesParams
object | null

Specifies the parameters which are related to Kubernetes Protection Groups.

kvmParams
object | null

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

mongodbParams
object | null

Specifies the source specific parameters for this Protection Group.

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.

office365Params
object | null

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

oracleParams
object | null

Specifies the parameters to create Oracle Protection Group.

physicalParams
object | null

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.

sfdcParams
object | null

Specifies the parameters to create SFDC Protection Group.

udaParams
object | null

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

Specifies the params for Continuous Data Protection.

Responses

Updated 3 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago