Skip to main content

Settings

The settings section configures global behavior. It is placed immediately after version and server, before apis.

settings:
timeout: 10000 # default, ms
proof: none # only option for now
plugins:
- source: ./plugins/heartbeat.ts
timeout: 5000

Fields

FieldTypeRequiredDefaultDescription
timeoutnumberNo10000Global upstream API request timeout in milliseconds.
proofstringYes--Proof mode. Currently only 'none' is supported.
pluginsarrayNo[]Plugin entries. See Plugin Configuration.

timeout

Default timeout for upstream API requests in milliseconds. This applies to all APIs unless overridden at the API level with apis[].timeout.

settings:
timeout: 15000 # 15 seconds for all APIs by default

proof

Proof mode for response verification. Currently only 'none' is supported. Future modes will include:

  • replay -- deterministic replay proofs
  • tee -- trusted execution environment attestation
  • tlsnotary -- TLS session proofs via TLSNotary
settings:
proof: none

plugins

An array of plugin entries. Each entry specifies a source file and a timeout budget. When omitted or empty, no plugins are loaded.

settings:
plugins:
- source: ./plugins/heartbeat.ts
timeout: 5000
- source: ./plugins/slack-alerts.ts
timeout: 3000

See Plugin Configuration for details on source resolution, timeout budgets, and ordering.