Update Protection Source registration.

put

https://helios.cohesity.com/v2/data-protect/sources/registrations/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Specifies the id of the Protection Source registration.

Body Params

Specifies the parameters to update the registration.

Specifies the Source registration Update request parameters.

advancedConfigs

array of objects | null

Specifies the advanced configuration for a protection source.

advancedConfigs

asyncRegistration

boolean | null

Indicates whether the source should be registered asynchronously. Currently supported only for VMware sources.

connectionId

int64 | null

Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. This field will be deprecated in future.

connections

array of objects | null

Specfies the list of connections for the source.

connections

connectorGroupId

int64 | null

Specifies the connector group id of connector groups.

dataSourceConnectionId

string | null

Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. Also, this is the 'string' of connectionId. This property was added to accommodate for ID values that exceed 2^53 - 1, which is the max value for which JS maintains precision.

encryptionKey

string | null

Specifies the key that user has encrypted the credential with.

environment

string | null

enum

required

Specifies the environment type of the Protection Source.

isInternalEncrypted

boolean | null

Specifies if credentials are encrypted by internal key.

name

string | null

A user specified name for this source.

awsParams

object | null

Specifies the parameters to register an AWS source.

azureParams

object | null

Specifies the parameters to register an Azure source.

cassandraParams

object | null

Specifies the parameters to update the registration of a Cassandra Protection Source.

confluenceParams

object | null

Specifies the parameters to register a Confluence source.

couchbaseParams

object | null

Specifies the parameters to register a Couchbase Protection Source.

db2Params

object | null

Specifies the parameters to register a DB2 source.

elastifileParams

object | null

Specifies the parameters to register an Elastifile Source.

ewsExchangeParams

object | null

Specifies the parameters to register an EWS Exchange source.

experimentalAdapterParams

object | null

Specifies the parameters to register an Experimental Adapter source.

flashbladeParams

object | null

Specifies the parameters to register an Flashblade Source.

gcpParams

object | null

Specifies the parameters to register a GCP source.

genericNasParams

object | null

Specifies the parameters to register a Generic Nas Source.

googleWorkspaceParams

object | null

Specifies the parameters to register a Google Workspace source.

gpfsParams

object | null

Specifies the parameters to register an GPFS Source.

hbaseParams

object | null

Specifies the parameters to update registration of an Hbase Protection Source. Update Hbase supports two operations - Reconfigure and Update Kerberos. For the Reconfigure operation you have to specify host, config directory and either SSHCredentials or SSHPrivateKey. All other fields in the request will be ignored. For the Update Kerberos operation you should set only the Kerberos field and not set any other field.

hdfsParams

object | null

Specifies the parameters to update registration of an HDFS Protection Source. Update for HDFS supports two operations - Reconfigure and Update Kerberos. For the Reconfigure operation you have to specify host, config directory and either SSHCredentials or SSHPrivateKey. All other fields in the request will be ignored. For the Update Kerberos operation you should set only the Kerberos field and not set any other field.

hiveParams

object | null

Specifies the parameters to update registration of an Hive Protection Source. Update Hive supports two operations - Reconfigure and Update Kerberos. For the Reconfigure operation you have to specify host, config directory and either SSHCredentials or SSHPrivateKey. All other fields in the request will be ignored. For the Update Kerberos operation you should set only the Kerberos field and not set any other field.

hypervParams

object | null

Specifies the parameters to register a HyperV Protection Source.

isilonParams

object | null

Specifies the parameters to register an Isilon Source.

jiraParams

object | null

Specifies the parameters to register a JIRA source.

kubernetesParams

object | null

Specifies the parameters to register an Kubernetes source.

lastModifiedTimestampUsecs

int64 | null

Specifies the last time this protection source was updated. If this is passed into a PUT request, then the backend will validate that the timestamp passed in matches the time that the protection source was actually last modified. If the two timestamps do not match, then the request will be rejected with a stale error.

mongodbOpsParams

object | null

Specifies the parameters to register a MongoDB Ops Manager Source.

mongodbParams

object | null

Specifies the parameters to register a MongoDB Protection Source.

netappParams

object | null

Specifies the parameters to register an Netapp Source.

nutanixFSParams

object | null

Specifies the parameters to register an Nutanix FS Source.

office365Params

object | null

Specifies the parameters to update the registration of an office 365 Source.

oktaParams

object | null

Specifies the parameters to register an Okta source.

physicalParams

object | null

Specifies the parameters to register a Physical Protection Source.

pineconeParams

object | null

Specifies the parameters to register a Pinecone source.

postgresParams

object | null

Specifies the parameters to register a Postgres source.

s3CompatibleParams

object

Specifies the parameters to register a S3 compatible source.

salesforceParams

object | null

Specifies the parameters to register a Salesforce source.

sapHanaParams

object | null

Specifies the parameters to register a SAP HANA protection source.

serviceNowParams

object | null

Specifies the parameters to register a ServiceNow source.

sfdcParams

object | null

Specifies the parameters to update the registration of a SFDC Adapter Protection Source.

udaParams

object | null

Specifies the parameters to update the registration of a Universal Data Adapter Protection Source.

vmwareParams

object | null

Specifies the parameters to register a VMware Protection Source.

Headers

accessClusterId

int64

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

Responses

200Success

defaultError