跳转到主要内容
POST
/
field
/
update
变更自定义字段
curl --request POST \
  --url 'https://api.flashcat.cloud/field/update?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "field_id": "66e9d3a4f7c2b04a1c8a91b3",
  "display_name": "Severity Class",
  "description": "Business severity tier.",
  "options": [
    "Critical",
    "High",
    "Medium",
    "Low"
  ],
  "default_value": "Medium"
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {}
}

​
调用限制

项值
速率限制每账户 1,000 次/分钟；50 次/秒
权限故障可管理 (on-call)

​
使用说明

  • 仅可修改 display_name、description、options、default_value；field_name、field_type、value_type 不可更改。
  • options 与 default_value 需保持与字段当前类型一致，规则同创建接口。
  • 该接口会被审计日志记录。

授权

​
app_key
string
query
必填

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

请求体

application/json
​
field_id
string
必填

字段 ID，24 位十六进制 ObjectID。

Pattern: ^[a-f0-9]{24}$
​
display_name
string

新的展示名，账号内仍须唯一。

Maximum string length: 39
​
description
string

新描述。

​
options
string[]

替换后的候选项，规则同创建接口。

​
default_value

替换后的默认值，类型须与字段当前 field_type 匹配。

响应

成功

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

​
request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

​
data
object
必填

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