---
title: "Get router"
method: GET
path: "/public/v2/routers/{routerId}"
tags: ["Routers"]
---

# Get router

`GET /public/v2/routers/{routerId}`

## Request

- Base URL: `https://starlink.com/api`
- URL: `https://starlink.com/api/public/v2/routers/{routerId}`
- Auth: HTTP bearer

Required permission: Device management, View.

## Path parameters

- `routerId` string, required

## Response `200`

RouterResponse

- RouterResponseV2ServiceResponse
  - `errors` ValidationResult[], nullable
    - `memberNames` string[], nullable
    - `errorMessage` string, nullable
  - `warnings` ValidationResult[], nullable
    - `memberNames` string[], nullable
    - `errorMessage` string, nullable
  - `information` string[], nullable
  - `isValid` boolean
  - `content` RouterResponseV2
    - `routerId` string: Router Id.
    - `nickname` string, nullable: Nickname of the router.
    - `userTerminalId` string: User terminal Id this router is bonded to.
    - `configId` string, nullable: Router config this router is assigned to, or null if no config assigned.
    - `hardwareVersion` string, nullable: Deprecated field. Value will always be null
    - `lastBonded` string, date-time, nullable: Deprecated field. Value will always be null

## Other responses

- `400`: Bad request. Invalid or missing parameter
- `401`: Unauthorized
- `403`: Missing required permission for this endpoint or resource
- `422`: Failed to get router

---

[API](https://skmtc.dev/starlink/apis/starlink-management-api.md) - [All operations](https://skmtc.dev/starlink/apis/starlink-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/starlink/apis/starlink-management-api/revisions/dfd7014cfd6d?raw)
