Get routes

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

GET /v1/ingress/routes/{id}

Ingress → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/ingress/routes/{id}`
Method	`GET`
Operation	`get_ingress_routes_by_id`
Auth	`Authorization: Bearer $HANZO_API_KEY`

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

Request

1 field.

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the object to act on, from the path.

Response

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

200 body — 7 fields.

Field	In	Type	Always	Description
`host`	body	string	—	Host is the exact hostname this route matches, lowercased with any trailing dot stripped.
`id`	body	string	—	ID identifies the route within the org: [A-Za-z0-9-_.], at most 128 chars.
`middlewares`	body	string[]	—	Middlewares are the ids of the edge transforms to apply, in this order, before the request reaches the service.
`pathPrefix`	body	string	—	PathPrefix narrows the match to requests under this path; it must start with "/".
`priority`	body	integer (int64)	—	Priority orders routes that share a host: higher wins, and equal priorities fall back to the longer PathPrefix.
`service`	body	string	—	Service is the id of the backend pool this route dispatches to.
`tls`	body	boolean	—	TLS asks the edge to terminate TLS for Host with an ACME-managed certificate.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo ingress routes get <id>

.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.getIngressRoutesById({ id: 'id' });

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_routes_by_id(id='id')

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

resp, _, err := client.IngressAPI.GetIngressRoutesById(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_routes_by_id(&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).getIngressRoutesById();

curl https://api.hanzo.ai/v1/ingress/routes/<id> \
  -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?

PreviousList middlewares NextList routes