v1

latestOpenAPI 3.0.1Apache 2.02026-07-1759153352.8 KB
Service

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

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

get/services/{id}/edge-routers

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": [
      {
        "hostname": "hostname",
        "cost": 5248,
        "name": "name",
        "noTraversal": true,
        "disabled": true,
        "isOnline": true,
        "supportedProtocols": {
          "key": "supportedProtocols"
        },
        "appData": {},
        "syncStatus": "syncStatus"
      },
      {
        "hostname": "hostname",
        "cost": 5248,
        "name": "name",
        "noTraversal": true,
        "disabled": true,
        "isOnline": true,
        "supportedProtocols": {
          "key": "supportedProtocols"
        },
        "appData": {},
        "syncStatus": "syncStatus"
      }
    ]
  },
  "meta": {
    "apiEnrollmentVersion": "apiEnrollmentVersion",
    "apiVersion": "apiVersion",
    "pagination": {
      "offset": 6.027456183070403,
      "limit": 0.8008281904610115,
      "totalCount": 1.4658129805029452
    },
    "filterableFields": [
      "filterableFields",
      "filterableFields"
    ]
  }
}