死活監視 API
アプリでできることは、すべて REST API からも行えます。デプロイパイプラインからモニターを作成し、稼働率と応答時間を自社のダッシュボードに取り込み、ステータスページと通知チャネルを常に同期できます。入力も出力も JSON、認証は Bearer トークン 1 つだけ。API トークンはBusiness プラン以上でご利用いただけます。
はじめに
ベース URL
https://app.centoculus.com/api/v1
すべてのリクエストに 2 つのヘッダーを付けます: Authorization: Bearer <token> と Accept: application/json。ボディを持つリクエストは Content-Type: application/json とともに JSON を送信します。
- Web アプリまたはスマートフォンアプリの「マイアカウント」→「API トークン」でトークンを作成し、スコープを選びます。
- トークンはすぐにコピーしてください。表示されるのは一度だけです。
GET /meを呼び出します。どのトークンでも使え、そのトークンの持ち主がわかります。
最初の呼び出し:
curl https://app.centoculus.com/api/v1/me \
-H "Authorization: Bearer $CENTOCULUS_TOKEN" \
-H "Accept: application/json"
レスポンスは、ロール、言語、トークンが届くワークスペースを含むユーザー情報です(短縮版)。
{
"data": {
"id": 4821,
"name": "Mara Lindqvist",
"email": "mara@example.com",
"role": "customer_admin",
"role_label": "admin",
"locale": "en",
"timezone": "Europe/Stockholm",
"customers": [{"id": 1207, "name": "Example Ltd"}],
"default_customer_id": 1207
}
}
トークンとスコープ
トークンには、名前、任意の有効期限(最大 730 日)、使用できるスコープがあります。連携に必要なスコープだけを選んでください。ダッシュボードには monitors:read と incidents:read、デプロイスクリプトには monitors:write を付与します。Business より下のプランでは、このセクションは表示されますがグレーアウトされます。
| スコープ | 許可される操作 |
|---|---|
monitors:read | モニターの一覧と詳細、稼働率、日別稼働率、応答時間、チェックの種類、ロケーション、ダッシュボードの概要 |
monitors:write | モニターの作成、更新、削除、一時停止、再開 |
servers:read | サーバーの一覧と詳細、およびそのメトリクス |
servers:write | サーバーの作成、更新、削除、一時停止、再開、エージェントの新しいインストールコマンド |
incidents:read | インシデントの一覧と詳細、ダッシュボードの概要 |
status-pages:read | ステータスページの一覧と詳細 |
status-pages:write | ステータスページとそのお知らせの作成、更新、削除 |
notifications:read | 通知チャネルとチャネルの種類の一覧と詳細 |
notifications:write | チャネル(メール、Telegram、Webhook、プッシュ)の作成、更新、削除、テスト送信 |
GET /me はどのトークンでも使えます。請求、チーム、トークン、アカウントのセキュリティ、修復は API トークンでは利用できず、403 を返します。対応するスコープがない呼び出しも同様です。
トークンは同じ場所で失効できます。失効すると直ちに使えなくなります。
共通の決まり
- レスポンスは JSON です。単一のオブジェクトは
dataに、一覧はdataに入り、linksとmetaが付きます。 - モニターとサーバーは UUID で、インシデント、ステータスページ、通知チャネルは数値の id で指定します。
- 日時は UTC の ISO 8601 形式です。例:
2026-11-15T08:30:00.000000Z。 - 一覧はクエリパラメーター
pageとper_pageでページ分割されます。metaにはcurrent_page、last_page、per_page、totalが入ります。既定のページサイズ: モニター 15(最大 200)、インシデント 25(最大 100)、通知チャネル 50、サーバー 100、ステータスページ 15。 - 複数のワークスペースを持つアカウント(パートナーやリセラー)は、作成時に
customer_idを渡し、一覧の絞り込みにも使えます。顧客アカウントでは指定しません。 - 全体のリクエスト上限はありません。一部のエンドポイントにはレート制限があり、たとえばメール確認の再送信は 1 分あたり 10 回までです。超えると
Retry-After付きで 429 を返します。チェック間隔より短い頻度でのポーリングは避け、リアルタイムのデータには Webhook チャネルをご利用ください。
エラー
エラーは message を含む JSON で返ります。バリデーションエラーでは、フィールドごとのメッセージ一覧を持つ errors が加わります。
| ステータス | 意味 |
|---|---|
401 | トークンがない、無効、期限切れ、または失効しています。 |
402 | プリペイド残高を使い切ったため、監視が一時停止されています(リセラーの顧客)。チャージすると再開します。 |
403 | トークンに必要なスコープがない、エンドポイントが API トークンに開放されていない、またはご利用のプランにその機能が含まれていません。 |
404 | 見つからないか、お使いのワークスペースにありません。 |
409 | 競合しています。たとえば、すでに確認済みのメールアドレスを確認しようとした場合です。 |
422 | バリデーションに失敗しました。errors を確認してください。プランの上限に達した場合、upgrade に上位プランで利用できる機能が示されます。 |
429 | レート制限のあるエンドポイントへのリクエストが多すぎます。Retry-After の秒数だけ待ってください。 |
バリデーションエラーの例:
HTTP/1.1 422 Unprocessable Content
{
"message": "The target field is required. (and 1 more error)",
"errors": {
"target": ["The target field is required."],
"interval_seconds": ["The interval must be at least 60 seconds on your plan."]
}
}
モニター
モニターは 1 つのチェックです。Web サイト、SSL 証明書、Ping、TCP ポート、DNS レコード、cron のハートビート、ドメインのメール設定が対象です。種類は http、ssl、ping、tcp、dns、heartbeat、maildns、mailflow。GET /check-types で、ご利用のプランに含まれる種類、間隔、ロケーションと、各種類の既定値を確認できます。
| エンドポイント | 内容 |
|---|---|
GET /monitors |
一覧。フィルターは status、search、ids(カンマ区切り)。with_stats=1 で稼働率と直近の応答時間を追加 |
POST /monitors |
作成。チェックはバックグラウンドで開始されます |
GET /monitors/{id} |
モニター 1 件。ロケーションと進行中のインシデントを含みます |
PATCH /monitors/{id} |
更新。種類は変更できません |
DELETE /monitors/{id} |
削除(204) |
POST /monitors/{id}/pause |
一時停止。進行中のインシデントは終了します |
POST /monitors/{id}/resume |
再開 |
GET /check-types |
種類、既定値、ご利用のプランの上限 |
GET /locations |
有効なチェックロケーション(code、name、country) |
作成時のフィールド
| フィールド | 説明 |
|---|---|
name |
表示名。255 文字まで。必須。 |
type |
上記の種類のいずれか。必須。作成後は変更できません。 |
target |
種類に応じて URL、ホスト名、IP アドレス、ドメインのいずれか。必須ですが、heartbeat は代わりに Ping 用 URL が発行されるため不要です。 |
interval_seconds |
チェック間隔。最小値はプランによって異なり、GET /check-types が limits.min_interval_seconds として返します。 |
locations |
ロケーションコード。例: ["eu", "sg"]。選べる数はプランによって異なります。 |
primary_location |
障害を最初に確認するメインのロケーション(Smart Verify)。 |
confirm_locations |
アラートを送る前に、何か所のロケーションで失敗を確認するか(1〜3)。上位プランで設定できます。 |
confirm_checks |
何回連続でチェックに失敗したら障害と確定するか(1〜3)。上位プランで設定できます。 |
options |
種類ごとのオプション。http の場合: method(GET、HEAD、POST)、expected_status(例: 200-399 や 200,301)、keyword と keyword_mode(present または absent)、timeout_seconds、check_ssl、warn_days、crit_days、allow_self_signed。省略したオプションは GET /check-types の既定値になります。 |
キーワードつきの Web サイトチェックを作成する:
curl -X POST https://app.centoculus.com/api/v1/monitors \
-H "Authorization: Bearer $CENTOCULUS_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"name": "Shop",
"type": "http",
"target": "https://shop.example.com",
"interval_seconds": 60,
"locations": ["eu", "sg"],
"options": {"keyword": "Add to cart", "expected_status": "200-399"}
}'
レスポンス(201)はモニターそのものです。ロケーションが引き継ぐと provisioning.state が synced になり、最初のチェックの後で status が pending から up に変わります。
{
"data": {
"id": "6f1c2b1e-9d3a-4c7e-8b21-0f5a1d2e3c44",
"customer_id": 1207,
"name": "Shop",
"type": "http",
"target": "https://shop.example.com",
"interval_seconds": 60,
"options": {
"method": "GET",
"expected_status": "200-399",
"keyword": "Add to cart",
"keyword_mode": "present",
"timeout_seconds": 10,
"check_ssl": true,
"warn_days": 14,
"crit_days": 3,
"allow_self_signed": false
},
"location_codes": ["eu", "sg"],
"primary_location": "eu",
"smart_verify": true,
"confirm_locations": 1,
"confirm_checks": 1,
"status": "pending",
"is_paused": false,
"provisioning": {"state": "pending"},
"locations": [
{"code": "eu", "role": "primary", "name": "Europe", "status": "pending", "last_response_ms": null, "last_checked_at": null},
{"code": "sg", "role": "verify", "name": "Singapore", "status": "pending", "last_response_ms": null, "last_checked_at": null}
],
"open_incident": null,
"last_checked_at": null,
"status_changed_at": null,
"created_at": "2026-11-15T08:30:12.000000Z",
"updated_at": "2026-11-15T08:30:12.000000Z"
}
}
ステータスの値: pending、up、degraded、down、paused。
デプロイ中はモニターを一時停止し、終わったら再開する:
curl -X POST https://app.centoculus.com/api/v1/monitors/6f1c2b1e-9d3a-4c7e-8b21-0f5a1d2e3c44/pause \
-H "Authorization: Bearer $CENTOCULUS_TOKEN" -H "Accept: application/json"
curl -X POST https://app.centoculus.com/api/v1/monitors/6f1c2b1e-9d3a-4c7e-8b21-0f5a1d2e3c44/resume \
-H "Authorization: Bearer $CENTOCULUS_TOKEN" -H "Accept: application/json"
稼働率と応答時間
稼働率は障害(重大度 major のインシデント)から算出します。証明書の期限切れ間近のような警告は含まれません。まだチェックされていない場合は 100 ではなく null です。
| エンドポイント | 内容 |
|---|---|
GET /monitors/{id}/uptime |
直近 24 時間、7 日間、30 日間の稼働率(パーセント) |
GET /monitors/{id}/daily-uptime |
暦日(UTC)ごとの稼働率。days は 1〜90、既定は 30 |
GET /monitors/{id}/response-times |
ロケーションごとの応答時間と可用性。range は 24h、7d、30d。1 時間単位のデータ点で、30d は 1 日単位 |
稼働率:
curl https://app.centoculus.com/api/v1/monitors/6f1c2b1e-9d3a-4c7e-8b21-0f5a1d2e3c44/uptime \
-H "Authorization: Bearer $CENTOCULUS_TOKEN" -H "Accept: application/json"
{"data": {"24h": 100, "7d": 99.952, "30d": 99.987}}
応答時間(短縮版):
curl "https://app.centoculus.com/api/v1/monitors/6f1c2b1e-9d3a-4c7e-8b21-0f5a1d2e3c44/response-times?range=24h" \
-H "Authorization: Bearer $CENTOCULUS_TOKEN" -H "Accept: application/json"
{
"data": {
"range": "24h",
"locations": {
"eu": [
{"time": "2026-11-15T07:00:00+00:00", "avg_ms": 212.4, "min_ms": 180, "max_ms": 402, "availability": 100},
{"time": "2026-11-15T08:00:00+00:00", "avg_ms": 230.1, "min_ms": 190, "max_ms": 388, "availability": 100}
],
"sg": [
{"time": "2026-11-15T07:00:00+00:00", "avg_ms": 512.8, "min_ms": 470, "max_ms": 790, "availability": 100}
]
}
}
}
サーバー
サーバーとは、エージェントを導入したマシンのことで、CPU、メモリ、負荷、ディスク、ネットワーク、サービスを報告します。サーバーを作成すると 1 回限りのインストールコマンドが返ります。マシン上で実行すると、しばらくしてサーバーが表示されます。
| エンドポイント | 内容 |
|---|---|
GET /servers |
一覧。フィルターは ids |
POST /servers |
作成。レスポンスに install_command(Linux)と install_command_freebsd を含みます |
GET /servers/{id} |
サーバー 1 台。インベントリ、最新のスナップショット、しきい値を含みます |
PATCH /servers/{id} |
名前の変更、監視する services の選択、thresholds の設定 |
DELETE /servers/{id} |
削除(204)。エージェントは監視から外れます |
POST /servers/{id}/pause |
一時停止。進行中のインシデントは終了します |
POST /servers/{id}/resume |
再開 |
POST /servers/{id}/install-token |
新しいインストールコマンド。rotate_key=true でエージェントキーも再発行します |
GET /servers/{id}/metrics |
グラフ用の時系列。range は 24h、7d、30d。メトリクス → コンテキスト → [unix time, avg, min, max] |
| フィールド | 説明 |
|---|---|
name |
表示名。100 文字まで。作成時は必須。 |
services |
エージェントに監視させるサービス名。例: ["nginx", "php8.4-fpm", "mariadb"]。最大 200 件。検出されたサービスは discovered.services で報告されます。 |
thresholds |
アラートのしきい値: cpu_max(パーセント)、load_max_per_cpu、mem_min_pavail(空きのパーセント)、fs_warn と fs_crit(使用率のパーセント)、inode_warn、agent_nodata_minutes、マウントポイントごとの filesystems、および正規表現の fs_types、fs_exclude、net_exclude。省略した値は既定のままです。 |
サーバーを追加し、レスポンスからインストールコマンドを読み取る:
curl -X POST https://app.centoculus.com/api/v1/servers \
-H "Authorization: Bearer $CENTOCULUS_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"name": "web-1"}'
{
"data": {
"id": "a3b9d6e2-5f10-4b8c-9e77-2c4d1a0f6b58",
"customer_id": 1207,
"name": "web-1",
"status": "pending",
"is_paused": false,
"provisioning": {"state": "pending"},
"services": [],
"install_token_expires_at": "2026-11-16T08:30:12.000000Z",
"install_command": "curl -fsSL https://app.centoculus.com/install/K7xQ2mVt9…Rd | sudo sh",
"install_command_freebsd": "fetch -qo - https://app.centoculus.com/install/K7xQ2mVt9…Rd | sh",
"created_at": "2026-11-15T08:30:12.000000Z"
}
}
3 つのサービスを監視し、ディスク使用率 80 パーセントでアラートを出す:
curl -X PATCH https://app.centoculus.com/api/v1/servers/a3b9d6e2-5f10-4b8c-9e77-2c4d1a0f6b58 \
-H "Authorization: Bearer $CENTOCULUS_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"services": ["nginx", "php8.4-fpm", "mariadb"],
"thresholds": {"fs_warn": 80, "fs_crit": 90}
}'
インシデント
インシデントとは、モニターまたはサーバーで起きた 1 回の障害や警告のことで、started_at から resolved_at までを指します。各インシデントにはアラート番号があり、アラートメールに表示されるものと同じです。
| エンドポイント | 内容 |
|---|---|
GET /incidents |
新しい順。フィルターは monitor_id、status(open または closed)、open=1(お知らせを除く進行中の障害)、from と to(日付) |
GET /incidents/{id} |
インシデント 1 件とそのタイムライン。どのロケーションがいつダウンし復旧したか、対応した修復の情報を含みます |
進行中のインシデント:
curl "https://app.centoculus.com/api/v1/incidents?status=open&per_page=10" \
-H "Authorization: Bearer $CENTOCULUS_TOKEN" -H "Accept: application/json"
{
"data": [
{
"id": 90412,
"monitor_id": "6f1c2b1e-9d3a-4c7e-8b21-0f5a1d2e3c44",
"monitor_name": "Shop",
"server_id": null,
"subject_type": "monitor",
"severity": "major",
"cause": "unreachable",
"started_at": "2026-11-15T09:14:03.000000Z",
"resolved_at": null,
"duration_seconds": 241,
"alert_number": 101,
"alert_label": "Incident #101",
"affected_locations": ["eu", "sg"],
"failure_reason": "HTTP 502 instead of 200-399",
"fix": null
}
],
"links": {"first": "…?page=1", "last": "…?page=1", "prev": null, "next": null},
"meta": {"current_page": 1, "from": 1, "last_page": 1, "per_page": 10, "to": 1, "total": 1}
}
主なフィールド: subject_type(monitor または server)、severity(major、warning、info)、cause(例: unreachable、network_issue、certificate_expiring、heartbeat_missed)、duration_seconds、affected_locations。進行中の間は、直近のチェック値を含む failure_reason も付きます。
ステータスページ
ステータスページは、選んだモニターを一般公開またはチーム向けに表示します。当社のドメインでも、お客様のドメインでも運用できます。お知らせは、メンテナンスの予告や、進行中のインシデントの説明に使います。
| エンドポイント | 内容 |
|---|---|
GET /status-pages |
一覧 |
POST /status-pages |
作成 |
GET /status-pages/{id} |
ページ 1 件。モニター、お知らせ、ドメインの状態を含みます |
PATCH /status-pages/{id} |
更新。monitors は一覧全体を置き換えます |
DELETE /status-pages/{id} |
削除(204) |
POST /status-pages/{id}/notices |
お知らせを追加 |
PUT /status-pages/{id}/notices/{notice} |
お知らせを更新 |
DELETE /status-pages/{id}/notices/{notice} |
お知らせを削除(204) |
| フィールド | 説明 |
|---|---|
slug |
アドレスの一部。3〜63 文字の小文字、数字、ハイフン。重複不可。必須。 |
title |
ページの見出し。必須。 |
description |
見出しの下に表示する短い文章。2000 文字まで。 |
logo_url |
ロゴの HTTPS アドレス。 |
custom_domain |
status.example.com のような独自ドメイン。独自のステータスドメインを含むプランが必要です。 |
is_public |
公開(true)、またはサインインしたユーザーのみ。 |
monitors |
{"id": "<monitor UUID>", "display_name": "…", "group": "…"} の順序つきリスト。display_name と group は任意です。 |
お知らせには kind(maintenance、info、incident)、title、body(任意、5000 文字まで)、starts_at、任意の ends_at があります。
モニター 2 つを含む公開ステータスページを作成する:
curl -X POST https://app.centoculus.com/api/v1/status-pages \
-H "Authorization: Bearer $CENTOCULUS_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"slug": "example-status",
"title": "Example status",
"is_public": true,
"monitors": [
{"id": "6f1c2b1e-9d3a-4c7e-8b21-0f5a1d2e3c44", "display_name": "Online shop", "group": "Web"},
{"id": "9c2d4e6f-1a3b-4c5d-8e7f-6a5b4c3d2e1f", "group": "Web"}
]
}'
メンテナンス時間を告知する:
curl -X POST https://app.centoculus.com/api/v1/status-pages/318/notices \
-H "Authorization: Bearer $CENTOCULUS_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"kind": "maintenance",
"title": "Database upgrade",
"body": "Checkout will be unavailable for about 15 minutes.",
"starts_at": "2026-11-20T01:00:00Z",
"ends_at": "2026-11-20T01:30:00Z"
}'
通知チャネル
通知チャネルとは、誰かに連絡する手段の 1 つで、メールアドレス、Telegram のチャット、Webhook、ユーザーのプッシュ通知端末が該当します。チャネルは、ワークスペースの全モニターのアラートを受け取るか、monitor_ids に指定したモニターのアラートだけを受け取ります。ご利用のプランに含まれるチャネルの種類は GET /notification-channel-types で確認できます。
| エンドポイント | 内容 |
|---|---|
GET /notification-channels |
一覧 |
POST /notification-channels |
作成。Webhook の署名用 secret が含まれるのはこのレスポンスだけです |
GET /notification-channels/{id} |
チャネル 1 件 |
PATCH /notification-channels/{id} |
更新。種類は変更できません |
DELETE /notification-channels/{id} |
削除(204) |
POST /notification-channels/{id}/test |
テスト通知を送信(202)。未確認のメールアドレスには、代わりに確認リンクが再送されます |
GET /notification-channel-types |
available と paid を含むチャネルの種類 |
| フィールド | 説明 |
|---|---|
type |
email、telegram、webhook、push のいずれか。必須。作成後は変更できません。 |
name |
表示名。必須。 |
config |
種類ごとに {"email": "…"}、{"chat_id": "…"}、{"url": "https://…"}。プッシュに設定は不要です。新しいメールアドレスは、アラートが送られる前にリンクで確認する必要があります。 |
monitor_ids |
このチャネルの対象にするモニターの UUID。省略すると全モニターが対象です。 |
quiet_hours |
{"start": "22:00", "end": "07:00", "timezone": "Europe/Berlin"}: この時間帯はアラートを送りません。 |
escalation_delay_minutes |
障害がこの時間続いたときだけ、このチャネルにアラートを送ります(0〜1440)。 |
notify_recovery |
復旧の通知も送るかどうか(true または false)。 |
is_active |
削除せずに、チャネルを有効または無効にします。 |
2 つのモニターを対象にした Webhook チャネルを作成し、secret を保存する:
curl -X POST https://app.centoculus.com/api/v1/notification-channels \
-H "Authorization: Bearer $CENTOCULUS_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"type": "webhook",
"name": "Ops bot",
"config": {"url": "https://hooks.example.com/centoculus"},
"monitor_ids": ["6f1c2b1e-9d3a-4c7e-8b21-0f5a1d2e3c44", "9c2d4e6f-1a3b-4c5d-8e7f-6a5b4c3d2e1f"],
"notify_recovery": true
}'
{
"data": {
"id": 512,
"customer_id": 1207,
"type": "webhook",
"name": "Ops bot",
"config": {"url": "https://hooks.example.com/centoculus", "secret": "wq7Hc2…48 characters…Zp"},
"quiet_hours": null,
"escalation_delay_minutes": 0,
"notify_recovery": true,
"is_active": true,
"confirmed": true,
"monitor_ids": ["6f1c2b1e-9d3a-4c7e-8b21-0f5a1d2e3c44", "9c2d4e6f-1a3b-4c5d-8e7f-6a5b4c3d2e1f"],
"created_at": "2026-11-15T08:41:55.000000Z",
"updated_at": "2026-11-15T08:41:55.000000Z"
}
}
Webhook ペイロード
Webhook チャネルは、すべてのアラートを JSON として、タイムアウト 10 秒、リダイレクトなしでお客様の URL に POST します。送信先は公開アドレスである必要があります。
ヘッダー: X-Webhook-Timestamp(Unix 時間)、X-Webhook-Signature(sha256= に続けて、チャネルの secret を鍵とした <timestamp>.<body> の HMAC-SHA256)、User-Agent: Uptime-Webhook/1。
event は down、recovered、paused、test のいずれかです。モニターのアラートでは、ボディに monitor(id、name、target)と incident(id、severity、cause、started_at、resolved_at、duration_seconds、affected_locations)が入ります。サーバーのアラートでは server(id、name)と、ロケーションの代わりに problem を持つ incident が入ります。subject はチャネルの言語で書かれたアラートの見出しです。
ダウンアラートのボディ:
POST /your-endpoint HTTP/1.1
Content-Type: application/json
User-Agent: Uptime-Webhook/1
X-Webhook-Timestamp: 1794912843
X-Webhook-Signature: sha256=3f1b9c…e2a7
{
"event": "down",
"monitor": {"id": "6f1c2b1e-9d3a-4c7e-8b21-0f5a1d2e3c44", "name": "Shop", "target": "https://shop.example.com"},
"incident": {
"id": 90412,
"severity": "major",
"cause": "unreachable",
"started_at": "2026-11-15T09:14:03+00:00",
"resolved_at": null,
"duration_seconds": 0,
"affected_locations": ["eu", "sg"]
},
"subject": "DOWN: Shop"
}
ボディを信用する前に署名を検証してください。受信した生のボディをそのまま使って HMAC を計算し、定数時間で比較します。数分より古いタイムスタンプは拒否してください。
シェルで署名を確認する:
expected="sha256=$(printf '%s.%s' "$TIMESTAMP" "$BODY" | openssl dgst -sha256 -hmac "$SECRET" | sed 's/^.* //')"
[ "$expected" = "$SIGNATURE" ] && echo "valid"
ダッシュボードの概要
GET /dashboard は、概要画面のタイルの元になる数を返します。ステータス別のモニター数(サーバーはプランの単位数で計上)、ステータス別のサーバー数、進行中のインシデント数です。monitors:read、servers:read、incidents:read のいずれかがあれば利用できます。
curl https://app.centoculus.com/api/v1/dashboard \
-H "Authorization: Bearer $CENTOCULUS_TOKEN" -H "Accept: application/json"
{
"data": {
"monitors": {"pending": 0, "up": 46, "degraded": 1, "down": 1, "paused": 2},
"monitors_total": 50,
"servers": {"pending": 0, "up": 3, "degraded": 0, "down": 0, "paused": 0},
"open_incidents": 2
}
}
よくある質問
API はどのプランに含まれますか?
API トークンは Business プラン以上に含まれます。それより下のプランでは、「マイアカウント」にこのセクションが表示されますがグレーアウトされ、アップグレードへのリンクが付きます。Centoculus のほかの機能は、API なしでご利用いただけます。
1 つのトークンで、アカウントでできることはすべてできますか?
いいえ。トークンが届くのは、スコープを与えた範囲だけです。請求、チームメンバー、ほかのトークン、アカウントのセキュリティ、修復には届きません。これらはアプリで操作します。
サンドボックスはありますか?
動作を確認するには、読み取りスコープだけのトークンを使い、テスト用のモニターは別アカウントの無料プランで作成してください。作成したモニターは、アプリで作成したものと同じようにご利用のプランの数に含まれます。
アラートを自社のシステムに取り込むには?
Webhook チャネルを作成し、配信ごとに署名を検証してください。障害、復旧、一時停止のたびに、モニター、原因、影響を受けたロケーションを含む JSON が数秒以内にお客様の URL に届きます。
API は変更されますか?
バージョンはアドレス(/api/v1)に含まれます。レスポンスに新しいフィールドが追加されることはありますが、同じバージョン内でフィールドが削除されたり名前が変わったりすることはありません。必要なものだけを読み取り、残りは無視してください。
監視の自動化を始めませんか?
API トークンは Business プラン以上に含まれます。プランを比較するか、無料で始めて、スクリプトの準備ができたらアップグレードしてください。