Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx Global IPs API

Global IPs

Telnyx Global IPs API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Global IPs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 20 operations across 13 paths, and defines 16 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

20 operations 13 paths 16 schemas 3 DELETE13 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Telnyx Global IPs API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 20

Across 13 paths, the API surfaces 20 operations — 3 DELETE, 13 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Global IPs 20

Global IPs

GET
/global_ip_allowed_ports
List all Global IP Allowed Ports
ListGlobalIpAllowedPorts → 200422default
GET
/global_ip_assignment_health
Global IP Assignment Health Check Metrics
GetGlobalIpAssignmentHealth 1 param → 200422default
GET
/global_ip_assignments
List all Global IP assignments
ListGlobalIpAssignments 1 param → 200422default
POST
/global_ip_assignments
Create a Global IP assignment
CreateGlobalIpAssignment body → 202422default
DELETE
/global_ip_assignments/{id}
Delete a Global IP assignment
DeleteGlobalIpAssignment 1 param → 200422default
GET
/global_ip_assignments/{id}
Retrieve a Global IP
GetGlobalIpAssignment 1 param → 200422default
PATCH
/global_ip_assignments/{id}
Update a Global IP assignment
UpdateGlobalIpAssignment 1 param body → 200422default
GET
/global_ip_assignments_usage
Global IP Assignment Usage Metrics
GetGlobalIpAssignmentUsage 1 param → 200422default
GET
/global_ip_health_check_types
List all Global IP Health check types
ListGlobalIpHealthCheckTypes → 200422default
GET
/global_ip_health_checks
List all Global IP health checks
ListGlobalIpHealthChecks 1 param → 200422default
POST
/global_ip_health_checks
Create a Global IP health check
CreateGlobalIpHealthCheck body → 202422default
DELETE
/global_ip_health_checks/{id}
Delete a Global IP health check
DeleteGlobalIpHealthCheck 1 param → 200422default
GET
/global_ip_health_checks/{id}
Retrieve a Global IP health check
GetGlobalIpHealthCheck 1 param → 200422default
GET
/global_ip_latency
Global IP Latency Metrics
GetGlobalIpLatency 1 param → 200422default
GET
/global_ip_protocols
List all Global IP Protocols
ListGlobalIpProtocols → 200422default
GET
/global_ip_usage
Global IP Usage Metrics
GetGlobalIpUsage 1 param → 200422default
GET
/global_ips
List all Global IPs
ListGlobalIps 1 param → 200422default
POST
/global_ips
Create a Global IP
CreateGlobalIp body → 202422default
DELETE
/global_ips/{id}
Delete a Global IP
DeleteGlobalIp 1 param → 200422default
GET
/global_ips/{id}
Retrieve a Global IP
GetGlobalIp 1 param → 200422default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are netapps_Error (5 properties), GlobalIpAssignmentUsageMetric (5 properties), GlobalIpLatencyMetric (5 properties), Record (4 properties). Each schema is shown below with its type and property counts.

GlobalIpAssignmentHealthMetric
object
4 properties
GlobalIPHealthCheck
GlobalIPAllowedPort
netapps_Errors
object
1 property
InterfaceStatus
string
The current status of the interface deployment.
GlobalIPProtocol
Record
object
4 properties
netapps_Error
object
5 properties 2 required
GlobalIpHealthCheckType
GlobalIpAssignmentUsageMetric
object
5 properties
GlobalIpLatencyMetric
object
5 properties
GlobalIpAssignment
PaginationMeta
object
4 properties
GlobalIpUsageMetric
object
4 properties
GlobalIpAssignmentUpdate
GlobalIP

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-global-ips-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
Telnyx Addresses API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx Authentication Providers API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API