状态页面

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

API端点:

GET 
https://pu.a.koq.net/api/v1/status-pages

请求示例: 

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

API端点:

GET 
https://pu.a.koq.net/api/v1/status-pages/{id}

请求示例: 

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

API端点:

POST 
https://pu.a.koq.net/api/v1/status-pages

请求示例: 

curl --location --request POST 'https://pu.a.koq.net/api/v1/status-pages' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={url}' \
--data-urlencode 'slug={id}'
参数
类型
描述
name
必填 string
名字.
slug
必填 string
别名.
monitor_ids[]
可选 array
监控ID
privacy
可选 integer
隐私. 可能的值为：公开的0, 私有的1, 密码的2 默认为：0
password
可选 string
密码. 仅在privacy字段设置为2时有效
domain
可选 string
自定义域名.
logo
可选 file
标志.
favicon
可选 file
网站图标.
remove_logo
可选 boolean
移除标志.
remove_favicon
可选 boolean
移除网站图标.
website_url
可选 string
网站地址.
contact_url
可选 string
联系地址.
custom_css
可选 string
自定义CSS.
custom_js
可选 string
自定义JS.
meta_title
可选 string
元标题.
meta_description
可选 string
元描述.
noindex
可选 boolean
将状态页面排除在搜索引擎之外
更新

API端点:

POST 
https://pu.a.koq.net/api/v1/status-pages/{id}

请求示例: 

curl --location --request POST 'https://pu.a.koq.net/api/v1/status-pages/{id}' \
--header 'Authorization: Bearer {api_key}' \
--form '_method="PUT"'
参数
类型
描述
_method
必填 string
必须设置为PUT
name
可选 string
名字.
slug
可选 string
别名.
monitor_ids[]
可选 array
监控ID
privacy
可选 integer
隐私. 可能的值为：公开的0, 私有的1, 密码的2
password
可选 string
密码. 仅在privacy字段设置为2时有效
domain
可选 string
自定义域名.
logo
可选 file
标志.
favicon
可选 file
网站图标.
remove_logo
可选 boolean
移除标志.
remove_favicon
可选 boolean
移除网站图标.
website_url
可选 string
网站地址.
contact_url
可选 string
联系地址.
custom_css
可选 string
自定义CSS.
custom_js
可选 string
自定义JS.
meta_title
可选 string
元标题.
meta_description
可选 string
元描述.
noindex
可选 boolean
将状态页面排除在搜索引擎之外
删除

API端点:

DELETE 
https://pu.a.koq.net/api/v1/status-pages/{id}

请求示例: 

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