Skip to main content
POST
更新状态页

限制说明

授权

app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。

请求体

application/json

更新已有状态页所需的参数。除 page_id 外均为可选字段;省略某字段或传 null 表示保持其原值。

page_id
integer<int64>
必填

状态页 ID,可通过 GET /status-page/list 获取。

name
string | null

状态页展示名称。省略或传 null 表示保持原值。

Maximum string length: 255
url_name
string | null

URL 安全的状态页路径,在账户和状态页类型内唯一。省略或传 null 表示保持原值。

Maximum string length: 255
custom_domain
string | null

公开状态页使用的自定义域名。省略或传 null 表示保持原值。

Maximum string length: 255
page_title
string | null

状态页浏览器标题。省略或传 null 表示保持原值。

logo
string | null

状态页 Logo 图片。省略或传 null 表示保持原值。

dark_logo
string | null

状态页暗色模式 Logo 图片。省略或传 null 表示保持原值。

logo_url
string | null

点击 Logo 时跳转的 URL。省略或传 null 表示保持原值。

Maximum string length: 255
favicon
string | null

状态页的网站图标。省略或传 null 表示保持原值。

page_header
string | null

状态页页头内容。省略或传 null 表示保持原值。

状态页页脚内容。省略或传 null 表示保持原值。

date_view
enum<string> | null

事件日期展示方式。省略或传 null 表示保持原值。calendar 为日历视图;list 为列表视图。

可用选项:
calendar,
list
display_uptime_mode
enum<string> | null

可用率展示方式。省略或传 null 表示保持原值。chart_and_percentage 同时展示图表与百分比;chart 仅展示图表;none 不展示。

可用选项:
chart_and_percentage,
chart,
none

状态页展示的自定义导航链接。省略或传空数组表示保持当前链接。

contact_info
string | null

联系信息,例如 mailto 或网站 URL。省略或传 null 表示保持原值。

subscription
object

订阅渠道开关。省略或传 null 表示保持原值。

template_preference
string | null

偏好的事件模板类型:pre_definedmessage。省略或传 null 表示保持原值。

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

空响应体。成功时服务端返回 data: null