Update Object Backup.

put

https://cluster.ip.address/v2/data-protect/protected-objects/{id}

Privileges: PROTECTION_MODIFY

Update Protected object backup configuration given a object id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Specifies the id of the Protected Object.

Body Params

Specifies the parameters to perform an update on protected objects.

abortInBlackouts

boolean | null

Specifies whether currently executing object backup 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.

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.

policyConfig

object

Specifies the policy configuration for protecting an object.

policyId

string | null

Specifies the unique id of the Protection Policy. The Policy settings will be attached with every object and will be used in backup.

priority

string | null

enum

Specifies the priority for the objects backup.

Allowed:

qosPolicy

string | null

enum

Specifies whether object backup will be written to HDD or SSD.

Allowed:

skipRigelForBackup

boolean | null

Specifies whether to skip Rigel for backup or not.

sla

array of objects | null

Specifies the SLA parameters for list of objects.

sla

startTime

object

Specifies the time of day. Used for scheduling purposes.

storageDomainId

int64 | null

Specifies the Storage Domain (View Box) ID where the object backup will be taken. This is not required if Cloud archive direct is benig used.

awsParams

object

Specifies the parameters which are specific to AWS related Object Protection and common to different AWS protection types.

azureParams

object

Specifies the parameters which are specific to Azure related Object Protection and common to different Azure protection types.

elastifileParams

object

Specifies the parameters which are specific to Elastifile object protection.

environment

string | null

enum

Specifies the environment for current object.

experimentalAdapterParams

object

Specifies the that are specific to Experimental Adapter Object Protection parameter section.

flashbladeParams

object

Specifies the parameters which are specific to Flashblade object protection.

genericNasParams

object

Specifies the parameters which are specific to Generic NAS object protection.

googleWorkspaceParams

object

Specifies the parameters which are specific to Google Workspace Object Protection.

gpfsParams

object

Specifies the parameters which are specific to Gpfs object protection.

hypervParams

object

Specifies the common object parameters required for HyperV protection.

isilonParams

object

Specifies the parameters which are specific to Isilon object protection.

kubernetesParams

object

Specifies the parameters that are specific to Kubernetes Object Protection.

mssqlParams

object

Specifies the common parameters for MSSQL Object Protection.

netappParams

object

Specifies the parameters which are specific to Netapp object protection.

office365Params

object

Specifies the parameters which are specific to Microsoft 365 Object Protection.

oracleParams

object

Specifies the parameters specific to Oracle Object Protection.

physicalParams

object

Specifies the parameters specific to Physical Object Protection.

sapHanaParams

object

Specifies the parameters that are specific to SAP HANA Object Protection.

serviceNowParams

object

Specifies the object parameters to create an ServiceNow Object Protection. If a table is in excludedTableVec and/or its prefix matches any of the prefixes in excludeTablePrefixVec then it will not be protected even if its name includeTableVec or its prefix matches any of the prefixes in includeTablePrefixVec.

sfdcParams

object

Specifies the parameters that are specific to Sfdc Object Protection.

udaParams

object

Specifies the parameters that are specific to Universal Data Adapter Object Protection.

vmwareParams

object

Specifies the common object parameters required for VMware protection.

Headers

requestInitiatorType

string

enum

Specifies the type of request from UI, which is used for services like magneto to determine the priority of requests.

Allowed:

Responses

200Success

defaultError