接口详情
GET /v1/admin/security/autodefense/blocks
Ban list entries with source autodefense
- operationId
adminListAutoDefenseBlocks- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
需要开通的功能:module.autodefense
参数
adminListAutoDefenseBlocks 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
tenant_scope_id | query | string(uuid) | 否 | Admin list routes only; filters the list to one tenant scope. Without it the platform administrator reads every tenant of this control plane (each row carries tenant_scope_id); the limit caps still apply. |
|---|
site_id | query | string(uuid) | 否 | — |
|---|
ip | query | any | any | 否 | — |
|---|
limit | query | integer | 否 | — |
|---|
响应
adminListAutoDefenseBlocks 响应| 状态码 | 说明 |
|---|
200 | Ban list entries with source autodefense. 字段:items: array<BlockEntry> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
POST /v1/admin/security/autodefense/blocks/{block_id}/release
Unblock (Lua and kernel), optionally whitelist and report a false positive
- operationId
adminReleaseAutoDefenseBlock- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense
参数
adminReleaseAutoDefenseBlock 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
block_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:是
adminReleaseAutoDefenseBlock 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
whitelist | boolean | 否 | 解除并加白 (IP |
|---|
allow_until | object | 否 | When the 解除并加白 entry expires (absent = permanent; only with whitelist; after now and within 365 days). An entry already listed keeps the longer expiry. |
|---|
false_positive | boolean | 否 | 标记误判; reason is then required and a false_positive_report is audited. |
|---|
reason | string | 否 | — |
|---|
响应
adminReleaseAutoDefenseBlock 响应| 状态码 | 说明 |
|---|
200 | What the release undid. 字段:site_id: string(uuid) released_targets: array<string> shadowed_signatures: array<string> whitelisted: array<string> allows: array<SiteAllow> observe_until?: string(date-time) false_positive_id?: string(uuid) |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
GET /v1/admin/security/autodefense/events
Attack event timeline, newest first
- operationId
adminListAutoDefenseEvents- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
需要开通的功能:module.autodefense
参数
adminListAutoDefenseEvents 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
site_id | query | string(uuid) | 否 | — |
|---|
limit | query | integer | 否 | — |
|---|
响应
adminListAutoDefenseEvents 响应| 状态码 | 说明 |
|---|
200 | Attack events. 字段:items: array<Event> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
GET /v1/admin/security/autodefense/false-positives
False positive reports
- operationId
adminListAutoDefenseFalsePositives- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
需要开通的功能:module.autodefense
参数
adminListAutoDefenseFalsePositives 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
tenant_scope_id | query | string(uuid) | 否 | Admin list routes only; filters the list to one tenant scope. Without it the platform administrator reads every tenant of this control plane (each row carries tenant_scope_id); the limit caps still apply. |
|---|
site_id | query | string(uuid) | 否 | — |
|---|
limit | query | integer | 否 | — |
|---|
响应
adminListAutoDefenseFalsePositives 响应| 状态码 | 说明 |
|---|
200 | False positive reports. 字段:items: array<FalsePositive> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
POST /v1/admin/security/autodefense/false-positives
Report a verdict or signature as a false positive (the signature is withdrawn at once)
- operationId
adminReportAutoDefenseFalsePositive- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense
参数
adminReportAutoDefenseFalsePositive 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:是
adminReportAutoDefenseFalsePositive 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
site_id | string(uuid) | 是 | — |
|---|
verdict_id | string(uuid) | 否 | — |
|---|
signature_id | string | 否 | — |
|---|
reason | object | 是 | — |
|---|
响应
adminReportAutoDefenseFalsePositive 响应| 状态码 | 说明 |
|---|
201 | The recorded report. 字段:id: string(uuid) site_id: string(uuid) tenant_scope_id: string(uuid) verdict_id?: string(uuid) block_id?: string(uuid) signature_id?: string target?: string reason: string reported_by: string created_at: string(date-time) |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
GET /v1/admin/security/autodefense/metrics
Per site report figures of the last 30 days (mitigations, false positive reports, attack events)
- operationId
adminListAutoDefenseSiteMetrics- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
需要开通的功能:module.autodefense
参数
adminListAutoDefenseSiteMetrics 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
tenant_scope_id | query | string(uuid) | 否 | Admin list routes only; filters the list to one tenant scope. Without it the platform administrator reads every tenant of this control plane (each row carries tenant_scope_id); the limit caps still apply. |
|---|
响应
adminListAutoDefenseSiteMetrics 响应| 状态码 | 说明 |
|---|
200 | Report figures per live site of the tenant (at most 500). 字段:items: array<SiteMetrics> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
GET /v1/admin/security/autodefense/nodes/{node_id}/port-groups
Layer 4 port groups the control plane derives for a node (website TCP ports, one per forward)
- operationId
listAutoDefensePortGroups- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
需要开通的功能:module.autodefense
参数
listAutoDefensePortGroups 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
node_id | path | string(uuid) | 是 | — |
|---|
响应
listAutoDefensePortGroups 响应| 状态码 | 说明 |
|---|
200 | The node's derived port groups in ID order. 字段:items: array<PortGroup> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
GET /v1/admin/security/autodefense/nodes/{node_id}/port-groups/{port_group_id}/modules
Layer 4 overlay of one node port group (platform only)
- operationId
listAutoDefensePortGroupModules- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
需要开通的功能:module.autodefense
参数
listAutoDefensePortGroupModules 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
node_id | path | string(uuid) | 是 | — |
|---|
port_group_id | path | string | 是 | — |
|---|
响应
listAutoDefensePortGroupModules 响应| 状态码 | 说明 |
|---|
200 | Modules with their items. 字段:items: array<Module> auto_mitigation_granted: boolean overlay: string: active / frozen / inactive |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
GET /v1/admin/security/autodefense/nodes/{node_id}/port-groups/{port_group_id}/modules/{module}/history
Item changes, newest first: node adjustments, 人工 locks, 恢复自动, range edits
- operationId
listAutoDefensePortGroupModuleHistory- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
需要开通的功能:module.autodefense
参数
listAutoDefensePortGroupModuleHistory 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
node_id | path | string(uuid) | 是 | — |
|---|
port_group_id | path | string | 是 | — |
|---|
module | path | string: l4 | 是 | — |
|---|
limit | query | integer | 否 | — |
|---|
响应
listAutoDefensePortGroupModuleHistory 响应| 状态码 | 说明 |
|---|
200 | Item changes, newest first. 字段:items: array<HistoryEntry> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
PUT /v1/admin/security/autodefense/nodes/{node_id}/port-groups/{port_group_id}/modules/{module}/items/{field}
A person sets an l4 item (manual until resumed)
- operationId
lockAutoDefensePortGroupItem- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense
参数
lockAutoDefensePortGroupItem 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
node_id | path | string(uuid) | 是 | — |
|---|
port_group_id | path | string | 是 | — |
|---|
module | path | string: l4 | 是 | — |
|---|
field | path | string | 是 | A field of the frozen registry of the module; waf.group:<slug> per rule group. |
|---|
请求体
application/json · 必填:是
lockAutoDefensePortGroupItem 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
value | integer | 是 | Within the field platform range; enum fields take the ordinal, bool 0 or 1. |
|---|
响应
lockAutoDefensePortGroupItem 响应| 状态码 | 说明 |
|---|
200 | The locked item. 字段:field: string kind: string: int / enum / bool unit?: string enum?: array<string> state: string: auto / manual manual: integer auto?: integer min: integer max: integer platform_min: integer platform_max: integer effective: integer suggestion?: integer locked_by?: string locked_at?: string(date-time) resumed_by?: string resumed_at?: string(date-time) frozen_until?: string(date-time) |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
PUT /v1/admin/security/autodefense/nodes/{node_id}/port-groups/{port_group_id}/modules/{module}/items/{field}/range
Narrow the item's automatic range (上下限); state and manual value unchanged
- operationId
setAutoDefensePortGroupItemRange- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense
参数
setAutoDefensePortGroupItemRange 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
node_id | path | string(uuid) | 是 | — |
|---|
port_group_id | path | string | 是 | — |
|---|
module | path | string: l4 | 是 | — |
|---|
field | path | string | 是 | A field of the frozen registry of the module; waf.group:<slug> per rule group. |
|---|
请求体
application/json · 必填:是
setAutoDefensePortGroupItemRange 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
min | integer | 是 | Within the field platform range, min <= max; bound to the manual value as the field requires. |
|---|
max | integer | 是 | — |
|---|
响应
setAutoDefensePortGroupItemRange 响应| 状态码 | 说明 |
|---|
200 | The locked item. 字段:field: string kind: string: int / enum / bool unit?: string enum?: array<string> state: string: auto / manual manual: integer auto?: integer min: integer max: integer platform_min: integer platform_max: integer effective: integer suggestion?: integer locked_by?: string locked_at?: string(date-time) resumed_by?: string resumed_at?: string(date-time) frozen_until?: string(date-time) |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
POST /v1/admin/security/autodefense/nodes/{node_id}/port-groups/{port_group_id}/modules/{module}/items/{field}/resume
恢复自动 for one l4 item
- operationId
resumeAutoDefensePortGroupItem- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense module.autodefense.auto
参数
resumeAutoDefensePortGroupItem 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
node_id | path | string(uuid) | 是 | — |
|---|
port_group_id | path | string | 是 | — |
|---|
module | path | string: l4 | 是 | — |
|---|
field | path | string | 是 | A field of the frozen registry of the module; waf.group:<slug> per rule group. |
|---|
请求体
application/json · 必填:否
响应
resumeAutoDefensePortGroupItem 响应| 状态码 | 说明 |
|---|
200 | Items that changed (empty when nothing was manual). 字段:items: array<Item> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
PUT /v1/admin/security/autodefense/nodes/{node_id}/port-groups/{port_group_id}/modules/{module}/mode
manual / auto / suggest of l4; auto needs module.autodefense.auto
- operationId
setAutoDefensePortGroupModuleMode- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense module.autodefense.auto
参数
setAutoDefensePortGroupModuleMode 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
node_id | path | string(uuid) | 是 | — |
|---|
port_group_id | path | string | 是 | — |
|---|
module | path | string: l4 | 是 | — |
|---|
请求体
application/json · 必填:是
setAutoDefensePortGroupModuleMode 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
mode | string: manual / auto / suggest | 是 | — |
|---|
响应
setAutoDefensePortGroupModuleMode 响应| 状态码 | 说明 |
|---|
200 | The module mode now in force. 字段:module: string mode: string: manual / auto / suggest |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
POST /v1/admin/security/autodefense/nodes/{node_id}/port-groups/{port_group_id}/modules/{module}/resume
全部恢复自动 of l4
- operationId
resumeAutoDefensePortGroupModule- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense module.autodefense.auto
参数
resumeAutoDefensePortGroupModule 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
node_id | path | string(uuid) | 是 | — |
|---|
port_group_id | path | string | 是 | — |
|---|
module | path | string: l4 | 是 | — |
|---|
请求体
application/json · 必填:否
响应
resumeAutoDefensePortGroupModule 响应| 状态码 | 说明 |
|---|
200 | Items that changed (empty when nothing was manual). 字段:items: array<Item> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
GET /v1/admin/security/autodefense/nodes/{node_id}/port-groups/{port_group_id}/modules/{module}/values
Each node's newest value of every item (in force or suggested) and its reason
- operationId
listAutoDefensePortGroupModuleValues- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
需要开通的功能:module.autodefense
参数
listAutoDefensePortGroupModuleValues 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
node_id | path | string(uuid) | 是 | — |
|---|
port_group_id | path | string | 是 | — |
|---|
module | path | string: l4 | 是 | — |
|---|
响应
listAutoDefensePortGroupModuleValues 响应| 状态码 | 说明 |
|---|
200 | Each node's newest value per item. 字段:items: array<NodeValue> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
Platform defaults, budgets and breaker thresholds (platform.admin)
- operationId
getAutoDefensePlatformSettings- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin
需要开通的功能:module.autodefense
参数
getAutoDefensePlatformSettings 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
响应
getAutoDefensePlatformSettings 响应| 状态码 | 说明 |
|---|
200 | Platform settings. 字段:default_mode: string: off / learning / observe / protect default_sensitivity: string: low / medium / high following_sites: integer admin_login_whitelist_days: integer max_sites_per_node: integer ban_l3_per_site_minute: integer ban_l4_per_site_minute: integer circuit_resume_minutes: integer circuit_manual_after_breaks: integer waf_adapt_shadow_hours: integer waf_adapt_active_days: integer waf_grey_challenge: boolean waf_exclusion_latency_us: integer waf_exclusion_memory_percent: integer revision: integer updated_at: string(date-time) |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
Replace the platform settings (revision guarded, platform.admin); default_mode protect needs module.autodefense.auto and applies to every following site
- operationId
putAutoDefensePlatformSettings- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin
需要开通的功能:module.autodefense module.autodefense.auto
参数
putAutoDefensePlatformSettings 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
请求体
application/json · 必填:是
putAutoDefensePlatformSettings 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
default_mode | string: off / learning / observe / protect | 是 | Mode of every site that follows the platform. protect needs module.autodefense.auto; sites still on the prior or short of samples mitigate within their maturity cap (prior <= L1, immature <= L2). |
|---|
default_sensitivity | string: low / medium / high | 是 | — |
|---|
following_sites | integer | 否 | Live sites following the platform default_mode (ignored on PUT). |
|---|
admin_login_whitelist_days | integer | 是 | — |
|---|
max_sites_per_node | integer | 是 | — |
|---|
ban_l3_per_site_minute | integer | 是 | — |
|---|
ban_l4_per_site_minute | integer | 是 | — |
|---|
circuit_resume_minutes | integer | 是 | — |
|---|
circuit_manual_after_breaks | integer | 是 | — |
|---|
waf_adapt_shadow_hours | integer | 是 | — |
|---|
waf_adapt_active_days | integer | 是 | — |
|---|
waf_grey_challenge | boolean | 是 | Grey zone challenge of sites that inherit it (default true). |
|---|
waf_exclusion_latency_us | integer | 是 | waf-exclcap2: extra time one request may pay for its site's automatic exclusions on a node (default 500 us); each node applies floor(95% of the budget / its measured per exclusion cost) of a site's ranked exclusions (5% headroom). |
|---|
waf_exclusion_memory_percent | integer | 是 | waf-exclcap2: share of node memory all automatic exclusions of a node may take (default 5); beyond it the lowest traffic sites lose their lowest ranked exclusions first. |
|---|
revision | integer | 是 | — |
|---|
updated_at | string(date-time) | 否 | — |
|---|
响应
putAutoDefensePlatformSettings 响应| 状态码 | 说明 |
|---|
200 | Platform settings. 字段:default_mode: string: off / learning / observe / protect default_sensitivity: string: low / medium / high following_sites: integer admin_login_whitelist_days: integer max_sites_per_node: integer ban_l3_per_site_minute: integer ban_l4_per_site_minute: integer circuit_resume_minutes: integer circuit_manual_after_breaks: integer waf_adapt_shadow_hours: integer waf_adapt_active_days: integer waf_grey_challenge: boolean waf_exclusion_latency_us: integer waf_exclusion_memory_percent: integer revision: integer updated_at: string(date-time) |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
GET /v1/admin/security/autodefense/signatures
Automatic rules (signatures)
- operationId
adminListAutoDefenseSignatures- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
需要开通的功能:module.autodefense
参数
adminListAutoDefenseSignatures 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
tenant_scope_id | query | string(uuid) | 否 | Admin list routes only; filters the list to one tenant scope. Without it the platform administrator reads every tenant of this control plane (each row carries tenant_scope_id); the limit caps still apply. |
|---|
site_id | query | string(uuid) | 否 | — |
|---|
limit | query | integer | 否 | — |
|---|
响应
adminListAutoDefenseSignatures 响应| 状态码 | 说明 |
|---|
200 | Automatic rules. 字段:items: array<Signature> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
POST /v1/admin/security/autodefense/signatures/{signature_id}/revoke
禁用此签名
- operationId
adminRevokeAutoDefenseSignature- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense
参数
adminRevokeAutoDefenseSignature 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
signature_id | path | string | 是 | SHA-256 of the canonical conditions, first 16 hex digits (contract 3.4). |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:否
响应
adminRevokeAutoDefenseSignature 响应| 状态码 | 说明 |
|---|
200 | One automatic rule. 字段:id: string site_id: string(uuid) tenant_scope_id: string(uuid) conditions: array<object> stage: string: shadow / challenge / block / standby cover_permille: integer fpr_ppm: integer hits: integer reason: string managed: boolean solidified_kind?: string: waf / cc solidified_rule_id?: string(uuid) solidified_pack_id?: string solidified_version?: string revoked: boolean origin: string: node / control origin_node_id?: string(uuid) evaluation: object scope: string: site / tenant / none created_at: string(date-time) |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
POST /v1/admin/security/autodefense/signatures/{signature_id}/solidify
固化为我的规则 is the tenant's own decision: platform administrators get 403 autodefense_permission_denied
- operationId
adminSolidifyAutoDefenseSignature- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense
参数
adminSolidifyAutoDefenseSignature 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
signature_id | path | string | 是 | SHA-256 of the canonical conditions, first 16 hex digits (contract 3.4). |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:是
adminSolidifyAutoDefenseSignature 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
kind | string: waf / cc | 是 | — |
|---|
响应
adminSolidifyAutoDefenseSignature 响应| 状态码 | 说明 |
|---|
200 | One automatic rule. 字段:id: string site_id: string(uuid) tenant_scope_id: string(uuid) conditions: array<object> stage: string: shadow / challenge / block / standby cover_permille: integer fpr_ppm: integer hits: integer reason: string managed: boolean solidified_kind?: string: waf / cc solidified_rule_id?: string(uuid) solidified_pack_id?: string solidified_version?: string revoked: boolean origin: string: node / control origin_node_id?: string(uuid) evaluation: object scope: string: site / tenant / none created_at: string(date-time) |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
GET /v1/admin/security/autodefense/sites
Sites with mode, baseline maturity, circuit, overlay and the auto-mitigation grant
- operationId
adminListAutoDefenseSites- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
需要开通的功能:module.autodefense
参数
adminListAutoDefenseSites 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
tenant_scope_id | query | string(uuid) | 否 | Admin list routes only; filters the list to one tenant scope. Without it the platform administrator reads every tenant of this control plane (each row carries tenant_scope_id); the limit caps still apply. |
|---|
limit | query | integer | 否 | — |
|---|
响应
adminListAutoDefenseSites 响应| 状态码 | 说明 |
|---|
200 | Sites of the tenant. 字段:items: array<Site> auto_mitigation_granted: boolean |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
POST /v1/admin/security/autodefense/sites/mode
Batch 开始学习 / 仅观察 / 开始防护 / 关闭 / 恢复跟随平台 (follow); protect needs module.autodefense.auto; one audit event per site
- operationId
adminSetAutoDefenseSiteModes- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense module.autodefense.auto
参数
adminSetAutoDefenseSiteModes 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:是
adminSetAutoDefenseSiteModes 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
site_ids | array<string(uuid)> | 是 | — |
|---|
mode | string: off / learning / observe / protect / follow | 是 | The site's own mode; follow = 跟随平台 (the site takes the platform default_mode and changes with it). |
|---|
confirm | boolean | 是 | Batch operations need an explicit confirmation. |
|---|
响应
adminSetAutoDefenseSiteModes 响应| 状态码 | 说明 |
|---|
200 | The sites and their mode before and after. 字段:items: array<object> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
GET /v1/admin/security/autodefense/sites/{site_id}
One site with its overlay
- operationId
adminGetAutoDefenseSite- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
需要开通的功能:module.autodefense
参数
adminGetAutoDefenseSite 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
响应
adminGetAutoDefenseSite 响应| 状态码 | 说明 |
|---|
200 | One site with the snapshot delivery state of every node serving it. 字段:site_id: string(uuid) tenant_scope_id: string(uuid) domain: string tenant_name: string state: string: normal / surge / protect_origin / attack / cooldown / circuit_open / baseline_stale current_level: integer last_event_reason?: string mode: string: off / learning / observe / protect follow_platform: boolean sensitivity: string: low / medium / high maturity: string: prior / hour / day / week cross_site: boolean circuit: Circuit observe_until?: string(date-time) last_event_at?: string(date-time) revision: integer updated_at: string(date-time) auto_mitigation_granted: boolean overlay: string: active / frozen / inactive max_level: Item modules: array<Module> drifts?: array<Drift> nodes: array<SiteNode> unsupported_nodes: array<string> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
PATCH /v1/admin/security/autodefense/sites/{site_id}
Sensitivity and cross-site federation (revision guarded)
- operationId
adminUpdateAutoDefenseSite- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense
参数
adminUpdateAutoDefenseSite 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:是
adminUpdateAutoDefenseSite 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
sensitivity | string: low / medium / high | 否 | — |
|---|
cross_site | boolean | 否 | — |
|---|
revision | integer | 是 | — |
|---|
响应
adminUpdateAutoDefenseSite 响应| 状态码 | 说明 |
|---|
200 | One site. 字段:site_id: string(uuid) tenant_scope_id: string(uuid) domain: string tenant_name: string state: string: normal / surge / protect_origin / attack / cooldown / circuit_open / baseline_stale current_level: integer last_event_reason?: string mode: string: off / learning / observe / protect follow_platform: boolean sensitivity: string: low / medium / high maturity: string: prior / hour / day / week cross_site: boolean circuit: Circuit observe_until?: string(date-time) last_event_at?: string(date-time) revision: integer updated_at: string(date-time) auto_mitigation_granted: boolean overlay: string: active / frozen / inactive max_level: Item modules: array<Module> drifts?: array<Drift> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
GET /v1/admin/security/autodefense/sites/{site_id}/allows
白名单: the site's allow list as the nodes get it (ACL allow rules = user, 解除并加白 = release, admin sign-in sources = admin_login); never mitigated
- operationId
adminListAutoDefenseSiteAllows- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
需要开通的功能:module.autodefense
参数
adminListAutoDefenseSiteAllows 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
响应
adminListAutoDefenseSiteAllows 响应| 状态码 | 说明 |
|---|
200 | The site's allow list in CIDR order. 字段:items: array<SiteAllow> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
POST /v1/admin/security/autodefense/sites/{site_id}/allows/remove
移出白名单: remove one 解除并加白 entry (ACL allows are edited in the ACL policy; admin sign-in sources expire)
- operationId
adminRemoveAutoDefenseSiteAllow- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense
参数
adminRemoveAutoDefenseSiteAllow 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:是
adminRemoveAutoDefenseSiteAllow 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
cidr | string | 否 | The 解除并加白 entry (IP address or network). |
|---|
ja4 | string | 否 | The 解除并加白 entry (JA4 fingerprint). |
|---|
响应
adminRemoveAutoDefenseSiteAllow 响应| 状态码 | 说明 |
|---|
200 | The removed allow list entry. 字段:cidr?: string ja4?: string source: string: user / release / admin_login until?: string(date-time) created_by?: string created_at?: string(date-time) |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
POST /v1/admin/security/autodefense/sites/{site_id}/circuit/resume
恢复自动防护: close the site circuit the nodes reported open (Q6: a second break within 24 hours needs a person)
- operationId
adminResumeAutoDefenseSiteCircuit- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense module.autodefense.auto
参数
adminResumeAutoDefenseSiteCircuit 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:否
响应
adminResumeAutoDefenseSiteCircuit 响应| 状态码 | 说明 |
|---|
200 | One site. 字段:site_id: string(uuid) tenant_scope_id: string(uuid) domain: string tenant_name: string state: string: normal / surge / protect_origin / attack / cooldown / circuit_open / baseline_stale current_level: integer last_event_reason?: string mode: string: off / learning / observe / protect follow_platform: boolean sensitivity: string: low / medium / high maturity: string: prior / hour / day / week cross_site: boolean circuit: Circuit observe_until?: string(date-time) last_event_at?: string(date-time) revision: integer updated_at: string(date-time) auto_mitigation_granted: boolean overlay: string: active / frozen / inactive max_level: Item modules: array<Module> drifts?: array<Drift> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
POST /v1/admin/security/autodefense/sites/{site_id}/drifts/confirm
确认基线漂移: confirm the site's pending baseline drifts (node baselines are not changed)
- operationId
adminConfirmAutoDefenseSiteDrifts- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense
参数
adminConfirmAutoDefenseSiteDrifts 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:否
响应
adminConfirmAutoDefenseSiteDrifts 响应| 状态码 | 说明 |
|---|
200 | The drifts the confirmation changed (empty when none was pending). 字段:items: array<Drift> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
GET /v1/admin/security/autodefense/sites/{site_id}/modules
Modules site (site.max_level), bot, cc, scan, waf with every item state 自动/人工
- operationId
adminListAutoDefenseSiteModules- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
需要开通的功能:module.autodefense
参数
adminListAutoDefenseSiteModules 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
响应
adminListAutoDefenseSiteModules 响应| 状态码 | 说明 |
|---|
200 | Modules with their items. 字段:items: array<Module> auto_mitigation_granted: boolean overlay: string: active / frozen / inactive |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
GET /v1/admin/security/autodefense/sites/{site_id}/modules/{module}/history
Item changes, newest first: node adjustments, 人工 locks, 恢复自动, range edits
- operationId
adminListAutoDefenseSiteModuleHistory- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
需要开通的功能:module.autodefense
参数
adminListAutoDefenseSiteModuleHistory 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
module | path | string: site / bot / cc / scan / waf | 是 | site holds the single item site.max_level (no module mode). |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
limit | query | integer | 否 | — |
|---|
响应
adminListAutoDefenseSiteModuleHistory 响应| 状态码 | 说明 |
|---|
200 | Item changes, newest first. 字段:items: array<HistoryEntry> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
PUT /v1/admin/security/autodefense/sites/{site_id}/modules/{module}/items/{field}
A person sets the item: it becomes manual and runs on this value until resumed (Q3)
- operationId
adminLockAutoDefenseSiteItem- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense
参数
adminLockAutoDefenseSiteItem 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
module | path | string: site / bot / cc / scan / waf | 是 | site holds the single item site.max_level (no module mode). |
|---|
field | path | string | 是 | A field of the frozen registry of the module; waf.group:<slug> per rule group. |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:是
adminLockAutoDefenseSiteItem 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
value | integer | 是 | Within the field platform range; enum fields take the ordinal, bool 0 or 1. |
|---|
响应
adminLockAutoDefenseSiteItem 响应| 状态码 | 说明 |
|---|
200 | The locked item. 字段:field: string kind: string: int / enum / bool unit?: string enum?: array<string> state: string: auto / manual manual: integer auto?: integer min: integer max: integer platform_min: integer platform_max: integer effective: integer suggestion?: integer locked_by?: string locked_at?: string(date-time) resumed_by?: string resumed_at?: string(date-time) frozen_until?: string(date-time) |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
PUT /v1/admin/security/autodefense/sites/{site_id}/modules/{module}/items/{field}/range
Narrow the item's automatic range (上下限); state and manual value unchanged
- operationId
adminSetAutoDefenseSiteItemRange- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense
参数
adminSetAutoDefenseSiteItemRange 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
module | path | string: site / bot / cc / scan / waf | 是 | site holds the single item site.max_level (no module mode). |
|---|
field | path | string | 是 | A field of the frozen registry of the module; waf.group:<slug> per rule group. |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:是
adminSetAutoDefenseSiteItemRange 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
min | integer | 是 | Within the field platform range, min <= max; bound to the manual value as the field requires. |
|---|
max | integer | 是 | — |
|---|
响应
adminSetAutoDefenseSiteItemRange 响应| 状态码 | 说明 |
|---|
200 | The locked item. 字段:field: string kind: string: int / enum / bool unit?: string enum?: array<string> state: string: auto / manual manual: integer auto?: integer min: integer max: integer platform_min: integer platform_max: integer effective: integer suggestion?: integer locked_by?: string locked_at?: string(date-time) resumed_by?: string resumed_at?: string(date-time) frozen_until?: string(date-time) |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
POST /v1/admin/security/autodefense/sites/{site_id}/modules/{module}/items/{field}/resume
恢复自动 for one item
- operationId
adminResumeAutoDefenseSiteItem- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense module.autodefense.auto
参数
adminResumeAutoDefenseSiteItem 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
module | path | string: site / bot / cc / scan / waf | 是 | site holds the single item site.max_level (no module mode). |
|---|
field | path | string | 是 | A field of the frozen registry of the module; waf.group:<slug> per rule group. |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:否
响应
adminResumeAutoDefenseSiteItem 响应| 状态码 | 说明 |
|---|
200 | Items that changed (empty when nothing was manual). 字段:items: array<Item> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
PUT /v1/admin/security/autodefense/sites/{site_id}/modules/{module}/mode
manual / auto / suggest; auto needs module.autodefense.auto
- operationId
adminSetAutoDefenseSiteModuleMode- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense module.autodefense.auto
参数
adminSetAutoDefenseSiteModuleMode 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
module | path | string: site / bot / cc / scan / waf | 是 | site holds the single item site.max_level (no module mode). |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:是
adminSetAutoDefenseSiteModuleMode 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
mode | string: manual / auto / suggest | 是 | — |
|---|
响应
adminSetAutoDefenseSiteModuleMode 响应| 状态码 | 说明 |
|---|
200 | The module mode now in force. 字段:module: string mode: string: manual / auto / suggest |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
POST /v1/admin/security/autodefense/sites/{site_id}/modules/{module}/resume
全部恢复自动: every manual item of the module returns to automatic
- operationId
adminResumeAutoDefenseSiteModule- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense module.autodefense.auto
参数
adminResumeAutoDefenseSiteModule 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
module | path | string: site / bot / cc / scan / waf | 是 | site holds the single item site.max_level (no module mode). |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:否
响应
adminResumeAutoDefenseSiteModule 响应| 状态码 | 说明 |
|---|
200 | Items that changed (empty when nothing was manual). 字段:items: array<Item> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
GET /v1/admin/security/autodefense/sites/{site_id}/modules/{module}/values
Each node's newest value of every item (in force or suggested) and its reason
- operationId
adminListAutoDefenseSiteModuleValues- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
需要开通的功能:module.autodefense
参数
adminListAutoDefenseSiteModuleValues 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
module | path | string: site / bot / cc / scan / waf | 是 | site holds the single item site.max_level (no module mode). |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
响应
adminListAutoDefenseSiteModuleValues 响应| 状态码 | 说明 |
|---|
200 | Each node's newest value per item. 字段:items: array<NodeValue> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
POST /v1/admin/security/autodefense/sites/{site_id}/release
一键解除: undo every automatic mitigation and hold the site in observe only (default 30 minutes)
- operationId
adminReleaseAutoDefenseSite- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense
参数
adminReleaseAutoDefenseSite 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:是
adminReleaseAutoDefenseSite 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
observe_minutes | integer | 否 | 0 = no observe-only hold. |
|---|
reason | string | 否 | — |
|---|
响应
adminReleaseAutoDefenseSite 响应| 状态码 | 说明 |
|---|
200 | What the release undid. 字段:site_id: string(uuid) released_targets: array<string> shadowed_signatures: array<string> whitelisted: array<string> allows: array<SiteAllow> observe_until?: string(date-time) false_positive_id?: string(uuid) |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
POST /v1/admin/security/autodefense/sites/{site_id}/releases/retry
重试: every serving node applies and answers the release again (retry + 1, at most 100; audited release_retry)
- operationId
adminRetryAutoDefenseRelease- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense
参数
adminRetryAutoDefenseRelease 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:是
adminRetryAutoDefenseRelease 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
kind | string: ip / cidr / ja4 | 是 | — |
|---|
target | string | 是 | — |
|---|
响应
adminRetryAutoDefenseRelease 响应| 状态码 | 说明 |
|---|
200 | The per node delivery of a single release. 字段:site_id: string(uuid) kind: string: ip / cidr / ja4 target: string released_at: string(date-time) retry: integer state: string: pending / applied / partial_failed / no_nodes nodes: array<object> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
GET /v1/admin/security/autodefense/sites/{site_id}/releases/status
解除状态: per node delivery of the site's single release of one target (已保存 → 待节点 → 全部节点已生效 / 部分失败)
- operationId
adminGetAutoDefenseReleaseStatus- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
需要开通的功能:module.autodefense
参数
adminGetAutoDefenseReleaseStatus 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
kind | query | string: ip / cidr / ja4 | 是 | — |
|---|
target | query | string | 是 | — |
|---|
响应
adminGetAutoDefenseReleaseStatus 响应| 状态码 | 说明 |
|---|
200 | The per node delivery of a single release. 字段:site_id: string(uuid) kind: string: ip / cidr / ja4 target: string released_at: string(date-time) retry: integer state: string: pending / applied / partial_failed / no_nodes nodes: array<object> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
GET /v1/admin/security/autodefense/sites/{site_id}/waf-adapt
Adaptive WAF (智能自动): exclusions by stage with merged evidence, typed parameters, grey zone challenge, rule advice
- operationId
adminGetAutoDefenseSiteWAFAdapt- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin waf_adapt.read
需要开通的功能:module.autodefense
参数
adminGetAutoDefenseSiteWAFAdapt 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
响应
adminGetAutoDefenseSiteWAFAdapt 响应| 状态码 | 说明 |
|---|
200 | The site's adaptive WAF state. 字段:site_id: string(uuid) runtime: object automatic: boolean auto_granted: boolean waf_mode: string: manual / auto / suggest frozen: boolean grey_challenge: object grey_repeat: object revision: integer evaluated_at: string(date-time) | null settings: object exclusions: array<WAFExclusion> typed_params: array<object> rule_advice: array<object> limits: object node_limits: array<object> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
POST /v1/admin/security/autodefense/sites/{site_id}/waf-adapt/exclusions/{exclusion_id}/{action}
A person's decision: adopt (采纳, a manual exclusion), reject (驳回), revoke (撤销), manual (设为人工), resume (恢复自动); module.autodefense only
- operationId
adminDecideAutoDefenseSiteWAFExclusion- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin waf_adapt.manage
需要开通的功能:module.autodefense
参数
adminDecideAutoDefenseSiteWAFExclusion 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
exclusion_id | path | string | 是 | WAFExclusionID (SHA-256 of "<rule>:<loc>:<name>", first 16 hex digits). |
|---|
action | path | string: adopt / reject / revoke / manual / resume | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:否
响应
adminDecideAutoDefenseSiteWAFExclusion 响应| 状态码 | 说明 |
|---|
200 | The exclusion after the decision. 字段:id: string rule: integer rule_set: string rule_set_name: string param: object stage: string: candidate / shadow / suggested / active / rejected stage_since: string(date-time) until: string(date-time) | null manual: string: none / exclude / keep manual_by: string | null manual_at: string(date-time) | null rejections: integer reject_reason: string: false_positive / attack / unneeded | null permanent: boolean cooldown_until: string(date-time) | null value_type: string: number / ident / text / json / binary / url len_bucket: integer evidence: object flipped: integer flipped_attack: integer first_seen: string(date-time) last_seen: string(date-time) |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
PUT /v1/admin/security/autodefense/sites/{site_id}/waf-adapt/grey-challenge
Grey zone challenge inherit / on / off (only 严格 / 极严格 tiers challenge)
- operationId
adminSetAutoDefenseSiteGreyChallenge- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin waf_adapt.manage
需要开通的功能:module.autodefense
参数
adminSetAutoDefenseSiteGreyChallenge 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:是
adminSetAutoDefenseSiteGreyChallenge 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
value | string: inherit / on / off | 是 | — |
|---|
响应
adminSetAutoDefenseSiteGreyChallenge 响应| 状态码 | 说明 |
|---|
200 | The grey zone challenge before and after. 字段:before: string: inherit / on / off value: string: inherit / on / off |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
PUT /v1/admin/security/autodefense/sites/{site_id}/waf-adapt/grey-repeat
Repeated grey zone source threshold / window of the site (null = node defaults 20 / 60 s)
- operationId
adminSetAutoDefenseSiteGreyRepeat- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin waf_adapt.manage
需要开通的功能:module.autodefense
说明(契约原文)
Only nodes declaring CAPABILITY_NAME_WAF_REPEAT_SITE use the site value; other nodes keep the defaults.
参数
adminSetAutoDefenseSiteGreyRepeat 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:是
adminSetAutoDefenseSiteGreyRepeat 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
value | GreyRepeat | null | 是 | — |
|---|
响应
adminSetAutoDefenseSiteGreyRepeat 响应| 状态码 | 说明 |
|---|
200 | The repeat setting before and after (null = node defaults). 字段:before: GreyRepeat | null value: GreyRepeat | null |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
GET /v1/admin/security/autodefense/verdicts
Recent individual verdicts
- operationId
adminListAutoDefenseVerdicts- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
需要开通的功能:module.autodefense
参数
adminListAutoDefenseVerdicts 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
tenant_scope_id | query | string(uuid) | 否 | Admin list routes only; filters the list to one tenant scope. Without it the platform administrator reads every tenant of this control plane (each row carries tenant_scope_id); the limit caps still apply. |
|---|
site_id | query | string(uuid) | 否 | — |
|---|
ip | query | any | any | 否 | — |
|---|
limit | query | integer | 否 | — |
|---|
响应
adminListAutoDefenseVerdicts 响应| 状态码 | 说明 |
|---|
200 | Verdicts. 字段:items: array<Verdict> |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
POST /v1/admin/security/autodefense/verdicts/{verdict_id}/release
解除 / 解除并加白 / 标记误判
- operationId
adminReleaseAutoDefenseVerdict- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
需要开通的功能:module.autodefense
参数
adminReleaseAutoDefenseVerdict 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | Echoed in X-Request-ID and error.request_id; generated when absent. |
|---|
verdict_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | Admin routes only; the tenant scope the platform administrator acts on. |
|---|
请求体
application/json · 必填:是
adminReleaseAutoDefenseVerdict 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
whitelist | boolean | 否 | 解除并加白 (IP |
|---|
allow_until | object | 否 | When the 解除并加白 entry expires (absent = permanent; only with whitelist; after now and within 365 days). An entry already listed keeps the longer expiry. |
|---|
false_positive | boolean | 否 | 标记误判; reason is then required and a false_positive_report is audited. |
|---|
reason | string | 否 | — |
|---|
响应
adminReleaseAutoDefenseVerdict 响应| 状态码 | 说明 |
|---|
200 | What the release undid. 字段:site_id: string(uuid) released_targets: array<string> shadowed_signatures: array<string> whitelisted: array<string> allows: array<SiteAllow> observe_until?: string(date-time) false_positive_id?: string(uuid) |
|---|
default | ErrorEnvelope; entitlement_feature_denied carries error.capability.feature. |
|---|
↑ 回到列表
GET /v1/admin/security/cc-stats
Read the CC rule statistics of a site of any tenant scope
- operationId
getAdminSiteCCStats- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
参数
getAdminSiteCCStats 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
tenant_scope_id | query | string(uuid) | 是 | — |
|---|
site_id | query | string(uuid) | 是 | — |
|---|
range | query | string: 1h / 6h / 24h | 否 | 1h (1 minute steps, default), 6h (5 minutes) or 24h (15 minutes). |
|---|
响应
getAdminSiteCCStats 响应| 状态码 | 说明 |
|---|
200 | The site's CC rule statistics. 字段:tenant_scope_id: string(uuid) range: string: 1h / 6h / 24h site_id: string(uuid) from: string(date-time) to: string(date-time) step_seconds: integer: 60 / 300 / 900 series: array<object> rules: array<object> top_clients: array<Top> top_paths: array<Top> |
|---|
400 | Error. |
|---|
401 | Error. |
|---|
403 | Error. |
|---|
404 | Error. |
|---|
405 | Error. |
|---|
503 | Error. |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。404 资源不存在或不属于当前租户。503 依赖暂不可用:稍后用原 Idempotency-Key 重试。
↑ 回到列表
GET /v1/admin/security/coordination/metrics
Read bounded cross-node CC and global firewall coordination counters
- operationId
getSecurityCoordinationMetrics- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
说明(契约原文)
Returns fixed-cardinality process counters. Node, tenant, policy, subject, address, and message labels are never exposed.
响应
getSecurityCoordinationMetrics 响应| 状态码 | 说明 |
|---|
200 | Fixed-cardinality in-process security coordination counters. 字段:schema: string cc: CCMetrics firewall: FirewallMetrics |
|---|
400 | Stable error code without identity or dependency detail. |
|---|
401 | Stable error code without identity or dependency detail. |
|---|
403 | Stable error code without identity or dependency detail. |
|---|
405 | Stable error code without identity or dependency detail. |
|---|
503 | Stable error code without identity or dependency detail. |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。503 依赖暂不可用:稍后用原 Idempotency-Key 重试。
↑ 回到列表
GET /v1/admin/security/escalate/sites/{site_id}
Read a site of any tenant scope
- operationId
getAdminEscalateSite- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin
参数
getAdminEscalateSite 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | — |
|---|
响应
getAdminEscalateSite 响应| 状态码 | 说明 |
|---|
200 | The site's settings, its package's ranges, the thresholds in force and its state. 字段:settings: object policy: Policy effective: object state: State |
|---|
400 | Error. |
|---|
401 | Error. |
|---|
403 | Error. |
|---|
404 | Error. |
|---|
409 | Error. |
|---|
503 | Error. |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。404 资源不存在或不属于当前租户。409 先回读资源当前状态;同一操作重试保持原 Idempotency-Key 和原请求内容。503 依赖暂不可用:稍后用原 Idempotency-Key 重试。
↑ 回到列表
GET /v1/admin/security/escalate/sites/{site_id}/events
List the level history of a site of any tenant scope
- operationId
listAdminEscalateSiteEvents- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin
参数
listAdminEscalateSiteEvents 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | — |
|---|
响应
listAdminEscalateSiteEvents 响应| 状态码 | 说明 |
|---|
200 | Level history, newest first. 字段:items: array<Event> |
|---|
400 | Error. |
|---|
401 | Error. |
|---|
403 | Error. |
|---|
404 | Error. |
|---|
503 | Error. |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。404 资源不存在或不属于当前租户。503 依赖暂不可用:稍后用原 Idempotency-Key 重试。
↑ 回到列表
POST /v1/admin/security/escalate/sites/{site_id}/lock
Hold a site at a level (管理员锁定) until unlocked
- operationId
lockEscalateSite- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin
需要开通的功能:module.escalate
说明(契约原文)
422 escalate_level_unavailable when the site's package cannot put the level in force (B/C without a line group, C via Cloudflare not bound and synced, D with the blackhole off, or no policy).
参数
lockEscalateSite 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | — |
|---|
请求体
application/json · 必填:是
lockEscalateSite 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
level | string: A / B / C / D | 是 | — |
|---|
revision | integer(int64) | 是 | The state revision read (0 when the site was never stepped). |
|---|
响应
lockEscalateSite 响应| 状态码 | 说明 |
|---|
200 | The site's state after the write. 字段:level: string: A / B / C / D applied_level: string: A / B / C / D c_via: string: / line_group / cloudflare / unlimited pending_reason: string entered_at?: string(date-time) last_qps: integer(int64) last_bps: integer(int64) attacked: boolean locked_level?: string: A / B / C / D revision: integer(int64) updated_at?: string(date-time) dns_ttl?: integer(int32) ttl_clamped?: boolean dropped_packets_5m?: integer(int64) drop_shared?: boolean platform_dns_hosted?: boolean split_cname?: string cname_auto?: object |
|---|
400 | Error. |
|---|
401 | Error. |
|---|
403 | Error. |
|---|
404 | Error. |
|---|
409 | Error. |
|---|
422 | Error. |
|---|
503 | Error. |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。404 资源不存在或不属于当前租户。409 先回读资源当前状态;同一操作重试保持原 Idempotency-Key 和原请求内容。503 依赖暂不可用:稍后用原 Idempotency-Key 重试。
↑ 回到列表
POST /v1/admin/security/escalate/sites/{site_id}/reset
Send a site back to level A now (一键回切), unlocking it
- operationId
resetEscalateSite- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin
需要开通的功能:module.escalate
参数
resetEscalateSite 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | — |
|---|
请求体
application/json · 必填:是
resetEscalateSite 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
revision | integer(int64) | 是 | The state revision read (0 when the site was never stepped). |
|---|
响应
resetEscalateSite 响应| 状态码 | 说明 |
|---|
200 | The site's state after the write. 字段:level: string: A / B / C / D applied_level: string: A / B / C / D c_via: string: / line_group / cloudflare / unlimited pending_reason: string entered_at?: string(date-time) last_qps: integer(int64) last_bps: integer(int64) attacked: boolean locked_level?: string: A / B / C / D revision: integer(int64) updated_at?: string(date-time) dns_ttl?: integer(int32) ttl_clamped?: boolean dropped_packets_5m?: integer(int64) drop_shared?: boolean platform_dns_hosted?: boolean split_cname?: string cname_auto?: object |
|---|
400 | Error. |
|---|
401 | Error. |
|---|
403 | Error. |
|---|
404 | Error. |
|---|
409 | Error. |
|---|
503 | Error. |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。404 资源不存在或不属于当前租户。409 先回读资源当前状态;同一操作重试保持原 Idempotency-Key 和原请求内容。503 依赖暂不可用:稍后用原 Idempotency-Key 重试。
↑ 回到列表
POST /v1/admin/security/escalate/sites/{site_id}/unlock
Release a site's lock (automatic levels resume)
- operationId
unlockEscalateSite- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin
需要开通的功能:module.escalate
参数
unlockEscalateSite 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
site_id | path | string(uuid) | 是 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | — |
|---|
请求体
application/json · 必填:是
unlockEscalateSite 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
revision | integer(int64) | 是 | The state revision read (0 when the site was never stepped). |
|---|
响应
unlockEscalateSite 响应| 状态码 | 说明 |
|---|
200 | The site's state after the write. 字段:level: string: A / B / C / D applied_level: string: A / B / C / D c_via: string: / line_group / cloudflare / unlimited pending_reason: string entered_at?: string(date-time) last_qps: integer(int64) last_bps: integer(int64) attacked: boolean locked_level?: string: A / B / C / D revision: integer(int64) updated_at?: string(date-time) dns_ttl?: integer(int32) ttl_clamped?: boolean dropped_packets_5m?: integer(int64) drop_shared?: boolean platform_dns_hosted?: boolean split_cname?: string cname_auto?: object |
|---|
400 | Error. |
|---|
401 | Error. |
|---|
403 | Error. |
|---|
404 | Error. |
|---|
409 | Error. |
|---|
503 | Error. |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。404 资源不存在或不属于当前租户。409 先回读资源当前状态;同一操作重试保持原 Idempotency-Key 和原请求内容。503 依赖暂不可用:稍后用原 Idempotency-Key 重试。
↑ 回到列表
POST /v1/admin/security/ja4-blocks
Create a tenant/site-scoped JA4 block as a platform administrator
- operationId
createAdminJA4BlockWorkflow- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.manage
参数
createAdminJA4BlockWorkflow 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
X-Request-ID | header | string | 否 | — |
|---|
Idempotency-Key | header | string | 是 | — |
|---|
If-Match | header | string | 是 | — |
|---|
X-Step-Up-Token | header | string | 是 | Single-use proof consumed by the configured step-up verifier; never persisted. |
|---|
请求体
application/json · 必填:是
createAdminJA4BlockWorkflow 请求体| 名称 | 类型 | 必填 | 说明 |
|---|
site_id | string(uuid) | 是 | — |
|---|
ja4 | string | 是 | — |
|---|
snapshot_at | string(date-time) | 是 | — |
|---|
duration_seconds | integer | 是 | — |
|---|
reason | string | 是 | — |
|---|
tenant_scope_id | string(uuid) | 是 | — |
|---|
响应
createAdminJA4BlockWorkflow 响应| 状态码 | 说明 |
|---|
202 | Durable workflow created or exact idempotent replay returned. 字段:id: string(uuid) tenant_scope_id: string(uuid) site_id: string(uuid) ja4_sha256: string snapshot_at: string(date-time) duration_seconds: integer reason: string phase: string: queued / policy_ready / edge_pending / active / failed / expired revision: integer policy_id?: string(uuid) policy_revision?: integer binding_id?: string(uuid) binding_revision?: integer edge_publication_id?: string(uuid) rollout_id: string(uuid) edge_state: string: / pending / active / failed / rolled_back attempt_count: integer last_error_code?: string replayed?: boolean |
|---|
400 | Stable error response. |
|---|
401 | Stable error response. |
|---|
403 | Stable error response. |
|---|
409 | Stable error response. |
|---|
412 | Stable error response. |
|---|
428 | Stable error response. |
|---|
503 | Stable error response. |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。409 先回读资源当前状态;同一操作重试保持原 Idempotency-Key 和原请求内容。412 版本已变:回读最新 ETag 后重新判断,再带新的 If-Match 提交。428 缺少前置条件:回读资源,带 If-Match(或页面要求的验证)再提交。503 依赖暂不可用:稍后用原 Idempotency-Key 重试。
↑ 回到列表
GET /v1/admin/security/ja4-blocks/{workflow_id}
Get one exact tenant JA4 block workflow without raw access events
- operationId
getAdminJA4BlockWorkflow- 认证
- 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
- 所需权限
全部需要:platform.admin security_policies.read
参数
getAdminJA4BlockWorkflow 参数| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|
workflow_id | path | string(uuid) | 是 | — |
|---|
X-Request-ID | header | string | 否 | — |
|---|
tenant_scope_id | query | string(uuid) | 是 | — |
|---|
响应
getAdminJA4BlockWorkflow 响应| 状态码 | 说明 |
|---|
200 | Fixed workflow state; raw access events are never returned. 字段:id: string(uuid) tenant_scope_id: string(uuid) site_id: string(uuid) ja4_sha256: string snapshot_at: string(date-time) duration_seconds: integer reason: string phase: string: queued / policy_ready / edge_pending / active / failed / expired revision: integer policy_id?: string(uuid) policy_revision?: integer binding_id?: string(uuid) binding_revision?: integer edge_publication_id?: string(uuid) rollout_id: string(uuid) edge_state: string: / pending / active / failed / rolled_back attempt_count: integer last_error_code?: string replayed?: boolean |
|---|
400 | Stable error response. |
|---|
401 | Stable error response. |
|---|
403 | Stable error response. |
|---|
404 | Stable error response. |
|---|
503 | Stable error response. |
|---|
失败时怎么办
400 按字段说明修正参数或请求体再发;不要原样重试。401 检查凭据格式、是否过期或被轮换。403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。404 资源不存在或不属于当前租户。503 依赖暂不可用:稍后用原 Idempotency-Key 重试。
↑ 回到列表