List network connections

Returns all network connections.

Note: This API call is subject to Flexible Routing Schemes.

Your routing policy defines how your transactions are routed. You can choose 1 of the 3 different schemes mentioned below for each asset type:

None; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to None will fail.
Custom; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.
Default; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as “Profile Routing”

Default Workspace Presets:

Network Profile Crypto → Custom
Network Profile FIAT → None
Network Connection Crypto → Default
Network Connection FIAT → Default

GET

network_connections

TypeScript

const response: Promise<FireblocksResponse<GetNetworkConnectionsResponse>> = fireblocks.networkConnections.getNetworkConnections();

[
  {
    "id": "<string>",
    "status": "WAITING_FOR_APPROVAL",
    "localNetworkId": {
      "id": "<string>",
      "name": "<string>"
    },
    "remoteNetworkId": {
      "id": "<string>",
      "name": "<string>"
    },
    "routingPolicy": {},
    "localChannel": {
      "networkId": "<string>",
      "name": "<string>"
    },
    "remoteChannel": {
      "networkId": "<string>",
      "name": "<string>"
    }
  }
]

Response

A list of network connections

string

required

status

enum<string>

required

Available options:

WAITING_FOR_APPROVAL,

WAITING_FOR_PEER_APPROVAL,

APPROVED,

CANCELLED,

FAILED,

REJECTED,

REJECTED_BY_PEER,

REMOVED,

REMOVED_BY_PEER

localNetworkId

object

required

Show child attributes

remoteNetworkId

object

required

Show child attributes

routingPolicy

object

required

Show child attributes

localChannel

object

deprecated

Deprecated - Replaced by localNetworkId

Show child attributes

remoteChannel

object

deprecated

Deprecated - Replaced by remoteNetworkId

Show child attributes

Create a new network connectionInitiates a new network connection. **Note:** This API call is subject to Flexible Routing Schemes. Your routing policy defines how your transactions are routed. You can choose 1 of the 3 different schemes mentioned below for each asset type: - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail. - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one. - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing" Default Workspace Presets: - Network Profile Crypto → **Custom** - Network Profile FIAT → **None** - Network Connection Crypto → **Default** - Network Connection FIAT → **Default** Supported asset groups for routing police can be found at `/network_ids/routing_policy_asset_groups` - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).

⌘I

TypeScript

const response: Promise<FireblocksResponse<GetNetworkConnectionsResponse>> = fireblocks.networkConnections.getNetworkConnections();

[
  {
    "id": "<string>",
    "status": "WAITING_FOR_APPROVAL",
    "localNetworkId": {
      "id": "<string>",
      "name": "<string>"
    },
    "remoteNetworkId": {
      "id": "<string>",
      "name": "<string>"
    },
    "routingPolicy": {},
    "localChannel": {
      "networkId": "<string>",
      "name": "<string>"
    },
    "remoteChannel": {
      "networkId": "<string>",
      "name": "<string>"
    }
  }
]

Introduction

Errors & Statuses

Data Objects

API Endpoints

List network connections

Response

Introduction

Errors & Statuses

Data Objects

API Endpoints

Documentation Index

Response