Update check
update_checkIdempotent
Update an existing check by UID or slug and return the updated check. PATCH semantics — only the fields you pass are modified, others stay as-is. Use create_check to make a new check and delete_check to remove one; to pause without deleting, set enabled:false instead. Requires the mcp scope (mcp:read tokens are refused) and at least the user role in the organization.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | New human-readable name, e.g. "API production". | |
| slug | No | New URL-friendly slug, e.g. "api-prod". | |
| config | No | Replace check-specific config (full object — not merged). | |
| labels | No | Replace labels object (empty object clears all). Example: {"env":"staging"}. | |
| period | No | New check interval as HH:MM:SS, e.g. "00:00:30" for 30 seconds. | |
| enabled | No | Toggle whether the check runs. Set to false to pause the check, true to resume it. | |
| regions | No | Pin the check to exactly these regions, e.g. ["eu-west-1","us-east-1"] (placement becomes "pinned"). An empty array puts the check back on the default placement: automatic across regionCount healthy regions (unless the org's own default_regions names a private location, which pins it to those defaults). The check keeps running either way; use enabled: false to stop it. | |
| placement | No | Switch the placement: "auto" lets the scheduler place the check (keeping its current region count and every current region still healthy) and move it off a region that goes dark; "pinned" freezes the current regions unless regions is also given. | |
| failQuorum | No | Multi-region quorum: how many of the check's regions must be failing, for the confirmation period, before it is down and an incident opens. "all", "majority" or a whole number such as "2" (clamped to the region count). The default is all regions for 1-2 regions and a majority for 3+. Fewer failing regions than the quorum is a "regional issue": the check shows warning and no incident opens. "all" keeps the per-result rule: any passing region resets the confirmation. Pass "default" to put the check back on the default. | |
| identifier | Yes | Check UID or URL-friendly slug, e.g. "api-prod" or "63d49e55-97e3-4e8c-b7ab-c862de7a43f3". | |
| regionPool | No | Automatic placement only: candidate cloud region slugs; an empty array means any. Implies placement auto. | |
| description | No | Updated free-text description shown in the UI. | |
| regionCount | No | Automatic placement only: how many regions run the check. Implies placement auto. | |
| checkGroupUid | No | Move to a different group (UID or slug). Pass an empty string to ungroup. | |
| recoveryPeriodSeconds | No | Wall-clock seconds the check must stay UP before auto-resolving. Any failure inside the window resets the recovery clock. 0 = resolve immediately. Range 0–86400. | |
| confirmationPeriodSeconds | No | Wall-clock seconds to wait after the first failure before opening an incident. 0 = open immediately. Range 0–86400 (one day). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | Check UID. | |
| name | No | Human-readable name. | |
| slug | No | URL-friendly slug. | |
| type | No | Check type, e.g. "http". | |
| config | No | Check-specific configuration for the type. | |
| labels | No | Key-value labels. | |
| period | No | Check interval as HH:MM:SS. | |
| status | No | Synthesized status: up, down, validating, created or degraded. | |
| enabled | No | Whether the check runs. | |
| regions | No | Regions the check runs from. | |
| createdAt | No | RFC3339 creation timestamp. | |
| placement | No | "pinned" or "auto". | |
| description | No | Free-text description. | |
| lastResultAt | No | RFC3339 timestamp of the newest real result. | |
| checkGroupUid | No | Check group UID, when the check belongs to a group. | |
| statusChangedAt | No | RFC3339 timestamp of the last status change. |