Register a Fortknox Onprem Primary Cluster.

post

https://helios.cohesity.com/v2/fortknox-onprem-primary-clusters

Register the Fortknox Onprem Primary Cluster on this cluster. This API can only be called on the Vault Clusters and the Vault Cluster will be registered on the Primary Cluster automatically.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Specifies the request to register a Fortknox Onprem Primary Cluster.

Specifies the parameters to create a Fortknox Onprem Primary Cluster config.

clusterId

int64 | null

Specifies the id of the cluster.

clusterIncarnationId

int64 | null

Specifies the incarnation id of the cluster.

allEndpointsReachable

boolean | null

Defaults to false

Starting with release 7.3.1, this field is deprecated and will always be overridden to false. Any value provided in API requests will be ignored. Previously, this field indicated whether all endpoints on the Cluster were reachable.

bandwidthLimit

object | null

Specifies settings for limiting the data transfer rate between the Primary Cluster and Vault Cluster.

compressionEnabled

boolean | null

Defaults to true

Starting with release 7.3.1, this field is deprecated and will always be overridden to true. Any value provided in API requests will be ignored. Previously, this field controlled whether outbound vaulting data was compressed during transfer to the Vault Cluster.

storageDomainConfigs

array of objects or null

length ≥ 1

Specifies a list of Storage Domain configurations.

storageDomainConfigs

Specifies a Storage Domain config. This contains the storage domain ids and names on the Primary Cluster and the Vault Cluster. The storage domain on the Primary Cluster is referred as Primary Domain, and the storage domain on the Vault Cluster is referred as Vault Domain. It also contains the vaulting window between the two domains.

primaryDomainId

int64 | null

required

Specifies the Storage Domain id on the Primary Cluster.

primaryDomainName

string | null

Specifies the Storage Domain name on the Primary Cluster.

vaultDomainId

int64 | null

required

Specifies the Storage Domain id on the Vault Cluster.

vaultDomainName

string | null

Specifies the Storage Domain name on the Primary Cluster.

vaultingWindowConfig

object | null

Specifies the vaulting window configuration between the domains.

Headers

accessClusterId

int64

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

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

201Success

defaultError