Getting StartedAPI ReferenceRecipesGitHub
API Reference

Update the registration of a Fortknox Onprem Primary Cluster.

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

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
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.

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 local and remote Clusters.

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
length ≥ 1

Specifies a list of Storage Domain configurations.

storageDomainConfigs
int64 | null
required

Specifies the Storage Domain id on the Primary Cluster.

string | null

Specifies the Storage Domain name on the Primary Cluster.

int64 | null
required

Specifies the Storage Domain id on the Vault Cluster.

string | null

Specifies the Storage Domain name on the Primary Cluster.

vaultingWindowConfig
object | null

Vaulting window configuration parameters.

Headers
int64

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

Responses

Updated 16 days 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 16 days ago