Validate Remote Cluster config.

post

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

Validate a Remote Cluster credentials. If includeRemoteClusterMetadata is true, response will include the remote cluster metadata.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

includeMetadata

boolean

Specifies if Remote Cluster metadata should be included in the response.

Body Params

Specifies the request to validate 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*

password

string

required

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

username

string

required

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

otpCode

string | null

Specifies OTP code for MFA verification.

otpType

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:

Headers

accessClusterId

int64

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

Responses

204

No Content

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError