> ## Documentation Index
> Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a Tailscale Subnet Router

> 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.



## OpenAPI

````yaml /openapi/source/external/netapps/netapps.json patch /tailscale_subnet_routers/{id}
openapi: 3.1.0
info:
  version: 2.0.0
  title: Telnyx API
  x-latency-category: responsive
  x-endpoint-cost: light
  description: SIP trunking, SMS, MMS, Call Control and Telephony Data Services.
  license:
    name: MIT
    identifier: MIT
  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: Networks
    description: Network operations
  - name: Public Internet Gateways
    description: Public Internet Gateway operations
  - name: WireGuard Interfaces
    description: WireGuard Interface operations
  - name: Tailscale Subnet Routers
    description: Tailscale Subnet Router operations
  - name: Virtual Cross Connects
    description: Virtual Cross Connect operations
  - name: Regions
    description: Regions
  - name: Global IPs
    description: Global IPs
paths:
  /tailscale_subnet_routers/{id}:
    patch:
      tags:
        - Tailscale Subnet Routers
      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
      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:
  parameters:
    ResourceId:
      name: id
      description: Identifies the resource.
      in: path
      required: true
      schema:
        format: uuid
        type: string
        example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
  schemas:
    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
    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'
    Errors:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      type: object
    Error:
      required:
        - code
        - title
      properties:
        code:
          type: string
        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
          additionalProperties: true
      type: object
  responses:
    GenericErrorResponse:
      description: Unexpected error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````