Update the registration of a Fortknox Onprem Primary Cluster.

put

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

Update the registration of the Fortknox Onprem Primary Cluster specified by the cluster id. This API can only be called on the Vault Clusters. The updates will be relayed to the Primary Cluster automatically.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clusterId

int64

required

Specifies the cluster id of the Fortknox Onprem Primary Cluster to update.

Body Params

Specifies the request to update Fortknox Onprem Primary Cluster config.

storageDomainConfigs

array of objects or null

length ≥ 1

Specifies a list of Storage Domain configurations.

storageDomainConfigs

primaryDomainId

int64 | null

required

Specifies the Storage Domain id on the Primary Cluster.

vaultDomainId

int64 | null

required

Specifies the Storage Domain id on the Vault Cluster.

primaryDomainName

string | null

Specifies the Storage Domain name on the Primary Cluster.

vaultDomainName

string | null

Specifies the Storage Domain name on the Primary Cluster.

vaultingWindowConfig

object | null

Vaulting window configuration parameters.

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.

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.

bandwidthLimit

object | null

Specifies settings for limiting the data transfer rate between the local and remote Clusters.

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

200Success

defaultError