EstaCaido をアプリケーションに統合
EstaCaido APIを使うと、モニターの管理、インシデントの表示、アラートの設定などを自分のコードから行えます。すべてのAPIエンドポイントは、リクエストとレスポンスの本文にJSONを使用します。
https://www.estacaido.com/api/v1/
各APIトークンは、一分あたり最大 100 件のリクエストを送信できます。上限を超えると 429 Too Many Requests が返されます。
すべてのAPIリクエストにトークン認証を使用します。トークンをAuthorizationヘッダーに含めてください。
/api/v1/auth/token/
curl -X POST https://www.estacaido.com/api/v1/auth/token/ \
-H "Content-Type: application/json" \
-d '{"username": "your@email.com", "password": "yourpassword"}'{
"token": "your-api-token-here"
}Authorization: Token your-api-token-hereウェブサイトのモニターを管理します。
/api/v1/monitors/
[
{
"id": 1,
"name": "Production API",
"company": {
"id": 1,
"website": "api.example.com"
},
"check_type": "http",
"check_interval": 300,
"is_active": true,
"is_paused": false,
"last_check_at": "2024-01-15T10:30:00Z",
"created_at": "2024-01-01T00:00:00Z"
}
]/api/v1/monitors/
name |
必須 | モニターの名前 |
domain |
必須 | 監視するドメイン。例: example.com |
check_interval |
任意 | チェック間隔(秒)。30, 60, 300, 600, 900, 1800, 3600 のいずれか。既定値: 300 |
check_type |
任意 | 次のいずれかの値: http, https, ping。既定値: https |
/api/v1/monitors/{id}/
/api/v1/monitors/{id}/
/api/v1/monitors/{id}/
/api/v1/monitors/{id}/pause/
/api/v1/monitors/{id}/resume/
/api/v1/monitors/{id}/statistics/
days |
任意 | 対象に含める日数。既定: 30 |
ダウンタイムのインシデントとその履歴を表示します。
/api/v1/incidents/
status |
任意 | ステータスで絞り込み: ongoing, resolved |
monitor |
任意 | モニターIDで絞り込み |
/api/v1/incidents/{id}/
モニターのアラート通知を設定します。
/api/v1/alerts/
/api/v1/alerts/
monitor |
必須 | モニターID |
alert_type |
必須 | 次のいずれかの値: email, sms, slack, discord, webhook, pagerduty, teams |
recipients |
必須 | 宛先アドレスまたはWebhook URL |
alert_on_down |
任意 | サイトがダウンしたときに通知 (既定: true) |
alert_on_recovery |
任意 | サイトが復旧したときに通知 (既定: true) |
/api/v1/alerts/{id}/
/api/v1/alerts/{id}/
公開ステータスページを作成・管理します。
/api/v1/status-pages/
/api/v1/status-pages/
title |
必須 | ステータスページのタイトル |
slug |
必須 | URLスラッグ (例: my-status-page) |
description |
任意 | 説明文 |
is_public |
任意 | 公開する (既定: true) |
チームのアクセスと共同作業を管理します。
/api/v1/teams/
/api/v1/teams/
/api/v1/teams/{id}/
import requests
API_TOKEN = 'your-api-token'
BASE_URL = 'https://www.estacaido.com/api/v1'
headers = {
'Authorization': f'Token {API_TOKEN}',
'Content-Type': 'application/json'
}
# List all monitors
response = requests.get(f'{BASE_URL}/monitors/', headers=headers)
monitors = response.json()
print(monitors)
# Create a new monitor
new_monitor = {
'name': 'My Website',
'domain': 'example.com',
'check_interval': 300
}
response = requests.post(f'{BASE_URL}/monitors/', json=new_monitor, headers=headers)
print(response.json())const API_TOKEN = 'your-api-token';
const BASE_URL = 'https://www.estacaido.com/api/v1';
const headers = {
'Authorization': `Token ${API_TOKEN}`,
'Content-Type': 'application/json'
};
// List all monitors
fetch(`${BASE_URL}/monitors/`, { headers })
.then(res => res.json())
.then(monitors => console.log(monitors));
// Create a new monitor
fetch(`${BASE_URL}/monitors/`, {
method: 'POST',
headers,
body: JSON.stringify({
name: 'My Website',
domain: 'example.com',
check_interval: 300
})
})
.then(res => res.json())
.then(data => console.log(data));# List all monitors
curl -X GET https://www.estacaido.com/api/v1/monitors/ \
-H "Authorization: Token your-api-token"
# Create a new monitor
curl -X POST https://www.estacaido.com/api/v1/monitors/ \
-H "Authorization: Token your-api-token" \
-H "Content-Type: application/json" \
-d '{"name": "My Website", "domain": "example.com", "check_interval": 300}'