Hanzo
OpenapiIngress

Returns every backend pool the caller's org has configured, ordered by id.

Returns every backend pool the caller's org has configured, ordered by id.

GET /v1/ingress/services

Addresshttps://api.hanzo.ai/v1/ingress/services
MethodGET
Operationget_ingress_services
AuthAuthorization: Bearer $HANZO_API_KEY

Returns every backend pool the caller's org has configured, ordered by id. A service is the weighted round-robin target a route dispatches to.

Request

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

Response

StatusBodyMeaning
200ingressServicesok

200 body — 6 fields.

FieldInTypeAlwaysDescription
servicesbodyUpstream[]Services is the org's services, ordered by id.
services[].backendsbodyBackend[]Backends are the upstream servers to balance across: 1..32 of them.
services[].backends[].urlbodystringURL is the upstream server, http(s)://host[:port].
services[].backends[].weightbodyintegerWeight is this member's share of the round-robin; must be >= 0.
services[].idbodystringID identifies the pool within the org: [A-Za-z0-9-_.], at most 128 chars.
services[].passHostHeaderbodybooleanPassHostHeader forwards the client's original Host header upstream instead of rewriting it to the backend's.

Failure carries the platform error shape — see Errors.

Examples

hanzo ingress services list

Ingress API · All Hanzo APIs · Interactive reference

How is this guide?

On this page