---
title: "List ingresses"
method: GET
path: "/ingresses"
---

# List ingresses

`GET /ingresses`

## Query parameters

- `tags` Tags — User-defined key-value tags.

## Response `200`

List of ingresses

- Ingress[]
  - `id` string, required — Auto-generated unique identifier
  - `name` string, required — Human-readable name
  - `tags` Tags — User-defined key-value tags.
  - `rules` IngressRule[], required — Routing rules for this ingress
    - `match` IngressMatch, required
      - `hostname` string, required — Hostname to match. Can be: - Literal: "api.example.com" (exact match on Host header) - Pattern: "{instance}.example.com" (dynamic routing based on subdomain) Pattern hostnames use named captures in curly braces (e.g., {instance}, {app}) that extract parts of the hostname for routing. The extracted values can be referenced in the target.instance field.
      - `port` integer — Host port to listen on for this rule (default 80)
    - `target` IngressTarget, required
      - `instance` string, required — Target instance name, ID, or capture reference. - For literal hostnames: Use the instance name or ID directly (e.g., "my-api") - For pattern hostnames: Reference a capture from the hostname (e.g., "{instance}") When using pattern hostnames, the instance is resolved dynamically at request time.
      - `port` integer, required — Target port on the instance
    - `tls` boolean — Enable TLS termination (certificate auto-issued via ACME).
    - `redirect_http` boolean — Auto-create HTTP to HTTPS redirect for this hostname (only applies when tls is enabled)
  - `created_at` string, date-time, required — Creation timestamp (RFC3339)

## Other responses

- `401` — Unauthorized
- `500` — Internal server error

## Changes

- **2026-03-09** `d3b8f05f7a0f` — 2 warning, 2 info
  - deleted the `query` request parameter `metadata`
  - removed the optional property `items/metadata` from the response with the `200` status
  - added the new optional `query` request parameter `tags`
  - added the optional property `items/tags` to the response with the `200` status
- **2026-03-07** `48572ed07140` — 2 info
  - added the new optional `query` request parameter `metadata`
  - added the optional property `items/metadata` to the response with the `200` status

[Change history](https://skmtc.dev/kernel/apis/hypeman-api/changes/ingresses/get.md)

---

[API](https://skmtc.dev/kernel/apis/hypeman-api.md) · [All operations](https://skmtc.dev/kernel/apis/hypeman-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kernel/hypeman-api/revisions/b4642bb950dc/schema)