Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Update an uptime source

Configures manifest reconciliation; absent subscriptions require an empty etag.

Configures manifest reconciliation; absent subscriptions require an empty etag.

  • Path PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/uptime_sources/uptime-source
  • Scope observability:write
  • Effect write — a successful call changes state.
  • Collection uptime_sources
  • Query update_mask

#Request

FieldTypeWhat it is
uptime_sourceUptimeSourceSubscription with an etag from Get, or empty on initial setup. Required.
update_maskfield_maskOnly spec is supported; omission also replaces the whole spec.

#UptimeSource

FieldTypeWhat it is
namestringOnly uptime_sources/manifest is supported.
metaResourceMetaLifecycle-bound etag and generation.
specUptimeSourceSpecDelegated source reconciliation policy. Required.

#ResourceMeta

FieldTypeWhat it is
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.

#UptimeSourceSpec

FieldTypeWhat it is
execution_delegationstringExact Access delegation reference; credentials never enter this resource. Required.
pausedboolStops source reconciliation; existing checks keep their own pause policy.

#Response

FieldTypeWhat it is
namestringOnly uptime_sources/manifest is supported.
uidstringNever reused; ownership receipts survive an empty source set. Output only.
metaResourceMetaLifecycle-bound etag and generation.
specUptimeSourceSpecDelegated source reconciliation policy. Required.
statusUptimeSourceStatusLast applied source and visible reconciliation outcome. 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.

#UptimeSourceSpec

FieldTypeWhat it is
execution_delegationstringExact Access delegation reference; credentials never enter this resource. Required.
pausedboolStops source reconciliation; existing checks keep their own pause policy.

#UptimeSourceStatus

FieldTypeWhat it is
observed_generationint64Subscription generation last fully converged. Output only.
conditionsCondition[]Reconciling or Ready, independently of probe health. Output only.
source_uidstringLast fully converged source identity. Output only.
applied_revisionstringOpaque owner-provided revision of the complete desired set. Output only.
reasonstringFinite error code, empty after successful convergence. Output only.
last_attempt_timetimestampLatest completed reconciliation attempt. Output only.
delegate_principalstringStable attested Observability workload principal to name as delegate. Output only.

#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 -X PATCH "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/uptime_sources/uptime-source" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"orgs/acme/projects/shop/envs/production/uptime_sources/uptime-source","spec":{"execution_delegation":"…"}}'