Skip to main content
PATCH
Update a Tailscale Subnet Router

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Identifies the resource.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

Body

application/json

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.

name
string

A user specified name for the router.

Required string length: 1 - 128
Example:

"tailnet-ashburn"

advertised_routes
string[]

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>
write-only

A replacement Tailscale auth key. Accepted only while the router has never enrolled, for example after a failed enrollment. Never returned.

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

"tskey-auth-k1AbCdEfGh2IjKlMnOpQrStUv"

Response

Successful response. The change is queued and provisioning has started.

data
TailscaleSubnetRouter · object