---
title: "List routers"
method: GET
path: "/routers"
tags: ["Router"]
---

# List routers

`GET /routers`

## Request

- Base URL: `https://demo.ziti.dev/fabric/v1`
- URL: `https://demo.ziti.dev/fabric/v1/routers`
- Auth: one of:
  - API key in header `zt-session`
  - OAuth 2
    - Authorization code: `/oidc/authorize`
    - Token URL: `/oidc/token` scopes: `openid`
- TypeScript: <https://skmtc.dev/openziti/apis/ziti-fabric/docs/routers/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a list of router resources; supports filtering, sorting, and pagination. Requires admin access.

## Query parameters

- `limit` integer
- `offset` integer
- `filter` string

## Response `200`

A list of routers

- ListRoutersEnvelope
  - `meta` Meta, required
    - `filterableFields` string[]
    - `pagination` Pagination
      - `limit` number, required
      - `offset` number, required
      - `totalCount` number, required
    - `apiEnrollmentVersion` string
    - `apiVersion` string
  - `data` RouterDetail[], required
    - `id` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `_links` Links, required: A map of named links
    - `tags` Tags, required
    - `name` string, required
    - `fingerprint` string, required
    - `connected` boolean, required
    - `cost` integer, required
    - `noTraversal` boolean, required
    - `disabled` boolean, required
    - `listenerAddresses` RouterListener[]
      - `address` string, required
      - `protocol` string, required
    - `versionInfo` VersionInfo: Application build information
      - `version` string
      - `revision` string
      - `buildDate` string
      - `os` string
      - `arch` string
    - `interfaces` Interface[]
      - `name` string, required
      - `hardwareAddress` string, required
      - `mtu` integer, required
      - `index` integer, required
      - `isUp` boolean, required
      - `isRunning` boolean, required
      - `isLoopback` boolean, required
      - `isBroadcast` boolean, required
      - `isMulticast` boolean, required
      - `addresses` string[], required
    - `ctrlChanListeners` object
    - `configs` string[]

## Other responses

- `401`: The currently supplied session does not have the correct access rights to request this resource
- `429`: The resource requested is rate limited and the rate limit has been exceeded

## Changes

- **2023-10-23** `61384eb76c21`: 1 info
  - added the non-success response with the status `429`
- **2023-08-16** `94130b45fa7e`: 1 info
  - removed the non-success response with the status `429`

[Operation history](https://skmtc.dev/openziti/apis/ziti-fabric/changes/routers/get.md)

---

[API](https://skmtc.dev/openziti/apis/ziti-fabric.md) - [All operations](https://skmtc.dev/openziti/apis/ziti-fabric/llms.txt) - [OpenAPI document](https://skmtc.dev/openziti/apis/ziti-fabric/revisions/b899875c8f57?raw)