List services

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

GET /v1/ingress/services

Ingress → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/ingress/services`
Method	`GET`
Operation	`get_ingress_services`
Auth	`Authorization: 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

Status	Body	Meaning
`200`	ingress.ingressServices	ok
`default`	problem-details	refused

200 body — 6 fields.

Field	In	Type	Always	Description
`services`	body	ingress.Upstream[]	—	Services is the org's services, ordered by id.
`services[].backends`	body	ingress.Backend[]	—	Backends are the upstream servers to balance across: 1..32 of them.
`services[].backends[].url`	body	string	—	URL is the upstream server, http(s)://host[:port].
`services[].backends[].weight`	body	integer (int64)	—	Weight is this member's share of the round-robin; must be >= 0.
`services[].id`	body	string	—	ID identifies the pool within the org: [A-Za-z0-9-_.], at most 128 chars.
`services[].passHostHeader`	body	boolean	—	PassHostHeader 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

CLI

SDK

HTTP

MCP

hanzo ingress services list

.ts

.py

.go

.rs

.java

import { Configuration, IngressApi } from 'hanzoai';

const api = new IngressApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getIngressServices();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import IngressApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = IngressApi(client).get_ingress_services()

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.IngressAPI.GetIngressServices(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, ingress_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = ingress_api::get_ingress_services(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.IngressApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new IngressApi(client).getIngressServices();

curl https://api.hanzo.ai/v1/ingress/services \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches ingress through the ingress tool, which names its 18 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_ingress_middlewares"
         }
       }
     }'

Ingress API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousGet services NextList status