版本 2.2.4 · 最新 下载 OpenAPI Markdown 版

接口变更 2.1.5 → 2.2.4

逐个比较操作、查询参数、请求体字段和资源字段，只列有差异的。 操作总数 336 → 426

从其他版本对比:2.2.0 → 2.2.4 查看 2.2.4 接口文档 ›
新增操作
90
变更操作
25
资源字段变更
15
删除操作
0

新增操作 90

新增
GET/api/v2/bans/source-counts按来源细类统计封禁防护 › 封禁
新增
GET/api/v2/bot-settings获取 Bot 设置防护 › Bot 设置
新增
PUT/api/v2/bot-settings修改 Bot 设置防护 › Bot 设置
新增
GET/api/v2/bot-stats获取 Bot 统计防护 › Bot 统计
新增
POST/api/v2/cc-matches/replay回放CC 匹配器草稿防护 › CC 匹配器
新增
GET/api/v2/intel获取高危 IP 库状态防护 › 高危 IP 库
新增
GET/api/v2/intel-reports查询情报上报记录防护 › 威胁情报上报记录
新增
POST/api/v2/intel/allow高危 IP 单条加白防护 › 高危 IP 库
新增
GET/api/v2/intel/ips查询高危 IP 库条目防护 › 高危 IP 库
新增
PUT/api/v2/intel/policy修改高危 IP 库处置策略防护 › 高危 IP 库
新增
GET/api/v2/intel/suspects查询可疑 IP 上报状态防护 › 高危 IP 库
新增
POST/api/v2/intel/suspects手动上报可疑 IP防护 › 高危 IP 库
新增
GET/api/v2/intel/visitors今日访问过我的高危 IP防护 › 高危 IP 库
新增
GET/api/v2/ip-sites/{id}/healthIP 站点回源健康状态IP 产品线 › IP 站点
新增
GET/api/v2/l2/revoke-impact授权失效的影响与回落窗口分层回源 › 分层回源 L2
新增
DELETE/api/v2/me/avatar移除头像用户账号 › 当前用户
新增
GET/api/v2/me/avatar取头像用户账号 › 当前用户
新增
PUT/api/v2/me/avatar上传头像用户账号 › 当前用户
新增
GET/api/v2/message-webhooks告警 Webhook 列表消息 › 告警 Webhook
新增
POST/api/v2/message-webhooks新建告警 Webhook消息 › 告警 Webhook
新增
POST/api/v2/message-webhooks/test测试未保存的告警 Webhook消息 › 告警 Webhook
新增
DELETE/api/v2/message-webhooks/{id}删除告警 Webhook消息 › 告警 Webhook
新增
PUT/api/v2/message-webhooks/{id}修改告警 Webhook消息 › 告警 Webhook
新增
POST/api/v2/message-webhooks/{id}/test测试已保存的告警 Webhook消息 › 告警 Webhook
新增
GET/api/v2/protect-schemes/leak获取防泄露方案防护 › 增值防护方案
新增
PUT/api/v2/protect-schemes/leak保存防泄露方案防护 › 增值防护方案
新增
GET/api/v2/protect-schemes/replay获取防重放方案防护 › 增值防护方案
新增
PUT/api/v2/protect-schemes/replay保存防重放方案防护 › 增值防护方案
新增
GET/api/v2/protect-schemes/replay/suggestions列出防重放保护接口建议防护 › 增值防护方案
新增
GET/api/v2/protect-schemes/tamper获取防篡改方案防护 › 增值防护方案
新增
PUT/api/v2/protect-schemes/tamper保存防篡改方案防护 › 增值防护方案
新增
POST/api/v2/protect-schemes/{kind}/apply把方案批量应用到网站防护 › 增值防护方案
新增
GET/api/v2/protect-schemes/{kind}/sites列出已设置这项防护的网站防护 › 增值防护方案
新增
POST/api/v2/protect-schemes/{kind}/sites/bulk批量重设或关闭网站的这项防护防护 › 增值防护方案
新增
GET/api/v2/reports/access-log-export-quota查看今天的访问日志下载额度报表 › 报表
新增
GET/api/v2/reports/checkup网站体检总览报表 › 报表
新增
GET/api/v2/reports/checkup/history体检历史得分报表 › 报表
新增
GET/api/v2/reports/checkup/ignores体检忽略项报表 › 报表
新增
POST/api/v2/reports/checkup/ignores/batch批量增减体检忽略项报表 › 报表
新增
GET/api/v2/reports/checkup/issues体检问题汇总报表 › 报表
新增
GET/api/v2/reports/checkup/issues/{key}/sites受某类体检问题影响的网站报表 › 报表
新增
POST/api/v2/reports/checkup/recheck重新体检报表 › 报表
新增
GET/api/v2/reports/checkup/runs/active进行中的体检批次报表 › 报表
新增
GET/api/v2/reports/checkup/runs/{id}体检批次进度报表 › 报表
新增
GET/api/v2/reports/checkup/settings读体检设置报表 › 报表
新增
PUT/api/v2/reports/checkup/settings保存体检设置报表 › 报表
新增
GET/api/v2/reports/checkup/sites/{id}网站体检报告报表 › 报表
新增
PUT/api/v2/reports/checkup/sites/{id}/app改写网站识别到的程序报表 › 报表
新增
PUT/api/v2/reports/checkup/sites/{id}/ignores设置网站的体检忽略项报表 › 报表
新增
GET/api/v2/reports/ip-seen访客 IP 的首次与最近出现报表 › 报表
新增
GET/api/v2/reports/nodes/realtime-batch节点实时曲线(多指标一次取)报表 › 报表
新增
GET/api/v2/reports/nodes/summary节点排行总表报表 › 报表
新增
GET/api/v2/reports/security/overview安全总览报表 › 报表
新增
GET/api/v2/reports/security/screen安全大屏聚合报表 › 报表
新增
GET/api/v2/reports/sites/realtime-batch站点实时曲线(多指标一次取)报表 › 报表
新增
GET/api/v2/reports/waf-events/export导出 WAF 事件 CSV报表 › 报表
新增
GET/api/v2/reports/waf-events/summaryWAF 事件汇总报表 › 报表
新增
GET/api/v2/reports/waf-events/{event_id}获取 WAF 事件详情报表 › 报表
新增
POST/api/v2/reports/waf-events/{event_id}/allow一键加白 WAF 事件报表 › 报表
新增
DELETE/api/v2/site-leak-guards/{site_id}站点防泄露恢复按方案防护 › 防泄露
新增
GET/api/v2/site-leak-guards/{site_id}获取站点防泄露设置防护 › 防泄露
新增
PUT/api/v2/site-leak-guards/{site_id}设置站点防泄露防护 › 防泄露
新增
DELETE/api/v2/site-replay-guards/{site_id}站点防重放恢复按方案防护 › 防重放
新增
GET/api/v2/site-replay-guards/{site_id}获取站点防重放设置防护 › 防重放
新增
PUT/api/v2/site-replay-guards/{site_id}设置站点防重放防护 › 防重放
新增
DELETE/api/v2/site-tamper-guards/{site_id}站点防篡改恢复按方案防护 › 防篡改
新增
GET/api/v2/site-tamper-guards/{site_id}获取站点防篡改设置防护 › 防篡改
新增
PUT/api/v2/site-tamper-guards/{site_id}设置站点防篡改防护 › 防篡改
新增
GET/api/v2/site-tamper-guards/{site_id}/diff看站点防篡改差异防护 › 防篡改
新增
POST/api/v2/site-tamper-guards/{site_id}/rebase更新站点防篡改基准防护 › 防篡改
新增
POST/api/v2/sites/checkup-fix-batch批量一键修复体检问题网站 › 网站
新增
GET/api/v2/sites/checkup-fix-batches列出最近的体检修复批次网站 › 网站
新增
POST/api/v2/sites/protect-recommend/apply批量套用推荐防护配置网站 › 网站
新增
POST/api/v2/sites/protect-recommend/preview预览推荐防护配置的影响网站 › 网站
新增
POST/api/v2/sites/protect-recommend/undo撤销一批推荐防护配置网站 › 网站
新增
POST/api/v2/sites/select-ids取筛选结果的全部站点 id网站 › 网站
新增
POST/api/v2/sites/{id}/checkup-fix一键修复体检问题网站 › 网站
新增
PUT/api/v2/sites/{id}/site-type设置网站类型网站 › 网站
新增
GET/api/v2/sites/{id}/upload-scan/exceptions列出站点的上传扫描例外网站 › 网站
新增
DELETE/api/v2/sites/{id}/upload-scan/false-positive撤销站点标记的上传扫描误报网站 › 网站
新增
POST/api/v2/sites/{id}/upload-scan/false-positive标记站点的上传扫描误报网站 › 网站
新增
GET/api/v2/sites/{id}/url-guard/active列出站点在途的全网 URL 防护网站 › 网站
新增
POST/api/v2/sites/{id}/url-guard/revoke手动撤销站点在途的全网 URL 防护网站 › 网站
新增
GET/api/v2/tamper-guard/pages列出全部网站的防篡改保护页面防护 › 防篡改保护页面总表
新增
GET/api/v2/upload-scan-settings获取上传防护设置防护 › 上传防护设置
新增
PUT/api/v2/upload-scan-settings修改上传防护设置防护 › 上传防护设置
新增
GET/api/v2/upload-scan-stats获取上传扫描统计防护 › 上传扫描统计
新增
GET/api/v2/url-guard-settings获取全网 URL 防护设置防护 › 全网 URL 防护设置
新增
PUT/api/v2/url-guard-settings修改全网 URL 防护设置防护 › 全网 URL 防护设置
新增
GET/api/v2/url-guard/active列出生效中的全网 URL 防护防护 › 全网 URL 防护

