---
title: "List of edge routers permitted to handle traffic for the specified service"
method: GET
path: "/services/{id}/edge-routers"
tags: ["Service"]
---

# List of edge routers permitted to handle traffic for the specified service

`GET /services/{id}/edge-routers`

## Request

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

Retrieves the list of edge routers permitted to handle traffic for the specified service

## Path parameters

- `id` string, required

## Query parameters

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

## Headers

- `session-token` string

## Response `200`

A list of edge routers suitable for dialing or binding the specified service by the authenticated identity

- ListServiceEdgeRoutersEnvelope
  - `data` ServiceEdgeRouters, required
    - `edgeRouters` CommonEdgeRouterProperties[]
      - `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

- `400`: The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information
- `401`: The supplied session does not have the correct access rights to request this resource
- `404`: The requested resource does not exist
- `429`: The resource requested is rate limited and the rate limit has been exceeded

## Changes

- **2026-10-14** `f7b51eaafbbb`: 1 breaking, 2 info
  - the response property `data/edgeRouters/items/appData` became nullable for the status `200`
  - added the optional property `data/edgeRouters/items/capabilities` to the response with the `200` status
  - added the optional property `data/edgeRouters/items/version` to the response with the `200` status
- **2024-05-29** `cce2800c1357`: 5 warning
  - the optional response header `WWW-Authenticate` removed for the status `200`
  - the optional response header `WWW-Authenticate` removed for the status `400`
  - the optional response header `WWW-Authenticate` removed for the status `401`
  - the optional response header `WWW-Authenticate` removed for the status `404`
  - …1 more

[Operation history](https://skmtc.dev/openziti/apis/ziti-edge-client/changes/services/:id/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)