Hanzo
OpenapiIngress

Returns every routing rule the caller's org has configured, ordered by id.

Returns every routing rule the caller's org has configured, ordered by id.

GET /v1/ingress/routes

Addresshttps://api.hanzo.ai/v1/ingress/routes
MethodGET
Operationget_ingress_routes
AuthAuthorization: Bearer $HANZO_API_KEY

Returns every routing rule the caller's org has configured, ordered by id. A route maps an exact Host (and optional path prefix) to a service.

Request

GET /v1/ingress/routes takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200ingressRoutesok

200 body — 8 fields.

FieldInTypeAlwaysDescription
routesbodyRoute[]Routes is the org's routes, ordered by id.
routes[].hostbodystringHost is the exact hostname this route matches, lowercased with any trailing dot stripped.
routes[].idbodystringID identifies the route within the org: [A-Za-z0-9-_.], at most 128 chars.
routes[].middlewaresbodystring[]Middlewares are the ids of the edge transforms to apply, in this order, before the request reaches the service.
routes[].pathPrefixbodystringPathPrefix narrows the match to requests under this path; it must start with "/".
routes[].prioritybodyintegerPriority orders routes that share a host: higher wins, and equal priorities fall back to the longer PathPrefix.
routes[].servicebodystringService is the id of the backend pool this route dispatches to.
routes[].tlsbodybooleanTLS asks the edge to terminate TLS for Host with an ACME-managed certificate.

Failure carries the platform error shape — see Errors.

Examples

hanzo ingress routes list

Ingress API · All Hanzo APIs · Interactive reference

How is this guide?

On this page