API operation index

This index lists HTTP methods, paths, tags and summaries from the bundled Swagger specification. Tags and summaries retain the original language of the specification; they are not English translations.

Paths below are the exact keys in swagger.json; basePath is not prepended again. Use the address of your own SamWaf management service for calls.

Raw Swagger specification · Authentication and interactive documentation · Conventions and scenarios

Method	Path (verbatim)	Tags (source language)	Summary (source language)
GET	/api/v1/owasp/audit_log	OWASP规则管理	获取OWASP规则变更审计日志
GET	/api/v1/owasp/base_config	OWASP规则管理	获取OWASP基线配置
POST	/api/v1/owasp/base_config	OWASP规则管理	更新OWASP基线配置
POST	/api/v1/owasp/crs_var	OWASP规则管理	设置单个CRS事务变量
DELETE	/api/v1/owasp/crs_var	OWASP规则管理	删除单个CRS事务变量
GET	/api/v1/owasp/crs_vars	OWASP规则管理	获取所有自定义CRS事务变量
GET	/api/v1/owasp/file_content	OWASP规则管理	获取OWASP规则文件原始内容
GET	/api/v1/owasp/files	OWASP规则管理	获取OWASP规则文件列表
GET	/api/v1/owasp/hit_stats	OWASP规则管理	获取OWASP规则命中统计
POST	/api/v1/owasp/hit_stats/reset	OWASP规则管理	清空OWASP规则命中统计
POST	/api/v1/owasp/reload	OWASP规则管理	手动触发WAF热重载
GET	/api/v1/owasp/rule_detail	OWASP规则管理	获取OWASP规则详情
POST	/api/v1/owasp/rule_override	OWASP规则管理	改写OWASP规则内容
POST	/api/v1/owasp/rule_reset	OWASP规则管理	还原OWASP规则为上游版本
POST	/api/v1/owasp/rule_toggle	OWASP规则管理	启用/禁用OWASP规则
GET	/api/v1/owasp/rules	OWASP规则管理	获取OWASP规则列表
POST	/api/v1/owasp/test/dry_run	OWASP规则管理	OWASP沙盒测试
GET	/api/v1/owasp/tuning	OWASP规则管理	获取OWASP调参配置
POST	/api/v1/owasp/tuning	OWASP规则管理	更新OWASP调参配置
POST	/api/v1/owasp/update/apply	OWASP规则管理	执行OWASP规则库升级
GET	/api/v1/owasp/update/check	OWASP规则管理	检查OWASP规则库是否有新版本
GET	/api/v1/owasp/usage/doc	OWASP规则管理	获取OWASP规则管理使用说明
POST	/diagnostic/cpuprofile/start	运行诊断	发起CPU采样
GET	/diagnostic/cpuprofile/status	运行诊断	查询CPU采样状态
GET	/diagnostic/package	运行诊断	下载运行诊断包
GET	/diagnostic/snapshot	运行诊断	获取运行诊断快照
GET	/diagnostic/trend	运行诊断	获取运行诊断趋势
POST	/firewall/ipblock/add	防火墙-IP封禁	新增防火墙IP封禁
GET	/firewall/ipblock/capability	防火墙-IP封禁	获取系统防火墙能力
GET	/firewall/ipblock/del	防火墙-IP封禁	删除防火墙IP封禁
POST	/firewall/ipblock/edit	防火墙-IP封禁	编辑防火墙IP封禁
POST	/firewall/ipblock/list	防火墙-IP封禁	获取防火墙IP封禁列表
POST	/hostconn/block	远程连接看板	封禁某个连接来源IP
POST	/hostconn/list	远程连接看板	远程连接列表
GET	/hostconn/refresh	远程连接看板	强制刷新连接快照
GET	/hostconn/summary	远程连接看板	远程连接汇总
POST	/hostguard/ban/list	主机防爆破	主机防爆破封禁列表
POST	/hostguard/ban/manual	主机防爆破	手工封禁一个IP
POST	/hostguard/ban/permanent	主机防爆破	提升为永久封禁
POST	/hostguard/ban/release	主机防爆破	提前解封
POST	/hostguard/event/list	主机防爆破	主机登录失败事件列表
GET	/hostguard/ladder/list	主机防爆破	获取封禁阶梯配置
POST	/hostguard/ladder/save	主机防爆破	保存封禁阶梯配置
POST	/hostguard/offender/del	主机防爆破	删除攻击者档案
POST	/hostguard/offender/list	主机防爆破	攻击者档案列表
POST	/hostguard/offender/reset	主机防爆破	重置攻击者阶梯
GET	/hostguard/statistics	主机防爆破	主机防爆破概览统计
GET	/hostguard/status	主机防爆破	主机防爆破运行状态
POST	/hostguard/whitelist/add	主机防爆破	把IP加入白名单
POST	/hostguard/whitelist/test	主机防爆破	白名单自测
GET	/logfilewrite/backupfiles	日志文件写入	获取日志备份文件列表
POST	/logfilewrite/clear	日志文件写入	清空当前日志文件
GET	/logfilewrite/currentfile	日志文件写入	获取当前日志文件信息
GET	/logfilewrite/preview	日志文件写入	获取日志文件预览
GET	/logfilewrite/variables	日志文件写入	获取日志模板变量列表
GET	/monitor/system_info	系统监控	获取系统监控信息
POST	/notify/channel/add	通知-渠道	新增通知渠道
GET	/notify/channel/del	通知-渠道	删除通知渠道
GET	/notify/channel/detail	通知-渠道	获取通知渠道详情
POST	/notify/channel/edit	通知-渠道	编辑通知渠道
POST	/notify/channel/list	通知-渠道	获取通知渠道列表
GET	/notify/globalthrottle	通知-订阅	获取通知全局默认频率配置
POST	/notify/globalthrottle/update	通知-订阅	更新通知全局默认频率配置
GET	/notify/log/del	通知日志	删除通知日志
GET	/notify/log/detail	通知日志	获取通知日志详情
POST	/notify/log/list	通知日志	获取通知日志列表
POST	/notify/subscription/add	通知-订阅	新增通知订阅
POST	/notify/subscription/batchconfig	通知-订阅	批量套用通知订阅配置
POST	/notify/subscription/config	通知-订阅	保存通知订阅精细化配置
GET	/notify/subscription/del	通知-订阅	删除通知订阅
POST	/notify/subscription/dryrun	通知-订阅	通知订阅干跑演算
POST	/notify/subscription/list	通知-订阅	获取通知订阅列表
POST	/notify/subscription/preview	通知-订阅	预览通知模板渲染结果
GET	/notify/subscription/templatevars	通知-订阅	获取通知模板可用变量
POST	/notify/subscription/test	通知-订阅	测试发送通知订阅
GET	/resetWAF	引擎-WAF引擎	重启WAF引擎
POST	/sslconfig/add	SSL-证书配置	新增SSL证书
GET	/sslconfig/del	SSL-证书配置	删除SSL证书
GET	/sslconfig/detail	SSL-证书配置	获取SSL证书详情
POST	/sslconfig/edit	SSL-证书配置	编辑SSL证书
POST	/sslconfig/list	SSL-证书配置	获取SSL证书列表
GET	/statrumtimesysinfo	统计-数据统计	获取运行时系统基本信息
GET	/statsysinfo	统计-数据统计	获取首页系统基本信息
GET	/sys_log/detail	系统日志	获取系统日志详情
GET	/sys_log/list	系统日志	获取系统日志列表
GET	/sysinfo/runtimeinfo	系统信息	获取系统运行环境信息
GET	/sysinfo/version	系统信息	获取系统版本信息
POST	/systemconfig/edit	系统配置	更新系统配置
POST	/systemconfig/editByItem	系统配置	通过item更新系统配置
POST	/systemconfig/list	系统配置	获取系统配置列表
POST	/tunnel/tunnel/add	隧道管理	新增隧道配置
GET	/tunnel/tunnel/connections	隧道管理	获取隧道实时连接信息
GET	/tunnel/tunnel/del	隧道管理	删除隧道配置
GET	/tunnel/tunnel/detail	隧道管理	获取隧道配置详情
POST	/tunnel/tunnel/edit	隧道管理	编辑隧道配置
POST	/tunnel/tunnel/list	隧道管理	获取隧道配置列表
POST	/upgradenotice/ack	升级须知	升级须知标记已处理
POST	/upgradenotice/downgradeack	升级须知	确认降级告警
POST	/upgradenotice/ignore	升级须知	升级须知忽略
POST	/upgradenotice/list	升级须知	升级须知列表
POST	/upgradenotice/popupshown	升级须知	升级须知弹窗已展示
POST	/upgradenotice/restore	升级须知	升级须知恢复待处理
GET	/upgradenotice/summary	升级须知	升级须知汇总
GET	/vipconfig/getDomainWhitelist	管理端配置	获取管理端域名白名单
GET	/vipconfig/getIpWhitelist	管理端配置	获取管理端IP白名单
GET	/vipconfig/getManageTrustedProxies	管理端配置	获取管理端可信代理网段
GET	/vipconfig/getNoticeTitle	管理端配置	获取通知标题前缀
GET	/vipconfig/getSecurityEntry	管理端配置	获取安全路径入口配置
GET	/vipconfig/getSslBindCert	管理端配置	获取管理端证书绑定的证书夹
GET	/vipconfig/getSslForceHttps	管理端配置	获取管理端仅允许HTTPS开关
GET	/vipconfig/getSslStatus	管理端配置	获取管理端SSL状态
GET	/vipconfig/manageClientIpProbe	管理端配置	管理端真实IP诊断
POST	/vipconfig/restartManager	管理端配置	重启管理端
POST	/vipconfig/updateDomainWhitelist	管理端配置	更新管理端域名白名单
POST	/vipconfig/updateIpWhitelist	管理端配置	更新管理端IP白名单
POST	/vipconfig/updateManageTrustedProxies	管理端配置	更新管理端可信代理网段
POST	/vipconfig/updateNoticeTitle	管理端配置	更新通知标题前缀
POST	/vipconfig/updateSecurityEntry	管理端配置	更新安全路径入口配置
POST	/vipconfig/updateSslBindCert	管理端配置	绑定/解绑管理端证书到证书夹
POST	/vipconfig/updateSslEnable	管理端配置	更新管理端SSL启用状态
POST	/vipconfig/updateSslForceHttps	管理端配置	更新管理端仅允许HTTPS开关
POST	/vipconfig/uploadSslCert	管理端配置	上传管理端SSL证书
POST	/wafhost/accessaccount/add	统一访问认证-访问账号	新增访问账号
GET	/wafhost/accessaccount/del	统一访问认证-访问账号	删除访问账号
GET	/wafhost/accessaccount/detail	统一访问认证-访问账号	获取访问账号详情
POST	/wafhost/accessaccount/edit	统一访问认证-访问账号	编辑访问账号
POST	/wafhost/accessaccount/list	统一访问认证-访问账号	获取访问账号列表
POST	/wafhost/accessaccount/otp/bind	统一访问认证-访问账号	绑定访问账号的二次验证
GET	/wafhost/accessaccount/otp/init	统一访问认证-访问账号	生成访问账号的二次验证密钥
POST	/wafhost/accessaccount/otp/unbind	统一访问认证-访问账号	解绑访问账号的二次验证
POST	/wafhost/accessaccount/resetpwd	统一访问认证-访问账号	重置访问账号密码
POST	/wafhost/accessaudit/list	统一访问认证-审计	获取统一访问认证审计日志
GET	/wafhost/accessconfig/detail	统一访问认证-配置	获取统一访问认证配置
GET	/wafhost/accessconfig/hostoptions	统一访问认证-配置	获取认证中心域名候选列表
POST	/wafhost/accessconfig/regenerate_secret	统一访问认证-配置	轮换统一访问认证的签名密钥
POST	/wafhost/accessconfig/save	统一访问认证-配置	保存统一访问认证配置
GET	/wafhost/accesssession/kick	统一访问认证-会话	踢下线指定会话
GET	/wafhost/accesssession/kickall	统一访问认证-会话	踢下线全部在线会话
POST	/wafhost/accesssession/kickbyaccount	统一访问认证-会话	踢下线指定账号的全部会话
POST	/wafhost/accesssession/list	统一访问认证-会话	获取统一访问认证的会话列表
POST	/wafhost/anticc/add	网站防护-CC防护	新增CC防护规则
GET	/wafhost/anticc/del	网站防护-CC防护	删除CC防护规则
GET	/wafhost/anticc/detail	网站防护-CC防护	获取CC防护规则详情
POST	/wafhost/anticc/edit	网站防护-CC防护	编辑CC防护规则
POST	/wafhost/anticc/list	网站防护-CC防护	获取CC防护规则列表
POST	/wafhost/cacherule/add	网站防护-缓存规则	新增缓存规则
GET	/wafhost/cacherule/del	网站防护-缓存规则	删除缓存规则
GET	/wafhost/cacherule/detail	网站防护-缓存规则	获取缓存规则详情
POST	/wafhost/cacherule/edit	网站防护-缓存规则	编辑缓存规则
POST	/wafhost/cacherule/list	网站防护-缓存规则	获取缓存规则列表
GET	/wafhost/dataretention/detail	数据保留策略	获取数据保留策略详情
POST	/wafhost/dataretention/edit	数据保留策略	编辑数据保留策略
POST	/wafhost/dataretention/list	数据保留策略	获取数据保留策略列表
POST	/wafhost/host/add	网站防护-主机管理	新增网站防护主机
POST	/wafhost/host/checkports	网站防护-主机管理	预检端口监听表
GET	/wafhost/host/del	网站防护-主机管理	删除网站防护主机
GET	/wafhost/host/detail	网站防护-主机管理	获取网站防护主机详情
POST	/wafhost/host/edit	网站防护-主机管理	编辑网站防护主机
GET	/wafhost/host/guardstatus	网站防护-主机管理	修改主机防御状态
POST	/wafhost/host/list	网站防护-主机管理	获取网站防护主机列表
GET	/wafhost/host/startstatus	网站防护-主机管理	修改主机启动状态
POST	/wafhost/hostgroup/add	网站防护-网站分组	新增网站分组
GET	/wafhost/hostgroup/all	网站防护-网站分组	获取全部网站分组
POST	/wafhost/hostgroup/assign	网站防护-网站分组	批量移动网站到分组
GET	/wafhost/hostgroup/del	网站防护-网站分组	删除网站分组
GET	/wafhost/hostgroup/detail	网站防护-网站分组	获取网站分组详情
POST	/wafhost/hostgroup/edit	网站防护-网站分组	编辑网站分组
POST	/wafhost/hostgroup/list	网站防护-网站分组	获取网站分组列表
POST	/wafhost/hostgroup/sort	网站防护-网站分组	网站分组排序
GET	/wafhost/httpauthsession/kick	网站密码访问-会话	踢下线指定会话
POST	/wafhost/httpauthsession/kickall	网站密码访问-会话	踢下线本站点的全部在线会话
POST	/wafhost/httpauthsession/kickbyuser	网站密码访问-会话	踢下线指定用户在本站点的全部会话
POST	/wafhost/httpauthsession/list	网站密码访问-会话	获取网站密码访问的在线会话列表
GET	/wafhost/ip/lookup	网站防护-IP策略命中查询	IP策略命中查询
POST	/wafhost/ipblock/add	网站防护-IP黑名单	新增IP黑名单
GET	/wafhost/ipblock/del	网站防护-IP黑名单	删除IP黑名单
GET	/wafhost/ipblock/detail	网站防护-IP黑名单	获取IP黑名单详情
POST	/wafhost/ipblock/edit	网站防护-IP黑名单	编辑IP黑名单
POST	/wafhost/ipblock/list	网站防护-IP黑名单	获取IP黑名单列表
GET	/wafhost/ipfailure/baniplist	网站防护-IP失败封禁	获取IP失败封禁列表
GET	/wafhost/ipfailure/config	网站防护-IP失败封禁	获取IP失败封禁配置
POST	/wafhost/ipfailure/config	网站防护-IP失败封禁	设置IP失败封禁配置
POST	/wafhost/ipgroup/add	网站防护-IP组	新增IP组
GET	/wafhost/ipgroup/del	网站防护-IP组	删除IP组
GET	/wafhost/ipgroup/detail	网站防护-IP组	获取IP组详情
POST	/wafhost/ipgroup/edit	网站防护-IP组	编辑IP组
POST	/wafhost/ipgroup/list	网站防护-IP组	获取IP组列表
GET	/wafhost/ipgroup/options	网站防护-IP组	获取IP组下拉选项
GET	/wafhost/ipgroup/refs	网站防护-IP组	查询IP组的引用情况
POST	/wafhost/ipgroup/validate	网站防护-IP组	校验IP写法
POST	/wafhost/ipgroupitem/add	网站防护-IP组	新增IP组条目
POST	/wafhost/ipgroupitem/batch/add	网站防护-IP组	批量新增IP组条目
POST	/wafhost/ipgroupitem/batch/del	网站防护-IP组	批量删除IP组条目
GET	/wafhost/ipgroupitem/del	网站防护-IP组	删除IP组条目
POST	/wafhost/ipgroupitem/delall	网站防护-IP组	清空IP组条目
GET	/wafhost/ipgroupitem/detail	网站防护-IP组	获取IP组条目详情
POST	/wafhost/ipgroupitem/edit	网站防护-IP组	编辑IP组条目
POST	/wafhost/ipgroupitem/list	网站防护-IP组	获取IP组条目列表
POST	/wafhost/ipwhite/add	网站防护-IP白名单	新增IP白名单
GET	/wafhost/ipwhite/del	网站防护-IP白名单	删除IP白名单
GET	/wafhost/ipwhite/detail	网站防护-IP白名单	获取IP白名单详情
POST	/wafhost/ipwhite/edit	网站防护-IP白名单	编辑IP白名单
POST	/wafhost/ipwhite/list	网站防护-IP白名单	获取IP白名单列表
POST	/wafhost/loadbalance/add	网站防护-负载均衡	新增负载均衡节点
GET	/wafhost/loadbalance/del	网站防护-负载均衡	删除负载均衡节点
GET	/wafhost/loadbalance/detail	网站防护-负载均衡	获取负载均衡节点详情
POST	/wafhost/loadbalance/edit	网站防护-负载均衡	编辑负载均衡节点
POST	/wafhost/loadbalance/list	网站防护-负载均衡	获取负载均衡节点列表
GET	/wafhost/onekeymod/del	一键修改	删除一键修改记录
GET	/wafhost/onekeymod/detail	一键修改	获取一键修改记录详情
POST	/wafhost/onekeymod/doModify	一键修改	执行一键修改
POST	/wafhost/onekeymod/list	一键修改	获取一键修改记录列表
POST	/wafhost/onekeymod/parseNginx	一键修改	解析nginx配置
GET	/wafhost/onekeymod/restore	一键修改	还原一键修改
GET	/wafhost/port/overview	网站防护-主机管理	端口占用总览
POST	/wafhost/privategroup/add	私有分组管理	新增私有分组
GET	/wafhost/privategroup/del	私有分组管理	删除私有分组
GET	/wafhost/privategroup/detail	私有分组管理	获取私有分组详情
POST	/wafhost/privategroup/edit	私有分组管理	编辑私有分组
POST	/wafhost/privategroup/list	私有分组管理	获取私有分组列表
POST	/wafhost/privategroup/listbybelongcloud	私有分组管理	按云环境查询私有分组列表
POST	/wafhost/privateinfo/add	私有信息管理	新增私有信息
GET	/wafhost/privateinfo/del	私有信息管理	删除私有信息
GET	/wafhost/privateinfo/detail	私有信息管理	获取私有信息详情
POST	/wafhost/privateinfo/edit	私有信息管理	编辑私有信息
POST	/wafhost/privateinfo/list	私有信息管理	获取私有信息列表
POST	/wafhost/rule/add	网站防护-规则管理	新增WAF规则
GET	/wafhost/rule/del	网站防护-规则管理	删除WAF规则
GET	/wafhost/rule/detail	网站防护-规则管理	获取WAF规则详情
POST	/wafhost/rule/edit	网站防护-规则管理	编辑WAF规则
POST	/wafhost/rule/list	网站防护-规则管理	获取WAF规则列表
GET	/wafhost/rule/rulestatus	网站防护-规则管理	修改WAF规则状态
POST	/wafhost/sensitive/add	网站防护-敏感词	新增敏感词
GET	/wafhost/sensitive/del	网站防护-敏感词	删除敏感词
GET	/wafhost/sensitive/detail	网站防护-敏感词	获取敏感词详情
POST	/wafhost/sensitive/edit	网站防护-敏感词	编辑敏感词
POST	/wafhost/sensitive/list	网站防护-敏感词	获取敏感词列表
POST	/wafhost/sslexpire/add	SSL到期监控	新增SSL到期监控
GET	/wafhost/sslexpire/del	SSL到期监控	删除SSL到期监控
GET	/wafhost/sslexpire/detail	SSL到期监控	获取SSL到期监控详情
POST	/wafhost/sslexpire/edit	SSL到期监控	编辑SSL到期监控
POST	/wafhost/sslexpire/list	SSL到期监控	获取SSL到期监控列表
GET	/wafhost/sslexpire/nowcheck	SSL到期监控	立即检测SSL到期情况
GET	/wafhost/sslexpire/sync_host	SSL到期监控	同步主机信息到SSL监控
POST	/wafhost/sslorder/add	SSL证书订单	新建SSL证书申请订单
GET	/wafhost/sslorder/del	SSL证书订单	删除SSL证书订单
GET	/wafhost/sslorder/detail	SSL证书订单	获取SSL证书订单详情
POST	/wafhost/sslorder/edit	SSL证书订单	续期SSL证书订单
POST	/wafhost/sslorder/list	SSL证书订单	获取SSL证书订单列表
POST	/wafhost/task/add	定时任务管理	新增定时任务
GET	/wafhost/task/del	定时任务管理	删除定时任务
GET	/wafhost/task/detail	定时任务管理	获取定时任务详情
POST	/wafhost/task/edit	定时任务管理	编辑定时任务
POST	/wafhost/task/list	定时任务管理	获取定时任务列表
GET	/wafhost/task/log	定时任务管理	获取定时任务日志
GET	/wafhost/task/log/clear	定时任务管理	清空定时任务日志
GET	/wafhost/task/manual_exec	定时任务管理	手动执行定时任务
POST	/wafhost/urlblock/add	网站防护-URL黑名单	新增URL黑名单
GET	/wafhost/urlblock/del	网站防护-URL黑名单	删除URL黑名单
GET	/wafhost/urlblock/detail	网站防护-URL黑名单	获取URL黑名单详情
POST	/wafhost/urlblock/edit	网站防护-URL黑名单	编辑URL黑名单
POST	/wafhost/urlblock/list	网站防护-URL黑名单	获取URL黑名单列表
POST	/wafhost/urlwhite/add	网站防护-URL白名单	新增URL白名单
GET	/wafhost/urlwhite/del	网站防护-URL白名单	删除URL白名单
GET	/wafhost/urlwhite/detail	网站防护-URL白名单	获取URL白名单详情
POST	/wafhost/urlwhite/edit	网站防护-URL白名单	编辑URL白名单
POST	/wafhost/urlwhite/list	网站防护-URL白名单	获取URL白名单列表
GET	/waflog/attack/detail	日志-攻击日志	获取攻击日志详情
POST	/waflog/attack/list	日志-攻击日志	获取攻击日志列表
GET	/wafstatqpstrend	统计-数据统计	获取实时QPS趋势
GET	/wafstatsitedetail	统计-数据统计	站点详情趋势查询
GET	/wafstatsiteoverview	统计-数据统计	站点综合概览统计
GET	/wafstatsumday	统计-数据统计	获取今日访问统计
GET	/wafstatsumdayrange	统计-数据统计	按日期范围统计访问量
GET	/wafstatsumdaytopiprange	统计-数据统计	统计攻击IP排行