List Node Setups

Lists a node's setups. A setup is one contract deployment of the node: it is bound to the custody wallet that signs it and to the network it runs on, and every deploy creates a new setup — so a node can have several setups, including several on the same wallet and network. Tokens, fees and contract upgrades all refer to a setup by its setup_id.

The list is not paginated.

Required permission: node:summary:view

Request

GET /v2/admin/nodes/{node_id}/setups

Parameters

Name	Type	In	Description
node_id	string	path	Required. The node's id
wallet_id	string	query	Only setups on this custody wallet
network_id	string	query	Only setups on this network

Headers

Name	Description
Authorization	Required. Bearer <access_token>

Example

curl --request GET \
  --url '{{baseUrl}}/v2/admin/nodes/6a4bef2b1e781b11c22e9707/setups?network_id=6740e0a20000000000000101' \
  --header 'Authorization: Bearer <access_token>'

Response

{
  "data": [
    {
      "setup_id": "6a552db09c6088e126a4be87",
      "name": "My Setup API",
      "wallet_id": "6a53f3dfad48accdb46eaf9e",
      "wallet_label": "Safe-Main-Wallet",
      "wallet_address": "0xAF4bf547c4d354266449dB91fe0c4d8861cFfc0E",
      "chain_id": "6740e0a10000000000000101",
      "chain_name": "EVM",
      "network_id": "6740e0a20000000000000101",
      "network_name": "Ethereum",
      "node_address": "0xAF4bf547c4d354266449dB91fe0c4d8861cFfc0E",
      "owner_address": "0x5B38Da6a701c568545dCfcB03FcB875f56beddC4",
      "platform_owner_address": "0x86123D7398a5a2C8b847b37B34eB499e07dE3A76",
      "platform_owner_wallet_label": "Platform Treasury",
      "completed": true,
      "status": "completed",
      "kyc_token_id": "6a51e0c2d4f1a2b3c4d5e6f7",
      "kyc_token_address": "0x1C0777276B13c56d416c41D4186744b9ba0a0D3a",
      "is_api": true
    }
  ]
}

Response Fields

Field	Type	Description
data	array	The node's setups
data[].setup_id	string	Setup id
data[].name	string	Setup name. Empty when none was given
data[].wallet_id	string	The custody wallet that signs the setup's contracts
data[].wallet_label	string	That wallet's label
data[].wallet_address	string	That wallet's address
data[].chain_id	string	The wallet's chain
data[].chain_name	string	Chain name
data[].network_id	string	The network the setup is deployed on
data[].network_name	string	Network name
data[].node_address	string	Address that receives the node's fee share on this setup's contracts
data[].owner_address	string	Address that receives the owner's fee share. Empty on an on-premise installation, which has no owner
data[].platform_owner_address	string	Address that receives the platform owner's fee share
data[].platform_owner_wallet_label	string	Label of the platform wallet behind platform_owner_address. Empty when that address is an external one
data[].completed	boolean	true once every contract is deployed and wired into the diamond
data[].status	string	completed or pending (mirrors completed)
data[].kyc_token_id	string	The KYC token the setup's diamond is wired to
data[].kyc_token_address	string	That KYC token's address. Empty when it could not be resolved
data[].is_api	boolean	true when the setup was created through the partner API

Empty strings in the wallet, chain and network fields mean that record could not be read; the setup is still listed.

Errors

Status	Code	Description
400	10016	node_id is not a valid id
400	10001	Node not found (node domain 2)
403	10005	The node is outside your part of the hierarchy (node domain 2)

See Errors for the error format and common codes.