<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Networking - Java

Installation

<!-- Maven -->
<dependency>
    <groupId>com.telnyx.sdk</groupId>
    <artifactId>telnyx</artifactId>
    <version>6.89.0</version>
</dependency>

// Gradle
implementation("com.telnyx.sdk:telnyx:6.89.0")

Setup

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

TelnyxClient client = TelnyxOkHttpClient.fromEnv();

All examples below assume client is already initialized as shown above.

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

import com.telnyx.sdk.errors.TelnyxServiceException;

try {
    var result = client.messages().send(params);
} catch (TelnyxServiceException e) {
    System.err.println("API error " + e.statusCode() + ": " + e.getMessage());
    if (e.statusCode() == 422) {
        System.err.println("Validation error — check required fields and formats");
    } else if (e.statusCode() == 429) {
        // Rate limited — wait and retry with exponential backoff
        Thread.sleep(1000);
    }
}

Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).

Important Notes

• Pagination: List methods return a page. Use .autoPager() for automatic iteration: for (var item : page.autoPager()) { ... }. For manual control, use .hasNextPage() and .nextPage().

List all clusters

GET /ai/clusters

import com.telnyx.sdk.models.ai.clusters.ClusterListPage;
import com.telnyx.sdk.models.ai.clusters.ClusterListParams;

ClusterListPage page = client.ai().clusters().list();

Returns: bucket (string), createdat (date-time), finishedat (date-time), minclustersize (integer), minsubclustersize (integer), status (enum: pending, starting, running, completed, failed), task_id (string)

Compute new clusters

Starts a background task to compute how the data in an embedded storage bucket is clustered. This helps identify common themes and patterns in the data.

POST /ai/clusters — Required: bucket

Optional: files (array[string]), minclustersize (integer), minsubclustersize (integer), prefix (string)

import com.telnyx.sdk.models.ai.clusters.ClusterComputeParams;
import com.telnyx.sdk.models.ai.clusters.ClusterComputeResponse;

ClusterComputeParams params = ClusterComputeParams.builder()
    .bucket("my-bucket")
    .build();
ClusterComputeResponse response = client.ai().clusters().compute(params);

Returns: task_id (string)

Fetch a cluster

GET /ai/clusters/{task_id}

import com.telnyx.sdk.models.ai.clusters.ClusterRetrieveParams;
import com.telnyx.sdk.models.ai.clusters.ClusterRetrieveResponse;

ClusterRetrieveResponse cluster = client.ai().clusters().retrieve("550e8400-e29b-41d4-a716-446655440000");

Returns: bucket (string), clusters (array[object]), status (enum: pending, starting, running, completed, failed)

Delete a cluster

DELETE /ai/clusters/{task_id}

import com.telnyx.sdk.models.ai.clusters.ClusterDeleteParams;

client.ai().clusters().delete("550e8400-e29b-41d4-a716-446655440000");

Fetch a cluster visualization

GET /ai/clusters/{task_id}/graph

import com.telnyx.sdk.core.http.HttpResponse;
import com.telnyx.sdk.models.ai.clusters.ClusterFetchGraphParams;

HttpResponse response = client.ai().clusters().fetchGraph("550e8400-e29b-41d4-a716-446655440000");

List Integrations

List all available integrations.

GET /ai/integrations

import com.telnyx.sdk.models.ai.integrations.IntegrationListParams;
import com.telnyx.sdk.models.ai.integrations.IntegrationListResponse;

IntegrationListResponse integrations = client.ai().integrations().list();

Returns: availabletools (array[string]), description (string), displayname (string), id (string), logo_url (string), name (string), status (enum: disconnected, connected)

List User Integrations

List user setup integrations

GET /ai/integrations/connections

import com.telnyx.sdk.models.ai.integrations.connections.ConnectionListParams;
import com.telnyx.sdk.models.ai.integrations.connections.ConnectionListResponse;

ConnectionListResponse connections = client.ai().integrations().connections().list();

Returns: allowedtools (array[string]), id (string), integrationid (string)

Get User Integration connection By Id

Get user setup integrations

GET /ai/integrations/connections/{userconnectionid}

import com.telnyx.sdk.models.ai.integrations.connections.ConnectionRetrieveParams;
import com.telnyx.sdk.models.ai.integrations.connections.ConnectionRetrieveResponse;

ConnectionRetrieveResponse connection = client.ai().integrations().connections().retrieve("550e8400-e29b-41d4-a716-446655440000");

Returns: allowedtools (array[string]), id (string), integrationid (string)

Delete Integration Connection

Delete a specific integration connection.

DELETE /ai/integrations/connections/{userconnectionid}

import com.telnyx.sdk.models.ai.integrations.connections.ConnectionDeleteParams;

client.ai().integrations().connections().delete("550e8400-e29b-41d4-a716-446655440000");

