跳转到主要内容
POST
更新公共集成

限制说明

使用说明

  • 仅发送的字段会被修改,未发送的字段保持原值。
  • 提交 settings 会替换配置;已识别的敏感字段不传或传 ****** 时保留原值。保留已存密钥的同时修改它的发送目标(如 endpoint、url、数据库主机或端口、IM 接口地址)会被拒绝,需要随新目标重新填写密钥;没有已存值的字段传 ****** 也会被拒绝。清空 Headers 请传 headers: {};清空 Body 请使用该集成类型的显式空值。
  • 同时提交 settings 与 is_test: true 可获得插件测试结果,返回的 settings 中密钥同样返回 ******。
  • 处理期间若有其他请求修改了同一集成的配置,本次调用返回 RequestLocked,重试即可。当前套餐已不包含该集成类型时返回 NoLicense。
  • 这些接口仅管理公共(账户级)集成,不管理协作空间专属集成。
  • 写操作还需对象权限:主体账户、管理员、创建者或所属团队成员可操作;未设置团队时,拥有集成中心管理权限的成员可操作,只读集成不可修改。
  • 每次调用都会记录到账户审计日志。

授权

app_key
string
query
必填

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

请求体

application/json

更新集成的请求体;仅发送的字段会被修改。

integration_id
integer<int64>
必填

公共集成 ID,可从 POST /integration/list 获取。ID 不存在或属于协作空间专属集成时返回 ResourceNotFound。

必填范围: x >= 1
示例:

6113996590131

name
string | null

新的集成名称,2–49 个字符。

Required string length: 2 - 49
description
string | null

新的集成描述,最长 499 个字符。

Maximum string length: 499
team_id
integer<int64> | null

新的所属团队 ID;传 0 表示清除团队归属。

必填范围: x >= 0
settings
object

替换类型专属配置;已识别的敏感字段不传或传 ****** 时保留原值,显式传空 headers 对象可清空 Headers。保留已存密钥时不能同时修改它的发送目标(如 endpoint、url、数据库主机或端口)。

is_test
boolean

提交 settings 时执行插件测试;仅更新名称、描述或团队时不执行测试。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

公共集成详情,包含存储配置与解密 Key;时间字段为 Unix 时间戳(秒)。