Menu
Platform
- Accounts and projects
- Regions
- Environments
- Keys and scopes
- Plans, usage and limits
- Errors
- API versions
- API reference
- CLI
- MCP
- Published CLI compatibility
- Terraform
- Management secret deletion
- API keys
- Artifacts
- Connection providers
- Connections
- Envs
- Key versions
- Keys
- Projects
- Secret versions
- Secrets
- Service enablements
- Token exchanges
- Trust policies
AI
Alerts and status pages
App store purchases
Credits
Database
Flags
Generated Assets
Hosting
Monitoring
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Get a serving route
Gets an authorized public route observation.
Gets an authorized public route observation.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/serving_routes/serving-route - Scope
hosting:read - Effect
read— nothing is written. - Collection serving_routes
#Request
| Field | Type | What it is |
|---|---|---|
name | string | Exact tenant-scoped route name. Required. |
#Response
| 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— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_FIELD— A field failed validation.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/serving_routes/serving-route" \
-H "Authorization: Bearer $SYLPHX_API_KEY"