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-ips-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 IPs 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 IPs 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: IPs
description: IP operations
paths:
/ips:
get:
summary: List Ips
description: Get all IPs belonging to the user that match the given filters.
operationId: ListIps
tags:
- IPs
x-group-parameters: 'true'
x-endpoint-cost: medium
parameters:
- $ref: '#/components/parameters/connections_PageConsolidated'
- name: filter
in: query
style: deepObject
explode: true
description: 'Consolidated filter parameter (deepObject style). Originally: filter[connection_id], filter[ip_address], filter[port]'
schema:
type: object
properties:
connection_id:
type: string
description: ID of the IP Connection to which this IP should be attached.
ip_address:
type: string
example: 192.168.0.0
description: IP adddress represented by this resource.
port:
type: integer
example: 5060
description: Port to use when connecting to this IP.
responses:
'200':
description: Successful response with a list of IPs.
content:
application/json:
schema:
type: object
title: List Ips Response
properties:
data:
type: array
items:
$ref: '#/components/schemas/Ip'
meta:
$ref: '#/components/schemas/connections_PaginationMeta'
'400':
$ref: '#/components/responses/connections_BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthenticatedResponse'
'403':
$ref: '#/components/responses/connections_UnauthorizedResponse'
post:
description: Creates a new IP record for use with IP-based connections, associating an IP address with the specified connection.
summary: Create an Ip
operationId: CreateIp
tags:
- IPs
x-endpoint-cost: medium
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateIpRequest'
responses:
'201':
description: Successful response with details about an IP.
content:
application/json:
schema:
type: object
title: Ip Response
properties:
data:
$ref: '#/components/schemas/Ip'
'401':
$ref: '#/components/responses/UnauthenticatedResponse'
'403':
$ref: '#/components/responses/connections_UnauthorizedResponse'
'422':
$ref: '#/components/responses/connections_UnprocessableEntityResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/ips/{id}:
delete:
description: Permanently deletes the specified IP record from its connection.
summary: Delete an Ip
operationId: DeleteIp
tags:
- IPs
parameters:
- $ref: '#/components/parameters/IpId'
responses:
'200':
description: Successful response with details about an IP.
content:
application/json:
schema:
type: object
title: Ip Response
properties:
data:
$ref: '#/components/schemas/Ip'
'400':
$ref: '#/components/responses/connections_BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthenticatedResponse'
'403':
$ref: '#/components/responses/connections_UnauthorizedResponse'
'404':
$ref: '#/components/responses/connections_NotFoundResponse'
get:
description: Return the details regarding a specific IP.
summary: Retrieve an Ip
operationId: RetrieveIp
tags:
- IPs
parameters:
- $ref: '#/components/parameters/IpId'
responses:
'200':
description: Successful response with details about an IP.
content:
application/json:
schema:
type: object
title: Ip Response
properties:
data:
$ref: '#/components/schemas/Ip'
'400':
$ref: '#/components/responses/connections_BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthenticatedResponse'
'403':
$ref: '#/components/responses/connections_UnauthorizedResponse'
'404':
$ref: '#/components/responses/connections_NotFoundResponse'
patch:
description: Updates the details of the specified IP record and returns the updated IP.
summary: Update an Ip
operationId: UpdateIp
tags:
- IPs
parameters:
- $ref: '#/components/parameters/IpId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateIpRequest'
responses:
'200':
description: Successful response with details about an IP.
content:
application/json:
schema:
type: object
title: Ip Response
properties:
data:
$ref: '#/components/schemas/Ip'
'401':
$ref: '#/components/responses/UnauthenticatedResponse'
'403':
$ref: '#/components/responses/connections_UnauthorizedResponse'
'404':
$ref: '#/components/responses/connections_NotFoundResponse'
'409':
description: Conflict. Another update to this connection is still in progress. Wait and retry the request later.
content:
application/json:
schema:
$ref: '#/components/schemas/connections_ErrorResponse'
example:
errors:
- detail: A previous update to this connection is still in progress. Please try again later.
'422':
$ref: '#/components/responses/connections_UnprocessableEntityResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
components:
responses:
UnauthenticatedResponse:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/call-scripting_ErrorResponse'
examples:
Authentication Failed:
value:
errors:
- code: '10009'
title: Authentication failed
detail: Could not understand the provided credentials.
meta:
url: https://developers.telnyx.com/docs/overview/errors/10009
connections_UnprocessableEntityResponse:
description: The request was well-formed but was unable to be followed due to semantic errors.
content:
application/json:
schema:
$ref: '#/components/schemas/connections_ErrorResponse'
examples:
unprocessableEntity:
value:
errors:
- code: '10015'
title: Bad Request
detail: 'Invalid dnis_format: test, was provided. Acceptable formats are +e164, e164, national, sip_username'
meta:
url: https://developers.telnyx.com/docs/overview/errors/10015
source:
pointer: /inbound/dnis_number_format
connections_UnauthorizedResponse:
description: The user doesn't have the required permissions to perform the requested action.
content:
application/json:
schema:
$ref: '#/components/schemas/connections_ErrorResponse'
examples:
notAuthorized:
value:
errors:
- code: '10010'
title: Not authorized
detail: You are not authorized to access the requested resource.
meta:
url: https://developers.telnyx.com/docs/overview/errors/10010
source:
pointer: /
connections_NotFoundResponse:
description: The requested resource doesn't exist.
content:
application/json:
schema:
$ref: '#/components/schemas/connections_ErrorResponse'
examples:
notFound:
value:
errors:
- code: '10005'
title: Resource not found
detail: The requested resource or URL could not be found.
meta:
url: https://developers.telnyx.com/docs/overview/errors/10005
source:
pointer: /
connections_BadRequestResponse:
description: Bad request, the request was unacceptable, often due to missing a required parameter.
content:
application/json:
schema:
$ref: '#/components/schemas/connections_ErrorResponse'
examples:
missingParameter:
value:
errors:
- code: '10015'
title: Bad Request
detail: The request failed because it was not well-formed.
source:
pointer: /
meta:
url: https://developers.telnyx.com/docs/overview/errors/10015
UnauthenticatedResponse_2:
content:
application/json:
examples:
Authentication Failed:
value:
errors:
- code: '10009'
detail: Could not understand the provided credentials.
meta:
url: https://developers.telnyx.com/docs/overview/errors/10009
title: Authentication failed
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
connections_UnprocessableEntityResponse_2:
content:
application/json:
examples:
unprocessableEntity:
value:
errors:
- code: '10015'
detail: 'Invalid dnis_format: test, was provided. Acceptable formats are +e164, e164, national, sip_username'
meta:
url: https://developers.telnyx.com/docs/overview/errors/10015
source:
pointer: /inbound/dnis_number_format
title: Bad Request
schema:
$ref: '#/components/schemas/ErrorResponse'
description: The request was well-formed but was unable to be followed due to semantic errors.
connections_UnauthorizedResponse_2:
content:
application/json:
examples:
notAuthorized:
value:
errors:
- code: '10010'
detail: You are not authorized to access the requested resource.
meta:
url: https://developers.telnyx.com/docs/overview/errors/10010
source:
pointer: /
title: Not authorized
schema:
$ref: '#/components/schemas/ErrorResponse'
description: The user doesn't have the required permissions to perform the requested action.
connections_NotFoundResponse_2:
content:
application/json:
examples:
notFound:
value:
errors:
- code: '10005'
detail: The requested resource or URL could not be found.
meta:
url: https://developers.telnyx.com/docs/overview/errors/10005
source:
pointer: /
title: Resource not found
schema:
$ref: '#/components/schemas/ErrorResponse'
description: The requested resource doesn't exist.
ListIpsResponse:
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/Ip'
type: array
meta:
$ref: '#/components/schemas/connections_PaginationMeta'
title: List Ips Response
type: object
description: Successful response with a list of IPs.
IpResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/Ip'
title: Ip Response
type: object
description: Successful response with details about an IP.
connections_BadRequestResponse_2:
content:
application/json:
examples:
missingParameter:
value:
errors:
- code: '10015'
detail: The request failed because it was not well-formed.
meta:
url: https://developers.telnyx.com/docs/overview/errors/10015
source:
pointer: /
title: Bad Request
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request, the request was unacceptable, often due to missing a required parameter.
parameters:
IpId:
name: id
description: Identifies the type of resource.
in: path
required: true
schema:
format: uuid
type: string
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
connections_PageConsolidated:
name: page
in: query
style: deepObject
explode: true
description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]'
schema:
type: object
properties:
size:
type: integer
minimum: 1
maximum: 250
default: 250
description: The size of the page
number:
type: integer
minimum: 1
default: 1
description: The page number to load
schemas:
CreateIpRequest:
title: Create Ip Request
type: object
required:
- ip_address
properties:
connection_id:
type: string
description: ID of the IP Connection to which this IP should be attached.
ip_address:
type: string
description: IP adddress represented by this resource.
example: 192.168.0.0
port:
type: integer
description: Port to use when connecting to this IP.
default: 5060
example: 5060
example:
connection_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
ip_address: 192.168.0.0
port: 5060
UpdateIpRequest:
title: Update Ip Request
type: object
required:
- ip_address
properties:
connection_id:
type: string
description: ID of the IP Connection to which this IP should be attached.
ip_address:
type: string
description: IP adddress represented by this resource.
example: 192.168.0.0
port:
type: integer
description: Port to use when connecting to this IP.
default: 5060
example: 5060
example:
connection_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
ip_address: 192.168.0.0
port: 5060
connections_PaginationMeta:
title: Pagination Meta
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
connections_ErrorResponse:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
detail:
type: string
meta:
type: object
properties:
url:
type: string
format: uri
title:
type: string
source:
type: object
properties:
pointer:
type: string
call-scripting_ErrorResponse:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
detail:
type: string
meta:
type: object
properties:
url:
type: string
format: uri
title:
type: string
source:
type: object
properties:
pointer:
type: string
Ip:
type: object
title: Ip
properties:
id:
type: string
description: Identifies the type of resource.
example: '1293384261075731499'
x-format: int64
record_type:
type: string
description: Identifies the type of the resource.
example: ip
connection_id:
type: string
description: ID of the IP Connection to which this IP should be attached.
ip_address:
type: string
description: IP adddress represented by this resource.
example: 192.168.0.0
port:
type: integer
description: Port to use when connecting to this IP.
default: 5060
example: 5060
created_at:
type: string
description: ISO 8601 formatted date indicating when the resource was created.
example: '2018-02-02T22:25:27.521Z'
updated_at:
type: string
description: ISO 8601 formatted date indicating when the resource was updated.
example: '2018-02-02T22:25:27.521Z'
example:
id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
record_type: ip
connection_id: '3456789987654'
ip_address: 192.168.0.0
port: 5060
created_at: '2018-02-02T22:25:27.521Z'
updated_at: '2018-02-02T22:25:27.521Z'
ErrorResponse:
properties:
errors:
items:
properties:
code:
type: string
detail:
type: string
meta:
properties:
url:
format: uri
type: string
type: object
source:
properties:
pointer:
type: string
type: object
title:
type: string
type: object
type: array
type: object
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