API文档

了解如何连接和集成我们的API。

 

验证

所有 API 端点都需要由承载身份验证方法发送的 API 密钥。

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://uptime.tedx.net/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

错误

我们的 API 使用传统的 HTTP 状态代码来指示请求的成功或失败。

{
    "errors": [
        {
            "title": "\u60a8\u65e0\u6743\u8bbf\u95ee\u8be5 API\u3002",
            "status": 401
        }
    ]
}
200 请求成功完成
400 错误的请求 - 必需的参数丢失或无效
401 未经授权 - API 密钥丢失或无效
404 未找到请求的资源
429 请求太多 - 超出速率限制
500 内部服务器错误 - 这意味着我们这边有问题
除非另有说明,所有 API 端点结果均适用于UTC时区
用户
正常运行时间监视器
DNS 监控器
服务器监视器
心跳监控
域名
通知处理程序
故障事件
账户日志