跳转到主要内容
POST
更新状态页

限制说明

使用说明

  • 省略或传 null 的字段保持原值;传空字符串会清空该字符串字段。
  • custom_links 无法清空:省略或传空数组时保留当前链接。
  • 新的 url_name 会被规范化为 slug,且在账户内同类型状态页中必须唯一;内部页不能设置 custom_domain。
  • 每次调用都会记录到账户审计日志,请勿在请求字段中写入敏感信息。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

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 安全 slug;会规范化为小写,非字母数字字符替换为连字符,且在账户内同类型状态页中必须唯一。省略或传 null 时保持不变。

Maximum string length: 255
custom_domain
string | null

公开状态页的自定义域名,不能被其他状态页占用;内部页不可设置。省略或传 null 时保持不变;传空字符串会移除域名。

Maximum string length: 255
page_title
string | 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

事件日期的展示方式:calendar 为日历视图,list 为列表视图。省略或传 null 时保持不变;传空字符串会清空该设置。

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

可用率的展示方式:chart_and_percentage 同时显示图表和百分比,chart 只显示图表,none 不显示。省略或传 null 时保持不变;传空字符串会清空该设置。

可用选项:
chart_and_percentage,
chart,
none,
,
null

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

contact_info
string | null

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

subscription
object

订阅渠道开关。公开页只能开启 email,内部页只能开启 im。省略或传 null 时保持不变。

template_preference
enum<string> | null

控制台发布事件时使用的模板模式:message(状态描述:按状态预设的描述文字)或 pre_defined(完整状态更新:包含标题、状态和描述的完整示例)。省略或传 null 时保持不变;服务端不校验取值。

可用选项:
pre_defined,
message,
null

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

无返回数据。不同接口的 data 可能是 {},也可能不出现在响应中;请只根据 HTTP 200 且没有 error 判断成功。