跳转到主要内容
POST
/
status-page
/
create
创建状态页
curl --request POST \
  --url 'https://api.flashcat.cloud/status-page/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Status Page",
  "url_name": "my-status-page",
  "type": "public",
  "page_header": "Welcome to our status page",
  "contact_info": "mailto:support@example.com"
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "page_id": 6294565612043,
    "page_name": "My Status Page",
    "page_url_name": "my-status-page"
  }
}

限制说明

项目说明
速率限制每个账户 1,000 次/分钟50 次/秒
权限要求状态页面管理on-call

授权

app_key
string
query
必填

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

请求体

application/json
name
string
必填

状态页展示名称。

Maximum string length: 255
url_name
string
必填

URL 安全的状态页路径,在账户和状态页类型内唯一。

Maximum string length: 255
type
enum<string>
必填

状态页可见性类型。

可用选项:
public,
internal
date_view
enum<string>
必填

事件日期展示方式。

可用选项:
calendar,
list
display_uptime_mode
enum<string>
必填

可用率展示方式。

可用选项:
chart_and_percentage,
chart,
none
custom_domain
string

公开状态页使用的自定义域名。

Maximum string length: 255
page_title
string

状态页浏览器标题。

page_header
string

状态页页头内容。

状态页页脚内容。

状态页展示的自定义导航链接。

contact_info
string

联系信息,例如 mailto 或网站 URL。

subscription
object

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

每个接口自己的业务 payload,详见各接口的 200 响应 schema。