Telnyx Tailscale Subnet Routers API
Tailscale Subnet Router operations
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-tailscale-subnet-routers-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:
version: 2.0.0
x-latency-category: responsive
x-endpoint-cost: light
title: Telnyx Tailscale Subnet Routers API
description: SIP trunking, SMS, MMS, Call Control and Telephony Data Services.
contact:
email: support@telnyx.com
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
security:
- bearerAuth: []
tags:
- name: Tailscale Subnet Routers
description: Tailscale Subnet Router operations
paths:
/tailscale_subnet_routers:
get:
summary: List all Tailscale Subnet Routers
description: Returns a paginated list of the Tailscale Subnet Routers on the account, with support for filtering by Network.
operationId: ListTailscaleSubnetRouters
tags:
- Tailscale Subnet Routers
parameters:
- name: filter
in: query
style: deepObject
explode: true
description: 'Consolidated filter parameter (deepObject style). Originally: filter[network_id]'
schema:
type: object
properties:
network_id:
type: string
example: 0de011ae-ee53-4df4-ba96-754728eb5aad
description: The id of the Network 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/TailscaleSubnetRouter'
meta:
$ref: '#/components/schemas/PaginationMeta'
example:
data:
- id: 5c6f0a7e-6c7b-4d7f-9f2e-3b1e4e9a8c21
record_type: tailscale_subnet_router
name: tailnet-ashburn
network_id: 0de011ae-ee53-4df4-ba96-754728eb5aad
region_code: ashburn-va
advertised_routes:
- 172.27.0.0/24
status: provisioned
customer_address: 172.27.254.1
device_id: n5c6f0a7e1CNTRL
tailnet_name: acme.example
tailscale_ips:
- 100.101.2.30
- fd7a:115c:a1e0::2a
created_at: '2026-10-13T15:04:05.123456Z'
updated_at: '2026-10-13T15:09:41.654321Z'
meta:
total_pages: 1
total_results: 1
page_number: 1
page_size: 25
'422':
$ref: '#/components/responses/netapps_UnprocessableEntity_17904fcfbc'
default:
$ref: '#/components/responses/GenericErrorResponse'
post:
summary: Create a Tailscale Subnet Router
description: Creates a Tailscale Subnet Router on a Network and enrolls it in the user's tailnet with the auth key. The response returns the router with `status` `provisioning`. Poll `GET /tailscale_subnet_routers/{id}` until it is `provisioned`. Then approve its routes in the tailnet, unless an auto-approver covers them.
operationId: CreateTailscaleSubnetRouter
tags:
- Tailscale Subnet Routers
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TailscaleSubnetRouterCreate'
example:
name: tailnet-ashburn
network_id: 0de011ae-ee53-4df4-ba96-754728eb5aad
region_code: ashburn-va
advertised_routes:
- 172.27.0.0/24
auth_key: tskey-auth-k1AbCdEfGh2IjKlMnOpQrStUv
responses:
'200':
description: Successful response. The router is created and provisioning has started.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/TailscaleSubnetRouter'
example:
data:
id: 5c6f0a7e-6c7b-4d7f-9f2e-3b1e4e9a8c21
record_type: tailscale_subnet_router
name: tailnet-ashburn
network_id: 0de011ae-ee53-4df4-ba96-754728eb5aad
region_code: ashburn-va
advertised_routes:
- 172.27.0.0/24
status: provisioning
customer_address: 172.27.254.1
device_id: null
tailnet_name: null
tailscale_ips: []
created_at: '2026-10-13T15:04:05.123456Z'
updated_at: '2026-10-13T15:04:05.123456Z'
'400':
description: 'Bad request: the body failed validation. `detail` says what failed, for example `Routes must exclude default, local, and Tailscale ranges.` or `The request contains unknown or read-only fields.`; a missing parameter or an unknown `network_id` or `region_code` names the field in `source.pointer`.'
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- code: '10015'
title: Bad Request
detail: Routes must exclude default, local, and Tailscale ranges.
meta:
url: https://developers.telnyx.com/docs/overview/errors/10015
'422':
description: 'Unprocessable entity: an advertised route overlaps the addresses reserved for routers, `172.27.254.0/24` and `198.18.0.0/20`. The body is the generic error; it does not name the route.'
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.
default:
$ref: '#/components/responses/GenericErrorResponse'
/tailscale_subnet_routers/{id}:
delete:
summary: Delete a Tailscale Subnet Router
description: Removes the router from the Network and logs it out of the tailnet. The response returns the router with `status` `deleting`. The record disappears once removal completes. A machine entry can remain in the tailnet's admin console until it is removed there.
operationId: DeleteTailscaleSubnetRouter
tags:
- Tailscale Subnet Routers
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
description: Successful response. Removal has started.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/TailscaleSubnetRouter'
example:
data:
id: 5c6f0a7e-6c7b-4d7f-9f2e-3b1e4e9a8c21
record_type: tailscale_subnet_router
name: tailnet-ashburn
network_id: 0de011ae-ee53-4df4-ba96-754728eb5aad
region_code: ashburn-va
advertised_routes:
- 172.27.0.0/24
status: deleting
customer_address: 172.27.254.1
device_id: n5c6f0a7e1CNTRL
tailnet_name: acme.example
tailscale_ips:
- 100.101.2.30
- fd7a:115c:a1e0::2a
created_at: '2026-10-13T15:04:05.123456Z'
updated_at: '2026-10-14T10:30:12.000000Z'
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
example:
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
'409':
description: Conflict. The router is `provisioning` or `deleting`, or another operation holds it. Wait for the current operation to finish.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
default:
$ref: '#/components/responses/GenericErrorResponse'
get:
summary: Retrieve a Tailscale Subnet Router
description: Returns the details of a single Tailscale Subnet Router by its identifier, including its enrollment state.
operationId: GetTailscaleSubnetRouter
tags:
- Tailscale Subnet Routers
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/TailscaleSubnetRouter'
example:
data:
id: 5c6f0a7e-6c7b-4d7f-9f2e-3b1e4e9a8c21
record_type: tailscale_subnet_router
name: tailnet-ashburn
network_id: 0de011ae-ee53-4df4-ba96-754728eb5aad
region_code: ashburn-va
advertised_routes:
- 172.27.0.0/24
status: provisioned
customer_address: 172.27.254.1
device_id: n5c6f0a7e1CNTRL
tailnet_name: acme.example
tailscale_ips:
- 100.101.2.30
- fd7a:115c:a1e0::2a
created_at: '2026-10-13T15:04:05.123456Z'
updated_at: '2026-10-13T15:09:41.654321Z'
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
example:
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
default:
$ref: '#/components/responses/GenericErrorResponse'
patch:
summary: Update a Tailscale Subnet Router
description: 'Renames the router, changes its advertised routes, or retries a failed enrollment. Any change queues a new provisioning run and returns the router with `status` `provisioning`. The router keeps its machine identity on the tailnet. Send an empty object to retry a `failed` router with its stored auth key. Include a new `auth_key` only while the router has never enrolled. The router''s Network and region cannot change: create a new router instead.'
operationId: UpdateTailscaleSubnetRouter
tags:
- Tailscale Subnet Routers
parameters:
- $ref: '#/components/parameters/ResourceId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TailscaleSubnetRouterUpdate'
example:
advertised_routes:
- 172.27.0.0/24
- 172.27.1.0/24
responses:
'200':
description: Successful response. The change is queued and provisioning has started.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/TailscaleSubnetRouter'
example:
data:
id: 5c6f0a7e-6c7b-4d7f-9f2e-3b1e4e9a8c21
record_type: tailscale_subnet_router
name: tailnet-ashburn
network_id: 0de011ae-ee53-4df4-ba96-754728eb5aad
region_code: ashburn-va
advertised_routes:
- 172.27.0.0/24
- 172.27.1.0/24
status: provisioning
customer_address: 172.27.254.1
device_id: n5c6f0a7e1CNTRL
tailnet_name: acme.example
tailscale_ips:
- 100.101.2.30
- fd7a:115c:a1e0::2a
created_at: '2026-10-13T15:04:05.123456Z'
updated_at: '2026-10-14T09:12:00.000000Z'
'400':
description: 'Bad request: the body failed validation. `detail` says what failed, for example `Routes must exclude default, local, and Tailscale ranges.` or `The request contains unknown or read-only fields.`; a missing parameter or an unknown `network_id` or `region_code` names the field in `source.pointer`.'
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- code: '10015'
title: Bad Request
detail: Routes must exclude default, local, and Tailscale ranges.
meta:
url: https://developers.telnyx.com/docs/overview/errors/10015
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
example:
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
'409':
description: 'Conflict: the router is `provisioning` or `deleting`, or another operation holds it. Wait for the current operation to finish. The body carries the generic bad-request error.'
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- code: '10015'
title: Bad Request
detail: The request failed because it was not well-formed.
meta:
url: https://developers.telnyx.com/docs/overview/errors/10015
'422':
description: 'Unprocessable entity: an advertised route overlaps the reserved ranges, the body carries an unknown or read-only field such as `network_id`, or `auth_key` is sent for a router that has already enrolled. The body is the generic error.'
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.
default:
$ref: '#/components/responses/GenericErrorResponse'
components:
schemas:
TailscaleSubnetRouterCreate:
type: object
title: TailscaleSubnetRouterCreate
additionalProperties: false
required:
- name
- network_id
- region_code
- advertised_routes
- auth_key
properties:
name:
type: string
minLength: 1
maxLength: 128
description: A user specified name for the router.
example: tailnet-ashburn
network_id:
type: string
format: uuid
description: The id of the Network to attach the router to.
example: 0de011ae-ee53-4df4-ba96-754728eb5aad
region_code:
type: string
description: The code of the region to create the router in. `GET /network_coverage` lists the regions whose `available_services` include `tailscale_subnet_router`.
example: ashburn-va
advertised_routes:
type: array
minItems: 1
maxItems: 64
uniqueItems: true
items:
type: string
example: 172.27.0.0/24
example:
- 172.27.0.0/24
description: IPv4 subnets of the Network that the router advertises to the tailnet. Each entry is a canonical CIDR that the Network routes. Default, loopback, link-local, multicast, and Tailscale (`100.64.0.0/10`) ranges are rejected. So are ranges that overlap the router's own, `172.27.254.0/24` and `198.18.0.0/20`.
auth_key:
type: string
writeOnly: true
format: password
pattern: ^tskey-auth-[A-Za-z0-9_-]{10,250}$
description: 'A Tailscale auth key that enrolls the router in the user''s tailnet: reusable, pre-approved, tagged, and not ephemeral. Telnyx stores it encrypted until enrollment succeeds, then discards it. It is never returned.'
example: tskey-auth-k1AbCdEfGh2IjKlMnOpQrStUv
Errors:
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
type: object
TailscaleSubnetRouterUpdate:
type: object
title: TailscaleSubnetRouterUpdate
additionalProperties: false
description: Every field is optional. A change queues a new provisioning run and returns the router with `status` `provisioning`. An empty object retries a `failed` router.
properties:
name:
type: string
minLength: 1
maxLength: 128
description: A user specified name for the router.
example: tailnet-ashburn
advertised_routes:
type: array
minItems: 1
maxItems: 64
uniqueItems: true
items:
type: string
example: 172.27.0.0/24
example:
- 172.27.0.0/24
description: IPv4 subnets of the Network that the router advertises to the tailnet. Each entry is a canonical CIDR that the Network routes. Default, loopback, link-local, multicast, and Tailscale (`100.64.0.0/10`) ranges are rejected. So are ranges that overlap the router's own, `172.27.254.0/24` and `198.18.0.0/20`.
auth_key:
type: string
writeOnly: true
format: password
pattern: ^tskey-auth-[A-Za-z0-9_-]{10,250}$
description: A replacement Tailscale auth key. Accepted only while the router has never enrolled, for example after a `failed` enrollment. Never returned.
example: tskey-auth-k1AbCdEfGh2IjKlMnOpQrStUv
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
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
TailscaleSubnetRouter:
type: object
title: TailscaleSubnetRouter
properties:
id:
type: string
format: uuid
description: Identifies the resource.
readOnly: true
example: 5c6f0a7e-6c7b-4d7f-9f2e-3b1e4e9a8c21
record_type:
type: string
description: Identifies the type of the resource.
readOnly: true
example: tailscale_subnet_router
name:
type: string
minLength: 1
maxLength: 128
description: A user specified name for the router.
example: tailnet-ashburn
network_id:
type: string
format: uuid
description: The id of the Network the router is attached to.
example: 0de011ae-ee53-4df4-ba96-754728eb5aad
region_code:
type: string
description: The code of the region the router is created in. `GET /network_coverage` lists the regions whose `available_services` include `tailscale_subnet_router`.
example: ashburn-va
advertised_routes:
type: array
minItems: 1
maxItems: 64
uniqueItems: true
items:
type: string
example: 172.27.0.0/24
example:
- 172.27.0.0/24
description: IPv4 subnets of the Network that the router advertises to the tailnet. Each entry is a canonical CIDR that the Network routes. Default, loopback, link-local, multicast, and Tailscale (`100.64.0.0/10`) ranges are rejected. So are ranges that overlap the router's own, `172.27.254.0/24` and `198.18.0.0/20`.
status:
type: string
enum:
- provisioning
- provisioned
- failed
- deleting
readOnly: true
example: provisioned
description: '`provisioning`: Telnyx is creating the router or applying a change. `provisioned`: the router is on the tailnet and advertises its routes; the tailnet still approves them. `failed`: enrollment did not complete, and `PATCH` retries it. `deleting`: the router is being removed.'
customer_address:
type: string
readOnly: true
example: 172.27.254.1
description: The router's address on the Network, from `172.27.254.0/24`. Tailnet traffic enters the Network from this address.
device_id:
type:
- string
- 'null'
readOnly: true
example: n5c6f0a7e1CNTRL
description: The router's node id on the tailnet. Set once the router has enrolled.
tailnet_name:
type:
- string
- 'null'
readOnly: true
example: acme.example
description: The name of the tailnet the router is enrolled in. Set once the router has enrolled.
tailscale_ips:
type: array
readOnly: true
items:
type: string
example:
- 100.101.2.30
- fd7a:115c:a1e0::2a
description: The router's addresses on the tailnet. Empty until the router has enrolled.
created_at:
type: string
format: date-time
description: ISO 8601 formatted date-time indicating when the resource was created.
readOnly: true
example: '2026-10-13T15:04:05.123456Z'
updated_at:
type: string
format: date-time
description: ISO 8601 formatted date-time indicating when the resource was updated.
readOnly: true
example: '2026-10-13T15:09:41.654321Z'
responses:
netapps_UnprocessableEntity_17904fcfbc:
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.
GenericErrorResponse:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
parameters:
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
ResourceId:
name: id
description: Identifies the resource.
in: path
required: true
schema:
format: uuid
type: string
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
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
pay-connectors_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key, not the processor bearer token.
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
telnyxApiKey:
type: http
scheme: bearer
description: Management-only Telnyx account credential.
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
x-service-info:
categories:
- communication
- developer-tools
docs:
apiReference: https://developers.telnyx.com
homepage: https://telnyx.com
llms: https://telnyx.com/llms.txt