Hanzo
OpenapiIngress

Returns one of the caller org's backend pools by id.

Returns one of the caller org's backend pools by id.

GET /v1/ingress/services/{id}

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

Returns one of the caller org's backend pools by id.

Request

1 field.

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

Response

StatusBodyMeaning
200Upstreamok

200 body — 5 fields.

FieldInTypeAlwaysDescription
backendsbodyBackend[]Backends are the upstream servers to balance across: 1..32 of them.
backends[].urlbodystringURL is the upstream server, http(s)://host[:port].
backends[].weightbodyintegerWeight is this member's share of the round-robin; must be >= 0.
idbodystringID identifies the pool within the org: [A-Za-z0-9-_.], at most 128 chars.
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 get <id>

Ingress API · All Hanzo APIs · Interactive reference

How is this guide?

On this page