# List routes

URL: https://docs.hanzo.ai/docs/openapi/ingress/get-ingress-routes

> Returns every routing rule the caller's org has configured, ordered by id.

`GET /v1/ingress/routes`

> [Ingress →](https://docs.hanzo.ai/docs/openapi/ingress) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                          |
| ------------- | ---------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/ingress/routes` |
| **Method**    | `GET`                                    |
| **Operation** | `get_ingress_routes`                     |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`   |

Returns every routing rule the caller's org has configured, ordered
by id. A route maps an exact Host (and optional path prefix) to a service.

## Request

`GET /v1/ingress/routes` takes no parameters and no body — the credential is the whole request.

## Response

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

`200` body — 8 fields.

| Field                  | In   | Type             | Always | Description                                                                                                     |
| ---------------------- | ---- | ---------------- | ------ | --------------------------------------------------------------------------------------------------------------- |
| `routes`               | body | ingress.Route\[] | —      | Routes is the org's routes, ordered by id.                                                                      |
| `routes[].host`        | body | string           | —      | Host is the exact hostname this route matches, lowercased with any trailing dot stripped.                       |
| `routes[].id`          | body | string           | —      | ID identifies the route within the org: \[A-Za-z0-9-\_.], at most 128 chars.                                    |
| `routes[].middlewares` | body | string\[]        | —      | Middlewares are the ids of the edge transforms to apply, in this order, before the request reaches the service. |
| `routes[].pathPrefix`  | body | string           | —      | PathPrefix narrows the match to requests under this path; it must start with "/".                               |
| `routes[].priority`    | body | integer (int64)  | —      | Priority orders routes that share a host: higher wins, and equal priorities fall back to the longer PathPrefix. |
| `routes[].service`     | body | string           | —      | Service is the id of the backend pool this route dispatches to.                                                 |
| `routes[].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](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo ingress routes list
```

**SDK**

**.ts**

```ts
import { Configuration, IngressApi } from 'hanzoai';

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

**.py**

```python
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()
```

**.go**

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

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

**.rs**

```rust
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(&cfg, Default::default()).await?;
```

**.java**

```java
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).getIngressRoutes();
```

**HTTP**

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

**MCP**

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:

```bash
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](https://docs.hanzo.ai/docs/openapi/ingress) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)