List Integration By Id

Retrieve integration details

GET /ai/integrations/{integration_id}

import com.telnyx.sdk.models.ai.integrations.IntegrationRetrieveParams;
import com.telnyx.sdk.models.ai.integrations.IntegrationRetrieveResponse;

IntegrationRetrieveResponse integration = client.ai().integrations().retrieve("550e8400-e29b-41d4-a716-446655440000");

Returns: availabletools (array[string]), description (string), displayname (string), id (string), logo_url (string), name (string), status (enum: disconnected, connected)

List all Global IP Allowed Ports

GET /globalipallowed_ports

import com.telnyx.sdk.models.globalipallowedports.GlobalIpAllowedPortListParams;
import com.telnyx.sdk.models.globalipallowedports.GlobalIpAllowedPortListResponse;

GlobalIpAllowedPortListResponse globalIpAllowedPorts = client.globalIpAllowedPorts().list();

Returns: firstport (integer), id (uuid), lastport (integer), name (string), protocolcode (string), recordtype (string)

Global IP Assignment Health Check Metrics

GET /globalipassignment_health

import com.telnyx.sdk.models.globalipassignmenthealth.GlobalIpAssignmentHealthRetrieveParams;
import com.telnyx.sdk.models.globalipassignmenthealth.GlobalIpAssignmentHealthRetrieveResponse;

GlobalIpAssignmentHealthRetrieveResponse globalIpAssignmentHealth = client.globalIpAssignmentHealth().retrieve();

Returns: globalip (object), globalip_assignment (object), health (object), timestamp (date-time)

List all Global IP assignments

List all Global IP assignments.

GET /globalipassignments

import com.telnyx.sdk.models.globalipassignments.GlobalIpAssignmentListPage;
import com.telnyx.sdk.models.globalipassignments.GlobalIpAssignmentListParams;

GlobalIpAssignmentListPage page = client.globalIpAssignments().list();

Returns: createdat (string), globalipid (uuid), id (uuid), isannounced (boolean), isconnected (boolean), isinmaintenance (boolean), recordtype (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string), wireguardpeer_id (uuid)

Create a Global IP assignment

Create a Global IP assignment.

POST /globalipassignments

Optional: createdat (string), globalipid (uuid), id (uuid), isannounced (boolean), isconnected (boolean), isinmaintenance (boolean), recordtype (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string), wireguardpeer_id (uuid)

import com.telnyx.sdk.models.globalipassignments.GlobalIpAssignment;
import com.telnyx.sdk.models.globalipassignments.GlobalIpAssignmentCreateResponse;

GlobalIpAssignment params = GlobalIpAssignment.builder().build();
GlobalIpAssignmentCreateResponse globalIpAssignment = client.globalIpAssignments().create(params);

Returns: createdat (string), globalipid (uuid), id (uuid), isannounced (boolean), isconnected (boolean), isinmaintenance (boolean), recordtype (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string), wireguardpeer_id (uuid)

Retrieve a Global IP

Retrieve a Global IP assignment.

GET /globalipassignments/{id}

import com.telnyx.sdk.models.globalipassignments.GlobalIpAssignmentRetrieveParams;
import com.telnyx.sdk.models.globalipassignments.GlobalIpAssignmentRetrieveResponse;

GlobalIpAssignmentRetrieveResponse globalIpAssignment = client.globalIpAssignments().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), globalipid (uuid), id (uuid), isannounced (boolean), isconnected (boolean), isinmaintenance (boolean), recordtype (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string), wireguardpeer_id (uuid)

Update a Global IP assignment

Update a Global IP assignment.

PATCH /globalipassignments/{id}

Optional: createdat (string), globalipid (string), id (uuid), isannounced (boolean), isconnected (boolean), isinmaintenance (boolean), recordtype (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string), wireguardpeer_id (string)

import com.telnyx.sdk.models.globalipassignments.GlobalIpAssignmentUpdateParams;
import com.telnyx.sdk.models.globalipassignments.GlobalIpAssignmentUpdateResponse;

GlobalIpAssignmentUpdateResponse globalIpAssignment = client.globalIpAssignments().update("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), globalipid (uuid), id (uuid), isannounced (boolean), isconnected (boolean), isinmaintenance (boolean), recordtype (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string), wireguardpeer_id (uuid)

Delete a Global IP assignment

Delete a Global IP assignment.

DELETE /globalipassignments/{id}

import com.telnyx.sdk.models.globalipassignments.GlobalIpAssignmentDeleteParams;
import com.telnyx.sdk.models.globalipassignments.GlobalIpAssignmentDeleteResponse;

GlobalIpAssignmentDeleteResponse globalIpAssignment = client.globalIpAssignments().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), globalipid (uuid), id (uuid), isannounced (boolean), isconnected (boolean), isinmaintenance (boolean), recordtype (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string), wireguardpeer_id (uuid)

