OverviewGetting StartedAPI Reference

快速开始

在5分钟内开始使用PulseAPI。

1

注册

在 创建您的账户。/signup.

基础版:10个端点,1分钟检查,邮件 + Telegram + Slack告警 - $19/月

2

添加您的第一个端点

登录后,您将看到引导向导。添加您的第一个端点:

  • 输入您的API URL(例如 https://api.example.com/health)
  • 选择HTTP方法(GET、POST等)
  • 设置检查间隔(1-60分钟)
  • 配置超时时间(5-60秒)
{
  "url": "https://api.example.com/health",
  "method": "GET",
  "checkInterval": 60,
  "timeout": 10
}
3

设置状态页

创建公开状态页以与用户共享可用性。前往仪表盘 > 状态页。

  • 为您的 URL 选择唯一的 slug
  • 使用您的 logo、颜色和公司名称自定义
  • 选择要显示的端点
  • 可选添加自定义域名(如 status.yourcompany.com)

您的状态页将在 status.pulseapi.com/your-slug 上可用

4

设置告警

PulseAPI自动发送以下告警:

宕机连续2次失败触发告警
恢复端点在宕机后恢复在线
慢速响应时间超过2000ms(最多每小时1次告警)

所有告警发送到您的注册邮箱。在设置中配置Webhook和Telegram以获取额外渠道。

5

监控仪表板

端点添加后,PulseAPI立即开始监控。查看:

  • 实时状态(运行正常、宕机、性能下降)
  • 响应时间图表(过去7天)
  • 正常运行时间百分比(24小时滚动窗口)
  • 检查历史表(分页、可排序)
6

使用API

创建 API 密钥以编程方式访问 PulseAPI。

  1. 前往仪表盘 > 设置 > API 密钥
  2. 点击创建,命名并选择权限范围(如 endpoints:read, alerts:read)
  3. 立即复制密钥 -- 仅显示一次
# List your endpoints
curl -H "Authorization: pk_live_abc123..." \
  https://api.pulseapi.tech/endpoints

# Trigger a manual check
curl -X POST -H "Authorization: pk_live_abc123..." \
  https://api.pulseapi.tech/endpoints/ENDPOINT_ID/check

查看获取完整的端点列表。API参考

后续步骤

需要帮助?

有问题或反馈?请发送邮件至 - 我们会回复每条消息。[email protected]