v1

latestOpenAPI 3.1.02026-07-24317911.4 MB
Routes

Read Routes

get/routes

Query parameters

route-destination-match-patternstring
route-source-match-patternstring
route-classstring
route-match-server-hostnamestring

Response

route-destination-match-patternstring required

This is the main route match for the destination.

route-source-match-patternstring

This is the source route, in most cases this should default to * and not be set otherwise.

route-classstring

This for jurisdictional routing of class. Leave as * for most cases.

route-match-server-hostnamestring hostname

This field will limit the route to only be effective on a matching hostname. This allow for localized routing to a closest carrier's POP or other special cases.

route-is-enabled'yes' | 'no'
descriptionstring required

This is the route description, use to to give a plain english explanation as to what the route is intended to do.

route-method'fixed' | 'cost' | 'percentage' required

This is the type of route to select the distribution method for the next hop/connection setting.

Example response

[
  {
    "route-match-server-hostname": "core1-phx.example.com"
  }
]