Skip to main content
POST
创建映射 API

授权

app_key
string
query
必填

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

请求体

application/json
api_name
string
必填

唯一的 API 名称(最多 199 个字符)。

Maximum string length: 199
url
string<uri>
必填

HTTP/HTTPS 端点 URL(最多 500 个字符)。

Maximum string length: 500
description
string

可选描述,超过 500 字符会被静默截断。

insecure_skip_verify
boolean

是否跳过 TLS 证书验证,默认 false。

headers
object

自定义 HTTP 请求头。SaaS 模式下安全敏感的请求头名(authorization、cookie、x-forwarded-for 等)会被拒绝;键须为 RFC 7230 token 字符(最长 1024),值最长 4096 字符。

timeout
integer

请求超时秒数(1–3),默认 2。

必填范围: 1 <= x <= 3
retry_count
integer

失败重试次数(0–1),默认 0。

必填范围: 0 <= x <= 1
team_id
integer<int64>

所属团队 ID,可通过 POST /team/list 获取。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

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