OverviewGetting StartedAPI Reference

PulseAPI 文档

PulseAPI 监控您的 API 端点,并在出现问题时发出告警。本文档涵盖设置、REST API 和核心概念。

核心概念

端点

您要监控的 URL。每个端点按可配置的间隔(1 分钟到 1 小时)通过 HTTP 检查。

检查

单次监控探测。每次检查记录状态码、响应时间和可选的断言结果。

告警

连续 2 次以上失败后自动触发。端点恢复时发送恢复告警。慢响应告警限制为每小时 1 次。

状态页

显示端点健康状态、可用性条和事件的公开页面。支持自定义域名和品牌。

事件

通过时间线更新、严重级别和事后分析跟踪故障。订阅者会自动收到通知。

基础 URL

https://api.pulseapi.tech

所有 API 端点均相对于此基础 URL。

快速示例

# Create an API key in Dashboard > Settings > API Keys, then:

# List your endpoints
curl -H "Authorization: pk_live_abc123..." \
  https://api.pulseapi.tech/endpoints

# Create a new endpoint
curl -X POST https://api.pulseapi.tech/endpoints \
  -H "Authorization: pk_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{"name":"My API","url":"https://api.example.com/health","method":"GET","checkInterval":300,"timeout":10}'

# Check uptime stats
curl -H "Authorization: pk_live_abc123..." \
  "https://api.pulseapi.tech/endpoints/ENDPOINT_ID/stats?period=24h"

准备开始了吗?阅读快速开始 或跳转到 API 参考.