API มอนิเตอร์อัปไทม์
ทุกอย่างที่คุณทำในแอปทำผ่าน REST API ได้เช่นกัน: สร้างมอนิเตอร์จาก deployment pipeline ดึงอัปไทม์และเวลาตอบสนองไปแสดงในแดชบอร์ดของคุณเอง และคงหน้าสถานะกับช่องทางแจ้งเตือนให้ตรงกันอยู่เสมอ ส่ง JSON เข้า รับ JSON ออก ใช้ Bearer token เพียงอันเดียว API token มีให้ตั้งแต่แพ็กเกจ Business ขึ้นไป
เริ่มต้นใช้งาน
Base URL
https://app.centoculus.com/api/v1
ทุกคำขอต้องมีสองส่วนหัว: Authorization: Bearer <token> และ Accept: application/json คำขอที่มี body ให้ส่ง JSON พร้อม Content-Type: application/json
- สร้าง token ที่บัญชีของฉัน → API token ในเว็บแอปหรือแอปมือถือ แล้วเลือก scope ของ token
- คัดลอก token ทันที เพราะจะแสดงเพียงครั้งเดียว
- เรียก
GET /meใช้ได้กับ token ทุกอัน และบอกว่า token นั้นเป็นของใคร
การเรียกครั้งแรกของคุณ:
curl https://app.centoculus.com/api/v1/me \
-H "Authorization: Bearer $CENTOCULUS_TOKEN" \
-H "Accept: application/json"
คำตอบคือข้อมูลผู้ใช้ของคุณ พร้อมบทบาท ภาษา และเวิร์กสเปซที่ token เข้าถึงได้ (ย่อให้สั้น):
{
"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
}
}
Token และ scope
Token มีชื่อ วันหมดอายุ (ไม่บังคับ สูงสุด 730 วัน) และ scope ที่ใช้ได้ เลือกเฉพาะ scope ที่การเชื่อมต่อต้องใช้: แดชบอร์ดใช้ monitors:read และ incidents:read สคริปต์ deployment ใช้ monitors:write ในแพ็กเกจที่ต่ำกว่า Business ส่วนนี้จะมองเห็นได้แต่ใช้งานไม่ได้
| Scope | อนุญาตให้ |
|---|---|
monitors:read | ดูรายการและรายละเอียดมอนิเตอร์ อัปไทม์ อัปไทม์รายวัน เวลาตอบสนอง ประเภทการตรวจสอบ ตำแหน่งตรวจสอบ และสรุปแดชบอร์ด |
monitors:write | สร้าง แก้ไข ลบ หยุดชั่วคราว และกลับมาทำงานต่อของมอนิเตอร์ |
servers:read | ดูรายการและรายละเอียดเซิร์ฟเวอร์พร้อมเมตริก |
servers:write | สร้าง แก้ไข ลบ หยุดชั่วคราว และกลับมาทำงานต่อของเซิร์ฟเวอร์ รวมถึงขอคำสั่งติดตั้งเอเจนต์ใหม่ |
incidents:read | ดูรายการและรายละเอียดเหตุขัดข้อง และสรุปแดชบอร์ด |
status-pages:read | ดูรายการและรายละเอียดหน้าสถานะ |
status-pages:write | สร้าง แก้ไข และลบหน้าสถานะและประกาศของหน้านั้น |
notifications:read | ดูรายการและรายละเอียดช่องทางแจ้งเตือนและประเภทช่องทาง |
notifications:write | สร้าง แก้ไข และลบช่องทาง (อีเมล, Telegram, webhook, push) และส่งการทดสอบ |
GET /me ใช้ได้กับ token ทุกอัน ส่วนการเรียกเก็บเงิน ทีม token ความปลอดภัยของบัญชี และการซ่อมแซม ไม่เปิดให้ API token เข้าถึง และจะตอบ 403 เช่นเดียวกับการเรียกที่ไม่มี scope ที่ตรงกัน
เพิกถอน token ได้ในที่เดียวกัน และจะใช้งานไม่ได้ทันที
ข้อกำหนดทั่วไป
- การตอบกลับเป็น JSON ออบเจ็กต์เดี่ยวอยู่ใต้
dataส่วนรายการอยู่ใต้dataพร้อมlinksและmeta - มอนิเตอร์และเซิร์ฟเวอร์อ้างอิงด้วย UUID ส่วนเหตุขัดข้อง หน้าสถานะ และช่องทางแจ้งเตือนอ้างอิงด้วย id ที่เป็นตัวเลข
- เวลาเป็นรูปแบบ ISO 8601 ใน UTC เช่น
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ตอนสร้างข้อมูล และใช้กรองรายการได้ บัญชีลูกค้าไม่ต้องส่ง - ไม่มีโควตาคำขอโดยรวม มีเพียงบาง endpoint ที่จำกัดอัตรา เช่น การส่งอีเมลยืนยันซ้ำ (10 ครั้งต่อนาที) ซึ่งจะตอบ 429 พร้อม
Retry-Afterอย่าเรียกถี่กว่าช่วงเวลาตรวจสอบของคุณ หากต้องการข้อมูลแบบเรียลไทม์ให้ใช้ช่องทาง webhook
ข้อผิดพลาด
ข้อผิดพลาดเป็น JSON ที่มี message ส่วนข้อผิดพลาดจากการตรวจสอบข้อมูลจะมี errors เพิ่มมา โดยแต่ละฟิลด์มีรายการข้อความของตัวเอง
| สถานะ | ความหมาย |
|---|---|
401 | ไม่มี token, token ไม่ถูกต้อง, หมดอายุ หรือถูกเพิกถอน |
402 | การมอนิเตอร์ถูกหยุดชั่วคราวเพราะยอดเงินที่เติมไว้หมด (ลูกค้าของรีเซลเลอร์) และจะกลับมาทำงานหลังเติมเงิน |
403 | Token ไม่มี scope ที่ต้องการ, endpoint ไม่เปิดให้ API token หรือแพ็กเกจของคุณไม่รวมฟีเจอร์นี้ |
404 | ไม่พบ หรือไม่อยู่ในเวิร์กสเปซของคุณ |
409 | ขัดแย้งกัน เช่น ยืนยันอีเมลที่ยืนยันไปแล้ว |
422 | การตรวจสอบข้อมูลไม่ผ่าน ดูที่ errors เมื่อถึงขีดจำกัดของแพ็กเกจ upgrade จะระบุฟีเจอร์ที่แพ็กเกจสูงขึ้นปลดล็อก |
429 | เรียก endpoint ที่จำกัดอัตราถี่เกินไป ให้รอตามจำนวนวินาทีใน 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."]
}
}
มอนิเตอร์
มอนิเตอร์คือการตรวจสอบหนึ่งรายการ: เว็บไซต์ ใบรับรอง SSL ping พอร์ต TCP เรคคอร์ด DNS cron heartbeat หรือการตั้งค่าอีเมลของโดเมน ประเภทที่มี: http, ssl, ping, tcp, dns, heartbeat, maildns, mailflow GET /check-types จะบอกว่าแพ็กเกจของคุณรวมประเภท ช่วงเวลา และตำแหน่งตรวจสอบใดบ้าง พร้อมค่าเริ่มต้นของแต่ละประเภท
| Endpoint | ทำอะไร |
|---|---|
GET /monitors |
แสดงรายการ กรองด้วย status, search, ids (คั่นด้วยจุลภาค) และ with_stats=1 เพิ่มอัปไทม์และเวลาตอบสนองล่าสุด |
POST /monitors |
สร้าง การตรวจสอบเริ่มทำงานเบื้องหลัง |
GET /monitors/{id} |
มอนิเตอร์หนึ่งรายการพร้อมตำแหน่งตรวจสอบและเหตุขัดข้องที่ยังเปิดอยู่ |
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 |
สร้างการตรวจสอบเว็บไซต์พร้อมคีย์เวิร์ด:
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
หยุดมอนิเตอร์ชั่วคราวระหว่าง deployment แล้วเปิดกลับมาทำงานต่อภายหลัง:
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) ส่วนคำเตือน เช่น ใบรับรองใกล้หมดอายุ ไม่นับรวม ถ้ายังไม่เคยตรวจสอบจะเป็น null ไม่ใช่ 100
| Endpoint | ทำอะไร |
|---|---|
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 จุดข้อมูลรายชั่วโมง และรายวันสำหรับ 30d |
อัปไทม์:
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 หน่วยความจำ โหลด ดิสก์ เครือข่าย และบริการต่าง ๆ เมื่อสร้างเซิร์ฟเวอร์ ระบบจะส่งคำสั่งติดตั้งแบบใช้ครั้งเดียวกลับมา ให้รันบนเครื่อง แล้วเซิร์ฟเวอร์จะปรากฏขึ้นภายในไม่นาน
| Endpoint | ทำอะไร |
|---|---|
GET /servers |
แสดงรายการ กรองด้วย ids |
POST /servers |
สร้าง คำตอบมี install_command (Linux) และ install_command_freebsd |
GET /servers/{id} |
เซิร์ฟเวอร์หนึ่งเครื่องพร้อมรายการทรัพยากร สแนปช็อตล่าสุด และเกณฑ์แจ้งเตือน |
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"
}
}
เฝ้าดูสามบริการ และแจ้งเตือนเมื่อใช้ดิสก์ถึง 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}
}'
เหตุขัดข้อง
เหตุขัดข้องคือเหตุขัดข้องหรือคำเตือนหนึ่งครั้งของมอนิเตอร์หรือเซิร์ฟเวอร์ ตั้งแต่ started_at จนถึง resolved_at ทุกเหตุขัดข้องมีหมายเลขการแจ้งเตือนของตัวเอง ซึ่งเป็นหมายเลขเดียวกับที่แสดงในอีเมลแจ้งเตือน
| Endpoint | ทำอะไร |
|---|---|
GET /incidents |
ใหม่สุดก่อน กรองด้วย monitor_id, status (open หรือ closed), open=1 (เหตุขัดข้องที่ยังเปิดอยู่ ไม่รวมประกาศ), from และ to (วันที่) |
GET /incidents/{id} |
เหตุขัดข้องหนึ่งรายการพร้อมไทม์ไลน์: ตำแหน่งตรวจสอบใดล่มและกลับมาเมื่อไร และการซ่อมแซมที่แก้ไข |
เหตุขัดข้องที่ยังเปิดอยู่:
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 พร้อมค่าจากการตรวจสอบล่าสุด
หน้าสถานะ
หน้าสถานะแสดงมอนิเตอร์ที่เลือกให้สาธารณะหรือทีมของคุณเห็น ภายใต้โดเมนของเราหรือโดเมนของคุณเอง ประกาศใช้แจ้งการบำรุงรักษาหรืออธิบายเหตุขัดข้องที่กำลังเกิดขึ้น
| Endpoint | ทำอะไร |
|---|---|
GET /status-pages |
แสดงรายการ |
POST /status-pages |
สร้าง |
GET /status-pages/{id} |
หน้าสถานะหนึ่งหน้าพร้อมมอนิเตอร์ ประกาศ และสถานะของโดเมน |
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 ที่ไม่บังคับ
สร้างหน้าสถานะสาธารณะที่มีมอนิเตอร์สองรายการ:
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"
}'
ช่องทางแจ้งเตือน
ช่องทางแจ้งเตือนคือหนึ่งวิธีที่จะติดต่อใครสักคน: ที่อยู่อีเมล แชต Telegram webhook หรืออุปกรณ์ push ของผู้ใช้ ช่องทางจะได้รับการแจ้งเตือนจากมอนิเตอร์ทั้งหมดในเวิร์กสเปซ หรือเฉพาะมอนิเตอร์ใน monitor_ids ดูประเภทช่องทางที่แพ็กเกจของคุณรวมอยู่ได้ที่ GET /notification-channel-types
| Endpoint | ทำอะไร |
|---|---|
GET /notification-channels |
แสดงรายการ |
POST /notification-channels |
สร้าง สำหรับ webhook secret ที่ใช้เซ็นจะอยู่ในคำตอบนี้เท่านั้น |
GET /notification-channels/{id} |
ช่องทางหนึ่งรายการ |
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://…"} push ไม่ต้องมี config อีเมลใหม่ต้องยืนยันผ่านลิงก์ก่อนจึงจะเริ่มส่งการแจ้งเตือน |
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 |
เปิดหรือปิดช่องทางโดยไม่ต้องลบ |
สร้างช่องทาง 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 payload
ช่องทาง webhook จะส่งการแจ้งเตือนทุกรายการเป็น JSON ด้วย POST ไปยัง URL ของคุณ โดยมีเวลารอสูงสุด 10 วินาทีและไม่ตามการเปลี่ยนเส้นทาง ปลายทางต้องเป็นที่อยู่สาธารณะ
ส่วนหัว: X-Webhook-Timestamp (เวลา Unix), X-Webhook-Signature (sha256= ตามด้วย HMAC-SHA256 ของ <timestamp>.<body> โดยใช้ secret ของช่องทางเป็นคีย์) และ User-Agent: Uptime-Webhook/1
event เป็น down, recovered, paused หรือ test สำหรับการแจ้งเตือนของมอนิเตอร์ body จะมี monitor (id, name, target) และ incident (id, severity, cause, started_at, resolved_at, duration_seconds, affected_locations) สำหรับการแจ้งเตือนของเซิร์ฟเวอร์จะมี server (id, name) และ incident ที่มี problem แทนตำแหน่งตรวจสอบ ส่วน subject คือหัวเรื่องของการแจ้งเตือนในภาษาของช่องทาง
body ของการแจ้งเตือนว่าล่ม:
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"
}
ตรวจสอบลายเซ็นก่อนเชื่อถือ body: คำนวณ HMAC จาก body ดิบตามที่ได้รับทุกประการ แล้วเปรียบเทียบด้วยวิธีที่ใช้เวลาคงที่ ปฏิเสธ timestamp ที่เก่ากว่าไม่กี่นาที
ตรวจสอบลายเซ็นใน shell:
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 token มีให้ตั้งแต่แพ็กเกจ Business ขึ้นไป ในแพ็กเกจที่เล็กกว่า คุณจะเห็นส่วนนี้ใต้บัญชีของฉันแต่ใช้งานไม่ได้ พร้อมลิงก์อัปเกรด ฟีเจอร์อื่นทั้งหมดของ Centoculus ใช้งานได้โดยไม่ต้องใช้ API
token หนึ่งอันทำได้ทุกอย่างที่บัญชีของฉันทำได้หรือไม่
ไม่ได้ Token เข้าถึงได้เฉพาะส่วนที่คุณกำหนด scope ให้ และเข้าถึงการเรียกเก็บเงิน สมาชิกทีม token อื่น ความปลอดภัยของบัญชี หรือการซ่อมแซมไม่ได้เลย ส่วนเหล่านี้ต้องทำในแอป
มี sandbox ไหม
ใช้ token ที่มีเฉพาะ scope แบบอ่านเพื่อสำรวจ และสร้างมอนิเตอร์ทดสอบในแพ็กเกจฟรีของบัญชีที่สอง มอนิเตอร์ที่คุณสร้างจะนับรวมในแพ็กเกจของคุณเหมือนที่สร้างในแอป
จะรับการแจ้งเตือนเข้าระบบของฉันเองได้อย่างไร
สร้างช่องทาง webhook และตรวจสอบลายเซ็นของทุกการส่ง เหตุขัดข้อง การกลับมาปกติ และการหยุดชั่วคราวทุกครั้งจะถึง URL ของคุณภายในไม่กี่วินาที พร้อมมอนิเตอร์ สาเหตุ และตำแหน่งตรวจสอบที่ได้รับผลกระทบเป็น JSON
API มีการเปลี่ยนแปลงหรือไม่
เวอร์ชันอยู่ในที่อยู่ (/api/v1) ฟิลด์ใหม่อาจถูกเพิ่มในคำตอบได้ทุกเมื่อ แต่ภายในเวอร์ชันเดียวกันจะไม่มีการลบหรือเปลี่ยนชื่อฟิลด์ อ่านเฉพาะสิ่งที่คุณต้องการ และข้ามส่วนที่เหลือ
พร้อมทำการมอนิเตอร์ให้อัตโนมัติแล้วหรือยัง
API token รวมอยู่ในแพ็กเกจ Business ขึ้นไป เปรียบเทียบแพ็กเกจ หรือเริ่มใช้ฟรีแล้วอัปเกรดเมื่อสคริปต์ของคุณพร้อม