变更操作 25

变更
DELETE/api/v2/auth/totp关闭动态口令登录认证 › 登录认证
  • 请求体形状: — → object
  • 删除查询参数 code
  • 新增请求体字段 code
变更
GET/api/v2/bans列出封禁防护 › 封禁
  • 新增查询参数 created_from
  • 新增查询参数 source_type
变更
POST/api/v2/bans创建封禁防护 › 封禁
  • 新增查询参数 tenant_id
变更
GET/api/v2/bans/site-counts按站点统计封禁防护 › 封禁
  • 新增查询参数 created_from
  • 新增查询参数 source_type
变更
POST/api/v2/cc-filters创建CC 过滤器防护 › CC 过滤器
  • 新增请求体字段 count_key
变更
PUT/api/v2/cc-filters/{id}修改CC 过滤器防护 › CC 过滤器
  • 新增请求体字段 count_key
变更
PUT/api/v2/me修改个人资料用户账号 › 当前用户
  • 新增请求体字段 nickname
变更
POST/api/v2/message-channels/test测试发信通道消息 › 发信通道
  • 新增请求体字段 draft
变更
POST/api/v2/packages创建套餐套餐 › 套餐
  • 新增请求体字段 l2
  • 新增请求体字段 waf_enhanced
变更
PUT/api/v2/packages/{id}修改套餐套餐 › 套餐
  • 新增请求体字段 l2
  • 新增请求体字段 waf_enhanced
