All URIs are relative to https://developers.fireblocks.com/reference/
| Method | HTTP request | Description |
|---|---|---|
| getWhitelistIpAddresses | GET /management/api_users/{userId}/whitelist_ip_addresses | Gets whitelisted ip addresses |
GetWhitelistIpAddressesResponse getWhitelistIpAddresses()
Gets whitelisted ip addresses for given Api user.
import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, WhitelistIpAddressesApiGetWhitelistIpAddressesRequest, GetWhitelistIpAddressesResponse } from '@fireblocks/ts-sdk';
// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");
const fireblocks = new Fireblocks();
let body: WhitelistIpAddressesApiGetWhitelistIpAddressesRequest = {
// string | The ID of the api user
userId: userId_example,
};
fireblocks.whitelistIpAddresses.getWhitelistIpAddresses(body).then((res: FireblocksResponse<GetWhitelistIpAddressesResponse>) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| userId | [string] | The ID of the api user | defaults to undefined |
GetWhitelistIpAddressesResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | successfully got whitelisted ip addresses | * X-Request-ID - |
| 401 | Unauthorized. Missing / invalid JWT token in Authorization header. | * X-Request-ID - |
| 403 | Lacking permissions. | * X-Request-ID - |
| 5XX | Internal error. | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]