Skip to content
Console
On this page

List services

Lists services in a environment.

Lists services in a environment.

  • 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

FieldTypeWhat it is
parentstringThe parent to list in. Required.
page_sizeint32At most this many; default 50, clamped to 1000.
page_tokenstringnext_page_token of the previous page.
filterstringAIP-160 filter over labels, filterable fields, and Ready.
order_bystringAIP-132 ordering over filterable fields.

Response

FieldTypeWhat it is
servicesService[]The page.
next_page_tokenstringThe token of the next page; empty on the last page.

Service

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/services/{service}.
uidstringsvc_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specServiceSpecDesired state, omitted when no immutable public projection is available.
statusServiceStatusObserved state. Output only.
projection_incompleteboolTrue when some desired inputs or serving observations are unavailable. Output only.
unavailable_fieldsstring[]Field paths not established by retained evidence. Output only.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong 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_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

ServiceSpec

FieldTypeWhat it is
sourceServiceSourceWhat the Service runs. Required.
commandstringOverrides the image's command.
portint32The port the application listens on; the public edge stays 443.
exposureServiceExposureWho can reach the Service; default PUBLIC. One of public, internal.
sizeInstanceSizeThe size of each instance; default the plan's. One of nano, micro, small, standard, large, xlarge, xxlarge.
scalingServiceScalingInstance bounds.
healthServiceHealthHow instances are probed.
envmap<string, string>Plain environment variables. Secret values bind through secret_env, never here.
secret_envmap<string, string>Environment variables bound to Sylphx Secrets: variable name to Secret name. The value never enters the spec.
regionsstring[]Regions to run in; default the project's home region.

ServiceStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
uristringThe default URL: https://<ref>.sylphx.app, or *.unclaimed.sylphx.app for an unclaimed project. Output only.
releasestringThe Sylphx Release now serving. Output only.
imagestringThe image digest now serving. Output only.
rolloutstringThe Rollout in progress, if any. Output only.
ready_instancesint32Instances passing health, summed over cells. Output only.
current_releasestringThe selected environment Release; not proof that this service runs it. Output only.
lifecycle_statestringThe persisted service lifecycle, independent of observed readiness. Output only.

ServiceSource

FieldTypeWhat it is
source_linkstringBuild from this SourceLink's repository on every push to branch. One of the source group.
imagestringRun this Artifact, by digest: registry.sylphx.net/<path>@sha256:<hex>. One of the source group.
branchstringThe branch that ships to this Service; default the SourceLink's production branch. Ignored for image.
buildServiceBuildHow Build turns the source into an image. Ignored for image.

ServiceScaling

FieldTypeWhat it is
min_instancesint32Instances kept running with no traffic; 0 idles to zero and wakes on request.
max_instancesint32Instances at most; 0 means the plan's limit.

ServiceHealth

FieldTypeWhat it is
protocolHealthProtocolHow to probe. Required. One of http, tcp.
pathstringThe HTTP path to probe when protocol is HTTP.
startup_timeoutdurationHow long a new instance may take to pass its first probe.

Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

Errors

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"