Get middlewares

Returns one of the caller org's edge transforms by id.

GET /v1/ingress/middlewares/{id}

Ingress → · All API references → · Get started →

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

Returns one of the caller org's edge transforms 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.Middleware	ok
`default`	problem-details	refused

200 body — 4 fields.

Field	In	Type	Always	Description
`config`	body	object	—	Config is the transform's parameters: redirectScheme takes scheme (default https) and permanent ("true" ⇒ 301, else 302); stripPrefix REQUIRES prefixes (comma-separated, first match wins); addPrefix REQUIRES prefix; headers is a header→value map set on the response.
`config.*`	body	string	—
`id`	body	string	—	ID identifies the transform within the org: [A-Za-z0-9-_.], at most 128 chars.
`type`	body	string	—	Type is the transform: redirectScheme, stripPrefix, addPrefix or headers.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo ingress middlewares 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.getIngressMiddlewaresById({ 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_middlewares_by_id(id='id')

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

resp, _, err := client.IngressAPI.GetIngressMiddlewaresById(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_middlewares_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).getIngressMiddlewaresById();

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

PreviousDelete services NextList middlewares