Update a External Target.

put

https://helios.cohesity.com/v2/data-protect/external-targets/{id}

Update the specified External Target.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Specifies the id of the External Target.

Body Params

Specifies the parameters to update a External Target.

cloudDomains

array of objects | null

Specifies the cloud domain information.

cloudDomains

compression

string | null

enum

Specifies whether the type of compression of the External Target

Allowed:

enableObjectLock

boolean | null

Whether to enable object lock for this vault. If this field is set, all the objects written to the vault will be object locked until all the archives referring to them expire.

globalId

string | null

Specifies the global identifier of the External Target.

isWormCapable

boolean | null

Specifies whether this external target has been found to be capable of supporting WORM archives.

name

string | null

required

Specifies the name of the External Target.

ownershipContext

string | null

enum

Specifies whether how this external target is being consumed either Local or FortKnox.

Allowed:

purposeType

string | null

enum

required

Specifies the purpose of the External Target.

Allowed:

storageDomainName

string | null

Specifies the storage domain associated with the target.

tenantIds

array of strings

Specifies the list of tenantIds for the External Target

tenantIds

useForApolloMrStore

boolean | null

Specifies whether this external target is used to store apollo mr records.

useRollingObjectLock

boolean | null

Whether the vault should use rolling object lock.

vaultTagMap

array of objects | null

A map that contains the tags relevant to the external target. Each tag entry consists of a key-value pair.

vaultTagMap

wormLockInComplianceMode

boolean | null

Whether archives to this vault should use compliance mode when adding data locks to objects.

archivalParams

object

Specifies the common parameters which are specific to Archival purpose type External Targets.

tieringParams

object

Specifies the common parameters which are specific to Tiering purpose type External Targets.

Headers

accessClusterId

int64

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

Responses

200Success

defaultError