Getting StartedAPI ReferenceRecipesGitHub
API Reference

Get all registered Remote Clusters.

get
https://cluster.ip.address/v2/remote-clusters

Privileges: CLUSTER_REMOTE_VIEW

List the Remote Clusters that are registered on this local Cluster and that matches the filter criteria specified using parameters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
clusterIds
array of int64s

Specifies a list of Remote Cluster ids to filter.

clusterIds
clusterNames
array of strings

Specifies a list of Remote Cluster names to filter.

clusterNames
nodeAddresses
array of strings

Specifies a list of Remote Cluster IPs to filter.

nodeAddresses
purpose
array of strings

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

purpose
boolean

If true, the response will include encrypted password.

boolean

If true, the response will include onprem vault. Onprem vault will not be included by default.

Responses

Updated 3 months ago

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

Updated 3 months ago