Skip to main content
PUT
TypeScript

Headers

Idempotency-Key
string

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Path Parameters

blockchainId
string
required

ID of the blockchain to update (supplied as a path parameter).

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

Body

application/json

Declared properties for blockchain configuration (create/update API and response) Only the fields sent by the API and returned in list/create/update responses.

chainName
string
required

Human-readable name of the blockchain.

Example:

"Ethereum"

chainId
number
required

EVM chain ID of the blockchain.

Example:

1

symbolName
string
required

Native asset symbol of the blockchain.

Example:

"ETH"

rpcUrls
string[]
required

RPC endpoint URLs for the blockchain.

Required array length: 1 element
Example:
environmentType
enum<string>
required

Network environment (mainnet or testnet).

Available options:
ENVIRONMENT_TYPE_MAINNET,
ENVIRONMENT_TYPE_TESTNET
Example:

"ENVIRONMENT_TYPE_MAINNET"

decimals
number

Number of decimals for the native asset.

Example:

18

blockExplorerUrl
string

Base URL of the block explorer.

Example:

"https://etherscan.io"

blockExplorerTransactionPath
string

Path template for a transaction on the block explorer.

Example:

"/tx"

blockExplorerAddressPath
string

Path template for an address on the block explorer.

Example:

"/address"

networkId
number

EVM network ID of the blockchain.

Example:

1

hasFee
boolean

Whether the blockchain charges transaction fees.

Example:

true

isPoa
boolean

Whether the blockchain uses proof-of-authority consensus.

Example:

false

hasLayeredFee
boolean

Whether the blockchain uses a layered fee model.

Example:

false

nodeType
enum<string>

Node client type for the blockchain.

Available options:
NODE_TYPE_CORE_GETH,
NODE_TYPE_FANTOM,
NODE_TYPE_ERIGON,
NODE_TYPE_PARITY,
NODE_TYPE_BESU
Example:

"NODE_TYPE_CORE_GETH"

transactionFormat
number

Transaction format identifier.

Example:

0

baseAssetTenantIds
string[]

Tenant IDs that share this base asset.

Example:
explorerApiUrl
string

Block explorer API base URL.

Example:

"https://api.etherscan.io"

explorerApiKey
string

API key for the block explorer API.

Example:

"my-explorer-api-key"

isTraceEnabled
boolean

Whether trace/debug RPC methods are enabled.

Example:

false

rpcAuth
object

Discriminated RPC auth payload. Sent on create/update so backend can distinguish "no auth" from "field unchanged" on PUT updates. Credential values are stored inside declaredProperties and fetched at activation time; they are deliberately not carried through workflow context.

Response

OK

blockchain
object
required

Blockchain entity

message
string
required

Human-readable result message.

Example:

"Blockchain updated successfully"