Update the registration of a Fortknox Onprem Primary Cluster.

put

https://cluster.ip.address/v2/fortknox-onprem-primary-clusters/{clusterId}

Privileges: FORTKNOX_ONPREM_VAULTING

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.

allEndpointsReachable

boolean | null

Defaults to false

Specifies if all endpoints on the Cluster are reachable.

bandwidthLimit

object

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

compressionEnabled

boolean | null

Defaults to true

Specifies whether to compress the outbound data when transferring the replication data over the network to the Vault Cluster.

storageDomainConfigs

array of objects

length ≥ 1

Specifies a list of Storage Domain configurations.

storageDomainConfigs

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

Vaulting window configuration parameters.

200Success

defaultError