NetworkConnectionsApi

All URIs are relative to https://developers.fireblocks.com/reference/

Method	HTTP request	Description
checkThirdPartyRouting	GET /network_connections/{connectionId}/is_third_party_routing/{assetType}	Retrieve third-party network routing validation by asset type.
createNetworkConnection	POST /network_connections	Creates a new network connection
createNetworkId	POST /network_ids	Creates a new Network ID
deleteNetworkConnection	DELETE /network_connections/{connectionId}	Deletes a network connection by ID
deleteNetworkId	DELETE /network_ids/{networkId}	Deletes specific network ID.
getNetwork	GET /network_connections/{connectionId}	Get a network connection
getNetworkConnections	GET /network_connections	List network connections
getNetworkId	GET /network_ids/{networkId}	Returns specific network ID.
getNetworkIds	GET /network_ids	Returns all network IDs, both local IDs and discoverable remote IDs
getRoutingPolicyAssetGroups	GET /network_ids/routing_policy_asset_groups	Returns all enabled routing policy asset groups
setNetworkIdDiscoverability	PATCH /network_ids/{networkId}/set_discoverability	Update network ID's discoverability.
setNetworkIdName	PATCH /network_ids/{networkId}/set_name	Update network ID's name.
setNetworkIdRoutingPolicy	PATCH /network_ids/{networkId}/set_routing_policy	Update network id routing policy.
setRoutingPolicy	PATCH /network_connections/{connectionId}/set_routing_policy	Update network connection routing policy.

checkThirdPartyRouting

CompletableFuture<ApiResponse> checkThirdPartyRouting checkThirdPartyRouting(connectionId, assetType)

Retrieve third-party network routing validation by asset type.

