Register a Protection Source.

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Specifies the parameters to register a Protection Source.

environment

string | null

enum

required

Specifies the environment type of the Protection Source.

name

string | null

A user specified name for this source.

isInternalEncrypted

boolean | null

Specifies if credentials are encrypted by internal key.

encryptionKey

string | null

Specifies the key that user has encrypted the credential with.

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.

advancedConfigs

array of objects | null

Specifies the advanced configuration for a protection source.

advancedConfigs

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.

asyncRegistration

boolean | null

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

vmwareParams

object | null

Specifies the paramaters to register a VMware source.

physicalParams

object | null

Specifies parameters to register physical server.

genericNasParams

object | null

Specifies parameters to register GenericNas MountPoint.

isilonParams

object | null

Specifies parameters to register an Isilon Source.

netappParams

object | null

Specifies parameters to register an Netapp Source.

nutanixFSParams

object | null

Specifies parameters to register an NutanixFS Source.

elastifileParams

object | null

Specifies parameters to register an Elastifile Source.

flashbladeParams

object | null

Specifies parameters to register an Flashblade Source.

gpfsParams

object | null

Specifies parameters to register an GPFS Source.

cassandraParams

object | null

Specifies the parameters to connect to a Cassandra seed node and fetch information from its cassandra config file.

mongodbParams

object | null

Specifies parameters to register MongoDB source.

couchbaseParams

object | null

Specifies the object to hold username and password.

hdfsParams

object | null

Specifies parameters to register an HDFS source.

hbaseParams

object | null

Specifies parameters to register an HBase source.

hiveParams

object | null

Specifies parameters to register Hive source.

udaParams

object | null

Specifies parameters to register a Universal Data Adapter source.

sapHanaParams

object | null

Specifies parameters to register a SAP HANA source.

office365Params

object | null

Specifies the object to hold username and password.

awsParams

object | null

Specifies the paramaters to register an AWS source.

hypervParams

object | null

Specifies the paramaters to register a HyperV source.

sfdcParams

object | null

Specifies parameters to register an SFDC Protection Source.

azureParams

object | null

Specifies the paramaters to register an Azure source.

experimentalAdapterParams

object | null

Specifies parameters to register an Experimental Adapter source.

kubernetesParams

object | null

Specifies the parameters to register a Kubernetes source.

mongodbOpsParams

object | null

Specifies parameters to register MongoDB Ops Manager.

s3CompatibleParams

object

Specifies the parameters to register a S3 compatible source.

db2Params

object | null

Specifies parameters to register a DB2 source.

googleWorkspaceParams

object | null

Specifies the paramaters to register a Google Workspace source.

ewsExchangeParams

object | null

Specifies the parameters to register an EWS Exchange source.

serviceNowParams

object | null

Specifies the parameters to register a ServiceNow source.

jiraParams

object | null

Specifies the parameters to register a JIRA source.

gcpParams

object | null

Specifies the paramaters to register a GCP source.

salesforceParams

object | null

Specifies the parameters to register a Salesforce source.

postgresParams

object | null

Specifies the object to hold username and password.

Headers

accessClusterId

int64

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

Responses

201Success

defaultError