Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Get an uptime manifest

Reads complete check declarations from the owner's selected source intent.

Reads complete check declarations from the owner's selected source intent. Missing, unavailable or invalid sources are errors, never an empty set.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/uptime_manifests/uptime-manifest
  • Scope hosting:read
  • Effect read — nothing is written.
  • Collection uptime_manifests

#Request

FieldTypeWhat it is
namestringThe singleton uptime_manifests/current in an authorized environment. Required.

#Response

FieldTypeWhat it is
namestringOnly uptime_manifests/current is supported.
uidstringStable source identity scoped to this environment. Output only.
metaResourceMetaResource metadata.
revisionstringComplete source snapshot revision; callers must not order it lexically. Output only.
source_shastringSource commit selected by the Hosting intent owner. Output only.
manifest_versionint64Exact bound project manifest version. Output only.
content_digeststringDigest recorded for that bound source manifest. Output only.
declarations_jsonstringJSON manifest fragment containing only services[].name and resources.telemetry.check. Valid absence is represented as an empty array. 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.

#Errors

Every error arrives in the body Errors describes.

#Examples

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