Global IP Assignment Usage Metrics

GET /globalipassignments_usage

import com.telnyx.sdk.models.globalipassignmentsusage.GlobalIpAssignmentsUsageRetrieveParams;
import com.telnyx.sdk.models.globalipassignmentsusage.GlobalIpAssignmentsUsageRetrieveResponse;

GlobalIpAssignmentsUsageRetrieveResponse globalIpAssignmentsUsage = client.globalIpAssignmentsUsage().retrieve();

Returns: globalip (object), globalip_assignment (object), received (object), timestamp (date-time), transmitted (object)

List all Global IP Health check types

List all Global IP Health check types.

GET /globaliphealthchecktypes

import com.telnyx.sdk.models.globaliphealthchecktypes.GlobalIpHealthCheckTypeListParams;
import com.telnyx.sdk.models.globaliphealthchecktypes.GlobalIpHealthCheckTypeListResponse;

GlobalIpHealthCheckTypeListResponse globalIpHealthCheckTypes = client.globalIpHealthCheckTypes().list();

Returns: healthcheckparams (object), healthchecktype (string), record_type (string)

List all Global IP health checks

List all Global IP health checks.

GET /globaliphealth_checks

import com.telnyx.sdk.models.globaliphealthchecks.GlobalIpHealthCheckListPage;
import com.telnyx.sdk.models.globaliphealthchecks.GlobalIpHealthCheckListParams;

GlobalIpHealthCheckListPage page = client.globalIpHealthChecks().list();

Returns: createdat (string), globalipid (uuid), healthcheckparams (object), healthchecktype (string), id (uuid), recordtype (string), updated_at (string)

Create a Global IP health check

Create a Global IP health check.

POST /globaliphealth_checks

Optional: createdat (string), globalipid (uuid), healthcheckparams (object), healthchecktype (string), id (uuid), recordtype (string), updated_at (string)

import com.telnyx.sdk.models.globaliphealthchecks.GlobalIpHealthCheckCreateParams;
import com.telnyx.sdk.models.globaliphealthchecks.GlobalIpHealthCheckCreateResponse;

GlobalIpHealthCheckCreateResponse globalIpHealthCheck = client.globalIpHealthChecks().create();

Returns: createdat (string), globalipid (uuid), healthcheckparams (object), healthchecktype (string), id (uuid), recordtype (string), updated_at (string)

Retrieve a Global IP health check

Retrieve a Global IP health check.

GET /globaliphealth_checks/{id}

import com.telnyx.sdk.models.globaliphealthchecks.GlobalIpHealthCheckRetrieveParams;
import com.telnyx.sdk.models.globaliphealthchecks.GlobalIpHealthCheckRetrieveResponse;

GlobalIpHealthCheckRetrieveResponse globalIpHealthCheck = client.globalIpHealthChecks().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), globalipid (uuid), healthcheckparams (object), healthchecktype (string), id (uuid), recordtype (string), updated_at (string)

Delete a Global IP health check

Delete a Global IP health check.

DELETE /globaliphealth_checks/{id}

import com.telnyx.sdk.models.globaliphealthchecks.GlobalIpHealthCheckDeleteParams;
import com.telnyx.sdk.models.globaliphealthchecks.GlobalIpHealthCheckDeleteResponse;

GlobalIpHealthCheckDeleteResponse globalIpHealthCheck = client.globalIpHealthChecks().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), globalipid (uuid), healthcheckparams (object), healthchecktype (string), id (uuid), recordtype (string), updated_at (string)

Global IP Latency Metrics

GET /globaliplatency

import com.telnyx.sdk.models.globaliplatency.GlobalIpLatencyRetrieveParams;
import com.telnyx.sdk.models.globaliplatency.GlobalIpLatencyRetrieveResponse;

GlobalIpLatencyRetrieveResponse globalIpLatency = client.globalIpLatency().retrieve();

Returns: globalip (object), meanlatency (object), percentilelatency (object), proberlocation (object), timestamp (date-time)

List all Global IP Protocols

GET /globalipprotocols

import com.telnyx.sdk.models.globalipprotocols.GlobalIpProtocolListParams;
import com.telnyx.sdk.models.globalipprotocols.GlobalIpProtocolListResponse;

GlobalIpProtocolListResponse globalIpProtocols = client.globalIpProtocols().list();

Returns: code (string), name (string), record_type (string)

Global IP Usage Metrics

GET /globalipusage

import com.telnyx.sdk.models.globalipusage.GlobalIpUsageRetrieveParams;
import com.telnyx.sdk.models.globalipusage.GlobalIpUsageRetrieveResponse;

GlobalIpUsageRetrieveResponse globalIpUsage = client.globalIpUsage().retrieve();

