SIsiafoundation
settings

Update host settings

Changed on

Partially updates the host's settings by merging the provided fields with the current values.

patch/settings

Request

  • Base URL
    http://localhost:9980/api
  • URL
    http://localhost:9980/api/settings
  • Auth
    HTTP basic

Request body

object required

Response

Updated host settings.

acceptingContractsboolean

Whether the host is accepting new contracts.

netAddressstring

Public hostname or IP address of the host. Must not include a port.

maxContractDurationinteger

Maximum allowed contract duration in blocks.

windowSizeinteger

Storage proof window size in blocks.

contractPricestring

Hastings (1 Siacoin = 10^24 Hastings).

baseRPCPricestring

Hastings (1 Siacoin = 10^24 Hastings).

sectorAccessPricestring

Hastings (1 Siacoin = 10^24 Hastings).

collateralMultipliernumber double

Multiplier applied to storage price to calculate collateral per byte per block.

maxCollateralstring

Hastings (1 Siacoin = 10^24 Hastings).

storagePricestring

Hastings (1 Siacoin = 10^24 Hastings).

egressPricestring

Hastings (1 Siacoin = 10^24 Hastings).

ingressPricestring

Hastings (1 Siacoin = 10^24 Hastings).

priceTableValidityinteger

How long a price table remains valid in nanoseconds.

maxRegistryEntriesinteger

Maximum number of registry entries the host will store.

accountExpiryinteger

Duration before an idle ephemeral account expires in nanoseconds.

maxAccountBalancestring

Hastings (1 Siacoin = 10^24 Hastings).

ingressLimitinteger

Bandwidth limit for RHP ingress in bytes per second. 0 means unlimited.

egressLimitinteger

Bandwidth limit for RHP egress in bytes per second. 0 means unlimited.

syncerIngressLimitinteger

Bandwidth limit for syncer ingress in bytes per second. 0 means unlimited.

syncerEgressLimitinteger

Bandwidth limit for syncer egress in bytes per second. 0 means unlimited.

sectorCacheSizeinteger

Deprecated. The sector cache was removed and the value is ignored.

revisioninteger

Settings revision number managed by the caller.

Changes

  • 3d701b97505eRevision changes
    • info

      response property sectorCacheSize deprecated

  • d96c56d6970bRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status