Get a network connection
GET {{baseUrl}}/network_connections/:connectionId
Gets a network connection by ID. 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 Default Workspace Presets:
- Network Profile Crypto → Custom
- Network Profile FIAT → None
- Network Connection Crypto → Default
- Network Connection FIAT → DefaultNone
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
- **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).
Body
PARAM
Key | Datatype | Required | Description |
HEADERS
Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
{
"id": "<string>",
"localNetworkId": {
"id": "<string>",
"name": "<string>"
},
"remoteNetworkId": {
"id": "<string>",
"name": "<string>"
},
"routingPolicy": {
"consequat_e": {
"scheme": "CUSTOM",
"dstType": "FIAT_ACCOUNT",
"dstId": "<string>"
},
"officia_b2d": {
"scheme": "CUSTOM",
"dstType": "EXCHANGE",
"dstId": "<string>"
}
},
"status": "REMOVED_BY_PEER",
"localChannel": {
"networkId": "<string>",
"name": "<string>"
},
"remoteChannel": {
"networkId": "<string>",
"name": "<string>"
}
} |
ENDPOINTS