监控

备注
专家级别
API密钥应作为请求授权头中的Bearer令牌发送 获取您的API密钥.
列表

API端点:

GET 
https://pu.a.koq.net/api/v1/monitors

请求示例: 

curl --location --request GET 'https://pu.a.koq.net/api/v1/monitors' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
参数
类型
描述
search
可选 string
搜索查询
search_by
可选 string
按条件搜索. 可能的值为：名字的name, 网址的url 默认为：name
status_page_id
可选 integer
状态页面ID.
sort_by
可选 string
排序依据. 可能的值为：创建日期的id, 名字的name, 网址的url 默认为：id
sort
可选 string
排序. 可能的值为：降序的desc, 升序的asc 默认为：desc
per_page
可选 integer
每页结果数. 可能的值为：10, 25, 50, 100 默认为：10
显示

API端点:

GET 
https://pu.a.koq.net/api/v1/monitors/{id}

请求示例: 

curl --location --request GET 'https://pu.a.koq.net/api/v1/monitors/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
存储

API端点:

POST 
https://pu.a.koq.net/api/v1/monitors

请求示例: 

curl --location --request POST 'https://pu.a.koq.net/api/v1/monitors' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'url={url}'
参数
类型
描述
name
必填 string
名字.
url
必填 string
网址.
interval
必填 integer
间隔. 可能的值为：60, 180, 300, 600, 900, 1800, 3600
alert_condition
必填 string
警报条件. 可能的值为：网址变得不可用的url_unavailable, 网址响应包含文本的url_text, 网址响应不包含文本的url_no_text
alert_text_lookup
可选 string
触发警报的查找文本 仅在alert_condition字段设置为url_text, url_no_text时有效
request_method
必填 string
请求方法. 可能的值为：GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS
request_headers[index][key]
可选 string
请求头名称
request_headers[index][value]
可选 string
请求头值
request_auth_username
可选 string
Username for Basic HTTP request authentication.
request_auth_password
可选 string
Password for Basic HTTP request authentication.
cache_buster
可选 integer
缓存清除. 可能的值为：禁用的0, 启用的1 默认为：0
ssl_alert_days
可选 integer
SSL证书到期前接收警报的天数 可能的值为：0, 1, 2, 3, 7, 14, 30, 60
domain_alert_days
可选 integer
域名到期前接收警报的天数 可能的值为：0, 1, 2, 3, 7, 14, 30, 60
maintenance_start_at
可选 string
维护开始日期格式为Y-m-d H:i
maintenance_end_at
可选 string
维护结束日期格式为Y-m-d H:i
alerts[index][key]
可选 string
警报渠道. 可能的值为：Email的email, Webhook的webhook, Slack的slack, Microsoft Teams的teams, Discord的discord, Flock的flock, SMS的sms
alerts[index][value]
可选 string
警报的值。
更新

API端点:

PUT PATCH 
https://pu.a.koq.net/api/v1/monitors/{id}

请求示例: 

curl --location --request PUT 'https://pu.a.koq.net/api/v1/monitors/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
参数
类型
描述
name
可选 string
名字.
url
可选 string
网址.
interval
可选 integer
间隔. 可能的值为：60, 180, 300, 600, 900, 1800, 3600
alert_condition
可选 string
警报条件. 可能的值为：网址变得不可用的url_unavailable, 网址响应包含文本的url_text, 网址响应不包含文本的url_no_text
alert_text_lookup
可选 string
触发警报的查找文本 仅在alert_condition字段设置为url_text, url_no_text时有效
request_method
可选 string
请求方法. 可能的值为：GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS
request_headers[index][key]
可选 string
请求头名称
request_headers[index][value]
可选 string
请求头值
request_auth_username
可选 string
Username for Basic HTTP request authentication.
request_auth_password
可选 string
Password for Basic HTTP request authentication.
cache_buster
可选 integer
缓存清除. 可能的值为：禁用的0, 启用的1
ssl_alert_days
可选 integer
SSL证书到期前接收警报的天数 可能的值为：0, 1, 2, 3, 7, 14, 30, 60
domain_alert_days
可选 integer
域名到期前接收警报的天数 可能的值为：0, 1, 2, 3, 7, 14, 30, 60
maintenance_start_at
可选 string
维护开始日期格式为Y-m-d H:i
maintenance_end_at
可选 string
维护结束日期格式为Y-m-d H:i
alerts[index][key]
可选 string
警报渠道. 可能的值为：Email的email, Webhook的webhook, Slack的slack, Microsoft Teams的teams, Discord的discord, Flock的flock, SMS的sms
alerts[index][value]
可选 string
警报的值。
paused
可选 boolean
暂停.
删除

API端点:

DELETE 
https://pu.a.koq.net/api/v1/monitors/{id}

请求示例: 

curl --location --request DELETE 'https://pu.a.koq.net/api/v1/monitors/{id}' \
--header 'Authorization: Bearer {api_key}'