API 文档

这是可用API端点的文档，这些端点是基于REST架构构建的。所有API端点将返回JSON响应，并带有标准的HTTP响应代码，需要通过API密钥进行Bearer身份验证。

获取您自己的 API 密钥

基本网址

认证

所有API端点都需要通过Bearer认证方法发送的API密钥。

Authorization: Bearer {api_key}

示例

curl --request GET \
--url 'https://uptimeset.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

错误

我们的 API 使用常规的 HTTP 状态码来指示请求的成功或失败.

示例

{
    "errors": [
        {
            "title": "\u60a8\u6ca1\u6709\u8bbf\u95ee\u8be5API\u7684\u6743\u9650\u3002",
            "status": 401
        }
    ]
}

状态码

200 请求已成功完成

400 错误请求 - 必需的参数缺失或无效

401 未授权 - API 密钥缺失或无效

404 请求的资源未找到

429 请求过多 - 超出速率限制

500 内部服务器错误 - 这意味着我们这边出现了问题

所有 API 端点结果都使用 UTC 时区，除非另有说明。

用户

正常运行时间监控器

DNS 监控器

服务器监控器

心跳

域名

通知处理程序

事件

账户付款

账户日志