Hanzo
OpenapiIngress

Creates or replaces one backend pool and hot-applies it. — PUT /v1/ingress/services/{id}

Creates or replaces one backend pool and hot-applies it.

PUT /v1/ingress/services/{id}

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

Creates or replaces one backend pool and hot-applies it. POST mints an id when the body omits one; PUT takes the id from the URL, which wins over any id in the body. A pool needs at least one backend and every backend URL must be http(s)://host[:port].

Request

6 fields, body application/json (required).

FieldInTypeRequiredDescription
idpathstringyesID identifies the pool within the org: [A-Za-z0-9-_.], at most 128 chars.
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.

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 set <id>

Ingress API · All Hanzo APIs · Interactive reference

How is this guide?

On this page