Skip to main content
POST
Create a Tailscale Subnet Router

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

A user specified name for the router.

Required string length: 1 - 128
Example:

"tailnet-ashburn"

network_id
string<uuid>
required

The id of the Network to attach the router to.

Example:

"0de011ae-ee53-4df4-ba96-754728eb5aad"

region_code
string
required

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
string[]
required

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.

Required array length: 1 - 64 elements
Example:
auth_key
string<password>
required
write-only

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.

Pattern: ^tskey-auth-[A-Za-z0-9_-]{10,250}$
Example:

"tskey-auth-k1AbCdEfGh2IjKlMnOpQrStUv"

Response

Successful response. The router is created and provisioning has started.

data
TailscaleSubnetRouter · object