变更
POST/api/v2/reports/access-log-exports申请下载访问日志报表 › 报表
  • 新增查询参数 block_reason
  • 新增查询参数 cache_status_not
  • 新增查询参数 group_id
  • 新增查询参数 http_ver
  • 新增查询参数 method
  • 新增查询参数 q
  • 新增查询参数 referer
  • 删除查询参数 site_id
  • 新增查询参数 site_ids
  • 新增查询参数 slow_ms
  • 新增查询参数 status_class
  • 新增查询参数 tenant_ids
  • 新增查询参数 upid
变更
GET/api/v2/reports/access-logs列出访问日志报表 › 报表
  • 新增查询参数 block_reason
  • 新增查询参数 cache_status_not
  • 新增查询参数 facets
  • 新增查询参数 group_id
  • 新增查询参数 http_ver
  • 新增查询参数 method
  • 新增查询参数 q
  • 新增查询参数 referer
  • 删除查询参数 site_id
  • 新增查询参数 site_ids
  • 新增查询参数 slow_ms
  • 新增查询参数 status_class
  • 新增查询参数 tenant_ids
  • 新增查询参数 total
  • 新增查询参数 upid
变更
GET/api/v2/reports/nodes/realtime节点实时曲线报表 › 报表
  • 变更查询参数 metric(enum: ["nic_in_bps","nic_out_bps","cpu_pct","mem_pct","load1","disk_space_pct","disk_inode_pct","tcp_conn","nginx_active","nginx_reading","nginx_writing","nginx_waiting","log_dropped","tls_hs_reject","worker_drain_killed"] → ["nic_in_bps","nic_out_bps","cpu_pct","mem_pct","load1","disk_space_pct","disk_inode_pct","tcp_conn","nginx_active","nginx_reading","nginx_writing","nginx_waiting","log_dropped","tls_hs_reject","worker_drain_killed","shm_used_pct","shm_write_fail"])
