Getting StartedAPI ReferenceRecipesGitHub
API Reference

Register a Remote Cluster.

post
https://helios.cohesity.com/v2/remote-clusters

Register a Remote Cluster on this local cluster for remote access and/or replication.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Specifies the request to register Remote Cluster.

string
required

Specifies the Cohesity user name used to connect to the Remote Cluster.

string
required

Specifies the password for Cohesity user to use when connecting to the Remote Cluster.

nodeAddresses
array of strings
required
length ≥ 1

Specifies the VIP or IP addresses of the Nodes on the Remote Cluster to connect with. Hostnames are not supported.

nodeAddresses*
string | null

Specifies OTP code for MFA verification.

string | null
enum

Specifies the list of mechanism to receive the OTP code. Supported types are: TOTP (Helios OnPrem Only) -> Time based OTP. Email OTP (Helios OnPrem Only) -> OTP via Email.

Allowed:
purpose
array of strings | null

Specifies the purpose for which the remote cluster is being registered.

purpose
replicationParams
object | null

Specifies the replication config for a Remote Cluster.

string | null

Specifies the name of the network interfaces to use for communicating with the Remote Cluster.

boolean | null
Defaults to false

Specifies if the Tx clusters should be automatically registered at the Rx site.

string | null

Specifies any additional information if needed.

boolean | null

Specifies if the Remote Cluster has Multi-Tenancy enabled.

boolean | null

Specifies if Tenant Storage Domain sharing is enabled on the Remote Cluster.

string | null
enum

Specifies the AES Encryption mode of the remote cluster.

Allowed:
string | null
enum

Specifies the effective AES Encryption mode negotiated between local and the remote cluster.

Allowed:
boolean | null

Specifies if TLS is enabled on the Remote Cluster.

Headers
int64

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

Responses

Updated 4 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago