Console

Start

Platform

App store purchases

Auth

Builds

Database

Flags

Hosting

Jobs and cron

Localization

Monitoring

Network

Notifications

Organizations

Payments

Queues

Events

Realtime

Runners

Sandboxes

Storage

Webhooks

Workflows

Getting Started

Installation

Authentication

AI Services

KV Store

Overview

Webhooks

Deploy & Infrastructure

Reference

On this page

Request
Response
Service
ResourceMeta
ServiceSpec
ServiceStatus
ServiceSource
ServiceScaling
ServiceHealth
Condition
Errors
Examples

Reference

List services

Lists services in a environment.

Checked 2026-09-28

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

Lists services in a environment.

Not available yet. Sylphx Hosting is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.

Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services
Scope hosting:read
Effect read — nothing is written.
Collection services
Query page_size, page_token, filter, order_by
Pagination the answer carries services and, when there is more, next_page_token

#Request

Field	Type	What it is
`parent`	`string`	The parent to list in. Required.
`page_size`	`int32`	At most this many; default 50, clamped to 1000.
`page_token`	`string`	`next_page_token` of the previous page.
`filter`	`string`	AIP-160 filter over labels, filterable fields, and Ready.
`order_by`	`string`	AIP-132 ordering over filterable fields.

#Response

Field	Type	What it is
`services`	`Service[]`	The page.
`next_page_token`	`string`	The token of the next page; empty on the last page.

#Service

Field	Type	What it is
`name`	`string`	`orgs/{org}/projects/{project}/envs/{env}/services/{service}`.
`uid`	`string`	`svc_<cell><ulid>`; never reused. Output only.
`meta`	`ResourceMeta`	Resource metadata.
`spec`	`ServiceSpec`	Desired state. Required.
`status`	`ServiceStatus`	Observed state. 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.

#ServiceSpec

Field	Type	What it is
`source`	`ServiceSource`	What the Service runs. Required.
`command`	`string`	Overrides the image's command.
`port`	`int32`	The port the application listens on; the public edge stays 443.
`exposure`	`ServiceExposure`	Who can reach the Service; default PUBLIC. One of `public`, `internal`.
`size`	`InstanceSize`	The size of each instance; default the plan's. One of `nano`, `micro`, `small`, `standard`, `large`, `xlarge`, `xxlarge`.
`scaling`	`ServiceScaling`	Instance bounds.
`health`	`ServiceHealth`	How instances are probed.
`env`	`map<string, string>`	Plain environment variables. Secret values bind through `secret_env`, never here.
`secret_env`	`map<string, string>`	Environment variables bound to Sylphx Secrets: variable name to Secret name. The value never enters the spec.
`regions`	`string[]`	Regions to run in; default the project's home region.

#ServiceStatus

Field	Type	What it is
`observed_generation`	`int64`	The generation this status was computed from. Output only.
`conditions`	`Condition[]`	Ready, Reconciling, Stalled. Output only.
`uri`	`string`	The default URL: `https://<ref>.sylphx.app`, or `*.unclaimed.sylphx.app` for an unclaimed project. Output only.
`release`	`string`	The Sylphx Release now serving. Output only.
`image`	`string`	The image digest now serving. Output only.
`rollout`	`string`	The Rollout in progress, if any. Output only.
`ready_instances`	`int32`	Instances passing health, summed over cells. Output only.

#ServiceSource

Field	Type	What it is
`source_link`	`string`	Build from this SourceLink's repository on every push to `branch`. One of the `source` group.
`image`	`string`	Run this Artifact, by digest: `registry.sylphx.net/<path>@sha256:<hex>`. One of the `source` group.
`branch`	`string`	The branch that ships to this Service; default the SourceLink's production branch. Ignored for `image`.
`build`	`ServiceBuild`	How Build turns the source into an image. Ignored for `image`.

#ServiceScaling

Field	Type	What it is
`min_instances`	`int32`	Instances kept running with no traffic; 0 idles to zero and wakes on request.
`max_instances`	`int32`	Instances at most; 0 means the plan's limit.

#ServiceHealth

Field	Type	What it is
`protocol`	`HealthProtocol`	How to probe. Required. One of `http`, `tcp`.
`path`	`string`	The HTTP path to probe when `protocol` is HTTP.
`startup_timeout`	`duration`	How long a new instance may take to pass its first probe.

#Condition

Field	Type	What it is
`type`	`string`	The condition type, for example `Ready`.
`status`	`ConditionStatus`	Whether the condition holds. One of `true`, `false`, `unknown`.
`observed_generation`	`int64`	The generation this observation was made against.
`reason`	`string`	A machine-readable UpperCamelCase reason.
`message`	`string`	A customer-safe human-readable message.
`severity`	`Severity`	How severe a FALSE condition is. One of `info`, `warning`, `error`.
`transition_time`	`timestamp`	When `status` last changed.

#Errors

UNAUTHENTICATED — No valid key or token was presented.
PERMISSION_DENIED — The key lacks the method's permission.
INVALID_FIELD — A field failed validation.
PAGE_TOKEN_MISMATCH — A page token was reused with different parameters.

Every error arrives in the body Errors describes.

#Examples

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

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links