变更
GET/api/v2/reports/nodes/top节点排行报表 › 报表
  • 变更查询参数 metric(enum: ["nic_in_bps","nic_out_bps","cpu_pct","mem_pct","load1","disk_space_pct","disk_inode_pct","tcp_conn","nginx_active","nginx_reading","nginx_writing","nginx_waiting","log_dropped","tls_hs_reject","worker_drain_killed"] → ["nic_in_bps","nic_out_bps","cpu_pct","mem_pct","load1","disk_space_pct","disk_inode_pct","tcp_conn","nginx_active","nginx_reading","nginx_writing","nginx_waiting","log_dropped","tls_hs_reject","worker_drain_killed","shm_used_pct","shm_write_fail"])
变更
GET/api/v2/reports/sites/geo访问归属地统计报表 › 报表
  • 新增查询参数 group_id
  • 删除查询参数 site_id
  • 新增查询参数 site_ids
  • 新增查询参数 tenant_ids
  • 新增查询参数 upid
变更
GET/api/v2/reports/sites/overview站点流量概览报表 › 报表
  • 新增查询参数 compare
  • 新增查询参数 group_id
  • 新增查询参数 site_ids
  • 新增查询参数 tenant_ids
  • 新增查询参数 upid
变更
GET/api/v2/reports/sites/realtime站点实时曲线报表 › 报表
  • 新增查询参数 group_id
  • 删除查询参数 site_id
  • 新增查询参数 site_ids
  • 新增查询参数 tenant_ids
  • 新增查询参数 upid
变更
GET/api/v2/reports/sites/top站点排行报表 › 报表
  • 变更查询参数 dim(required: true → false; enum: ["ip","prefix","url","referer","site","status","http_ver","scheme","cache_status","ctype"] → ["ip","prefix","url","referer","site","status","http_ver","scheme","cache_status","ctype","country","prov","isp","port","block_reason"])
  • 新增查询参数 dims
  • 新增查询参数 group_id
  • 新增查询参数 limit
  • 删除查询参数 site_id
  • 新增查询参数 site_ids
  • 新增查询参数 tenant_ids
  • 新增查询参数 upid
变更
GET/api/v2/reports/streams/realtime四层转发实时曲线报表 › 报表
  • 变更查询参数 metric(enum: ["bandwidth","bandwidth_in","traffic","traffic_in"] → ["bandwidth","bandwidth_in","traffic","traffic_in","req","conn_peak"])
变更
GET/api/v2/reports/usage用量曲线报表 › 报表
  • 新增查询参数 group_id
  • 变更查询参数 interval(enum: ["auto","5m"] → ["auto","5m","1h"])
  • 变更查询参数 metric(enum: ["bandwidth","traffic","req","qps","req_hit_ratio","status_5xx_ratio"] → ["bandwidth","traffic","req","qps","req_hit_ratio","status_5xx_ratio","status_4xx_ratio","backend_bandwidth","backend_traffic","backend_resp_time","blocked"])
  • 删除查询参数 site_id
  • 新增查询参数 site_ids
  • 新增查询参数 tenant_ids