The Fireblocks Network allows for flexibility around incoming deposits. A receiver can receive network deposits to locations other than Fireblocks. This endpoint validates whether future transactions are routed to the displayed recipient or to a 3rd party.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.NetworkConnectionsApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        String connectionId = "connectionId_example"; // String | The ID of the network connection
        String assetType = "assetType_example"; // String | The destination asset type
        try {
            CompletableFuture<ApiResponse<ThirdPartyRouting>> response = fireblocks.networkConnections().checkThirdPartyRouting(connectionId, assetType);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling NetworkConnectionsApi#checkThirdPartyRouting");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConnectionsApi#checkThirdPartyRouting");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
connectionId	String	The ID of the network connection
assetType	String	The destination asset type

Return type

CompletableFuture<ApiResponse<ThirdPartyRouting>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	result for the validation	* X-Request-ID -
0	Error Response	* X-Request-ID -

createNetworkConnection

CompletableFuture<ApiResponse> createNetworkConnection createNetworkConnection(networkConnection, idempotencyKey)

Creates a new network connection

Initiates 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`).

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.NetworkConnectionsApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        NetworkConnection networkConnection = new NetworkConnection(); // NetworkConnection | 
        String idempotencyKey = "idempotencyKey_example"; // 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.
        try {
            CompletableFuture<ApiResponse<NetworkConnectionResponse>> response = fireblocks.networkConnections().createNetworkConnection(networkConnection, idempotencyKey);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling NetworkConnectionsApi#createNetworkConnection");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConnectionsApi#createNetworkConnection");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
networkConnection	NetworkConnection		[optional]
idempotencyKey	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.	[optional]

Return type

CompletableFuture<ApiResponse<NetworkConnectionResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	A Network Connection object	* X-Request-ID -
0	Error Response	* X-Request-ID -

createNetworkId

CompletableFuture<ApiResponse> createNetworkId createNetworkId(createNetworkIdRequest, idempotencyKey)

Creates a new Network ID

Creates a new Network 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 `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`).

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.NetworkConnectionsApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        CreateNetworkIdRequest createNetworkIdRequest = new CreateNetworkIdRequest(); // CreateNetworkIdRequest | 
        String idempotencyKey = "idempotencyKey_example"; // 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.
        try {
            CompletableFuture<ApiResponse<NetworkIdResponse>> response = fireblocks.networkConnections().createNetworkId(createNetworkIdRequest, idempotencyKey);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling NetworkConnectionsApi#createNetworkId");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConnectionsApi#createNetworkId");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
createNetworkIdRequest	CreateNetworkIdRequest		[optional]
idempotencyKey	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.	[optional]

Return type

CompletableFuture<ApiResponse<NetworkIdResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Returns the new network ID in your workspace	* X-Request-ID -
0	Error Response	* X-Request-ID -

deleteNetworkConnection

CompletableFuture<ApiResponse> deleteNetworkConnection deleteNetworkConnection(connectionId)

Deletes a network connection by ID

Deletes an existing network connection specified by its connection 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 `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 - Note: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.NetworkConnectionsApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        String connectionId = "connectionId_example"; // String | The ID of the network connection to delete
        try {
            CompletableFuture<ApiResponse<DeleteNetworkConnectionResponse>> response = fireblocks.networkConnections().deleteNetworkConnection(connectionId);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling NetworkConnectionsApi#deleteNetworkConnection");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConnectionsApi#deleteNetworkConnection");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
connectionId	String	The ID of the network connection to delete

Return type

CompletableFuture<ApiResponse<DeleteNetworkConnectionResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Network ID	* X-Request-ID -
0	Error Response	* X-Request-ID -

deleteNetworkId

CompletableFuture<ApiResponse> deleteNetworkId deleteNetworkId(networkId)

Deletes specific network ID.

Deletes a network by its 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 `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 - Note: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.NetworkConnectionsApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        String networkId = "networkId_example"; // String | The ID of the network
        try {
            CompletableFuture<ApiResponse<DeleteNetworkIdResponse>> response = fireblocks.networkConnections().deleteNetworkId(networkId);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling NetworkConnectionsApi#deleteNetworkId");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConnectionsApi#deleteNetworkId");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
networkId	String	The ID of the network

Return type

CompletableFuture<ApiResponse<DeleteNetworkIdResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Network ID	-
0	Error Response	* X-Request-ID -

getNetwork

CompletableFuture<ApiResponse> getNetwork getNetwork(connectionId)

Get a network connection

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 `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 - Note: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.NetworkConnectionsApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        String connectionId = "connectionId_example"; // String | The ID of the connection
        try {
            CompletableFuture<ApiResponse<NetworkConnectionResponse>> response = fireblocks.networkConnections().getNetwork(connectionId);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling NetworkConnectionsApi#getNetwork");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConnectionsApi#getNetwork");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
connectionId	String	The ID of the connection

Return type

CompletableFuture<ApiResponse<NetworkConnectionResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A network connection	* X-Request-ID -
0	Error Response	* X-Request-ID -

getNetworkConnections

CompletableFuture<ApiResponse<List>> getNetworkConnections getNetworkConnections()

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 - Note: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.NetworkConnectionsApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        try {
            CompletableFuture<ApiResponse<List<NetworkConnectionResponse>>> response = fireblocks.networkConnections().getNetworkConnections();
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling NetworkConnectionsApi#getNetworkConnections");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConnectionsApi#getNetworkConnections");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

CompletableFuture<ApiResponse<List<NetworkConnectionResponse>>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of network connections	* X-Request-ID -
0	Error Response	* X-Request-ID -

getNetworkId

CompletableFuture<ApiResponse> getNetworkId getNetworkId(networkId)

Returns specific network ID.

Retrieves a network by its 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 `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 - Note: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.NetworkConnectionsApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        String networkId = "networkId_example"; // String | The ID of the network
        try {
            CompletableFuture<ApiResponse<NetworkIdResponse>> response = fireblocks.networkConnections().getNetworkId(networkId);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling NetworkConnectionsApi#getNetworkId");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConnectionsApi#getNetworkId");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
networkId	String	The ID of the network

Return type

CompletableFuture<ApiResponse<NetworkIdResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Network ID	* X-Request-ID -
0	Error Response	* X-Request-ID -

getNetworkIds

CompletableFuture<ApiResponse<List>> getNetworkIds getNetworkIds()

Returns all network IDs, both local IDs and discoverable remote IDs

Retrieves a list of all local and discoverable remote network IDs. 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 - Note: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.NetworkConnectionsApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        try {
            CompletableFuture<ApiResponse<List<NetworkIdResponse>>> response = fireblocks.networkConnections().getNetworkIds();
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling NetworkConnectionsApi#getNetworkIds");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConnectionsApi#getNetworkIds");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

CompletableFuture<ApiResponse<List<NetworkIdResponse>>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of network IDs	* X-Request-ID -
0	Error Response	* X-Request-ID -

getRoutingPolicyAssetGroups

CompletableFuture<ApiResponse<List>> getRoutingPolicyAssetGroups getRoutingPolicyAssetGroups()

Returns all enabled routing policy asset groups

Retrieves a list of all enabled routing policy asset groups. Your routing policy defines how your transactions are routed. You can use one or more enabled routing policy asset groups to describe connection or network id routing policy.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.NetworkConnectionsApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        try {
            CompletableFuture<ApiResponse<List<String>>> response = fireblocks.networkConnections().getRoutingPolicyAssetGroups();
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling NetworkConnectionsApi#getRoutingPolicyAssetGroups");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConnectionsApi#getRoutingPolicyAssetGroups");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

CompletableFuture<ApiResponse<List<String>>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of enabled routing policy asset groups	* X-Request-ID -
0	Error Response	* X-Request-ID -

setNetworkIdDiscoverability

CompletableFuture<ApiResponse> setNetworkIdDiscoverability setNetworkIdDiscoverability(setNetworkIdDiscoverabilityRequest, networkId)

Update network ID's discoverability.

Update whether or not the network ID is discoverable by others. 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 - Note: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.NetworkConnectionsApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        SetNetworkIdDiscoverabilityRequest setNetworkIdDiscoverabilityRequest = new SetNetworkIdDiscoverabilityRequest(); // SetNetworkIdDiscoverabilityRequest | 
        String networkId = "networkId_example"; // String | The ID of the network
        try {
            CompletableFuture<ApiResponse<SetNetworkIdResponse>> response = fireblocks.networkConnections().setNetworkIdDiscoverability(setNetworkIdDiscoverabilityRequest, networkId);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling NetworkConnectionsApi#setNetworkIdDiscoverability");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConnectionsApi#setNetworkIdDiscoverability");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
setNetworkIdDiscoverabilityRequest	SetNetworkIdDiscoverabilityRequest
networkId	String	The ID of the network

Return type

CompletableFuture<ApiResponse<SetNetworkIdResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Network ID	* X-Request-ID -
0	Error Response	* X-Request-ID -

setNetworkIdName

CompletableFuture<ApiResponse> setNetworkIdName setNetworkIdName(setNetworkIdNameRequest, networkId)

Update network ID's name.

Updates name of a specified network 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 `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 - Note: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.NetworkConnectionsApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        SetNetworkIdNameRequest setNetworkIdNameRequest = new SetNetworkIdNameRequest(); // SetNetworkIdNameRequest | 
        String networkId = "networkId_example"; // String | The ID of the network
        try {
            CompletableFuture<ApiResponse<SetNetworkIdResponse>> response = fireblocks.networkConnections().setNetworkIdName(setNetworkIdNameRequest, networkId);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling NetworkConnectionsApi#setNetworkIdName");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConnectionsApi#setNetworkIdName");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
setNetworkIdNameRequest	SetNetworkIdNameRequest
networkId	String	The ID of the network

Return type

CompletableFuture<ApiResponse<SetNetworkIdResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Network ID	* X-Request-ID -
0	Error Response	* X-Request-ID -

setNetworkIdRoutingPolicy

CompletableFuture<ApiResponse> setNetworkIdRoutingPolicy setNetworkIdRoutingPolicy(networkId, setNetworkIdRoutingPolicyRequest)

Update network id routing policy.

Updates the routing policy of a specified network 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 `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`).

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.NetworkConnectionsApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        String networkId = "networkId_example"; // String | The ID of the network
        SetNetworkIdRoutingPolicyRequest setNetworkIdRoutingPolicyRequest = new SetNetworkIdRoutingPolicyRequest(); // SetNetworkIdRoutingPolicyRequest | 
        try {
            CompletableFuture<ApiResponse<SetNetworkIdResponse>> response = fireblocks.networkConnections().setNetworkIdRoutingPolicy(networkId, setNetworkIdRoutingPolicyRequest);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling NetworkConnectionsApi#setNetworkIdRoutingPolicy");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConnectionsApi#setNetworkIdRoutingPolicy");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
networkId	String	The ID of the network
setNetworkIdRoutingPolicyRequest	SetNetworkIdRoutingPolicyRequest		[optional]

Return type

CompletableFuture<ApiResponse<SetNetworkIdResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Network ID	* X-Request-ID -
0	Error Response	* X-Request-ID -

setRoutingPolicy

CompletableFuture<ApiResponse> setRoutingPolicy setRoutingPolicy(connectionId, setRoutingPolicyRequest)

Update network connection routing policy.

Updates an existing network connection's routing policy. 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`).

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.NetworkConnectionsApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        String connectionId = "connectionId_example"; // String | The ID of the network connection
        SetRoutingPolicyRequest setRoutingPolicyRequest = new SetRoutingPolicyRequest(); // SetRoutingPolicyRequest | 
        try {
            CompletableFuture<ApiResponse<SetRoutingPolicyResponse>> response = fireblocks.networkConnections().setRoutingPolicy(connectionId, setRoutingPolicyRequest);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling NetworkConnectionsApi#setRoutingPolicy");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConnectionsApi#setRoutingPolicy");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
connectionId	String	The ID of the network connection
setRoutingPolicyRequest	SetRoutingPolicyRequest		[optional]

Return type

CompletableFuture<ApiResponse<SetRoutingPolicyResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Network ID	* X-Request-ID -
0	Error Response	* X-Request-ID -

Files

NetworkConnectionsApi.md

Latest commit

History

NetworkConnectionsApi.md

File metadata and controls

NetworkConnectionsApi

checkThirdPartyRouting

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createNetworkConnection

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createNetworkId

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteNetworkConnection

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteNetworkId

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getNetwork

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getNetworkConnections

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getNetworkId

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getNetworkIds

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getRoutingPolicyAssetGroups

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

setNetworkIdDiscoverability

Example

Parameters