Update Ledger binding

patch

https://example.com/ledger/{name}/update

Update a ledger integration

Path Params

name

string

required

.*\S.*

Unique identifier for the ledger name. This value must be unique across all ledger bindings

Body Params

endpoint

string | null

.*\S.*

Ledger adapter address in host:port format

requestTimeout

string | null

^[1-9]\d*(?:\.\d+)?(h|m|s|ms|us|µs|ns)(\d+(?:\.\d+)?(h|m|s|ms|us|µs|ns))*$

The maximum time allowed for the entire request operation to complete, including all retry attempts. After this duration, the request will fail with a timeout error

backoff

string | null

^[1-9]\d*(?:\.\d+)?(h|m|s|ms|us|µs|ns)(\d+(?:\.\d+)?(h|m|s|ms|us|µs|ns))*$

The waiting period between consecutive retry attempts when a request fails. This delay helps prevent overwhelming the ledger adapter during temporary failures

singleRequestTimeout

string | null

^[1-9]\d*(?:\.\d+)?(h|m|s|ms|us|µs|ns)(\d+(?:\.\d+)?(h|m|s|ms|us|µs|ns))*$

The maximum time allowed for each individual request attempt. If a single attempt exceeds this duration, it will be retried according to the backoff configuration

auth

idempotency

retryStrategy

displayName

string | null

.*\S.*

A human-readable name for the ledger that appears in user interfaces

balanceSyncAllowed

boolean | null

Defaults to true

Indicates whether balance synchronization is enabled for this ledger

Responses

200

successful operation

400Bad Request

500Internal Server Error