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.

Specifies the request to update an object backup configuration.

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.

pauseInBlackouts

boolean | null

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

policyConfig

object | null

Specifies the policies for protecting an object with multiple policies. One of policyId and policyConfig is required.

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

Specifies the start time for the backup to trigger. 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 the object backup will be taken. This is not required if Cloud archive direct is benig used.

awsParams

object | null

Specifies the parameters which are specific to Aws related Object Backup.

azureParams

object | null

Specifies the parameters which are specific to Azure related Object Backup.

confluenceParams

object | null

Specifies the parameters which are specific to Confluence related Object Backup.

elastifileParams

object | null

Specifies the parameters which are specific to Elastifile related Object Backup.

environment

string | null

enum

Specifies the environment for current object.

experimentalAdapterParams

object | null

Specifies the parameters which are specific to Experimental Adapter related Object Backup.

flashbladeParams

object | null

Specifies the parameters which are specific to Flashblade related Object Backup.

genericNasParams

object | null

Specifies the parameters which are specific to Generic Nas related Object Backup.

googleWorkspaceParams

object | null

Specifies the parameters which are specific to Google Workspace related Object Backup.

gpfsParams

object | null

Specifies the parameters which are specific to Gpfs related Object Backup.

hypervParams

object | null

Specifies the parameters which are specific to HyperV related Object Backup.

isilonParams

object | null

Specifies the parameters which are specific to Isilon related Object Backup.

jiraParams

object | null

Specifies the parameters which are specific to JIRA related Object Backup.

kubernetesParams

object | null

Specifies the parameters which are specific to Kubernetes source related Object Backup.

mssqlParams

object | null

Specifies the parameters which are specific to Mssql related Object Backup.

netappParams

object | null

Specifies the parameters which are specific to Netapp related Object Backup.

nutanixFSParams

object | null

Specifies the parameters which are specific to Nutanix FS related Object Backup.

office365Params

object | null

Specifies the parameters which are specific to Microsoft 365 related Object Backup.

oktaParams

object | null

Specifies the parameters which are specific to Okta related Object Backup.

oracleParams

object | null

Specifies the parameters which are specific to Oracle related Object Backup.

physicalParams

object

Specifies the update parameters specific to Physical object protection.

salesforceParams

object | null

Specifies the parameters which are specific to Salesforce related Object Backup.

sapHanaParams

object | null

Specifies the parameters which are specific to SAP HANA related Object Backup.

serviceNowParams

object | null

Specifies the parameters which are specific to Service Now related Object Backup.

sfdcParams

object | null

Specifies the parameters which are specific to Sfdc related Object Backup.

udaParams

object | null

Specifies the parameters which are specific to Universal Data Adapter related Object Backup.

vmwareParams

object | null

Specifies the parameters which are specific to VMware related Object Backup.

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

Language

Credentials

Header

Loading…

Response

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

application/json

200Success

defaultError