Returns: global_ip (object), received (object), timestamp (date-time), transmitted (object)

List all Global IPs

List all Global IPs.

GET /global_ips

import com.telnyx.sdk.models.globalips.GlobalIpListPage;
import com.telnyx.sdk.models.globalips.GlobalIpListParams;

GlobalIpListPage page = client.globalIps().list();

Returns: createdat (string), description (string), id (uuid), ipaddress (string), name (string), ports (object), recordtype (string), updatedat (string)

Create a Global IP

Create a Global IP.

POST /global_ips

Optional: createdat (string), description (string), id (uuid), ipaddress (string), name (string), ports (object), recordtype (string), updatedat (string)

import com.telnyx.sdk.models.globalips.GlobalIpCreateParams;
import com.telnyx.sdk.models.globalips.GlobalIpCreateResponse;

GlobalIpCreateResponse globalIp = client.globalIps().create();

Returns: createdat (string), description (string), id (uuid), ipaddress (string), name (string), ports (object), recordtype (string), updatedat (string)

Retrieve a Global IP

Retrieve a Global IP.

GET /global_ips/{id}

import com.telnyx.sdk.models.globalips.GlobalIpRetrieveParams;
import com.telnyx.sdk.models.globalips.GlobalIpRetrieveResponse;

GlobalIpRetrieveResponse globalIp = client.globalIps().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), description (string), id (uuid), ipaddress (string), name (string), ports (object), recordtype (string), updatedat (string)

Delete a Global IP

Delete a Global IP.

DELETE /global_ips/{id}

import com.telnyx.sdk.models.globalips.GlobalIpDeleteParams;
import com.telnyx.sdk.models.globalips.GlobalIpDeleteResponse;

GlobalIpDeleteResponse globalIp = client.globalIps().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), description (string), id (uuid), ipaddress (string), name (string), ports (object), recordtype (string), updatedat (string)

List all Networks

List all Networks.

GET /networks

import com.telnyx.sdk.models.networks.NetworkListPage;
import com.telnyx.sdk.models.networks.NetworkListParams;

NetworkListPage page = client.networks().list();

Returns: createdat (string), id (uuid), name (string), recordtype (string), updated_at (string)

Create a Network

Create a new Network.

POST /networks — Required: name

Optional: createdat (string), id (uuid), recordtype (string), updated_at (string)

import com.telnyx.sdk.models.networks.NetworkCreate;
import com.telnyx.sdk.models.networks.NetworkCreateResponse;

NetworkCreate params = NetworkCreate.builder()
    .name("test network")
    .build();
NetworkCreateResponse network = client.networks().create(params);

Returns: createdat (string), id (uuid), name (string), recordtype (string), updated_at (string)

Retrieve a Network

Retrieve a Network.

GET /networks/{id}

import com.telnyx.sdk.models.networks.NetworkRetrieveParams;
import com.telnyx.sdk.models.networks.NetworkRetrieveResponse;

NetworkRetrieveResponse network = client.networks().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), id (uuid), name (string), recordtype (string), updated_at (string)

Update a Network

Update a Network.

PATCH /networks/{id} — Required: name

Optional: createdat (string), id (uuid), recordtype (string), updated_at (string)

import com.telnyx.sdk.models.networks.NetworkCreate;
import com.telnyx.sdk.models.networks.NetworkUpdateParams;
import com.telnyx.sdk.models.networks.NetworkUpdateResponse;

NetworkUpdateParams params = NetworkUpdateParams.builder()
    .networkId("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
    .networkCreate(NetworkCreate.builder()
        .name("test network")
        .build())
    .build();
NetworkUpdateResponse network = client.networks().update(params);

Returns: createdat (string), id (uuid), name (string), recordtype (string), updated_at (string)

Delete a Network

Delete a Network.

DELETE /networks/{id}

import com.telnyx.sdk.models.networks.NetworkDeleteParams;
import com.telnyx.sdk.models.networks.NetworkDeleteResponse;

NetworkDeleteResponse network = client.networks().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), id (uuid), name (string), recordtype (string), updated_at (string)

Get Default Gateway status.

GET /networks/{id}/default_gateway

import com.telnyx.sdk.models.networks.defaultgateway.DefaultGatewayRetrieveParams;
import com.telnyx.sdk.models.networks.defaultgateway.DefaultGatewayRetrieveResponse;

DefaultGatewayRetrieveResponse defaultGateway = client.networks().defaultGateway().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), id (uuid), networkid (uuid), recordtype (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string), wireguardpeerid (uuid)

Create Default Gateway.

POST /networks/{id}/default_gateway

Optional: createdat (string), id (uuid), networkid (uuid), recordtype (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string), wireguardpeerid (uuid)

