GlobalIpsApi

All URIs are relative to https://api.telnyx.com/v2

Method	HTTP request	Description
createGlobalIp	POST /global_ips	Create a Global IP
createGlobalIpAssignment	POST /global_ip_assignments	Create a Global IP assignment
createGlobalIpHealthCheck	POST /global_ip_health_checks	Create a Global IP health check
deleteGlobalIp	DELETE /global_ips/{id}	Delete a Global IP
deleteGlobalIpAssignment	DELETE /global_ip_assignments/{id}	Delete a Global IP assignment
deleteGlobalIpHealthCheck	DELETE /global_ip_health_checks/{id}	Delete a Global IP health check
getGlobalIp	GET /global_ips/{id}	Retrieve a Global IP
getGlobalIpAssignment	GET /global_ip_assignments/{id}	Retrieve a Global IP
getGlobalIpAssignmentHealth	GET /global_ip_assignment_health
getGlobalIpAssignmentUsage	GET /global_ip_assignments_usage
getGlobalIpHealthCheck	GET /global_ip_health_checks/{id}	Retrieve a Global IP health check
getGlobalIpLatency	GET /global_ip_latency
getGlobalIpUsage	GET /global_ip_usage
listGlobalIpAllowedPorts	GET /global_ip_allowed_ports	List all Global IP Allowed Ports
listGlobalIpAssignments	GET /global_ip_assignments	List all Global IP assignments
listGlobalIpHealthCheckTypes	GET /global_ip_health_check_types	List all Global IP Health check types
listGlobalIpHealthChecks	GET /global_ip_health_checks	List all Global IP health checks
listGlobalIpProtocols	GET /global_ip_protocols	List all Global IP Protocols
listGlobalIps	GET /global_ips	List all Global IPs
updateGlobalIpAssignment	PATCH /global_ip_assignments/{id}	Update a Global IP assignment

createGlobalIp

CreateGlobalIp202Response createGlobalIp(globalIP)

Create a Global IP

Create a Global IP.

Example

// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        GlobalIP globalIP = new GlobalIP(); // GlobalIP | 
        try {
            CreateGlobalIp202Response result = apiInstance.createGlobalIp(globalIP);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#createGlobalIp");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
globalIP	GlobalIP

Return type

CreateGlobalIp202Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Successful response	-
422	Unprocessable entity. Check the 'detail' field in response for details.	-
0	Unexpected error	-

createGlobalIpAssignment

CreateGlobalIpAssignment202Response createGlobalIpAssignment(globalIpAssignment)

Create a Global IP assignment

Create a Global IP assignment.

Example

// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        GlobalIpAssignment globalIpAssignment = new GlobalIpAssignment(); // GlobalIpAssignment | 
        try {
            CreateGlobalIpAssignment202Response result = apiInstance.createGlobalIpAssignment(globalIpAssignment);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#createGlobalIpAssignment");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
globalIpAssignment	GlobalIpAssignment

Return type

CreateGlobalIpAssignment202Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Successful response	-
422	Unprocessable entity. Check the 'detail' field in response for details.	-
0	Unexpected error	-

createGlobalIpHealthCheck

CreateGlobalIpHealthCheck202Response createGlobalIpHealthCheck(globalIPHealthCheck)

Create a Global IP health check

Create a Global IP health check.

Example

// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        GlobalIPHealthCheck globalIPHealthCheck = new GlobalIPHealthCheck(); // GlobalIPHealthCheck | 
        try {
            CreateGlobalIpHealthCheck202Response result = apiInstance.createGlobalIpHealthCheck(globalIPHealthCheck);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#createGlobalIpHealthCheck");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
globalIPHealthCheck	GlobalIPHealthCheck

Return type

CreateGlobalIpHealthCheck202Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Successful response	-
422	Unprocessable entity. Check the 'detail' field in response for details.	-
0	Unexpected error	-

deleteGlobalIp

CreateGlobalIp202Response deleteGlobalIp(id)

Delete a Global IP

Delete a Global IP.

Example

import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
        try {
            CreateGlobalIp202Response result = apiInstance.deleteGlobalIp(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#deleteGlobalIp");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	UUID	Identifies the resource.

Return type

CreateGlobalIp202Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

deleteGlobalIpAssignment

CreateGlobalIpAssignment202Response deleteGlobalIpAssignment(id)

Delete a Global IP assignment

Delete a Global IP assignment.

Example

import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
        try {
            CreateGlobalIpAssignment202Response result = apiInstance.deleteGlobalIpAssignment(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#deleteGlobalIpAssignment");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	UUID	Identifies the resource.

Return type

CreateGlobalIpAssignment202Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

deleteGlobalIpHealthCheck

CreateGlobalIpHealthCheck202Response deleteGlobalIpHealthCheck(id)

Delete a Global IP health check

Delete a Global IP health check.

Example

import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
        try {
            CreateGlobalIpHealthCheck202Response result = apiInstance.deleteGlobalIpHealthCheck(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#deleteGlobalIpHealthCheck");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	UUID	Identifies the resource.

Return type

CreateGlobalIpHealthCheck202Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

getGlobalIp

CreateGlobalIp202Response getGlobalIp(id)

Retrieve a Global IP

Retrieve a Global IP.

Example

import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
        try {
            CreateGlobalIp202Response result = apiInstance.getGlobalIp(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#getGlobalIp");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	UUID	Identifies the resource.

Return type

CreateGlobalIp202Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

getGlobalIpAssignment

CreateGlobalIpAssignment202Response getGlobalIpAssignment(id)

Retrieve a Global IP

Retrieve a Global IP assignment.

Example

import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
        try {
            CreateGlobalIpAssignment202Response result = apiInstance.getGlobalIpAssignment(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#getGlobalIpAssignment");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	UUID	Identifies the resource.

Return type

CreateGlobalIpAssignment202Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

getGlobalIpAssignmentHealth

GetGlobalIpAssignmentHealth200Response getGlobalIpAssignmentHealth(filterGlobalIpIdIn, filterGlobalIpAssignmentIdIn, filterTimestampGt, filterTimestampLt)

Example

import java.time.OffsetDateTime;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        String filterGlobalIpIdIn = "filterGlobalIpIdIn_example"; // String | Filter by Global IP ID(s) separated by commas
        String filterGlobalIpAssignmentIdIn = "filterGlobalIpAssignmentIdIn_example"; // String | Filter by Global IP Assignment ID(s) separated by commas
        OffsetDateTime filterTimestampGt = OffsetDateTime.parse("2019-01-01T00:00Z"); // OffsetDateTime | Filter by timestamp greater than
        OffsetDateTime filterTimestampLt = OffsetDateTime.parse("2019-01-01T00:00Z"); // OffsetDateTime | Filter by timestamp less than
        try {
            GetGlobalIpAssignmentHealth200Response result = apiInstance.getGlobalIpAssignmentHealth(filterGlobalIpIdIn, filterGlobalIpAssignmentIdIn, filterTimestampGt, filterTimestampLt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#getGlobalIpAssignmentHealth");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
filterGlobalIpIdIn	String	Filter by Global IP ID(s) separated by commas	[optional]
filterGlobalIpAssignmentIdIn	String	Filter by Global IP Assignment ID(s) separated by commas	[optional]
filterTimestampGt	OffsetDateTime	Filter by timestamp greater than	[optional]
filterTimestampLt	OffsetDateTime	Filter by timestamp less than	[optional]

Return type

GetGlobalIpAssignmentHealth200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

getGlobalIpAssignmentUsage

GetGlobalIpAssignmentUsage200Response getGlobalIpAssignmentUsage(filterGlobalIpAssignmentIdIn, filterGlobalIpIdIn, filterTimestampGt, filterTimestampLt)

Example

import java.time.OffsetDateTime;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        String filterGlobalIpAssignmentIdIn = "filterGlobalIpAssignmentIdIn_example"; // String | Filter by Global IP Assignment ID(s) separated by commas
        String filterGlobalIpIdIn = "filterGlobalIpIdIn_example"; // String | Filter by Global IP ID(s), separated by commas
        OffsetDateTime filterTimestampGt = OffsetDateTime.parse("2019-01-01T00:00Z"); // OffsetDateTime | Filter by timestamp greater than
        OffsetDateTime filterTimestampLt = OffsetDateTime.parse("2019-01-01T00:00Z"); // OffsetDateTime | Filter by timestamp less than
        try {
            GetGlobalIpAssignmentUsage200Response result = apiInstance.getGlobalIpAssignmentUsage(filterGlobalIpAssignmentIdIn, filterGlobalIpIdIn, filterTimestampGt, filterTimestampLt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#getGlobalIpAssignmentUsage");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
filterGlobalIpAssignmentIdIn	String	Filter by Global IP Assignment ID(s) separated by commas	[optional]
filterGlobalIpIdIn	String	Filter by Global IP ID(s), separated by commas	[optional]
filterTimestampGt	OffsetDateTime	Filter by timestamp greater than	[optional]
filterTimestampLt	OffsetDateTime	Filter by timestamp less than	[optional]

Return type

GetGlobalIpAssignmentUsage200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

getGlobalIpHealthCheck

CreateGlobalIpHealthCheck202Response getGlobalIpHealthCheck(id)

Retrieve a Global IP health check

Retrieve a Global IP health check.

Example

import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
        try {
            CreateGlobalIpHealthCheck202Response result = apiInstance.getGlobalIpHealthCheck(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#getGlobalIpHealthCheck");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	UUID	Identifies the resource.

Return type

CreateGlobalIpHealthCheck202Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

getGlobalIpLatency

GetGlobalIpLatency200Response getGlobalIpLatency(filterGlobalIpIdIn, filterTimestampGt, filterTimestampLt)

Example

import java.time.OffsetDateTime;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        String filterGlobalIpIdIn = "filterGlobalIpIdIn_example"; // String | Filter by Global IP ID(s) separated by commas
        OffsetDateTime filterTimestampGt = OffsetDateTime.parse("2019-01-01T00:00Z"); // OffsetDateTime | Filter by timestamp greater than
        OffsetDateTime filterTimestampLt = OffsetDateTime.parse("2019-01-01T00:00Z"); // OffsetDateTime | Filter by timestamp less than
        try {
            GetGlobalIpLatency200Response result = apiInstance.getGlobalIpLatency(filterGlobalIpIdIn, filterTimestampGt, filterTimestampLt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#getGlobalIpLatency");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
filterGlobalIpIdIn	String	Filter by Global IP ID(s) separated by commas	[optional]
filterTimestampGt	OffsetDateTime	Filter by timestamp greater than	[optional]
filterTimestampLt	OffsetDateTime	Filter by timestamp less than	[optional]

Return type

GetGlobalIpLatency200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

getGlobalIpUsage

GetGlobalIpUsage200Response getGlobalIpUsage(filterGlobalIpIdIn, filterTimestampGt, filterTimestampLt)

Example

import java.time.OffsetDateTime;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        String filterGlobalIpIdIn = "filterGlobalIpIdIn_example"; // String | Filter by Global IP ID(s) separated by commas
        OffsetDateTime filterTimestampGt = OffsetDateTime.parse("2019-01-01T00:00Z"); // OffsetDateTime | Filter by timestamp greater than
        OffsetDateTime filterTimestampLt = OffsetDateTime.parse("2019-01-01T00:00Z"); // OffsetDateTime | Filter by timestamp less than
        try {
            GetGlobalIpUsage200Response result = apiInstance.getGlobalIpUsage(filterGlobalIpIdIn, filterTimestampGt, filterTimestampLt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#getGlobalIpUsage");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
filterGlobalIpIdIn	String	Filter by Global IP ID(s) separated by commas	[optional]
filterTimestampGt	OffsetDateTime	Filter by timestamp greater than	[optional]
filterTimestampLt	OffsetDateTime	Filter by timestamp less than	[optional]

Return type

GetGlobalIpUsage200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

listGlobalIpAllowedPorts

ListGlobalIpAllowedPorts200Response listGlobalIpAllowedPorts()

List all Global IP Allowed Ports

Example

// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        try {
            ListGlobalIpAllowedPorts200Response result = apiInstance.listGlobalIpAllowedPorts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#listGlobalIpAllowedPorts");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

ListGlobalIpAllowedPorts200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

listGlobalIpAssignments

ListGlobalIpAssignments200Response listGlobalIpAssignments(pageNumber, pageSize)

List all Global IP assignments

List all Global IP assignments.

Example

// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        Integer pageNumber = 1; // Integer | The page number to load
        Integer pageSize = 20; // Integer | The size of the page
        try {
            ListGlobalIpAssignments200Response result = apiInstance.listGlobalIpAssignments(pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#listGlobalIpAssignments");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
pageNumber	Integer	The page number to load	[optional] [default to 1]
pageSize	Integer	The size of the page	[optional] [default to 20]

Return type

ListGlobalIpAssignments200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

listGlobalIpHealthCheckTypes

ListGlobalIpHealthCheckTypes200Response listGlobalIpHealthCheckTypes()

List all Global IP Health check types

List all Global IP Health check types.

Example

// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        try {
            ListGlobalIpHealthCheckTypes200Response result = apiInstance.listGlobalIpHealthCheckTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#listGlobalIpHealthCheckTypes");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

ListGlobalIpHealthCheckTypes200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

listGlobalIpHealthChecks

ListGlobalIpHealthChecks200Response listGlobalIpHealthChecks(pageNumber, pageSize)

List all Global IP health checks

List all Global IP health checks.

Example

// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        Integer pageNumber = 1; // Integer | The page number to load
        Integer pageSize = 20; // Integer | The size of the page
        try {
            ListGlobalIpHealthChecks200Response result = apiInstance.listGlobalIpHealthChecks(pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#listGlobalIpHealthChecks");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
pageNumber	Integer	The page number to load	[optional] [default to 1]
pageSize	Integer	The size of the page	[optional] [default to 20]

Return type

ListGlobalIpHealthChecks200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

listGlobalIpProtocols

ListGlobalIpProtocols200Response listGlobalIpProtocols()

List all Global IP Protocols

Example

// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        try {
            ListGlobalIpProtocols200Response result = apiInstance.listGlobalIpProtocols();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#listGlobalIpProtocols");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

ListGlobalIpProtocols200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

listGlobalIps

ListGlobalIps200Response listGlobalIps(pageNumber, pageSize)

List all Global IPs

List all Global IPs.

Example

// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        Integer pageNumber = 1; // Integer | The page number to load
        Integer pageSize = 20; // Integer | The size of the page
        try {
            ListGlobalIps200Response result = apiInstance.listGlobalIps(pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#listGlobalIps");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
pageNumber	Integer	The page number to load	[optional] [default to 1]
pageSize	Integer	The size of the page	[optional] [default to 20]

Return type

ListGlobalIps200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

updateGlobalIpAssignment

CreateGlobalIpAssignment202Response updateGlobalIpAssignment(id, globalIpAssignmentUpdate)

Update a Global IP assignment

Update a Global IP assignment.

Example

import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.GlobalIpsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GlobalIpsApi apiInstance = new GlobalIpsApi(defaultClient);
        UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
        GlobalIpAssignmentUpdate globalIpAssignmentUpdate = new GlobalIpAssignmentUpdate(); // GlobalIpAssignmentUpdate | 
        try {
            CreateGlobalIpAssignment202Response result = apiInstance.updateGlobalIpAssignment(id, globalIpAssignmentUpdate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalIpsApi#updateGlobalIpAssignment");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	UUID	Identifies the resource.
globalIpAssignmentUpdate	GlobalIpAssignmentUpdate

Return type

CreateGlobalIpAssignment202Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

Files

GlobalIpsApi.md

Latest commit

History

GlobalIpsApi.md

File metadata and controls

GlobalIpsApi

createGlobalIp

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createGlobalIpAssignment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createGlobalIpHealthCheck

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteGlobalIp

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteGlobalIpAssignment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteGlobalIpHealthCheck

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getGlobalIp

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getGlobalIpAssignment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getGlobalIpAssignmentHealth

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getGlobalIpAssignmentUsage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getGlobalIpHealthCheck

Example

Parameters