hosting

PATCH /v1/uptime/monitors/{monitor_id}

Pause, resume or rename a monitored address.

すべての hosting エンドポイント

認証

ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X PATCH https://api.zinndigital.com/v1/uptime/monitors/{monitor_id} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

Gated on `uptime.manage`. ⛔ The **URL cannot be changed**: a monitor's Core Web Vitals readings are joined back to it by that canonical string, so a mutable URL would silently re-point a monitor at another address's history. Change an address by deleting the monitor and adding another. Pausing closes any open incident, so a paused monitor cannot accrue an outage out of us not looking.

パラメータ

名前タイプ必須これがその内容です
monitor_id (path)stringはい

リクエスト本文

名前タイプ必須これがその内容です
enabledbooleanいいえPause or resume. Pausing closes any open incident.
namestringいいえ

返信

名前タイプ必須これがその内容です
idstringはい
urlstringはい
namestringいいえ
statestring<unknown, up, down, paused>はい⛔ `unknown` is a real state and is not a synonym for `up` — it means "not checked yet" and is excluded from every uptime percentage.
enabledbooleanはい
expect_textstringいいえ
site_idstringいいえSet only when the address happens to be one of this organisation's own sites. Navigation only — the monitor works identically without it, and must, because the product exists to…
last_result_atstringいいえ
last_up_atstringいいえ
last_down_atstringいいえ
created_atstringはい
summaryUptimeSummaryいいえ
historyUptimeHistoryPoint[]いいえ
incidentsUptimeIncident[]いいえ
vitalsUptimeVitalsPoint[]いいえ
migration_offerUptimeMigrationOfferいいえ

このエンドポイントが返すエラー

401 · 403 · 404