变更
GET/api/v2/reports/waf-events列出 WAF 事件报表 › 报表
  • 新增查询参数 action
  • 新增查询参数 country
  • 新增查询参数 disposition
  • 新增查询参数 end
  • 新增查询参数 ja4
  • 新增查询参数 node_id
  • 新增查询参数 observe
  • 新增查询参数 province
  • 新增查询参数 start
  • 新增查询参数 type
  • 新增查询参数 url
变更
GET/api/v2/sites列出站点网站 › 网站
  • 新增查询参数 app
  • 新增查询参数 group_ids
变更
PATCH/api/v2/sites/{id}/l2修改网站分层回源网站 › 网站
  • 新增请求体字段 l2_pick
变更
PUT/api/v2/user-packages/{id}修改用户套餐套餐 › 已购套餐
  • 新增请求体字段 l2
  • 新增请求体字段 waf_enhanced
变更
PUT/api/v2/waf-settings修改 WAF 设置防护 › WAF 设置
  • 新增请求体字段 enhanced
  • 新增请求体字段 intel_share
  • 新增请求体字段 level
  • 新增请求体字段 observe_days
  • 新增请求体字段 rule_lib
  • 新增请求体字段 scanner
  • 新增请求体字段 semantic
  • 新增请求体字段 trunc_action

资源字段变更 15

字段
auth登录认证登录认证
  • 新增字段 recovery_codes
字段
bans封禁防护
  • 新增字段 filter_id
  • 新增字段 intel
  • 新增字段 intel_hit
  • 新增字段 items
  • 新增字段 rule_id
  • 新增字段 source_type
字段
cc-filtersCC 过滤器防护
  • 新增字段 count_key
字段
cc-matchesCC 匹配器防护
  • 新增字段 hits
  • 新增字段 ips
  • 新增字段 reason
  • 新增字段 sampled
  • 新增字段 site_id
  • 新增字段 sites
  • 新增字段 supported
  • 新增字段 top_ips
  • 新增字段 top_urls
  • 新增字段 total
  • 新增字段 window_hours
字段
ip-sitesIP 站点IP 产品线
  • 新增字段 checked_at
  • 新增字段 nodes
  • 新增字段 status
字段
l2分层回源 L2分层回源
  • 新增字段 l2_pick
  • 新增字段 origin_l2_only
  • 新增字段 owner_id
  • 新增字段 owner_name
字段
me当前用户用户账号
  • 新增字段 avatar_ver
  • 新增字段 client_ip
  • 新增字段 delegated_session
  • 新增字段 nickname
  • 新增字段 size
  • 新增字段 totp_recovery_left
字段
message-channels发信通道消息
  • 新增字段 draft
字段
packages套餐套餐
  • 新增字段 l2
  • 新增字段 waf_enhanced
字段
registrations注册用户账号
  • 新增字段 avatar_ver
  • 新增字段 client_ip
  • 新增字段 delegated_session
  • 新增字段 nickname
  • 新增字段 totp_recovery_left
