SuperAPI AI 工具集

crowdsec-service-api

编程与开发

查看项目

更新于 10-15 20:29

技能介绍

用途:驱动 CrowdSec Console 的付费云端 REST API(SAPI),以编程方式管理云端对象(私有黑名单、白名单、决策、防火墙集成),这些对象会下发到已注册的引擎和 bouncer。它不是本地引擎 API,没有 cscli,只有 HTTPS。

主要能力:创建和管理云端私有黑名单并通过 API 推送 IP;将防火墙/设备(Palo Alto、Fortinet 等)接入云端集成;管理云端白名单,订阅引擎/标签/组织到列表;创建组织级决策(定向或临时封禁、非 IP 范围、按标签/实体);拉取修复 ROI 指标。

使用方式:基础 URL 为 https://admin.api.crowdsec.net/v1,每次调用使用 x-api-key 头认证(集成内容端点例外,使用创建集成时生成的 HTTP Basic 凭据)。交互式文档见 https://admin.api.crowdsec.net/v1/docs,规范见 https://admin.api.crowdsec.net/v1/openapi.json。先解析密钥:KEY="${CROWDSEC_SAPI_KEY:-$(cat ~/.config/crowdsec/sapi_key 2>/dev/null)}",再用 curl -s -H "x-api-key: $KEY" https://admin.api.crowdsec.net/v1/info 验证密钥并确认租户。GET、下载、POST …/search 为安全读操作;所有改变状态的 POST/PATCH/DELETE 需先展示确切 URL 和 JSON 体并等待确认。

适用场景:云端黑名单/白名单管理、防火墙集成、组织级决策、修复指标查询。

限制:每次调用都作用于生产环境,可能改变已订阅引擎的强制执行内容;云端白名单/黑名单只有在引擎注册并订阅后才生效,且按轮询周期拉取;bulk_overwrite 会先清空列表;密钥不得打印、记录或持久化到 ~/.config/crowdsec/sapi_key 以外位置;测试创建的对象需清理,暴露的密钥需轮换。本地引擎安装、cscli、bouncer、WAF 及引擎注册属于 crowdsec 技能范畴。