Update Object Backup.

put

https://helios.cohesity.com/v2/data-protect/protected-objects/{id}

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.

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.

policyConfig

object | null

Specifies the policy configuration for protecting an object.

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.

startTime

object | null

Specifies the time of day. Used for scheduling purposes.

priority

string | null

enum

Specifies the priority for the objects backup.

Allowed:

sla

array of objects | null

Specifies the SLA parameters for list of objects.

sla

qosPolicy

string | null

enum

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

Allowed:

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.

skipRigelForBackup

boolean | null

Specifies whether to skip Rigel for backup or not.

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

Specifies the environment for current object.

vmwareParams

object | null

Specifies the common object parameters required for VMware protection.

genericNasParams

object | null

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

gpfsParams

object | null

Specifies the parameters which are specific to Gpfs object protection.

elastifileParams

object | null

Specifies the parameters which are specific to Elastifile object protection.

netappParams

object | null

Specifies the parameters which are specific to Netapp object protection.

nutanixFSParams

object | null

Specifies the parameters which are specific to NutanixFS object protection.

isilonParams

object | null

Specifies the parameters which are specific to Isilon object protection.

flashbladeParams

object | null

Specifies the parameters which are specific to Flashblade object protection.

mssqlParams

object | null

Specifies the common parameters for MSSQL Object Protection.

oracleParams

object | null

Specifies the parameters specific to Oracle Object Protection.

office365Params

object | null

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

awsParams

object | null

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

hypervParams

object | null

Specifies the common object parameters required for HyperV protection.

physicalParams

object

Specifies the parameters specific to Physical Object Protection.

sfdcParams

object | null

Specifies the parameters that are specific to Sfdc Object Protection.

udaParams

object | null

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

sapHanaParams

object | null

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

kubernetesParams

object | null

Specifies the parameters that are specific to Kubernetes Object Protection.

azureParams

object | null

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

experimentalAdapterParams

object | null

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

googleWorkspaceParams

object | null

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

jiraParams

object | null

Specifies the object parameters to create a JIRA Object Protection. Allows filtering by project keys and modification time for incremental backups.

serviceNowParams

object | null

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.

salesforceParams

object | null

Specifies the object parameters to create an Salesforce Object 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:

accessClusterId

int64

This field uniquely represents a Cohesity Cluster and is used for making on-prem calls from Helios.

Responses

200Success

defaultError