---
title: "Return this list of Edge Routers the identity has access to"
method: GET
path: "/current-identity/edge-routers"
tags: ["Current Identity", "Edge Router"]
---

# Return this list of Edge Routers the identity has access to

`GET /current-identity/edge-routers`

## Request

- Base URL: `https://demo.ziti.dev/edge/client/v1`
- URL: `https://demo.ziti.dev/edge/client/v1/current-identity/edge-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-edge-client/docs/current-identity/edge-routers/get.ts> (a function with typed inputs; its response is checked against the schema)

Lists the Edge Routers that the current identity has access to via policies. The data returned
includes their address and online status

## Response `200`

A list of edge routers

- ListCurrentIdentityEdgeRoutersEnvelope
  - `data` CurrentIdentityEdgeRouterDetail[], required: A list of edge router resources
    - `_links` object, required: A map of named links
    - `createdAt` string, date-time, required
    - `id` string, required
    - `tags` Tags
    - `updatedAt` string, date-time, required
    - `appData` Tags
    - `capabilities` string[]: Capabilities this edge router advertises, used by SDK clients to select a router that supports a given feature before connecting. Open-ended: clients ignore values they do not recognize. Absent when the controller predates this field.
    - `cost` integer, nullable, required
    - `disabled` boolean, required
    - `hostname` string, required
    - `isOnline` boolean, required
    - `name` string, required
    - `noTraversal` boolean, nullable, required
    - `supportedProtocols` object, required
    - `syncStatus` string, required
    - `version` string: The version of the edge router binary, as reported to the controller when the router connects. Empty when the controller has not yet received a version from the router or predates this field.
  - `meta` Meta, required
    - `apiEnrollmentVersion` string
    - `apiVersion` string
    - `filterableFields` string[]
    - `pagination` Pagination
      - `limit` number, required
      - `offset` number, required
      - `totalCount` number, required

## Other responses

- `401`: The 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
- `503`: The request could not be completed due to the server being busy or in a temporarily bad state

## Changes

- **2026-10-14** `f7b51eaafbbb`: 2 breaking, 2 info
  - the response property `data/items/allOf[#/components/schemas/baseEntity]/tags` became nullable for the status `200`
  - the response property `data/items/allOf[#/components/schemas/commonEdgeRouterProperties]/appData` became nullable for the status `200`
  - added the optional property `data/items/allOf[#/components/schemas/commonEdgeRouterProperties]/capabilities` to the response with the `200` status
  - added the optional property `data/items/allOf[#/components/schemas/commonEdgeRouterProperties]/version` to the response with the `200` status
- **2025-01-24** `19dfd92f02a2`: 1 info
  - added the non-success response with the status `503`
- **2024-05-29** `cce2800c1357`: 3 warning, 1 info
  - the optional response header `WWW-Authenticate` removed for the status `200`
  - the optional response header `WWW-Authenticate` removed for the status `401`
  - the optional response header `WWW-Authenticate` removed for the status `429`
  - removed the non-success response with the status `503`

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

---

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