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

Telnyx Networking - curl

Installation

# curl is pre-installed on macOS, Linux, and Windows 10+

Setup

export TELNYX_API_KEY="YOUR_API_KEY_HERE"

All examples below use $TELNYXAPIKEY for authentication.

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:

# Check HTTP status code in response
response=$(curl -s -w "\n%{http_code}" \
  -X POST "https://api.telnyx.com/v2/messages" \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to": "+13125550001", "from": "+13125550002", "text": "Hello"}')

http_code=$(echo "$response" | tail -1)
body=$(echo "$response" | sed '$d')

case $http_code in
  2*) echo "Success: $body" ;;
  422) echo "Validation error — check required fields and formats" ;;
  429) echo "Rate limited — retry after delay"; sleep 1 ;;
  401) echo "Authentication failed — check TELNYX_API_KEY" ;;
  *)   echo "Error $http_code: $body" ;;
esac

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 endpoints return paginated results. Use page[number] and page[size] query parameters to navigate pages. Check meta.total_pages in the response.

List all clusters

GET /ai/clusters

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/clusters"

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)

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "bucket": "my-bucket"
}' \
  "https://api.telnyx.com/v2/ai/clusters"

Returns: task_id (string)

Fetch a cluster

GET /ai/clusters/{task_id}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/clusters/{task_id}"

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

Delete a cluster

DELETE /ai/clusters/{task_id}

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/ai/clusters/{task_id}"

Fetch a cluster visualization

GET /ai/clusters/{task_id}/graph

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/clusters/{task_id}/graph"

List Integrations

List all available integrations.

GET /ai/integrations

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/integrations"

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

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/integrations/connections"

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

Get User Integration connection By Id

Get user setup integrations

GET /ai/integrations/connections/{userconnectionid}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/integrations/connections/{user_connection_id}"

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

Delete Integration Connection

Delete a specific integration connection.

DELETE /ai/integrations/connections/{userconnectionid}

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/ai/integrations/connections/{user_connection_id}"

List Integration By Id

Retrieve integration details

GET /ai/integrations/{integration_id}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/integrations/{integration_id}"

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

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/global_ip_allowed_ports"

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

Global IP Assignment Health Check Metrics

GET /globalipassignment_health

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/global_ip_assignment_health"

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

List all Global IP assignments

List all Global IP assignments.

GET /globalipassignments

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/global_ip_assignments"

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)

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/global_ip_assignments"

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}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/global_ip_assignments/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)

curl \
  -X PATCH \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/global_ip_assignments/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}

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/global_ip_assignments/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

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/global_ip_assignments_usage"

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

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/global_ip_health_check_types"

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

List all Global IP health checks

List all Global IP health checks.

GET /globaliphealth_checks

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/global_ip_health_checks"

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)

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/global_ip_health_checks"

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}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/global_ip_health_checks/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}

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/global_ip_health_checks/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

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/global_ip_latency"

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

List all Global IP Protocols

GET /globalipprotocols

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/global_ip_protocols"

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

Global IP Usage Metrics

GET /globalipusage

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/global_ip_usage"

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

List all Global IPs

List all Global IPs.

GET /global_ips

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/global_ips"

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)

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/global_ips"

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}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/global_ips/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}

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/global_ips/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

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/networks"

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)

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "test network"
}' \
  "https://api.telnyx.com/v2/networks"

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

Retrieve a Network

Retrieve a Network.

GET /networks/{id}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/networks/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)

curl \
  -X PATCH \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "test network"
}' \
  "https://api.telnyx.com/v2/networks/6a09cdc3-8948-47f0-aa62-74ac943d6c58"

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

Delete a Network

Delete a Network.

DELETE /networks/{id}

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/networks/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

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/networks/6a09cdc3-8948-47f0-aa62-74ac943d6c58/default_gateway"

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)

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/networks/6a09cdc3-8948-47f0-aa62-74ac943d6c58/default_gateway"

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

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/networks/6a09cdc3-8948-47f0-aa62-74ac943d6c58/default_gateway"

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

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/networks/6a09cdc3-8948-47f0-aa62-74ac943d6c58/network_interfaces"

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

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/private_wireless_gateways?filter[name]=my private gateway&filter[ip_range]=192.168.0.0/24&filter[region_code]=dc2&filter[created_at]=2018-02-02T22:25:27.521Z&filter[updated_at]=2018-02-02T22:25:27.521Z"

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)

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "name": "My private wireless gateway"
}' \
  "https://api.telnyx.com/v2/private_wireless_gateways"

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}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/private_wireless_gateways/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}

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/private_wireless_gateways/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

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/public_internet_gateways"

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)

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/public_internet_gateways"

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}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/public_internet_gateways/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}

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/public_internet_gateways/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

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/regions"

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

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/virtual_cross_connects"

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)

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "cloud_provider": "aws",
  "cloud_provider_region": "us-east-1",
  "bgp_asn": 1234,
  "primary_cloud_account_id": "123456789012",
  "region_code": "ashburn-va"
}' \
  "https://api.telnyx.com/v2/virtual_cross_connects"

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}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/virtual_cross_connects/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)

curl \
  -X PATCH \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/virtual_cross_connects/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}

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/virtual_cross_connects/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

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/virtual_cross_connects_coverage"

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

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/wireguard_interfaces"

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)

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "region_code": "ashburn-va"
}' \
  "https://api.telnyx.com/v2/wireguard_interfaces"

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}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/wireguard_interfaces/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}

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/wireguard_interfaces/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

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/wireguard_peers"

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)

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "wireguard_interface_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
}' \
  "https://api.telnyx.com/v2/wireguard_peers"

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}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/wireguard_peers/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)

curl \
  -X PATCH \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/wireguard_peers/6a09cdc3-8948-47f0-aa62-74ac943d6c58"

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}

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/wireguard_peers/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

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/wireguard_peers/6a09cdc3-8948-47f0-aa62-74ac943d6c58/config"