---
# @generated by sylphx-gen. Do not edit.
title: "Create an uptime check"
description: "`observability.uptime_checks.create` (POST /v1/{parent}/uptime_checks): Creates one tenant uptime check."
type: reference
product: alerts
summary: "Creates one tenant uptime check."
updated: 2026-09-28
nav: false
---

Creates one tenant uptime check.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/uptime_checks`
- **Scope** `observability:write`
- **Effect** `write` — a successful call changes state.
- **Collection** [uptime_checks](/docs/api/uptime_checks)
- **Query** `uptime_check_id`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | The authorized environment. Required. |
| `uptime_check` | `UptimeCheck` | Safe observation policy. Required. |
| `uptime_check_id` | `string` | Unique DNS label, 1 through 63 characters. Required. |

### UptimeCheck

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The tenant-scoped check name. |
| `meta` | `ResourceMeta` | Resource metadata, generation and etag. |
| `spec` | `UptimeCheckSpec` | Safe desired observation policy. Required. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |

### UptimeCheckSpec

| Field | Type | What it is |
| --- | --- | --- |
| `public_uri` | `string` | HTTPS public URL, without credentials, query, fragment or redirects. One of the `target` group. |
| `service` | `string` | Same-environment Hosting Service resource name. One of the `target` group. |
| `bound_public_revisions` | `bool` | True enumerates every authorized bound public Host/path and compares independent public response identity with the selected serving Release. One of the `target` group. |
| `instrument` | `string` | HTTP, READY or JOURNEY. JOURNEY is valid only for a Job target. |
| `method` | `string` | GET or HEAD; defaults to HEAD. No headers, credentials or request body. |
| `path` | `string` | Private HTTP path; defaults to /healthz. Not used by READY. |
| `interval` | `duration` | 30, 60, 300 or 900 seconds; defaults to 60 seconds. |
| `timeout` | `duration` | HTTP: 1, 2, 5 or 10 seconds. Journey: 10 through 900 seconds, including admission and execution. Defaults to 10 seconds. |
| `expect_status` | `uint32[]` | Transport successes; defaults to 200 through 299. Denial and rate limits always remain unknown, even when included here. |
| `expect_body` | `string` | Bounded literal substring, only with GET. |
| `failures_before_alert` | `uint32` | Consecutive known failures before a transport alert; defaults to two. |
| `paused` | `bool` | Paused checks dispatch nothing and accrue no expected slots. |
| `severity` | `string` | ticket or page; defaults to ticket. |
| `notify` | `string[]` | Existing email: or registered webhook: targets. Events owns signing, delivery and replay. No unregistered callback is silently considered sent. |
| `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. |
| `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. One of the `target` group. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The tenant-scoped check name. |
| `uid` | `string` | A new immutable identity on every creation, including name reuse. Output only. |
| `meta` | `ResourceMeta` | Resource metadata, generation and etag. |
| `spec` | `UptimeCheckSpec` | Safe desired observation policy. Required. |
| `status` | `UptimeCheckStatus` | Durable evidence, including missing coverage. Output only. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong 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_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

### UptimeCheckSpec

| Field | Type | What it is |
| --- | --- | --- |
| `public_uri` | `string` | HTTPS public URL, without credentials, query, fragment or redirects. One of the `target` group. |
| `service` | `string` | Same-environment Hosting Service resource name. One of the `target` group. |
| `bound_public_revisions` | `bool` | True enumerates every authorized bound public Host/path and compares independent public response identity with the selected serving Release. One of the `target` group. |
| `instrument` | `string` | HTTP, READY or JOURNEY. JOURNEY is valid only for a Job target. |
| `method` | `string` | GET or HEAD; defaults to HEAD. No headers, credentials or request body. |
| `path` | `string` | Private HTTP path; defaults to /healthz. Not used by READY. |
| `interval` | `duration` | 30, 60, 300 or 900 seconds; defaults to 60 seconds. |
| `timeout` | `duration` | HTTP: 1, 2, 5 or 10 seconds. Journey: 10 through 900 seconds, including admission and execution. Defaults to 10 seconds. |
| `expect_status` | `uint32[]` | Transport successes; defaults to 200 through 299. Denial and rate limits always remain unknown, even when included here. |
| `expect_body` | `string` | Bounded literal substring, only with GET. |
| `failures_before_alert` | `uint32` | Consecutive known failures before a transport alert; defaults to two. |
| `paused` | `bool` | Paused checks dispatch nothing and accrue no expected slots. |
| `severity` | `string` | ticket or page; defaults to ticket. |
| `notify` | `string[]` | Existing email: or registered webhook: targets. Events owns signing, delivery and replay. No unregistered callback is silently considered sent. |
| `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. |
| `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. One of the `target` group. |

### UptimeCheckStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | Last reconciled generation. Output only. |
| `conditions` | `Condition[]` | Ready, Reconciling, Stalled. Output only. |
| `last_sample_time` | `timestamp` | Time of the last committed observation, absent before the first sample. Output only. |
| `last_result` | `string` | up, down, match, mismatch or unknown. Output only. |
| `firing` | `bool` | Whether any target has an open firing episode. Output only. |
| `coverage` | `UptimeCoverage[]` | Exactly the 24-hour, 7-day and 30-day windows. Output only. |
| `targets` | `UptimeTargetStatus[]` | Latest target population page (up to 100), including unknown targets. Output only. |
| `next_target_page_token` | `string` | Continue with GetUptimeCheck.target_page_token; aggregates cover all targets. Output only. |

### Condition

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | The condition type, for example `Ready`. |
| `status` | `ConditionStatus` | Whether the condition holds. One of `true`, `false`, `unknown`. |
| `observed_generation` | `int64` | The generation this observation was made against. |
| `reason` | `string` | A machine-readable UpperCamelCase reason. |
| `message` | `string` | A customer-safe human-readable message. |
| `severity` | `Severity` | How severe a FALSE condition is. One of `info`, `warning`, `error`. |
| `transition_time` | `timestamp` | When `status` last changed. |

### UptimeCoverage

| Field | Type | What it is |
| --- | --- | --- |
| `window_seconds` | `int64` | 86400, 604800 or 2592000 seconds. Output only. |
| `expected` | `int64` | Due observations, including missing slots. Output only. |
| `succeeded` | `int64` | Known successful observations. Output only. |
| `failed` | `int64` | Known failed observations. Output only. |
| `unknown` | `int64` | Received but inconclusive observations. Output only. |
| `missing` | `int64` | Due observations with no sample. Output only. |

### UptimeTargetStatus

| Field | Type | What it is |
| --- | --- | --- |
| `target` | `string` | Stable target identity within this check lifecycle. Output only. |
| `uri` | `string` | Exact public URL or same-environment service name. Output only. |
| `expected_release` | `string` | Current selected serving Release, never desired or merely latest source. Output only. |
| `expected_source_shas` | `string[]` | Admitted positive-weight source population, empty when unknown. Output only. |
| `observed_source_sha` | `string` | Exactly one validated response header, empty when unknown. Output only. |
| `result` | `string` | up, down, match, mismatch or unknown. Output only. |
| `reason` | `string` | Why evidence is unknown or failed, without losing the distinction. Output only. |
| `sample_time` | `timestamp` | Actual observation time. Output only. |
| `firing` | `bool` | Open episode latch; only proven equality or transport success resolves. Output only. |
| `events_deliveries` | `string[]` | Existing Events carrier receipts; receiver delivery is read from Events. Output only. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/uptime_checks" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{"execution_delegation":"…"}}'
```

**TypeScript**

```ts
const response = await sylphx.observability.uptimeChecks.create({ parent: 'orgs/acme/projects/shop/envs/production', uptimeCheck: { spec: { executionDelegation: '…' } } })
```

**Rust**

```rust
let mut req = sylphx::observability::CreateUptimeCheckRequest::default();
req.parent = "orgs/acme/projects/shop/envs/production".to_string();
req.uptime_check = Some(sylphx::observability::UptimeCheck {
    spec: Some(sylphx::observability::UptimeCheckSpec {
        execution_delegation: "…".to_string(),
        ..Default::default()
    }),
    ..Default::default()
});
let response = sx.observability().uptime_checks().create(req).await?;
```

**CLI**

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

**MCP**

```json
{ "method_id": "observability.uptime_checks.create", "args": {"parent":"orgs/acme/projects/shop/envs/production","uptime_check":{"spec":{"execution_delegation":"…"}}} }
```