Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/telnyx:telnyx-networks-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Telnyx Networks API
version: 2.0.0
contact:
email: support@telnyx.com
x-endpoint-cost: light
x-refined-note:
- x-latency-category differs across the merged source definitions and was not carried
description: 'Operations tagged Networks across 3 of this provider''s published API definitions: telnyx-openapi.json, telnyx-openapi.yml, telnyx-openapi_2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
security:
- bearerAuth: []
tags:
- name: Networks
description: Network operations
paths:
/networks:
get:
summary: List all Networks
description: Returns a paginated list of the private networks on your account, with support for filtering.
operationId: ListNetworks
tags:
- Networks
parameters:
- name: filter
in: query
style: deepObject
explode: true
description: 'Consolidated filter parameter (deepObject style). Originally: filter[name]'
schema:
type: object
properties:
name:
type: string
example: test network
description: The network name to filter on.
- $ref: '#/components/parameters/PageConsolidated'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Network'
meta:
$ref: '#/components/schemas/PaginationMeta'
'422':
$ref: '#/components/responses/GenericErrorResponse'
default:
$ref: '#/components/responses/GenericErrorResponse'
post:
summary: Create a Network
description: Creates a new private network, the container that links your WireGuard interfaces, gateways, and cross connects.
operationId: CreateNetwork
tags:
- Networks
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NetworkCreate'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Network'
'422':
$ref: '#/components/responses/UnprocessableEntity'
default:
$ref: '#/components/responses/GenericErrorResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/networks/{id}:
delete:
summary: Delete a Network
description: Permanently deletes the specified network from your account.
operationId: DeleteNetwork
tags:
- Networks
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Network'
'422':
$ref: '#/components/responses/GenericErrorResponse'
default:
$ref: '#/components/responses/GenericErrorResponse'
get:
summary: Retrieve a Network
description: Returns the details of a single network by its identifier.
operationId: GetNetwork
tags:
- Networks
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Network'
'422':
$ref: '#/components/responses/GenericErrorResponse'
default:
$ref: '#/components/responses/GenericErrorResponse'
patch:
summary: Update a Network
description: Updates the specified network's attributes and returns the updated network.
operationId: UpdateNetwork
tags:
- Networks
parameters:
- $ref: '#/components/parameters/ResourceId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NetworkCreate'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Network'
'422':
$ref: '#/components/responses/GenericErrorResponse'
default:
$ref: '#/components/responses/GenericErrorResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/networks/{id}/default_gateway:
delete:
summary: Delete Default Gateway
description: Removes the default gateway from the specified network.
operationId: DeleteDefaultGateway
tags:
- Networks
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/DefaultGateway'
meta:
$ref: '#/components/schemas/PaginationMeta'
'422':
$ref: '#/components/responses/GenericErrorResponse'
default:
$ref: '#/components/responses/GenericErrorResponse'
get:
summary: Get Default Gateway status
description: Returns the status of the default gateway configured on the specified network.
operationId: GetDefaultGateway
tags:
- Networks
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/DefaultGateway'
meta:
$ref: '#/components/schemas/PaginationMeta'
'422':
$ref: '#/components/responses/GenericErrorResponse'
default:
$ref: '#/components/responses/GenericErrorResponse'
post:
summary: Create Default Gateway
description: Creates a default gateway on the specified network, directing the network's outbound traffic through the chosen gateway.
operationId: CreateDefaultGateway
tags:
- Networks
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DefaultGateway'
required: true
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/DefaultGateway'
meta:
$ref: '#/components/schemas/PaginationMeta'
'422':
$ref: '#/components/responses/GenericErrorResponse'
default:
$ref: '#/components/responses/GenericErrorResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/networks/{id}/network_interfaces:
get:
summary: List all Interfaces for a Network
description: Returns a paginated list of the interfaces attached to the specified network, with support for filtering.
operationId: ListNetworkInterfaces
tags:
- Networks
parameters:
- $ref: '#/components/parameters/ResourceId'
- name: filter
in: query
style: deepObject
explode: true
description: 'Consolidated filter parameter (deepObject style). Originally: filter[name], filter[type], filter[status]'
schema:
type: object
properties:
name:
type: string
example: test interface
description: The interface name to filter on.
type:
type: string
example: wireguard_interface
description: The interface type to filter on.
status:
$ref: '#/components/schemas/InterfaceStatus'
description: The interface status to filter on.
- $ref: '#/components/parameters/PageConsolidated'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/NetworkInterface'
meta:
$ref: '#/components/schemas/PaginationMeta'
'422':
$ref: '#/components/responses/GenericErrorResponse'
default:
$ref: '#/components/responses/GenericErrorResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
components:
parameters:
ResourceId:
name: id
description: Identifies the resource.
in: path
required: true
schema:
format: uuid
type: string
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
PageConsolidated:
name: page
in: query
style: deepObject
explode: true
description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]'
schema:
type: object
properties:
number:
type: integer
minimum: 1
default: 1
description: The page number to load
size:
type: integer
minimum: 1
maximum: 250
default: 20
description: The size of the page
schemas:
NetworkCreate:
allOf:
- $ref: '#/components/schemas/Network'
- type: object
title: NetworkCreate
required:
- name
Errors:
properties:
errors:
type: array
items:
$ref: '#/components/schemas/billing-group_Error'
type: object
DefaultGateway:
allOf:
- $ref: '#/components/schemas/Record'
- type: object
title: DefaultGateway
properties:
record_type:
type: string
description: Identifies the type of the resource.
readOnly: true
example: default_gateway
network_id:
type: string
format: uuid
description: Network ID.
readOnly: true
example: e66c496d-4a85-423b-8b2a-8e63fac20320
wireguard_peer_id:
type: string
format: uuid
description: Wireguard peer ID.
example: e66c496d-4a85-423b-8b2a-8e63fac20320
status:
$ref: '#/components/schemas/InterfaceStatus'
Network:
allOf:
- $ref: '#/components/schemas/Record'
- type: object
title: Network
properties:
record_type:
type: string
description: Identifies the type of the resource.
readOnly: true
example: network
name:
type: string
description: A user specified name for the network.
example: test network
PaginationMeta:
type: object
properties:
total_pages:
type: integer
example: 3
total_results:
type: integer
example: 55
page_number:
type: integer
example: 2
page_size:
type: integer
example: 25
billing-group_Error:
type: object
required:
- code
- title
properties:
code:
type: integer
format: int32
title:
type: string
detail:
type: string
source:
type: object
properties:
pointer:
description: JSON pointer (RFC6901) to the offending entity.
type: string
parameter:
description: Indicates which query parameter caused the error.
type: string
meta:
type: object
properties: {}
additionalProperties: true
InterfaceStatus:
type: string
enum:
- created
- provisioning
- provisioned
- deleting
description: The current status of the interface deployment.
readOnly: true
example: provisioned
Record:
type: object
properties:
id:
type: string
format: uuid
description: Identifies the resource.
readOnly: true
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
record_type:
type: string
description: Identifies the type of the resource.
readOnly: true
example: sample_record_type
created_at:
type: string
description: ISO 8601 formatted date-time indicating when the resource was created.
readOnly: true
example: '2018-02-02T22:25:27.521Z'
updated_at:
type: string
description: ISO 8601 formatted date-time indicating when the resource was updated.
readOnly: true
example: '2018-02-02T22:25:27.521Z'
Interface:
type: object
properties:
network_id:
description: The id of the network associated with the interface.
type: string
format: uuid
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
name:
type: string
description: A user specified name for the interface.
example: test interface
status:
$ref: '#/components/schemas/InterfaceStatus'
NetworkInterface:
allOf:
- $ref: '#/components/schemas/Record'
- $ref: '#/components/schemas/Interface'
- $ref: '#/components/schemas/RegionOut'
- type: object
title: NetworkInterface
properties:
record_type:
type: string
description: Identifies the type of the resource.
readOnly: true
example: network_interface
type:
type: string
description: Identifies the type of the interface.
readOnly: true
example: wireguard_interface
RegionOut:
type: object
properties:
region_code:
description: The region interface is deployed to.
type: string
example: ashburn-va
region:
type: object
properties:
code:
description: Region code of the interface.
type: string
example: ashburn-va
name:
description: Region name of the interface.
type: string
example: Ashburn
record_type:
type: string
description: Identifies the type of the resource.
readOnly: true
example: region
netapps_Errors:
properties:
errors:
items:
$ref: '#/components/schemas/netapps_Error'
type: array
type: object
netapps_Error:
properties:
code:
type: string
detail:
type: string
meta:
additionalProperties: true
type: object
source:
properties:
parameter:
description: Indicates which query parameter caused the error.
type: string
pointer:
description: JSON pointer (RFC6901) to the offending entity.
type: string
type: object
title:
type: string
required:
- code
- title
type: object
Errors_2:
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
type: object
Error:
required:
- code
- title
properties:
code:
type: string
x-format: int64
title:
type: string
detail:
type: string
description: A human-readable explanation of the error.
description:
type: string
source:
type: object
properties:
pointer:
description: JSON pointer (RFC6901) to the offending entity.
type: string
format: json-pointer
parameter:
description: Indicates which query parameter caused the error.
type: string
meta:
type: object
additionalProperties: true
example:
title: Invalid street address
source:
pointer: /street_address
code: '20207'
description: The street address provided is invalid.
type: object
responses:
GenericErrorResponse:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
UnprocessableEntity:
description: Unprocessable entity. Check the 'detail' field in response for details.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- code: '10027'
title: Unprocessable Entity
detail: The server understood the syntax of the request but was unable to process the instructions.
NetworkResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/Network'
type: object
description: Successful response
NetworkInterfaceListResponse:
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/NetworkInterface'
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
type: object
description: Successful response
NetworkListResponse:
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/Network'
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
type: object
description: Successful response
netapps_UnprocessableEntity:
content:
application/json:
schema:
$ref: '#/components/schemas/netapps_Errors'
description: Unprocessable entity. Check the 'detail' field in response for details.
DefaultGatewayResponse:
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/DefaultGateway'
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
type: object
description: Successful response
netapps_GenericErrorResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/netapps_Errors'
description: Unexpected error
netapps_UnprocessableEntity_17904fcfbc:
description: Unprocessable entity. Check the 'detail' field in response for details.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors_2'
example:
errors:
- code: '10027'
title: Unprocessable Entity
detail: The server understood the syntax of the request but was unable to process the instructions.
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: API key
description: 'Telnyx API key supplied as `Authorization: Bearer <token>`. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.'
Payment:
type: apiKey
in: header
name: Authorization
description: 'Machine Payment Protocol credential used on paid retries, sent as `Authorization: Payment ...`. Obtained by paying a challenge returned in the `WWW-Authenticate` header of a 402 response. This is not a Telnyx API key; initial challenge requests use standard bearer authentication instead.'
agent-memory_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key
bearerAuth:
type: http
scheme: bearer
branded-calling_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
collections_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Collections and results are automatically scoped to the authenticated user's organization.
number-reputation_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
oauthClientAuth:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://api.telnyx.com/v2/oauth/token
scopes:
admin: Administrative access to Telnyx resources
authorizationCode:
authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
tokenUrl: https://api.telnyx.com/v2/oauth/token
refreshUrl: https://api.telnyx.com/v2/oauth/token
scopes:
admin: Administrative access to Telnyx resources
description: OAuth 2.0 authentication for Telnyx API and MCP integrations
outbound-voice-profiles_bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
pronunciation-dicts_bearerAuth:
type: http
scheme: bearer
description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
rcs-registration_bearerAuth:
type: http
scheme: bearer
bearerFormat: API key
stored-payment-transactions_bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
transcriptions-search_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Results are automatically scoped to the authenticated user's organization.
web-search_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key
pay-connectors_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key, not the processor bearer token.
telnyxApiKey:
type: http
scheme: bearer
description: Management-only Telnyx account credential.
x-refined-from:
- telnyx-openapi.json
- telnyx-openapi.yml
- telnyx-openapi_2.json
x-service-info:
categories:
- communication
- developer-tools
docs:
apiReference: https://developers.telnyx.com
homepage: https://telnyx.com
llms: https://telnyx.com/llms.txt