Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Uptime checks

An UptimeCheck observes safe transport behavior or the public revision of every authorized bound host/path.

An UptimeCheck observes safe transport behavior or the public revision of every authorized bound host/path. Workflows owns its durable clock.

Service Sylphx Observability · Resource type observability.sylphx.com/UptimeCheck · Name pattern orgs/{org}/projects/{project}/envs/{env}/uptime_checks/{uptime_check} · Shape spec_status

#Fields

FieldTypeWhat it is
namestringThe tenant-scoped check name.
uidstringA new immutable identity on every creation, including name reuse. Output only.
metaResourceMetaResource metadata, generation and etag.
specUptimeCheckSpecSafe desired observation policy. Required.
statusUptimeCheckStatusDurable evidence, including missing coverage. Output only.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
POSTcreateCreates one tenant uptime check.
GETgetGets one tenant uptime check.
GETlistLists checks and aggregate status. GetUptimeCheck reads target pages.
PATCHupdateUpdates one tenant uptime check.
DELETEdeleteDeletes one tenant uptime check.

#create

Creates one tenant uptime check.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/uptime_checks · scope observability:write · effect write · Request, response and examples

#get

Gets one tenant uptime check.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/uptime_checks/uptime-check · scope observability:read · effect read · Request, response and examples

#list

Lists checks and aggregate status. GetUptimeCheck reads target pages.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/uptime_checks · scope observability:read · effect read · paginated · Request, response and examples

#update

Updates one tenant uptime check.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/uptime_checks/uptime-check · scope observability:write · effect write · Request, response and examples

#delete

Deletes one tenant uptime check.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/uptime_checks/uptime-check · scope observability:write · effect destructive · Request, response and examples