import com.telnyx.sdk.models.networks.defaultgateway.DefaultGatewayCreateParams;
import com.telnyx.sdk.models.networks.defaultgateway.DefaultGatewayCreateResponse;

DefaultGatewayCreateResponse defaultGateway = client.networks().defaultGateway().create("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), id (uuid), networkid (uuid), recordtype (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string), wireguardpeerid (uuid)

Delete Default Gateway.

DELETE /networks/{id}/default_gateway

import com.telnyx.sdk.models.networks.defaultgateway.DefaultGatewayDeleteParams;
import com.telnyx.sdk.models.networks.defaultgateway.DefaultGatewayDeleteResponse;

DefaultGatewayDeleteResponse defaultGateway = client.networks().defaultGateway().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), id (uuid), networkid (uuid), recordtype (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string), wireguardpeerid (uuid)

List all Interfaces for a Network.

GET /networks/{id}/network_interfaces

import com.telnyx.sdk.models.networks.NetworkListInterfacesPage;
import com.telnyx.sdk.models.networks.NetworkListInterfacesParams;

NetworkListInterfacesPage page = client.networks().listInterfaces("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), id (uuid), name (string), networkid (uuid), recordtype (string), region (object), regioncode (string), status (enum: created, provisioning, provisioned, deleting), type (string), updated_at (string)

Get all Private Wireless Gateways

Get all Private Wireless Gateways belonging to the user.

GET /privatewirelessgateways

import com.telnyx.sdk.models.privatewirelessgateways.PrivateWirelessGatewayListPage;
import com.telnyx.sdk.models.privatewirelessgateways.PrivateWirelessGatewayListParams;

PrivateWirelessGatewayListPage page = client.privateWirelessGateways().list();

Returns: assignedresources (array[object]), createdat (string), id (uuid), iprange (string), name (string), networkid (uuid), recordtype (string), regioncode (string), status (object), updated_at (string)

Create a Private Wireless Gateway

Asynchronously create a Private Wireless Gateway for SIM cards for a previously created network. This operation may take several minutes so you can check the Private Wireless Gateway status at the section Get a Private Wireless Gateway.

POST /privatewirelessgateways — Required: network_id, name

Optional: region_code (string)

import com.telnyx.sdk.models.privatewirelessgateways.PrivateWirelessGatewayCreateParams;
import com.telnyx.sdk.models.privatewirelessgateways.PrivateWirelessGatewayCreateResponse;

PrivateWirelessGatewayCreateParams params = PrivateWirelessGatewayCreateParams.builder()
    .name("My private wireless gateway")
    .networkId("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
    .build();
PrivateWirelessGatewayCreateResponse privateWirelessGateway = client.privateWirelessGateways().create(params);

Returns: assignedresources (array[object]), createdat (string), id (uuid), iprange (string), name (string), networkid (uuid), recordtype (string), regioncode (string), status (object), updated_at (string)

Get a Private Wireless Gateway

Retrieve information about a Private Wireless Gateway.

GET /privatewirelessgateways/{id}

import com.telnyx.sdk.models.privatewirelessgateways.PrivateWirelessGatewayRetrieveParams;
import com.telnyx.sdk.models.privatewirelessgateways.PrivateWirelessGatewayRetrieveResponse;

PrivateWirelessGatewayRetrieveResponse privateWirelessGateway = client.privateWirelessGateways().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: assignedresources (array[object]), createdat (string), id (uuid), iprange (string), name (string), networkid (uuid), recordtype (string), regioncode (string), status (object), updated_at (string)

Delete a Private Wireless Gateway

Deletes the Private Wireless Gateway.

DELETE /privatewirelessgateways/{id}

import com.telnyx.sdk.models.privatewirelessgateways.PrivateWirelessGatewayDeleteParams;
import com.telnyx.sdk.models.privatewirelessgateways.PrivateWirelessGatewayDeleteResponse;

PrivateWirelessGatewayDeleteResponse privateWirelessGateway = client.privateWirelessGateways().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: assignedresources (array[object]), createdat (string), id (uuid), iprange (string), name (string), networkid (uuid), recordtype (string), regioncode (string), status (object), updated_at (string)

List all Public Internet Gateways

List all Public Internet Gateways.

GET /publicinternetgateways

import com.telnyx.sdk.models.publicinternetgateways.PublicInternetGatewayListPage;
import com.telnyx.sdk.models.publicinternetgateways.PublicInternetGatewayListParams;

PublicInternetGatewayListPage page = client.publicInternetGateways().list();

Returns: createdat (string), id (uuid), name (string), networkid (uuid), publicip (string), recordtype (string), regioncode (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string)

Create a Public Internet Gateway

Create a new Public Internet Gateway.

POST /publicinternetgateways

Optional: createdat (string), id (uuid), name (string), networkid (uuid), publicip (string), recordtype (string), regioncode (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string)

import com.telnyx.sdk.models.publicinternetgateways.PublicInternetGatewayCreateParams;
import com.telnyx.sdk.models.publicinternetgateways.PublicInternetGatewayCreateResponse;

PublicInternetGatewayCreateResponse publicInternetGateway = client.publicInternetGateways().create();

Returns: createdat (string), id (uuid), name (string), networkid (uuid), publicip (string), recordtype (string), regioncode (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string)

Retrieve a Public Internet Gateway

Retrieve a Public Internet Gateway.

GET /publicinternetgateways/{id}

import com.telnyx.sdk.models.publicinternetgateways.PublicInternetGatewayRetrieveParams;
import com.telnyx.sdk.models.publicinternetgateways.PublicInternetGatewayRetrieveResponse;

PublicInternetGatewayRetrieveResponse publicInternetGateway = client.publicInternetGateways().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), id (uuid), name (string), networkid (uuid), publicip (string), recordtype (string), regioncode (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string)

Delete a Public Internet Gateway

Delete a Public Internet Gateway.

DELETE /publicinternetgateways/{id}

import com.telnyx.sdk.models.publicinternetgateways.PublicInternetGatewayDeleteParams;
import com.telnyx.sdk.models.publicinternetgateways.PublicInternetGatewayDeleteResponse;

PublicInternetGatewayDeleteResponse publicInternetGateway = client.publicInternetGateways().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), id (uuid), name (string), networkid (uuid), publicip (string), recordtype (string), regioncode (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string)

