---
# @generated by sylphx-gen. Do not edit.
title: "List serving routes"
description: "`hosting.serving_routes.list` (GET /v1/{parent}/serving_routes): Lists every authorized public route; follow all pages in one snapshot."
type: reference
product: hosting
summary: "Lists every authorized public route; follow all pages in one snapshot."
updated: 2026-09-28
nav: false
---

Lists every authorized public route; follow all pages in one snapshot.

- **Path** `GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/serving_routes`
- **Scope** `hosting:read`
- **Effect** `read` — nothing is written.
- **Collection** [serving_routes](/docs/api/serving_routes)
- **Query** `page_size`, `page_token`
- **Pagination** the answer carries `serving_routes` and, when there is more, `next_page_token`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | Exact authorized environment. Required. |
| `page_size` | `int32` | At most 100 routes; each retains its full host/rule population. |
| `page_token` | `string` | Continuation bound to this parent and owner snapshot. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `serving_routes` | `ServingRoute[]` | Routes in stable identity order. |
| `next_page_token` | `string` | Empty only at the end of this snapshot. |
| `snapshot_id` | `string` | Changes when routes, observations or current Release policy change. |

### ServingRoute

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | Tenant-scoped name of this route observation. |
| `uid` | `string` | Stable identity of the underlying route lifetime. Output only. |
| `meta` | `ResourceMeta` | Route generation and observation time. |
| `service` | `string` | Owning same-environment service. Output only. |
| `hostnames` | `string[]` | Full declared hostname population; wildcard values stay wildcard. Output only. |
| `rules` | `ServingRouteRule[]` | Every rule, including unsupported or unobserved ones. Output only. |
| `observed` | `bool` | True only when the owner has observed the current route generation. Output only. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

### ServingRouteRule

| Field | Type | What it is |
| --- | --- | --- |
| `index` | `int32` | Stable index in this route generation. |
| `matches` | `ServingRouteMatch[]` | Complete match population. No match means the default prefix /. |
| `backends` | `ServingRouteBackend[]` | Every selected backend, including weight zero for truthful readback. |
| `expected_release` | `string` | Current serving Release, or the admitted rollout moving this rule. |
| `expected_source_shas` | `string[]` | Expected tenant sources from current Release members and admitted positive-weight rollout choices; never copied from response headers. |
| `unknown_reason` | `string` | Nonempty for redirect-only, unsupported or unavailable policy. |

### ServingRouteMatch

| Field | Type | What it is |
| --- | --- | --- |
| `path_type` | `string` | Exact, PathPrefix, or RegularExpression. |
| `path` | `string` | Exact path or path expression. |
| `method` | `string` | Empty matches any method; otherwise the exact HTTP method. |
| `requires_request_context` | `bool` | True when headers/query or unknown match extensions need caller input. |

### ServingRouteBackend

| Field | Type | What it is |
| --- | --- | --- |
| `revision` | `string` | Immutable selected revision name, when the backend is a revision. |
| `weight` | `int32` | Effective positive selection weight; zero receives no traffic. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`PAGE_TOKEN_MISMATCH`](/docs/api/errors/PAGE_TOKEN_MISMATCH) — A page token was reused with different parameters.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/serving_routes" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.hosting.servingRoutes.list({ parent: 'orgs/acme/projects/shop/envs/production' })
```

**Rust**

```rust
let mut req = sylphx::hosting::ListServingRoutesRequest::default();
req.parent = "orgs/acme/projects/shop/envs/production".to_string();
let response = sx.hosting().serving_routes().list(req).await?;
```

**CLI**

```bash
sylphx hosting serving-routes list orgs/acme/projects/shop/envs/production
```

**MCP**

```json
{ "method_id": "hosting.serving_routes.list", "args": {"parent":"orgs/acme/projects/shop/envs/production"} }
```