Skip to content

Latest commit

 

History

History
95 lines (71 loc) · 3.64 KB

WhitelistIpAddressesApi.md

File metadata and controls

95 lines (71 loc) · 3.64 KB
Raw

WhitelistIpAddressesApi

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

getWhitelistIpAddresses

CompletableFuture<ApiResponse> getWhitelistIpAddresses getWhitelistIpAddresses(userId)

Gets whitelisted ip addresses

Gets whitelisted ip addresses for given Api user.

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.WhitelistIpAddressesApi;
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 userId = "userId_example"; // String | The ID of the api user
        try {
            CompletableFuture<ApiResponse<GetWhitelistIpAddressesResponse>> response = fireblocks.whitelistIpAddresses().getWhitelistIpAddresses(userId);
            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 WhitelistIpAddressesApi#getWhitelistIpAddresses");
            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 WhitelistIpAddressesApi#getWhitelistIpAddresses");
            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
userId String The ID of the api user

Return type

CompletableFuture<ApiResponse<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 -