List all Regions

List all regions and the interfaces that region supports

GET /regions

import com.telnyx.sdk.models.regions.RegionListParams;
import com.telnyx.sdk.models.regions.RegionListResponse;

RegionListResponse regions = client.regions().list();

Returns: code (string), createdat (string), name (string), recordtype (string), supportedinterfaces (array[string]), updatedat (string)

List all Virtual Cross Connects

List all Virtual Cross Connects.

GET /virtualcrossconnects

import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectListPage;
import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectListParams;

VirtualCrossConnectListPage page = client.virtualCrossConnects().list();

Returns: bandwidthmbps (number), bgpasn (number), cloudprovider (enum: aws, azure, gce), cloudproviderregion (string), createdat (string), id (uuid), name (string), networkid (uuid), primarybgpkey (string), primarycloudaccountid (string), primarycloudip (string), primaryenabled (boolean), primaryroutingannouncement (boolean), primarytelnyxip (string), recordtype (string), region (object), regioncode (string), secondarybgpkey (string), secondarycloudaccountid (string), secondarycloudip (string), secondaryenabled (boolean), secondaryroutingannouncement (boolean), secondarytelnyxip (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string)

Create a Virtual Cross Connect

Create a new Virtual Cross Connect. For AWS and GCE, you have the option of creating the primary connection first and the secondary connection later. You also have the option of disabling the primary and/or secondary connections at any time and later re-enabling them. With Azure, you do not have this option.

POST /virtualcrossconnects — Required: networkid, regioncode, cloudprovider, cloudproviderregion, bgpasn, primarycloudaccount_id

Optional: bandwidthmbps (number), createdat (string), id (uuid), name (string), primarybgpkey (string), primarycloudip (string), primaryenabled (boolean), primarytelnyxip (string), recordtype (string), secondarybgpkey (string), secondarycloudaccountid (string), secondarycloudip (string), secondaryenabled (boolean), secondarytelnyxip (string), status (enum: created, provisioning, provisioned, deleting), updated_at (string)

import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectCreateParams;
import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectCreateResponse;

VirtualCrossConnectCreateParams params = VirtualCrossConnectCreateParams.builder()
    .regionCode("ashburn-va")
    .build();
VirtualCrossConnectCreateResponse virtualCrossConnect = client.virtualCrossConnects().create(params);

Returns: bandwidthmbps (number), bgpasn (number), cloudprovider (enum: aws, azure, gce), cloudproviderregion (string), createdat (string), id (uuid), name (string), networkid (uuid), primarybgpkey (string), primarycloudaccountid (string), primarycloudip (string), primaryenabled (boolean), primaryroutingannouncement (boolean), primarytelnyxip (string), recordtype (string), region (object), regioncode (string), secondarybgpkey (string), secondarycloudaccountid (string), secondarycloudip (string), secondaryenabled (boolean), secondaryroutingannouncement (boolean), secondarytelnyxip (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string)

Retrieve a Virtual Cross Connect

Retrieve a Virtual Cross Connect.

GET /virtualcrossconnects/{id}

import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectRetrieveParams;
import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectRetrieveResponse;

