Start

Agents

Alerts and status pages

App store purchases

Auth

Builds

Credits

Database

Flags

Generated Assets

Hosting

Jobs and cron

Knowledge

Localization

Monitoring

Network

Notifications

Organizations

Queues

Realtime

Runners

Sandboxes

Storage

Webhooks

Workflows

Getting Started

Installation

Authentication

AI Services

KV Store

Overview

Webhooks

Deploy & Infrastructure

Reference

On this page

create
get
list
update
delete

Reference

sylphx observability uptime_checks

Every sylphx observability uptime_checks command: its argument, its flags and a run line.

Checked 2026-09-28

The uptime_checks commands of Sylphx Observability, as the CLI spells them: the same calls as the uptime_checks API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

#create

Creates one tenant uptime check.

ID — The id segment of the new Resource's name; the server assigns one when omitted.

CLI

Shell

sylphx observability uptime-checks create --parent orgs/acme/projects/shop/envs/production --spec.execution-delegation …

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

Flags

Flag	Type	What it does
`--parent`	`string`	The parent to create in; defaults to the linked project or the key's scope.
`--meta.labels`	`key=value`	Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
`--meta.annotations`	`key=value`	Caller-writable, unindexed annotations. Repeat the flag for each value.
`--meta.display-name`	`string`	Caller-writable human-readable name.
`--spec.public-uri`	`string`	HTTPS public URL, without credentials, query, fragment or redirects.
`--spec.service`	`string`	Same-environment Hosting Service resource name.
`--spec.bound-public-revisions`	`bool`	True enumerates every authorized bound public Host/path and compares independent public response identity with the selected serving Release.
`--spec.instrument`	`string`	HTTP, READY or JOURNEY. JOURNEY is valid only for a Job target.
`--spec.method`	`string`	GET or HEAD; defaults to HEAD. No headers, credentials or request body.
`--spec.path`	`string`	Private HTTP path; defaults to /healthz. Not used by READY.
`--spec.interval`	`duration`	30, 60, 300 or 900 seconds; defaults to 60 seconds.
`--spec.timeout`	`duration`	HTTP: 1, 2, 5 or 10 seconds. Journey: 10 through 900 seconds, including admission and execution. Defaults to 10 seconds.
`--spec.expect-status`	`int`	Transport successes; defaults to 200 through 299. Denial and rate limits always remain unknown, even when included here. Repeat the flag for each value.
`--spec.expect-body`	`string`	Bounded literal substring, only with GET.
`--spec.failures-before-alert`	`int`	Consecutive known failures before a transport alert; defaults to two.
`--spec.paused`	`bool`	Paused checks dispatch nothing and accrue no expected slots.
`--spec.severity`	`string`	ticket or page; defaults to ticket.
`--spec.notify`	`string`	Existing email: or registered webhook: targets. Events owns signing, delivery and replay. No unregistered callback is silently considered sent. Repeat the flag for each value.
`--spec.execution-delegation`	`string`	Access delegation naming Observability's workload principal, confined to this environment and the needed read/invoke permissions. Every dispatch exchanges it afresh; expiration or revocation prevents outbound work. Required.
`--spec.job`	`string`	Same-environment Workflows Job containing a versioned journey bundle. It runs once per slot with no retries; it is not an HTTP request body.

#get

Gets one tenant uptime check.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx observability uptime-checks get orgs/acme/projects/shop/envs/production/uptime_checks/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

Flags

Flag	Type	What it does
`--target-page-token`	`string`	Continue the latest target population from status.next_target_page_token.

#list

Lists checks and aggregate status. GetUptimeCheck reads target pages.

PARENT — optional: the CLI fills it from the linked project or the key's scope when it is left out.

CLI

Shell

sylphx observability uptime-checks list orgs/acme/projects/shop/envs/production

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

Flags

Flag	Type	What it does
`--page-size`	`int`	At most 100 checks per page.
`--page-token`	`string`	Opaque continuation from this exact parent.

#update

Updates one tenant uptime check.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx observability uptime-checks update orgs/acme/projects/shop/envs/production/uptime_checks/uptime-check --spec.execution-delegation …

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

Flags

Flag	Type	What it does
`--meta.labels`	`key=value`	Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
`--meta.annotations`	`key=value`	Caller-writable, unindexed annotations. Repeat the flag for each value.
`--meta.display-name`	`string`	Caller-writable human-readable name.
`--spec.public-uri`	`string`	HTTPS public URL, without credentials, query, fragment or redirects.
`--spec.service`	`string`	Same-environment Hosting Service resource name.
`--spec.bound-public-revisions`	`bool`	True enumerates every authorized bound public Host/path and compares independent public response identity with the selected serving Release.
`--spec.instrument`	`string`	HTTP, READY or JOURNEY. JOURNEY is valid only for a Job target.
`--spec.method`	`string`	GET or HEAD; defaults to HEAD. No headers, credentials or request body.
`--spec.path`	`string`	Private HTTP path; defaults to /healthz. Not used by READY.
`--spec.interval`	`duration`	30, 60, 300 or 900 seconds; defaults to 60 seconds.
`--spec.timeout`	`duration`	HTTP: 1, 2, 5 or 10 seconds. Journey: 10 through 900 seconds, including admission and execution. Defaults to 10 seconds.
`--spec.expect-status`	`int`	Transport successes; defaults to 200 through 299. Denial and rate limits always remain unknown, even when included here. Repeat the flag for each value.
`--spec.expect-body`	`string`	Bounded literal substring, only with GET.
`--spec.failures-before-alert`	`int`	Consecutive known failures before a transport alert; defaults to two.
`--spec.paused`	`bool`	Paused checks dispatch nothing and accrue no expected slots.
`--spec.severity`	`string`	ticket or page; defaults to ticket.
`--spec.notify`	`string`	Existing email: or registered webhook: targets. Events owns signing, delivery and replay. No unregistered callback is silently considered sent. Repeat the flag for each value.
`--spec.execution-delegation`	`string`	Access delegation naming Observability's workload principal, confined to this environment and the needed read/invoke permissions. Every dispatch exchanges it afresh; expiration or revocation prevents outbound work. Required.
`--spec.job`	`string`	Same-environment Workflows Job containing a versioned journey bundle. It runs once per slot with no retries; it is not an HTTP request body.

#delete

Deletes one tenant uptime check.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx observability uptime-checks delete orgs/acme/projects/shop/envs/production/uptime_checks/uptime-check --yes

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

Flags

Flag	Type	What it does
`--etag`	`string`	Current resource etag.
`--yes`	`bool`	Do not ask before this destructive call.

Was this page helpful?

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

Send feedback

Platform links