v1

latestOpenAPI 3.0.02026-07-17506168.4 KB
settings

Current host settings

Returns the host's current configuration settings.

get/settings

Response

Host configuration.

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

Number of sectors to cache in memory for faster reads.

revisioninteger

Settings revision number managed by the caller.