VirtualCrossConnectRetrieveResponse virtualCrossConnect = client.virtualCrossConnects().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: bandwidthmbps (number), bgpasn (number), cloudprovider (enum: aws, azure, gce), cloudproviderregion (string), createdat (string), id (uuid), name (string), networkid (uuid), primarybgpkey (string), primarycloudaccountid (string), primarycloudip (string), primaryenabled (boolean), primaryroutingannouncement (boolean), primarytelnyxip (string), recordtype (string), region (object), regioncode (string), secondarybgpkey (string), secondarycloudaccountid (string), secondarycloudip (string), secondaryenabled (boolean), secondaryroutingannouncement (boolean), secondarytelnyxip (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string)

Update the Virtual Cross Connect

Update the Virtual Cross Connect. Cloud IPs can only be patched during the created state, as GCE will only inform you of your generated IP once the pending connection requested has been accepted.

PATCH /virtualcrossconnects/{id}

Optional: primarycloudip (string), primaryenabled (boolean), primaryroutingannouncement (boolean), secondarycloudip (string), secondaryenabled (boolean), secondaryroutingannouncement (boolean)

import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectUpdateParams;
import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectUpdateResponse;

VirtualCrossConnectUpdateResponse virtualCrossConnect = client.virtualCrossConnects().update("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: bandwidthmbps (number), bgpasn (number), cloudprovider (enum: aws, azure, gce), cloudproviderregion (string), createdat (string), id (uuid), name (string), networkid (uuid), primarybgpkey (string), primarycloudaccountid (string), primarycloudip (string), primaryenabled (boolean), primaryroutingannouncement (boolean), primarytelnyxip (string), recordtype (string), region (object), regioncode (string), secondarybgpkey (string), secondarycloudaccountid (string), secondarycloudip (string), secondaryenabled (boolean), secondaryroutingannouncement (boolean), secondarytelnyxip (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string)

Delete a Virtual Cross Connect

Delete a Virtual Cross Connect.

DELETE /virtualcrossconnects/{id}

import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectDeleteParams;
import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectDeleteResponse;

VirtualCrossConnectDeleteResponse virtualCrossConnect = client.virtualCrossConnects().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: bandwidthmbps (number), bgpasn (number), cloudprovider (enum: aws, azure, gce), cloudproviderregion (string), createdat (string), id (uuid), name (string), networkid (uuid), primarybgpkey (string), primarycloudaccountid (string), primarycloudip (string), primaryenabled (boolean), primaryroutingannouncement (boolean), primarytelnyxip (string), recordtype (string), region (object), regioncode (string), secondarybgpkey (string), secondarycloudaccountid (string), secondarycloudip (string), secondaryenabled (boolean), secondaryroutingannouncement (boolean), secondarytelnyxip (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string)

List Virtual Cross Connect Cloud Coverage

List Virtual Cross Connects Cloud Coverage. This endpoint shows which cloud regions are available for the location_code your Virtual Cross Connect will be provisioned in.

GET /virtualcrossconnects_coverage

import com.telnyx.sdk.models.virtualcrossconnectscoverage.VirtualCrossConnectsCoverageListPage;
import com.telnyx.sdk.models.virtualcrossconnectscoverage.VirtualCrossConnectsCoverageListParams;

VirtualCrossConnectsCoverageListPage page = client.virtualCrossConnectsCoverage().list();

Returns: availablebandwidth (array[number]), cloudprovider (enum: aws, azure, gce), cloudproviderregion (string), location (object), record_type (string)

List all WireGuard Interfaces

List all WireGuard Interfaces.

GET /wireguard_interfaces

import com.telnyx.sdk.models.wireguardinterfaces.WireguardInterfaceListPage;
import com.telnyx.sdk.models.wireguardinterfaces.WireguardInterfaceListParams;

WireguardInterfaceListPage page = client.wireguardInterfaces().list();

Returns: createdat (string), enablesiptrunking (boolean), endpoint (string), id (uuid), name (string), networkid (uuid), publickey (string), recordtype (string), region (object), regioncode (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string)

Create a WireGuard Interface

Create a new WireGuard Interface. Current limitation of 10 interfaces per user can be created.

POST /wireguardinterfaces — Required: networkid, region_code

Optional: createdat (string), enablesiptrunking (boolean), endpoint (string), id (uuid), name (string), publickey (string), recordtype (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string)

import com.telnyx.sdk.models.wireguardinterfaces.WireguardInterfaceCreateParams;
import com.telnyx.sdk.models.wireguardinterfaces.WireguardInterfaceCreateResponse;

WireguardInterfaceCreateResponse wireguardInterface = client.wireguardInterfaces().create();

Returns: createdat (string), enablesiptrunking (boolean), endpoint (string), id (uuid), name (string), networkid (uuid), publickey (string), recordtype (string), region (object), regioncode (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string)

Retrieve a WireGuard Interfaces

Retrieve a WireGuard Interfaces.

GET /wireguard_interfaces/{id}

import com.telnyx.sdk.models.wireguardinterfaces.WireguardInterfaceRetrieveParams;
import com.telnyx.sdk.models.wireguardinterfaces.WireguardInterfaceRetrieveResponse;

WireguardInterfaceRetrieveResponse wireguardInterface = client.wireguardInterfaces().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), enablesiptrunking (boolean), endpoint (string), id (uuid), name (string), networkid (uuid), publickey (string), recordtype (string), region (object), regioncode (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string)

