Test connection to a source.

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Specifies the parameters to test connectivity with a source.

environment

string | null

enum

required

Specifies the environment type of the Protection Source.

Allowed:

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.

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. This is connectionId in string format to help UI preserve the precision for int values larger than 2^53 - 1

cassandraConnectionParams

object

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

hiveConnectionParams

object

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

hbaseConnectionParams

object

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

hdfsConnectionParams

object

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

mssqlConnectionParams

object

Specifies the common parameters to connect to a SQL node/cluster

oracleConnectionParams

object

Specifies the parameters to connect to a Oracle node/cluster using given IP or hostname FQDN.

vmwareConnectionParams

object

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

Headers

accessClusterId

int64

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

Responses

200Success

defaultError