Hanzo
OpenapiIngress

Returns one of the caller org's routing rules by id.

Returns one of the caller org's routing rules by id.

GET /v1/ingress/routes/{id}

Addresshttps://api.hanzo.ai/v1/ingress/routes/{id}
MethodGET
Operationget_ingress_routes_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one of the caller org's routing rules by id.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the object to act on, from the path.

Response

StatusBodyMeaning
200Routeok

200 body — 7 fields.

FieldInTypeAlwaysDescription
hostbodystringHost is the exact hostname this route matches, lowercased with any trailing dot stripped.
idbodystringID identifies the route within the org: [A-Za-z0-9-_.], at most 128 chars.
middlewaresbodystring[]Middlewares are the ids of the edge transforms to apply, in this order, before the request reaches the service.
pathPrefixbodystringPathPrefix narrows the match to requests under this path; it must start with "/".
prioritybodyintegerPriority orders routes that share a host: higher wins, and equal priorities fall back to the longer PathPrefix.
servicebodystringService is the id of the backend pool this route dispatches to.
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 get <id>

Ingress API · All Hanzo APIs · Interactive reference

How is this guide?

On this page