Delete a WireGuard Interface

Delete a WireGuard Interface.

DELETE /wireguard_interfaces/{id}

import com.telnyx.sdk.models.wireguardinterfaces.WireguardInterfaceDeleteParams;
import com.telnyx.sdk.models.wireguardinterfaces.WireguardInterfaceDeleteResponse;

WireguardInterfaceDeleteResponse wireguardInterface = client.wireguardInterfaces().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), enablesiptrunking (boolean), endpoint (string), id (uuid), name (string), networkid (uuid), publickey (string), recordtype (string), region (object), regioncode (string), status (enum: created, provisioning, provisioned, deleting), updatedat (string)

List all WireGuard Peers

List all WireGuard peers.

GET /wireguard_peers

import com.telnyx.sdk.models.wireguardpeers.WireguardPeerListPage;
import com.telnyx.sdk.models.wireguardpeers.WireguardPeerListParams;

WireguardPeerListPage page = client.wireguardPeers().list();

Returns: createdat (string), id (uuid), lastseen (string), privatekey (string), publickey (string), recordtype (string), updatedat (string), wireguardinterfaceid (uuid)

Create a WireGuard Peer

Create a new WireGuard Peer. Current limitation of 5 peers per interface can be created.

POST /wireguardpeers — Required: wireguardinterface_id

Optional: createdat (string), id (uuid), lastseen (string), privatekey (string), publickey (string), recordtype (string), updatedat (string)

import com.telnyx.sdk.models.wireguardpeers.WireguardPeerCreateParams;
import com.telnyx.sdk.models.wireguardpeers.WireguardPeerCreateResponse;

WireguardPeerCreateParams params = WireguardPeerCreateParams.builder()
    .wireguardInterfaceId("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
    .build();
WireguardPeerCreateResponse wireguardPeer = client.wireguardPeers().create(params);

Returns: createdat (string), id (uuid), lastseen (string), privatekey (string), publickey (string), recordtype (string), updatedat (string), wireguardinterfaceid (uuid)

Retrieve the WireGuard Peer

Retrieve the WireGuard peer.

GET /wireguard_peers/{id}

import com.telnyx.sdk.models.wireguardpeers.WireguardPeerRetrieveParams;
import com.telnyx.sdk.models.wireguardpeers.WireguardPeerRetrieveResponse;

WireguardPeerRetrieveResponse wireguardPeer = client.wireguardPeers().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), id (uuid), lastseen (string), privatekey (string), publickey (string), recordtype (string), updatedat (string), wireguardinterfaceid (uuid)

Update the WireGuard Peer

Update the WireGuard peer.

PATCH /wireguard_peers/{id}

Optional: public_key (string)

import com.telnyx.sdk.models.wireguardpeers.WireguardPeerPatch;
import com.telnyx.sdk.models.wireguardpeers.WireguardPeerUpdateParams;
import com.telnyx.sdk.models.wireguardpeers.WireguardPeerUpdateResponse;

WireguardPeerUpdateParams params = WireguardPeerUpdateParams.builder()
    .id("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
    .wireguardPeerPatch(WireguardPeerPatch.builder().build())
    .build();
WireguardPeerUpdateResponse wireguardPeer = client.wireguardPeers().update(params);

Returns: createdat (string), id (uuid), lastseen (string), privatekey (string), publickey (string), recordtype (string), updatedat (string), wireguardinterfaceid (uuid)

Delete the WireGuard Peer

Delete the WireGuard peer.

DELETE /wireguard_peers/{id}

import com.telnyx.sdk.models.wireguardpeers.WireguardPeerDeleteParams;
import com.telnyx.sdk.models.wireguardpeers.WireguardPeerDeleteResponse;

WireguardPeerDeleteResponse wireguardPeer = client.wireguardPeers().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), id (uuid), lastseen (string), privatekey (string), publickey (string), recordtype (string), updatedat (string), wireguardinterfaceid (uuid)

Retrieve Wireguard config template for Peer

GET /wireguard_peers/{id}/config

import com.telnyx.sdk.models.wireguardpeers.WireguardPeerRetrieveConfigParams;

String response = client.wireguardPeers().retrieveConfig("6a09cdc3-8948-47f0-aa62-74ac943d6c58");