Skip to content

WhitelistIpAddressesApi.md

Latest commit

 

History

History
88 lines (59 loc) · 3.03 KB

WhitelistIpAddressesApi.md

File metadata and controls

88 lines (59 loc) · 3.03 KB

fireblocks.WhitelistIpAddressesApi

All URIs are relative to https://api.fireblocks.io/v1

Method HTTP request Description
get_whitelist_ip_addresses GET /management/api_users/{userId}/whitelist_ip_addresses Get whitelisted ip addresses for an API Key

get_whitelist_ip_addresses

GetWhitelistIpAddressesResponse get_whitelist_ip_addresses(user_id)

Get whitelisted ip addresses for an API Key

Get a list of the whitelisted IP addresses for a specific API Key

  • Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.
    Endpoint Permission: Admin, Non-Signing Admin.

Example

from fireblocks.models.get_whitelist_ip_addresses_response import GetWhitelistIpAddressesResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    user_id = 'user_id_example' # str | The ID of the api user

    try:
        # Get whitelisted ip addresses for an API Key
        api_response = fireblocks.whitelist_ip_addresses.get_whitelist_ip_addresses(user_id).result()
        print("The response of WhitelistIpAddressesApi->get_whitelist_ip_addresses:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WhitelistIpAddressesApi->get_whitelist_ip_addresses: %s\n" % e)

Parameters

Name Type Description Notes
user_id str The ID of the api user

Return type

GetWhitelistIpAddressesResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

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]