跳转到主要内容
POST
/
enrichment
/
mapping
/
api
/
create
创建映射 API
curl --request POST \
  --url 'https://api.flashcat.cloud/enrichment/mapping/api/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_name": "CMDB API",
  "description": "查询 CMDB 主机元数据",
  "url": "https://cmdb.example.com/api/lookup",
  "headers": {
    "X-Token": "mytoken"
  },
  "timeout": 2,
  "retry_count": 1,
  "insecure_skip_verify": false
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "api_id": "665f1a2b3c4d5e6f7a8b9c02",
    "api_name": "CMDB API"
  }
}

​
限制说明

项目说明
速率限制每个账户 1,000 次/分钟；50 次/秒
权限要求无 —— 持有有效的 app_key 即可调用

​
使用说明

  • url 须以 http:// 或 https:// 开头，SaaS 模式下不得解析为内网 IP。
  • timeout 为 HTTP 读取超时秒数（1–3，默认 2）。
  • retry_count 为失败重试次数（0–1，默认 0）。
  • SaaS 模式下，含敏感名称的请求头（如 authorization、cookie）将被拒绝。
  • 账户最多可创建 50 个映射 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

可选描述。

​
insecure_skip_verify
boolean

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

​
headers
object

自定义 HTTP 请求头。

​
timeout
integer

请求超时秒数（1–3），默认 2。

​
retry_count
integer

失败重试次数（0–1），默认 0。

​
team_id
integer<int64>

所属团队 ID。

响应

成功

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

​
request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

​
data
object
必填

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