Service

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

Changed on Oct 14, 2026

Retrieves the 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
Auth
- API key in header zt-session
- or OAuth 2
  Authorization code/oidc/authorize
  Token URL/oidc/token
  Scopesopenid
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.

Path parameters

idstring required

The id of the requested resource

Query parameters

limitinteger

offsetinteger

filterstring

Headers

session-tokenstring

an optional JWT token use to authenticate the request. If provided, the token must be valid else a not authorized response is returned.

Response

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

Example response

{
  "data": {
    "edgeRouters": [
      {
        "appData": {},
        "capabilities": [
          "capabilities",
          "capabilities"
        ],
        "cost": 5248,
        "disabled": true,
        "hostname": "hostname",
        "isOnline": true,
        "name": "name",
        "noTraversal": true,
        "supportedProtocols": {
          "key": "supportedProtocols"
        },
        "syncStatus": "syncStatus",
        "version": "version"
      },
      {
        "appData": {},
        "capabilities": [
          "capabilities",
          "capabilities"
        ],
        "cost": 5248,
        "disabled": true,
        "hostname": "hostname",
        "isOnline": true,
        "name": "name",
        "noTraversal": true,
        "supportedProtocols": {
          "key": "supportedProtocols"
        },
        "syncStatus": "syncStatus",
        "version": "version"
      }
    ]
  },
  "meta": {
    "apiEnrollmentVersion": "apiEnrollmentVersion",
    "apiVersion": "apiVersion",
    "filterableFields": [
      "filterableFields",
      "filterableFields"
    ],
    "pagination": {
      "limit": 0.8008281904610115,
      "offset": 6.027456183070403,
      "totalCount": 1.4658129805029452
    }
  }
}

Changes

Oct 14, 2026f7b51eaafbbb Revision changes
- breaking
  the response property /// became nullable for the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
May 29, 2024cce2800c1357 Revision changes
- warning
  the optional response header WWW-Authenticate removed for the status 200
- warning
  the optional response header WWW-Authenticate removed for the status 400
- warning
  the optional response header WWW-Authenticate removed for the status 401
- warning
  the optional response header WWW-Authenticate removed for the status 404
- warning
  the optional response header WWW-Authenticate removed for the status 429

Operation history