字段
reports报表报表
  • 新增字段 advice
  • 新增字段 app
  • 新增字段 app_manual
  • 新增字段 app_version
  • 新增字段 approx
  • 新增字段 attack_types
  • 新增字段 attacked_sites
  • 新增字段 ban_hits
  • 新增字段 block
  • 新增字段 blocked_by_feature
  • 新增字段 body_trunc
  • 新增字段 bot_score
  • 新增字段 category
  • 新增字段 challenge
  • 新增字段 checked_at
  • 新增字段 checkup
  • 新增字段 compare
  • 变更字段 countries(type: GeoCount[] → SecurityCountryCount[])
  • 新增字段 covered
  • 新增字段 critical
  • 新增字段 current_site_id
  • 新增字段 cves
  • 新增字段 dims
  • 新增字段 domain
  • 新增字段 done_site_ids
  • 新增字段 done_sites
  • 新增字段 exception
  • 新增字段 extra
  • 新增字段 facets
  • 新增字段 file_count
  • 新增字段 file_ctype
  • 新增字段 file_field
  • 新增字段 file_magic
  • 新增字段 file_name
  • 新增字段 file_sha256
  • 新增字段 file_size
  • 新增字段 findings
  • 新增字段 first_seen
  • 新增字段 first_seen_at
  • 新增字段 flows
  • 新增字段 frequency
  • 新增字段 geo_summary
  • 新增字段 handled_by_feature
  • 新增字段 headers
  • 新增字段 history
  • 新增字段 hit_layer
  • 新增字段 intel_hit
  • 变更字段 items(type: NodeTopItem[] → CheckupHistoryPoint[])
  • 新增字段 ja4
  • 新增字段 keys
  • 变更字段 kind(type: HostNotFoundKind → string; enum: ["site","pointed_here","not_pointed","typo","scanner","unknown"] → ["domain","ip"])
  • 新增字段 last_seen_at
  • 新增字段 level
  • 新增字段 limit
  • 新增字段 medium
  • 新增字段 metrics
  • 新增字段 name
  • 新增字段 node_city
  • 新增字段 node_ips
  • 新增字段 node_lat
  • 新增字段 node_lon
  • 新增字段 node_spots
  • 新增字段 node_unknown
  • 新增字段 notify_critical
  • 新增字段 observe
  • 新增字段 observe_rule
  • 新增字段 op
  • 新增字段 open_url
  • 新增字段 other
  • 新增字段 param
  • 新增字段 params
  • 新增字段 path
  • 变更字段 points(type: SitesOverviewPoint[] → SecurityPoint[])
  • 新增字段 prev_score
  • 新增字段 previous
  • 新增字段 probes
  • 新增字段 protocol
  • 新增字段 province
  • 新增字段 provinces
  • 新增字段 publish_seq
  • 新增字段 recent
  • 新增字段 referer_open_url
  • 新增字段 remaining
  • 新增字段 reset
  • 新增字段 result
  • 新增字段 rule
  • 新增字段 rules_ver
  • 新增字段 run
  • 新增字段 saved_bytes
  • 新增字段 scan_status
  • 新增字段 scan_steps
  • 新增字段 score
  • 新增字段 severity
  • 新增字段 site_deleted
  • 新增字段 site_ids
  • 新增字段 site_name
  • 新增字段 snippet
  • 新增字段 source_ips
  • 新增字段 stage
  • 新增字段 started_at
  • 新增字段 state
  • 新增字段 step
  • 新增字段 summary
  • 新增字段 target
  • 新增字段 top_rules
  • 新增字段 top_sites
  • 新增字段 total_sites
  • 新增字段 type
  • 新增字段 types
  • 新增字段 unavailable
  • 新增字段 unlimited
  • 新增字段 url
  • 新增字段 used
  • 新增字段 version
  • 新增字段 window_min
字段
sites网站网站
  • 新增字段 added_at
  • 新增字段 app
  • 新增字段 batch
  • 新增字段 default_pick
  • 新增字段 domain
  • 新增字段 gate_reasons
  • 新增字段 group_id
  • 新增字段 key
  • 新增字段 l2_pick
  • 新增字段 observe_days
  • 新增字段 origin
  • 新增字段 path
  • 新增字段 rec_ver
  • 新增字段 revoked
  • 新增字段 revoking_until
  • 新增字段 sha256
  • 新增字段 sig
  • 新增字段 site_id
  • 新增字段 skip
  • 新增字段 source
  • 新增字段 total
  • 新增字段 truncated
  • 新增字段 type
  • 新增字段 waf_gate
  • 新增字段 waf_gate_reason
字段
user-packages已购套餐套餐
  • 新增字段 l2
  • 新增字段 waf_enhanced
字段
users用户管理用户账号
  • 新增字段 avatar_ver
  • 新增字段 client_ip
  • 新增字段 delegated_session
  • 新增字段 nickname
  • 新增字段 totp_recovery_left
字段
waf-settingsWAF 设置防护
  • 新增字段 enhanced
  • 新增字段 intel_share
  • 新增字段 level
  • 新增字段 observe_days
  • 新增字段 rule_lib
  • 新增字段 scanner
  • 新增字段 semantic
  • 新增字段 trunc_action