Auto Mitigation
Auto Mitigation
Overview
Clean Pipe Auto Mitigation API
Version information
Version : 1.0.0.BETA
License information
Terms of service : https://www.nexusguard.com/
URI scheme
Host : {your_basic_domain}
BasePath : /api
Schemes : HTTPS
Paths
Edit Allow/Blocklist content for site.
POST /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/allow-block-list
Description
Add or update source IPs and/or source countries for the site’s Allow/Blocklist content.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | cp_auto_mitigation_allow-block-list_service optional |
Allow list or block list configuration (list type and enabled state). | cp_auto_mitigation_allow-block-list_service |
cp_auto_mitigation_allow-block-list_service
| Name | Description | Schema |
|---|---|---|
| ip_set_id optional |
ip set id for allow_list or block_list.Can be obtained by invoking this API for ip set ids. | string |
| source_countries optional |
country code list for allow_list or block_list content, such as ‘Asia/Pacific Region’.Can be obtained by invoking this API for countries. | < string > array |
| source_ips optional |
ip list for allow_list or block_list content. | < string > array |
| type required |
allow list/block list type. in (allow_list, block_list). | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get Allow/Blocklist content for site.
GET /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/allow-block-list
Description
Returns the current Allow/Blocklist configuration for the site.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Query | type required |
Policy type: allow_list or block_list. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| ip_set optional |
ip_set | |
| is_enabled optional |
Status of the allow block list. ‘0’ means off, ‘1’ means on. | integer |
| source_countries optional |
The source countries of traffic. | < string > array |
| source_ips optional |
Source IP. | < string > array |
| Name | Description | Schema |
|---|---|---|
| ip_set_desc optional |
More details about the purpose of the policy. | string |
| ip_set_id optional |
Unique identifier of ip set. | string |
| ip_set_name optional |
The name of the policy. | string |
| source_countries optional |
< string > array | |
| source_ips optional |
< string > array |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change Allow/Blocklist auto-mitigation policy status for site.
POST /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/allow-block-list/switch
Description
Update Allow/Blocklist auto-mitigation policy status for site.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | site_id required |
Site ID.Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | cp_auto_mitigation_allow-block-list_service optional |
Allow list or block list configuration (list type and enabled state). | cp_auto_mitigation_allow-block-list_service |
cp_auto_mitigation_allow-block-list_service
| Name | Description | Schema |
|---|---|---|
| is_enabled required |
0 = disabled; 1 = enabled; 2 = enabled with an IP set template. |
integer |
| type required |
Policy type. One of: allow_list, block_list. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit auto-mitigation profile name.
POST /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/profile/{profile_id}
Description
Updates the profile name for an auto-mitigation profile.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| FormData | profile_name required |
Profile name. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get auto-mitigation profile information.
GET /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/profile/{profile_id}
Description
Returns detailed information for an auto-mitigation profile.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| profile_id optional |
Profile ID. | string |
| profile_name optional |
The name of the profile. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete auto-mitigation profile.
DELETE /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/profile/{profile_id}
Description
Deletes an auto-mitigation profile.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. Can be obtained by invoking this API for profile_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Update TCP anti-flood policy.
POST /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/profile/{profile_id}/anti-flood/l3l4/tcp
Description
Incrementally updates the TCP anti-flood policy for the auto-mitigation profile. Include only fields or sub-objects to change; omitted fields are preserved.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | profile_id required |
Auto mitigation profile identifier. Obtain from GET /spe/customer/{customer_id}/cp/site/{site_id}/policy/mitigation/auto-profiles. | string |
| Path | site_id required |
Clean Pipe Protection site identifier. Obtain from GET /spe/customer/{customer_id}/cp/sites or list sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this API. | string |
| Body | policy required |
TCP anti-flood policy. | AntiFloodL3L4TcpPolicyInput |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get TCP anti-flood policy.
GET /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/profile/{profile_id}/anti-flood/l3l4/tcp
Description
Returns the TCP anti-flood policy for the auto-mitigation profile.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | profile_id required |
Auto mitigation profile identifier. Obtain from GET /spe/customer/{customer_id}/cp/site/{site_id}/policy/mitigation/auto-profiles. | string |
| Path | site_id required |
Clean Pipe Protection site identifier. Obtain from GET /spe/customer/{customer_id}/cp/sites or list sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code. 0 indicates success. | integer |
| msg optional |
Error message. | string |
| result optional |
AntiFloodL3L4TcpPolicy |
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Clone auto-mitigation profile.
POST /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/profile/{profile_id}/clone
Description
Clones an auto-mitigation profile.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Update Zombie host detection policy.
POST /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/profile/{profile_id}/zombie
Description
Incrementally updates zombie host/network detection settings. Include only fields or sub-objects to change; omitted fields are preserved. Flex zombie rules are managed via flex-zombie CRUD APIs.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | profile_id required |
Auto mitigation profile identifier. Obtain from GET /spe/customer/{customer_id}/cp/site/{site_id}/policy/mitigation/auto-profiles. | string |
| Path | site_id required |
Clean Pipe Protection site identifier. Obtain from GET /spe/customer/{customer_id}/cp/sites or list sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this API. | string |
| Body | policy required |
Zombie host detection policy. | ZombiePolicyInput |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get Zombie host detection policy.
GET /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/profile/{profile_id}/zombie
Description
Returns the zombie host detection policy for the auto-mitigation profile.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | profile_id required |
Auto mitigation profile identifier. Obtain from GET /spe/customer/{customer_id}/cp/site/{site_id}/policy/mitigation/auto-profiles. | string |
| Path | site_id required |
Clean Pipe Protection site identifier. Obtain from GET /spe/customer/{customer_id}/cp/sites or list sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code. 0 indicates success. | integer |
| msg optional |
Error message. | string |
| result optional |
ZombiePolicy |
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Create flex zombie rule.
POST /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/profile/{profile_id}/zombie/flex-zombie
Description
Creates a flex zombie rule for the auto-mitigation profile.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | profile_id required |
Auto mitigation profile identifier. Obtain from GET /spe/customer/{customer_id}/cp/site/{site_id}/policy/mitigation/auto-profiles. | string |
| Path | site_id required |
Clean Pipe Protection site identifier. Obtain from GET /spe/customer/{customer_id}/cp/sites or list sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this API. | string |
| Body | rule required |
Flex zombie rule configuration. | FlexZombieRuleInput |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code. 0 indicates success. | integer |
| msg optional |
Error message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| rule_id optional |
Rule ID | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get flex zombie rule.
GET /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/profile/{profile_id}/zombie/flex-zombie/{rule_id}
Description
Returns a flex zombie rule for the auto-mitigation profile.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | profile_id required |
Auto mitigation profile identifier. Obtain from GET /spe/customer/{customer_id}/cp/site/{site_id}/policy/mitigation/auto-profiles. | string |
| Path | rule_id required |
Unique identifier of the flex zombie rule. | string |
| Path | site_id required |
Clean Pipe Protection site identifier. Obtain from GET /spe/customer/{customer_id}/cp/sites or list sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code. 0 indicates success. | integer |
| msg optional |
Error message. | string |
| result optional |
FlexZombieRule |
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Update flex zombie rule.
PUT /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/profile/{profile_id}/zombie/flex-zombie/{rule_id}
Description
Updates a flex zombie rule for the auto-mitigation profile.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | profile_id required |
Auto mitigation profile identifier. Obtain from GET /spe/customer/{customer_id}/cp/site/{site_id}/policy/mitigation/auto-profiles. | string |
| Path | rule_id required |
Unique identifier of the flex zombie rule. | string |
| Path | site_id required |
Clean Pipe Protection site identifier. Obtain from GET /spe/customer/{customer_id}/cp/sites or list sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this API. | string |
| Body | rule required |
Flex zombie rule configuration. | FlexZombieRuleInput |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete flex zombie rule.
DELETE /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/profile/{profile_id}/zombie/flex-zombie/{rule_id}
Description
Deletes a flex zombie rule from the auto-mitigation profile.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | profile_id required |
Auto mitigation profile identifier. Obtain from GET /spe/customer/{customer_id}/cp/site/{site_id}/policy/mitigation/auto-profiles. | string |
| Path | rule_id required |
Unique identifier of the flex zombie rule. | string |
| Path | site_id required |
Clean Pipe Protection site identifier. Obtain from GET /spe/customer/{customer_id}/cp/sites or list sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get flex zombie rules.
GET /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/profile/{profile_id}/zombie/flex-zombies
Description
Returns the flex zombie rules for the auto-mitigation profile.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | profile_id required |
Auto mitigation profile identifier. Obtain from GET /spe/customer/{customer_id}/cp/site/{site_id}/policy/mitigation/auto-profiles. | string |
| Path | site_id required |
Clean Pipe Protection site identifier. Obtain from GET /spe/customer/{customer_id}/cp/sites or list sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code. 0 indicates success. | integer |
| msg optional |
Error message. | string |
| result optional |
< FlexZombieRule > array |
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get auto-mitigation profile list.
GET /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/profiles
Description
Returns the list of auto-mitigation profiles for the site.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | site_id required |
Site ID. | string |
| Query | access_token required |
API access token for authentication. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
< result > array |
| Name | Description | Schema |
|---|---|---|
| profile_id optional |
Profile ID. | string |
| profile_name optional |
The name of the profile. | string |
| type optional |
The ip type of the profile. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit FlexFilter/TCP option filter sets for an auto-mitigation profile.
POST /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/tcp-option/filter-sets
Description
Applies or updates FlexFilter/TCP option filter sets for an auto-mitigation profile. Only one filter set ID is supported.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | filter_set_id required |
Filter set ID(s) to apply. Only one ID is supported. | < string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get FlexFilter/TCP option policy for an auto-mitigation profile.
GET /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/tcp-option/policy
Description
Returns the current FlexFilter/TCP option policy for an auto-mitigation profile.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | site_id required |
Site ID. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| filter_sets optional |
< filter_sets > array | |
| is_enabled optional |
FlexFilter/TCP option status: 0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| filter_set_desc optional |
Optional policy description. | string |
| filter_set_id optional |
Filter set ID. | string |
| filter_set_name optional |
Policy name. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Enables or disables FlexFilter/TCP option for an auto-mitigation profile.
POST /spe/customer/{customer_id}/cp/site/{site_id}/auto-mitigation/tcp-option/switch
Description
Enables or disables FlexFilter/TCP option for an auto-mitigation profile.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | site_id required |
Site ID. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | is_enabled required |
0 = disabled, 1 = enabled. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get FlexFilter or ACL Filter info for auto-mitigation.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/acl-filter
Description
Get the info of FlexFilter/ACL Filter for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| common_rule_sets optional |
The filter sets. | < common_rule_sets > array |
| custom_rule_set optional |
Custom Filters. | custom_rule_set |
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| Name | Description | Schema |
|---|---|---|
| rule_set_desc optional |
More details about the purpose of the policy. | string |
| rule_set_id optional |
Unique identifier of common rule. | integer |
| rule_set_name optional |
The name of the policy. | string |
| Name | Description | Schema |
|---|---|---|
| action optional |
Either rate limiting, dropping or letting the traffic pass are taken. | string |
| bps_limit optional |
ratelimit in bps. | string |
| dst_ip optional |
IP Address of the recipient. | < string > array |
| dst_port optional |
Port number to which the data packet is sent. | < integer > array |
| is_enabled optional |
0 means it is disabled and 1 means enabled. |
integer |
| package_length optional |
The package length of the rule. Can be updated regardless of the selected protocol. | < string > array |
| pps_limit optional |
ratelimit in pps. | string |
| protocol optional |
The protocol of the rule. Allowed values: any, tcp, udp, icmp, or a custom IANA protocol number as a decimal string (0-255). Numeric values 1 (icmp), 6 (tcp), and 17 (udp) must use the named strings instead. Pattern : "^(any\|tcp\|udp\|icmp\|(0\|[2-5]\|[7-9]\|1[0-6]\|1[89]\|[2-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5]))$" |
string |
| rule_desc optional |
More details about the purpose of the policy. | string |
| rule_id optional |
Unique identifier of custom rule. | string |
| rule_name optional |
The name of the policy | string |
| src_ip optional |
IP address of the sender, as it is shown in the data packet. | < string > array |
| src_port optional |
Port number from which the data packet is sent | < integer > array |
| tcp_flags optional |
In TCP connection, flags are used to indicate a particular state of connection or to provide some additional useful information. | < string > array |
| ttl optional |
Time-to-live (TTL) is a value in an IP packet that tells a network router whether or not the packet has been in the network too long and should be discarded. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Add FlexFilter, ACL Filter, or custom filter rules.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/acl-filter/custom-filter
Description
Add rules for the FlexFilter/ACL Filter/ custom filters.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | body required |
FlexFilter/Custom filter rule configuration. | body |
| Name | Description | Schema |
|---|---|---|
| action required |
You can select “pass”, “drop” or “ratelimit”. Selecting the ratelimit can allow you to define the capacity of the bandwidth that data packets can consume. | string |
| bps_limit optional |
The rate limit whose must be a number or K, M, G format must be provided when the ratelimit is switched on. | string |
| dst_ip optional |
IP Address of the recipient. | < string > array |
| dst_port optional |
Port number to which the data packet is sent. | < integer > array |
| icmp_code optional |
Can be updated when the protocol is icmp or a custom IANA protocol number. Required for ICMP-unreach, ICMP-Redirect or ICMP-Paramprob; when ICMP-unreach is 0-15, ICMP-redirect is 0-3, and ICMP-paramprob is 0-2. | integer |
| icmp_type optional |
Can be updated when the protocol is icmp or a custom IANA protocol number. The value can be a decimal string from 0 to 255, or from the filter_ICMP_type field that returns the result from config options. | string |
| package_length optional |
The package length of the rule. Can be updated regardless of the selected protocol. | < string > array |
| pps_limit optional |
The rate limit whose must be a number or K, M, G format must be provided when the ratelimit is switched on. | string |
| protocol required |
The protocol of the rule. Allowed values: any, tcp, udp, icmp, or a custom IANA protocol number as a decimal string (0-255). Numeric values 1 (icmp), 6 (tcp), and 17 (udp) must use the named strings instead. Pattern : "^(any\|tcp\|udp\|icmp\|(0\|[2-5]\|[7-9]\|1[0-6]\|1[89]\|[2-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5]))$" |
string |
| rule_desc optional |
Optional policy description. | string |
| rule_name required |
Unique identifier of a policy created. | string |
| src_ip optional |
IP address of the sender, as it is shown in the data packet. | < string > array |
| src_port optional |
Port number from which the data packet is sent. | < integer > array |
| tcp_flags optional |
When the protocol is TCP, its value is retrieved from the filter_tcp_flags in the configuration options. | < string > array |
| ttl optional |
Time-to-live (TTL) is a value in an IP packet that tells a network router whether or not the packet has been in the network too long and should be discarded. It is set to a value between zero and 255. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| rule_id optional |
Rule ID, an unique identifier assigned to each FlexFilter Custom Filters. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get FlexFilter, ACL Filter, and custom filters policy for auto-mitigation.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/acl-filter/custom-filter/{rule_id}
Description
Returns the FlexFilter, ACL Filter, and custom filters policy for the host.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | rule_id required |
Unique identifier of custom rule. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| action optional |
Either rate limiting, dropping or letting the traffic pass are taken. | string |
| bps_limit optional |
ratelimit in bps. | string |
| dst_ip optional |
IP Address of the recipient. | < string > array |
| dst_port optional |
Port number to which the data packet is sent. | < integer > array |
| icmp_code optional |
ICMP Code. | integer |
| icmp_type optional |
The filters for ICMP. | string |
| is_enabled optional |
0 means it is disabled and 1 means enabled. |
integer |
| package_length optional |
The package length of the rule. Can be updated regardless of the selected protocol. | < string > array |
| pps_limit optional |
ratelimit in pps. | string |
| protocol optional |
The protocol of the rule. Allowed values: any, tcp, udp, icmp, or a custom IANA protocol number as a decimal string (0-255). Numeric values 1 (icmp), 6 (tcp), and 17 (udp) must use the named strings instead. Pattern : "^(any\|tcp\|udp\|icmp\|(0\|[2-5]\|[7-9]\|1[0-6]\|1[89]\|[2-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5]))$" |
string |
| rule_desc optional |
More details about the purpose of the policy. | string |
| rule_id optional |
Unique identifier of a policy. | string |
| rule_name optional |
The name of the policy | string |
| src_ip optional |
IP address of the sender, as it is shown in the data packet. | < string > array |
| src_port optional |
Port number from which the data packet is sent | < integer > array |
| tcp_flags optional |
In TCP connection, flags are used to indicate a particular state of connection or to provide some additional useful information. | < string > array |
| ttl optional |
Time-to-live (TTL) is a value in an IP packet that tells a network router whether or not the packet has been in the network too long and should be discarded. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit FlexFilter, ACL Filter, or custom filter rules.
PUT /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/acl-filter/custom-filter/{rule_id}
Description
Edit the rules for FlexFilter/ACL Filter/custom filters.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | rule_id required |
Unique identifier of a rule. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | body required |
FlexFilter/ACL Custom filter rule configuration. | body |
| Name | Description | Schema |
|---|---|---|
| action required |
You can select “pass”, “drop” or “ratelimit”. Selecting the ratelimit can allow you to define the capacity of the bandwidth that data packets can consume. | string |
| bps_limit optional |
The rate limit whose must be a number or K, M, G format must be provided when the ratelimit is switched on. | string |
| dst_ip optional |
IP Address of the recipient. | < string > array |
| dst_port optional |
Port number to which the data packet is sent. | < integer > array |
| icmp_code optional |
Can be updated when the protocol is icmp or a custom IANA protocol number. Required for ICMP-unreach, ICMP-Redirect or ICMP-Paramprob; when ICMP-unreach is 0-15, ICMP-redirect is 0-3, and ICMP-paramprob is 0-2. Can be obtained by invoking this API for icmp codes. | integer |
| icmp_type optional |
Can be updated when the protocol is icmp or a custom IANA protocol number. The value can be a decimal string from 0 to 255, or from the filter_ICMP_type field that returns the result from config options. Can be obtained by invoking this API for icmp types. | string |
| package_length optional |
The package length of the rule. Can be updated regardless of the selected protocol. | < string > array |
| pps_limit optional |
The rate limit whose must be a number or K, M, G format must be provided when the ratelimit is switched on. | string |
| protocol required |
The protocol of the rule. Allowed values: any, tcp, udp, icmp, or a custom IANA protocol number as a decimal string (0-255). Numeric values 1 (icmp), 6 (tcp), and 17 (udp) must use the named strings instead. Pattern : "^(any\|tcp\|udp\|icmp\|(0\|[2-5]\|[7-9]\|1[0-6]\|1[89]\|[2-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5]))$" |
string |
| rule_desc optional |
Optional policy description. | string |
| rule_name required |
Unique identifier of a policy created. | string |
| src_ip optional |
IP address of the sender, as it is shown in the data packet. | < string > array |
| src_port optional |
Port number from which the data packet is sent. | < integer > array |
| tcp_flags optional |
When the protocol is TCP, its value is retrieved from the filter_tcp_flags in the configuration options.Can be obtained by invoking this API for tcp flags. | < string > array |
| ttl optional |
Time-to-live (TTL) is a value in an IP packet that tells a network router whether or not the packet has been in the network too long and should be discarded. It is set to a value between zero and 255. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete FlexFilter, ACL Filter, or custom filter rule.
DELETE /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/acl-filter/custom-filter/{rule_id}
Description
Deletes FlexFilter/ ACL Filter/ custom filters.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | rule_id required |
Unique identifier of custom rule. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change FlexFilter, ACL Filter, or custom filters switch status.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/acl-filter/custom-filter/{rule_id}/switch
Description
Change the status of the switch of the FlexFilter/ ACL Filter/custom filters.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | rule_id required |
Unique identifier of custom rule. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | is_enabled required |
0 means the switch of ACL Filter is disabled whereas 1 means it is enabled. |
integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit FlexFilter filter sets for the host.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/acl-filter/filter-sets
Description
Edit the FlexFilter filter sets for the host.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | rule_set_id required |
Enter the rule id you want to add. Can be obtained by invoking this API for rule_set_id. | < string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change FlexFilter or ACL Filter policy switch status.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/acl-filter/switch
Description
Changes the status of the switch for the policies for FlexFilter/ACL Filter.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | is_enabled required |
0 = disabled, 1 = enabled. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit Allow/Blocklist content for host.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/allow-block-list
Description
Add or update source IPs and/or source countries for the host’s Allow/Blocklist.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | cp_auto_mitigation_allow-block-list_service optional |
Allow list or block list configuration (list type and enabled state). | cp_auto_mitigation_allow-block-list_service |
cp_auto_mitigation_allow-block-list_service
| Name | Description | Schema |
|---|---|---|
| ip_set_id optional |
ip set id for allow_list or block_list.Can be obtained by invoking this API for ip set ids. | string |
| source_countries optional |
country code list for allow_list or block_list content, such as ‘Asia/Pacific Region’.Can be obtained by invoking this API for countries. | < string > array |
| source_ips optional |
ip list for allow_list or block_list content. | < string > array |
| type required |
allow list/block list type. in (allow_list, block_list). | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get allow list or block list content for host.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/allow-block-list
Description
Returns the current allow list or block list content (status, source IPs, source countries) for the host.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Query | type required |
Policy type: allow_list or block_list. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| ip_set optional |
ip_set | |
| is_enabled optional |
Status of the allow block list. ‘0’ means off, ‘1’ means on. | integer |
| source_countries optional |
The source countries of traffic. | < string > array |
| source_ips optional |
Source IP. | < string > array |
| Name | Description | Schema |
|---|---|---|
| ip_set_desc optional |
More details about the purpose of the policy. | string |
| ip_set_id optional |
Unique identifier of ip set. | string |
| ip_set_name optional |
The name of the policy. | string |
| source_countries optional |
< string > array | |
| source_ips optional |
< string > array |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change Allow/Blocklist auto-mitigation policy status for host.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/allow-block-list/switch
Description
Update Allow/Blocklist auto-mitigation policy status for host.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID.Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID.Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | cp_auto_mitigation_allow-block-list_service optional |
Allow list or block list configuration (list type and enabled state). | cp_auto_mitigation_allow-block-list_service |
cp_auto_mitigation_allow-block-list_service
| Name | Description | Schema |
|---|---|---|
| is_enabled required |
0 means the switch of the basic network filtering is disabled whereas 1 means it is enabled , ‘2’ means it is enabled with a template of ip sets. |
integer |
| type required |
allow list/block list type. in (allow_list, block_list). | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change Bogons auto-mitigation policy.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/bogons/switch
Description
Enables or disables Bogons auto-mitigation for the site/host (e.g. martian_address, land_attack).
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | is_enabled required |
0 = disabled, 1 = enabled. | integer |
| FormData | type required |
Bogons type: martian_address or land_attack. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get Bogons auto-mitigation switch status.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/bogons/switch
Description
Returns the current Bogons auto-mitigation switch status for the site/host.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| land_attack optional |
The property of the land_attack. | land_attack |
| martian_address optional |
The property of the martian address. | martian_address |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the land_attack switch is disabled whereas 1 means it is enabled. |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the martian_address switch is disabled whereas 1 means it is enabled. |
integer |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit traffic policies.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/filter-policing
Description
It is used to edit Traffic Policies.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | threshold_bps required |
Threshold values in bps.must be a number or K, M, G format. | string |
| FormData | threshold_pps required |
Threshold values in pps.must be a number or K, M, G format. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get traffic policing or filter policing info.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/filter-policing
Description
Get auto-mitigation traffic policing info.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the mitigation policy for zombie is disabled whereas 1 means it is enabled. |
integer |
| threshold_bps optional |
Threshold values in bps. | string |
| threshold_pps optional |
Threshold values in pps. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change traffic policing or filter policing switch status.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/filter-policing/switch
Description
It is a switch to change the status of Traffic Policing/Filter Policing.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | is_enabled required |
0 means the filter policy is disabled whereas 1 means it is enabled. |
integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get ICMP flood policy info.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/icmp-flood
Description
Returns ICMP flood policy info for the host.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| custom_icmp_filter optional |
The info of customizable ICMP filters. | custom_icmp_filter |
| icmp_fragmentation optional |
The info of ICMP fragmentation. | icmp_fragmentation |
| Name | Description | Schema |
|---|---|---|
| default optional |
The default ICMP filters. | default |
| filters optional |
The list of customizable ICMP filters. | < filters > array |
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| Name | Description | Schema |
|---|---|---|
| action optional |
pass or ratelimit. | string |
| bps_limit optional |
The ratelimit in bps. | string |
| filter_name optional |
The name of the filter. | string |
| icmp_length optional |
The length of ICMP to be dropped must range between 1 to 1500. | integer |
| icmp_type optional |
The type of icmp filters. | integer |
| pps_limit optional |
The ratelimit in pps. | string |
| Name | Description | Schema |
|---|---|---|
| action optional |
pass or ratelimit. | string |
| bps_limit optional |
The ratelimit in bps. | string |
| filter_id optional |
Unique identifier of custom filter. | string |
| filter_name optional |
The name of filters. | string |
| icmp_length optional |
The length of ICMP you want to drop. | integer |
| icmp_type optional |
The type of ICMP. | integer |
| pps_limit optional |
The ratelimit in pps. | string |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Add ICMP flood or customizable protocol filters.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/icmp-flood/icmp-filter
Description
Add filters for ICMP flood/Customizable protocol filters.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | body required |
ICMP filter configuration. | body |
| Name | Description | Schema |
|---|---|---|
| action required |
Actions to be performed when the filter policy is triggered , ‘pass’ or ‘ratelimit’ supported. | string |
| bps_limit optional |
The rate limit in bps of threshold,be 1-4300000000,should be provided when the action is ratelimit. | integer (int64) |
| filter_name required |
The name of the filters. | string |
| icmp_length required |
The size of the data packet, must be 1-1500. | integer |
| icmp_type required |
The icmp type number.Can be obtained by invoking this API for icmp types. | integer |
| pps_limit optional |
The rate limit in pps of threshold,be 1-4300000000,should be provided when the action is ratelimit. | integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| filter_id optional |
Filter ID, an unique identifier assigned to each Custom ICMP Filter. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get ICMP flood or customizable ICMP filter policies.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/icmp-flood/icmp-filter/{filter_id}
Description
Returns ICMP flood or customizable ICMP filter policies for the host.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Custom filter ID. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| action optional |
pass or ratelimit. | string |
| bps_limit optional |
The ratelimit in bps. | string |
| filter_name optional |
The name of the filter | string |
| icmp_length optional |
The length of ICMP you can drop. | integer |
| icmp_type optional |
The type of icmp. | integer |
| pps_limit optional |
The ratelimit in pps. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit ICMP flood or customizable protocol filter policies.
PUT /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/icmp-flood/icmp-filter/{filter_id}
Description
Edit the policies of the filters for ICMP flood/Customizable protocol.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Custom filter ID. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | body required |
ICMP filter configuration. | body |
| Name | Description | Schema |
|---|---|---|
| action optional |
Actions to be performed when the filter policy is triggered , ‘pass’ or ‘ratelimit’ supported. | string |
| bps_limit optional |
The rate limit in bps of threshold,be 1-4300000000,should be provided when the action is ratelimit. | integer (int64) |
| filter_name optional |
The name of the filters. | string |
| icmp_length optional |
The size of the data packet, must be 1-1500. | integer |
| icmp_type optional |
The icmp type number.Can be obtained by invoking this API for icmp types. | integer |
| pps_limit optional |
The rate limit in pps of threshold,be 1-4300000000,should be provided when the action is ratelimit. | integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete ICMP flood or customizable protocol filter policy.
DELETE /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/icmp-flood/icmp-filter/{filter_id}
Description
Delete the policies for the filter for ICMP flood/Customizable protocol.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Custom filter ID. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change ICMP flood policy status.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/icmp-flood/switch
Description
Enables or disables ICMP flood auto-mitigation for the host.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | is_enabled required |
0 = disabled, 1 = enabled. | integer |
| FormData | module required |
ICMP flood module: icmp_fragmentation, custom_icmp_filter, or drop_large_ping_packets. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get IP Flood auto-mitigation configuration.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/ip-flood
Description
Returns IP flood auto-mitigation settings (e.g. IP fragmentation, customizable protocol filters).
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| custom_protocol_filter optional |
The property of the customizable protocol filters. | custom_protocol_filter |
| drop_invalid_ip_packets optional |
Drop invalid IP packets settings. | drop_invalid_ip_packets |
| ip_fragmentation optional |
The property of the IP fragmentation. | ip_fragmentation |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch of the customizable protocol filters is disabled whereas 1 means it is enabled. |
integer |
| protocol optional |
The list of the protocol. | < integer > array |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch of IP fragmentation is disabled whereas 1 means it is enabled. |
integer |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit customizable protocol filter policy.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/ip-flood/protocol
Description
Edit customizable protocol filter policy.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | protocols required |
Protocol numbers (0–255) from configuration options.Can be obtained by invoking this API for protocol numbers. | < integer > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change IP Flood policy status.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/ip-flood/switch
Description
Enables or disables IP Flood auto-mitigation for the site/host.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | is_enabled required |
Enable status.Values: 0 = off, 1 = drop. | integer |
| FormData | module required |
IP Flood type. in (drop_invalid_ip_packets, ip_fragmentation, custom_protocol_filter). drop_invalid_ip_packets = drop invalid IP packets, ip_fragmentation = IP fragmentation, custom_protocol_filter = Custom Protocol Filter. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Add a custom filter for L7 flood auto-mitigation.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/custom-filter
Description
Add a custom filter for L7 flood auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | body required |
Request body. | body |
| Name | Description | Schema |
|---|---|---|
| filter_desc optional |
Filter description | string |
| filter_name required |
Filter name | string |
| filter_port required |
Port list | < string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
Data | result |
| Name | Description | Schema |
|---|---|---|
| filter_id optional |
Filter ID | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get a single custom filter info for L7 flood auto-mitigation.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/custom-filter/{filter_id}
Description
Get the info of a custom filter for L7 flood auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Filter ID | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
CustomFilter |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Update a custom filter for L7 flood auto-mitigation.
PUT /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/custom-filter/{filter_id}
Description
Update the info of a custom filter for L7 flood auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Unique identifier of filter. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | body optional |
CustomFilter |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
Result data. | object |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete a custom filter for L7 flood auto-mitigation.
DELETE /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/custom-filter/{filter_id}
Description
Delete a custom filter for L7 flood auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Filter ID | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
Result data. | object |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get L7 flood custom filter info for auto-mitigation.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/custom-filters
Description
Get the info of L7 flood custom filters for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Set L7 flood HTTP filters for auto-mitigation.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/http-filter
Description
Set the info of L7 flood HTTP filters for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | body required |
body |
| Name | Schema |
|---|---|
| filter_desc optional |
string |
| filter_name required |
string |
| filter_port required |
< integer > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
Data | result |
| Name | Description | Schema |
|---|---|---|
| filter_id optional |
Filter ID | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get L7 flood HTTP filter info for auto-mitigation.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/http-filter/{filter_id}
Description
Get the info of L7 flood HTTP filters for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Unique identifier of a L7 flood HTTP filter. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
HTTP filter configuration request | HttpFilter |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Set L7 flood HTTP filters for auto-mitigation.
PUT /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/http-filter/{filter_id}
Description
Set the info of L7 flood HTTP filters for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Unique identifier of a L7 flood HTTP filter. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | body optional |
HttpFilter |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete L7 flood HTTP filters for auto-mitigation.
DELETE /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/http-filter/{filter_id}
Description
Delete the info of L7 flood HTTP filters for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Unique identifier of a filter. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get L7 flood HTTP filters.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/http-filters
Description
Get the info of L7 flood HTTP filters for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
HTTP filters | < HttpFilter > array |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Add an L7 flood QUIC filter for auto-mitigation.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/quic-filter
Description
Add a L7 flood QUIC filter for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | body required |
body |
| Name | Schema |
|---|---|
| filter_desc optional |
string |
| filter_name required |
string |
| filter_port required |
< integer > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
Data | result |
| Name | Description | Schema |
|---|---|---|
| filter_id optional |
Filter ID | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get L7 flood QUIC filter info for auto-mitigation.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/quic-filter/{filter_id}
Description
Get the info of L7 flood QUIC filter for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Filter ID | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
Quic filter info. | QuicFilter |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Update L7 flood QUIC filter for auto-mitigation.
PUT /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/quic-filter/{filter_id}
Description
Update the info of L7 flood QUIC filter for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Filter ID | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | body optional |
QuicFilter |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete L7 flood QUIC filters for auto-mitigation.
DELETE /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/quic-filter/{filter_id}
Description
Delete the info of L7 flood QUIC filters for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Filter ID | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get L7 flood QUIC filters.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/quic-filters
Description
Get the info of L7 flood QUIC filters for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Add an L7 flood SIP filter for auto-mitigation.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/sip-filter
Description
Add a L7 flood SIP filter for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | body required |
Request body. | body |
| Name | Description | Schema |
|---|---|---|
| filter_desc optional |
Filter description | string |
| filter_name optional |
Filter name | string |
| filter_tcp_port required |
Port list | < integer > array |
| filter_udp_port required |
Filter UDP port | < integer > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
Data | result |
| Name | Description | Schema |
|---|---|---|
| filter_id optional |
Filter ID | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get a single L7 flood SIP filter info for auto-mitigation.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/sip-filter/{filter_id}
Description
Get the info of a L7 flood SIP filter for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Filter ID | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
SipFilter |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Set L7 flood custom filters for auto-mitigation.
PUT /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/sip-filter/{filter_id}
Description
Set the info of L7 flood custom filters for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Filter ID | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | body optional |
SipFilter |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete L7 flood custom filters for auto-mitigation.
DELETE /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/sip-filter/{filter_id}
Description
Delete the info of L7 flood custom filters for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Filter ID | integer |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get L7 flood SIP filter info for auto-mitigation.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/sip-filters
Description
Get the info of L7 flood SIP filters for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Set L7 flood TLS filters for auto-mitigation.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/tls-filter
Description
Set the info of L7 flood TLS filters for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | body required |
body |
| Name | Schema |
|---|---|
| filter_desc optional |
string |
| filter_name required |
string |
| filter_port required |
< integer > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
Data | result |
| Name | Description | Schema |
|---|---|---|
| filter_id optional |
Filter ID | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get L7 flood TLS filter info for auto-mitigation.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/tls-filter/{filter_id}
Description
Get the info of L7 flood TLS filters for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Unique identifier of a L7 flood HTTP filter. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
Tls filter info | TlsFilter |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Set L7 flood QUIC filters for auto-mitigation.
PUT /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/tls-filter/{filter_id}
Description
Set the info of L7 flood QUIC filters for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Unique identifier of a filter. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | body required |
TlsFilter |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete L7 flood TLS filters for auto-mitigation.
DELETE /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/tls-filter/{filter_id}
Description
Delete the info of L7 flood TLS filters for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Unique identifier of a L7 flood TLS filter. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get L7 flood HTTP filter info for auto-mitigation.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/l7-flood/tls-filters
Description
Get the info of L7 flood HTTP filters for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change NTIF auto-mitigation policy.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/ntif
Description
Edit NTIF auto-mitigation policy for the host.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | is_enabled required |
0 = disabled, 1 = monitor on trigger, 2 = drop on trigger. | integer |
| FormData | type required |
NTIF type (e.g. proxy, tor, ddos, reputation, malware, scanner, dark_spider, spam). | enum (proxy, tor, ddos, reputation, malware, scanner, dark_spider, spam) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get NTIF auto-mitigation configuration.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/ntif
Description
Returns the current NTIF auto-mitigation switch status for the host.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| dark_spider optional |
The property of the dark spider. | dark_spider |
| ddos optional |
The property of the ddos. | ddos |
| malware optional |
The property of the malware. | malware |
| proxy optional |
The property of the proxy. | proxy |
| reputation optional |
The property of the reputation. | reputation |
| scanner optional |
The property of the scanner. | scanner |
| spam optional |
The property of the spam. | spam |
| tor optional |
The property of the tor. | tor |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the dark spider switch is disabled whereas 1 means it is enabled. |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the ddos switch is disabled whereas 1 means it is enabled. |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the malware switch is disabled whereas 1 means it is enabled. |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the proxy switch is disabled whereas 1 means it is enabled. |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the reputation switch is disabled whereas 1 means it is enabled. |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the scanner switch is disabled whereas 1 means it is enabled. |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the spam switch is disabled whereas 1 means it is enabled. |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the tor switch is disabled whereas 1 means it is enabled. |
integer |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change NTIF auto-mitigation policy status.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/ntif/switch
Description
Enables or disables NTIF auto-mitigation for the site/host.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | is_enabled required |
0 = disabled, 1 = enabled. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get FlexFilter or Payload Filter info for auto-mitigation.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/payload-filter
Description
Returns info of FlexFilter/Payload Filter for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
< result > array |
| Name | Description | Schema |
|---|---|---|
| action optional |
An action will be taken when they match. | string |
| bps_limit optional |
ratelimit in bps. | string |
| filter_id optional |
Unique identifier of advanced rule. | string |
| filter_name optional |
The name of the policies. | string |
| payload_string optional |
The string of the payload. | payload_string |
| port optional |
The port number of the data packet. | port |
| pps_limit optional |
ratelimit in pps. | string |
| protocol optional |
The protocol of the data packet. | protocol |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| string optional |
Key word or phrase to look for in a payload. | < string > array |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| ports optional |
The lists of the port numbers. | < integer > array |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| type optional |
Currently, tcp, udp and ip supported protocol for the data packet can be used. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Add FlexFilter or Payload Filter policy.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/payload-filter/filter
Description
Add the policies for the FlexFilter/Payload Filter.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | body required |
Advanced payload filtering rule configuration. | body |
| Name | Description | Schema |
|---|---|---|
| action required |
You can select ‘pass’, ‘drop’ or ‘ratelimit’. Selecting the ratelimit can allow you to define the capacity of the bandwidth that data packets can consume. | string |
| bps_limit optional |
The rate limit whose must be a number or K, M, G format must be provided when the ratelimit is switched on. | string |
| filter_name required |
The name of the policies created. | string |
| payload_string optional |
If ‘payload_string_enabled’ is switched on, the key word or phase must be provided to be looked for in a payload. | < string > array |
| payload_string_enabled optional |
0 means the switch for the payload string is disabled whereas 1 means it is enabled.At least one of the protocol_enabled, port_enabled, and payload_string_enabled must be enabled. |
integer |
| port optional |
If the ‘port_enable’ is switched on, the port number of the data packet must be provided. The port number can be either source or destination port | < integer > array |
| port_enabled optional |
0 means the port switch is disabled whereas 1 means it is enabled.At least one of the protocol_enabled, port_enabled, and payload_string_enabled must be enabled. |
integer |
| pps_limit optional |
The rate limit whose must be a number or K, M, G format must be provided when the ratelimit is switched on. | string |
| protocol optional |
If the ‘port_enable’ is switched on, the name of protocol of the data packet must be provided. Currently, this function supports TCP, UDP and IP protocol. | string |
| protocol_enabled optional |
0 means the switch for the protocol is disabled whereas 1 means it is enabled.At least one of the protocol_enabled, port_enabled, and payload_string_enabled must be enabled. |
integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| filter_id optional |
Filter ID, an unique identifier assigned to each FlexFilter/Advanced Payload Filtering. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get FlexFilter or Payload Filter policy list for auto-mitigation.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/payload-filter/{filter_id}
Description
Returns info of policies for FlexFilter/Payload Filter for auto-mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Advanced payload filter ID. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| action optional |
An action will be taken when they match. | string |
| bps_limit optional |
ratelimit in bps. | string |
| filter_name optional |
The name of the policies. | string |
| payload_string optional |
The payload of the string. | payload_string |
| port optional |
The port number of the data packet. | port |
| pps_limit optional |
ratelimit in pps. | string |
| protocol optional |
The protocol of the data packet. | protocol |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| string optional |
The key word or phase to be lookedfor in a payload. | < string > array |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| ports optional |
The list of the port number. | < integer > array |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| type optional |
Currently, tcp, udp and ip supported protocol for the data packet can be used. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit FlexFilter/Advanced Payload Filtering.
PUT /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/payload-filter/{filter_id}
Description
Edit FlexFilter/Advanced Payload Filtering.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Unique identifier of advanced filter. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | body required |
Advanced payload filtering rule configuration. | body |
| Name | Description | Schema |
|---|---|---|
| action required |
You can select ‘pass’, ‘drop’ or ‘ratelimit’. Selecting the ratelimit can allow you to define the capacity of the bandwidth that data packets can consume. | string |
| bps_limit optional |
The rate limit whose must be a number or K, M, G format must be provided when the ratelimit is switched on. | string |
| filter_name required |
The name of the policies created. | string |
| payload_string optional |
If ‘payload_string_enabled’ is switched on, the key word or phase must be provided to be looked for in a payload. | < string > array |
| payload_string_enabled optional |
0 means the switch for the payload string is disabled whereas 1 means it is enabled.At least one of the protocol_enabled, port_enabled, and payload_string_enabled must be enabled. |
integer |
| port optional |
If the ‘port_enable’ is switched on, the port number of the data packet must be provided. The port number can be either source or destination port | < integer > array |
| port_enabled optional |
0 means the port switch is disabled whereas 1 means it is enabled.At least one of the protocol_enabled, port_enabled, and payload_string_enabled must be enabled. |
integer |
| pps_limit optional |
The rate limit whose must be a number or K, M, G format must be provided when the ratelimit is switched on. | string |
| protocol optional |
If the ‘port_enable’ is switched on, the name of protocol of the data packet must be provided. Currently, this function supports TCP, UDP and IP protocol. | string |
| protocol_enabled optional |
0 means the switch for the protocol is disabled whereas 1 means it is enabled.At least one of the protocol_enabled, port_enabled, and payload_string_enabled must be enabled. |
integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete policies for FlexFilter/Payload Filter.
DELETE /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/payload-filter/{filter_id}
Description
Delete policies for FlexFilter/Payload Filter.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | filter_id required |
Unique identifier of advanced filter. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit smart filter policy.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/smart-filter/filter
Description
It is used to edit the policy for smart filter.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| Body | body required |
Body of the request. | body |
| Name | Description | Schema |
|---|---|---|
| amplification optional |
Amplification. | integer |
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| threat_intelligence optional |
Threat intelligence. | integer |
| traffic_generator optional |
Traffic generator. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| amplification optional |
Amplification. | integer |
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| threat_intelligence optional |
Threat intelligence. | integer |
| traffic_generator optional |
Traffic generator. | integer |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get smart filter policy info.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/smart-filter/filter
Description
Returns the smart filter auto-mitigation policy for the host.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| amplification optional |
Amplification. | integer |
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| threat_intelligence optional |
Threat intelligence. | integer |
| traffic_generator optional |
Traffic generator. | integer |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get TCP Flood auto-mitigation configuration.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/tcp-flood
Description
Get the info of auto-mitigation for TCP Flood configuration.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| malformed_tcp_packets optional |
The info of the malformed TCP packets. | malformed_tcp_packets |
| tcp_fragmentation optional |
The info of TCP fragmentation. | tcp_fragmentation |
| tcp_rate_limit optional |
The info of TCP rate limit. | tcp_rate_limit |
| tcp_syn_flood optional |
The info of TCP syn flood. | tcp_syn_flood |
| tcp_syn_mss optional |
The info of TCP syn mss. | tcp_syn_mss |
| Name | Schema |
|---|---|
| invalid_tcp_flag optional |
invalid_tcp_flag |
| invalid_tcp_reserved_flag optional |
invalid_tcp_reserved_flag |
| invalid_tcp_syn_option optional |
invalid_tcp_syn_option |
| invalid_tcp_syn_payload optional |
invalid_tcp_syn_payload |
| tcp_syn optional |
tcp_syn |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| size optional |
The size of the TCP from the option. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| size optional |
The size of the payload. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| Name | Description | Schema |
|---|---|---|
| bps_limit optional |
The ratelimit in bps. | string |
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| pps_limit optional |
The ratelimit in pps. | string |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| session_check optional |
session_check | |
| session_timeout optional |
session_timeout | |
| syn_authentication optional |
syn_authentication |
| Name | Description | Schema |
|---|---|---|
| seconds optional |
The amount of time, in seconds, to wait before checking an SYN session. | integer |
| Name | Description | Schema |
|---|---|---|
| seconds optional |
The minimum time, in seconds, for the SYN-packet retransmission to consider the retransmission to be valid. | integer |
| Name | Description | Schema |
|---|---|---|
| strict_mode optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| syn_auth optional |
The model of TCP syn authentication. | string |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| size optional |
The size of the maximum segment. | integer |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit TCP Flood/Malformed TCP packets policy.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/tcp-flood/packets
Description
Edit TCP Flood/Malformed TCP packets policy.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | module required |
TCP flood/malformed TCP packets type. in (payload、option). | string |
| FormData | size required |
The size of string must range between 42 and 1500. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change TCP flood or TCP Malformed Packets auto-mitigation policy.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/tcp-flood/packets/switch
Description
Change the auto-mitigation policy for TCP flood or TCP Malformed Packets.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | is_enabled required |
Module enabled status. Values: 0 = disabled, 1 = enabled. | integer |
| FormData | module required |
The type of TCP flood switch consists of invalid_tcp_flag,invalid_tcp_reserved_flag,tcp_syn,invalid_tcp_syn_payload,invalid_tcp_syn_option. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit TCP Flood/TCP rate limit.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/tcp-flood/rate-limit
Description
Edit TCP Flood/TCP rate limit.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | bps_limit required |
The ratelimit in bps, must be 1-4000000000 or number with unit K/M/G (e.g. 1K, 2 M, 4 G) | string |
| FormData | pps_limit required |
The ratelimit in pps, must be 1-4000000000 or number with unit K/M/G (e.g. 1K, 2 M, 4 G) | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change TCP flood policy status.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/tcp-flood/switch
Description
Change the status of the policies for TCP flood.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | is_enabled required |
0 = disabled, 1 = enabled. | integer |
| FormData | module required |
The switch for the type of TCP flood auto-mitigation includes tcp_rate_limit,tcp_fragmentation,tcp_syn_mss,tcp_syn_flood. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit TCP SYN Flood Module of TCP Flood policy.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/tcp-flood/syn-flood
Description
Edit TCP SYN Flood Module of TCP Flood policy.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | session_check_seconds optional |
The amount of time, in seconds (10–255), to wait before checking an SYN session. | integer |
| FormData | session_timeout_seconds optional |
The minimum time, in seconds (60–600), for the SYN-packet retransmission to consider the retransmission to be valid. | integer |
| FormData | strict_mode optional |
0 = half, 1 = full. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit TCP flood or TCP Rewrite MSS Size policy.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/tcp-flood/syn-mss
Description
Edit TCP Flood/TCP Rewrite MSS Size.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | size required |
The size of string must range between 34 and 1500. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get UDP Flood auto-mitigation configuration.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/udp-flood
Description
Returns configuration of the auto-mitigation of UDP Flood.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| dns_flood_amplification optional |
The info of DNS flood and its amplification. | dns_flood_amplification |
| no_data_payload optional |
The info of No data payload. | no_data_payload |
| ntp_amplification optional |
The info of NTP amplification. | ntp_amplification |
| snmp_amplification optional |
The info of SNMP amplification. | snmp_amplification |
| ssdp_flood optional |
The info of SSDP flood. | ssdp_flood |
| udp_fragmentation optional |
The info of UDP fragmentation. | udp_fragmentation |
| udp_rate_limit optional |
The info about the rate limit of UDP. | udp_rate_limit |
| zero_data_payload optional |
The info of Zero data payload. | zero_data_payload |
| Name | Schema |
|---|---|
| dns_query_length optional |
dns_query_length |
| dns_query_rate_limit optional |
dns_query_rate_limit |
| dns_response_length optional |
dns_response_length |
| dns_response_rate_limit optional |
dns_response_rate_limit |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 mean it is enabled. |
integer |
| size optional |
The size of the DNS query. | integer |
| Name | Description | Schema |
|---|---|---|
| bps_limit optional |
ratelimit in bps. | string |
| is_enabled optional |
0 means the switch is disabled whereas 1 mean it is enabled. |
integer |
| pps_limit optional |
ratelimit in pps. | string |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 mean it is enabled. |
integer |
| size optional |
The size of the DNS response. | integer |
| Name | Description | Schema |
|---|---|---|
| bps_limit optional |
ratelimit in bps. | string |
| is_enabled optional |
0 means the switch is disabled whereas 1 mean it is enabled. |
integer |
| pps_limit optional |
ratelimit in pps. | string |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 it is enabled. |
integer |
| Name | Schema |
|---|---|
| ntp_response_length optional |
ntp_response_length |
| ntp_response_rate_limit optional |
ntp_response_rate_limit |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 mean it is enabled. |
integer |
| size optional |
The size of the NTP response. | integer |
| Name | Description | Schema |
|---|---|---|
| bps_limit optional |
ratelimit in bps. | string |
| is_enabled optional |
State of the switch. 0 means the switch is disabled whereas 1 mean it is enabled. |
integer |
| pps_limit optional |
ratelimit in pps. | string |
| Name | Schema |
|---|---|
| snmp_response_rate_limit optional |
snmp_response_rate_limit |
| Name | Description | Schema |
|---|---|---|
| bps_limit optional |
ratelimit in bps. | string |
| is_enabled optional |
0 means the switch is disabled whereas 1 mean it is enabled. |
integer |
| pps_limit optional |
ratelimit in pps. | string |
| Name | Schema |
|---|---|
| drop_ssdp optional |
drop_ssdp |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 mean it is enabled. |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas ‘1” means it is enabled. |
integer |
| Name | Description | Schema |
|---|---|---|
| bps_limit optional |
ratelimit in bps. | string |
| is_enabled optional |
0 means the switch is disabled whereas ‘1” means it is enabled. |
integer |
| pps_limit optional |
ratelimit in pps. | string |
| Name | Schema |
|---|---|
| drop_ssdp optional |
drop_ssdp |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the switch is disabled whereas 1 mean it is enabled. |
integer |
| zero_payload_length optional |
The length of the zero payload. | integer |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit UDP Flood Submodule Settings.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/udp-flood/policy
Description
Edit the info of submodule of the UDP flood including DNS Flood & Amplification, NTP Amplification, and SNMP Amplification.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | bps_limit optional |
When the module is dns_query_rate_limit,udp_rate_limit or dns_response_rate_limit, must be 1-4000000000 or number with unit K/M/G (e.g. 1K, 2 M, 4 G). | string |
| FormData | module required |
The switch for the type of UDP flood module includes dns_query_length,dns_query_rate_limit,dns_response_length,dns_response_rate_limit,ntp_response_length,ntp_response_rate_limit,snmp_response_rate_limit,udp_rate_limit. | string |
| FormData | pps_limit optional |
When the module is dns_query_rate_limit,udp_rate_limit or dns_response_rate_limit, must be 1-4000000000 or number with unit K/M/G (e.g. 1K, 2 M, 4 G). | string |
| FormData | size optional |
When the module is selected as dns_query_length or dns_response_length, the size must range between 42 and 1500. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change UDP flood submodule auto-mitigation policies.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/udp-flood/policy/switch
Description
Change the auto-mitigation policies for UDP flood submodule.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | is_enabled required |
0 means the sub switch for the policies for the UDP flood is disabled whereas 1 means it is enabled. |
integer |
| FormData | module required |
The switch for the type of UDP flood module includes dns_query_length,dns_query_rate_limit,dns_response_length,dns_response_rate_limit,ntp_response_length,ntp_response_rate_limit,snmp_response_rate_limit,drop_ssdp. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change UDP Flood auto-mitigation policies.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/udp-flood/switch
Description
Change the auto-mitigation policies for UDP Flood.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | is_enabled required |
0 means the switch for the policies of UDP flood is disabled whereas 1 means it is enabled. |
integer |
| FormData | module required |
The policies for UDP flood can handle udp_fragmentation,no_data_payload,udp_rate_limit,zero_data_payload. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit UDP Packet contain all ‘0’ Data .
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/udp-flood/zero-data-payload
Description
Edit the policies for UDP Packet contain all ‘0’ Data .
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | length required |
Length of the zero payload.Max matched length of zero data payload is limited 42-128 bytes. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit zombie policy.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/zombie
Description
It is used to edit the filter for Zombie
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | action required |
ratelimit or blacklist. | string |
| FormData | blacklist_timeout required |
Blocklist timeout.Blocklist timeout must be numeric with range 10-120. | integer |
| FormData | threshold_bps required |
Threshold values in bps, must be 1-4000000000 or number with unit K/M/G (e.g. 1K, 2 M, 4 G) | string |
| FormData | threshold_pps required |
Threshold values in pps, must be 1-4000000000 or number with unit K/M/G (e.g. 1K, 2 M, 4 G) | string |
| FormData | zombie_type required |
Zombie level: zombie_host or zombie_network. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get zombie policy info.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/zombie
Description
Returns the zombie auto-mitigation policy for the host.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| zombie_host optional |
Host level configuration. | zombie_host |
| zombie_network optional |
Network level configuration. | zombie_network |
| Name | Description | Schema |
|---|---|---|
| action optional |
ratelimit or blacklist. | string |
| blacklist_timeout optional |
Blacklist timeout. | integer |
| is_enabled optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| threshold_bps optional |
Threshold values in bps. | string |
| threshold_pps optional |
Threshold values in pps. | string |
| Name | Description | Schema |
|---|---|---|
| action optional |
ratelimit or blacklist. | string |
| blacklist_timeout optional |
Blacklist timeout. | integer |
| is_enabled optional |
State of the switch. 0 means it is disabled and 1 means enabled. |
integer |
| threshold_bps optional |
Threshold values in bps. | string |
| threshold_pps optional |
Threshold values in pps. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change zombie filter status.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/auto-mitigation/zombie/switch
Description
It is used to change the status of Zombie.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | host_id required |
Host ID. Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Site ID. Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Query | profile_id required |
Profile ID. Can be obtained by invoking this API for profile_id. | string |
| FormData | is_enabled required |
0 means the auto-mitigation policy for zombie is disabled whereas 1 means it is enabled. |
integer |
| FormData | zombie_type required |
Zombie level. zombie_host or zombie_network. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get a Clean Pipe Protection auto-mitigation profile.
GET /spe/customer/{customer_id}/cp/site/{site_id}/policy/mitigation/auto-profile/{profile_id}
Description
Returns detailed information for an auto-mitigation profile.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | profile_id required |
Auto-mitigation profile ID. Obtain from GET /spe/customer/{customer_id}/cp/site/{site_id}/policy/mitigation/auto-profiles. | string |
| Path | site_id required |
Clean Pipe Protection site ID. Obtain from GET /spe/customer/{customer_id}/cp/sites or list sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code. 0 indicates success. | integer |
| msg optional |
Error message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| description optional |
Description of an auto-mitigation profile. | string |
| profile_id optional |
Unique identifier of an auto-mitigation profile. | string |
| profile_name optional |
Name of an auto-mitigation profile. | string |
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get the Clean Pipe Protection auto-mitigation profile list.
GET /spe/customer/{customer_id}/cp/site/{site_id}/policy/mitigation/auto-profiles
Description
Returns auto-mitigation profiles for selecting network-level or host-level templates in the Clean Pipe Overview.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Customer ID. Can be obtained by invoking this API for customer_id. | string |
| Path | site_id required |
Clean Pipe Protection site ID. Obtain from GET /spe/customer/{customer_id}/cp/sites or list sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code. 0 indicates success. | integer |
| msg optional |
Error message. | string |
| result optional |
< result > array |
| Name | Description | Schema |
|---|---|---|
| description optional |
Description of an auto-mitigation profile. Length : 0 - 100 |
string |
| profile_id optional |
Unique identifier of an auto-mitigation profile. | string |
| profile_name optional |
Name of an auto-mitigation profile. Length : 2 - 40 |
string |
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Definitions
AclRule
ACL rule in a site-level ACL rule set.
| Name | Description | Schema |
|---|---|---|
| action optional |
The action of the rule. Allowed values: ratelimit, pass, drop. | enum (ratelimit, pass, drop) |
| bps_limit optional |
The rate limit in bps of the rule. Required when the action is ratelimit. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| dst_ip optional |
< string > array | |
| dst_port optional |
The destination port of the rule. Can be updated when the protocol is any, tcp or udp. | < integer > array |
| icmp_code optional |
The ICMP code of the rule. Valid only when protocol is icmp; ignored/rejected for other protocols. Minimum value : 0 Maximum value : 255 |
integer |
| icmp_type optional |
The ICMP type of the rule. Valid only when protocol is icmp; ignored/rejected for other protocols. Minimum value : 0 Maximum value : 31 |
integer |
| package_length optional |
The package length of the rule. Can be updated regardless of the selected protocol. | < string > array |
| pps_limit optional |
The rate limit in pps of the rule. Required when the action is ratelimit. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| protocol optional |
The protocol of the rule. Allowed values: any, tcp, udp, icmp, or a custom IANA protocol number as a decimal string (0-255). Numeric values 1 (icmp), 6 (tcp), and 17 (udp) must use the named strings instead. Pattern : "^(any\|tcp\|udp\|icmp\|(0\|[2-5]\|[7-9]\|1[0-6]\|1[89]\|[2-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5]))$" |
string |
| rule_desc optional |
The description of the rule. Length : 0 - 128 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| rule_id optional |
The unique identifier of the rule. | string |
| rule_name optional |
The name of the rule. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ -]+$" |
string |
| src_ip optional |
< string > array | |
| src_port optional |
< integer > array | |
| tcp_flags optional |
< enum (r1, r2, r3, ns, cwr, ece, urg, ack, psh, rst, syn, fin) > array | |
| ttl optional |
The TTL of the rule. Minimum value : 0 Maximum value : 255 |
integer |
AclRuleInput
| Name | Description | Schema |
|---|---|---|
| action required |
The action of the rule. Allowed values: ratelimit, pass, drop. | enum (ratelimit, pass, drop) |
| bps_limit optional |
The rate limit in bps of the rule. Required when the action is ratelimit. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| dst_ip optional |
< string > array | |
| dst_port optional |
The destination port of the rule. Can be updated when the protocol is any, tcp or udp. | < integer > array |
| icmp_code optional |
The ICMP code of the rule. Valid only when protocol is icmp; ignored/rejected for other protocols. Minimum value : 0 Maximum value : 255 |
integer |
| icmp_type optional |
The ICMP type of the rule. Valid only when protocol is icmp; ignored/rejected for other protocols. Minimum value : 0 Maximum value : 31 |
integer |
| package_length optional |
The package length of the rule. Can be updated regardless of the selected protocol. | < string > array |
| pps_limit optional |
The rate limit in pps of the rule. Required when the action is ratelimit. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| protocol required |
The protocol of the rule. Allowed values: any, tcp, udp, icmp, or a custom IANA protocol number as a decimal string (0-255). Numeric values 1 (icmp), 6 (tcp), and 17 (udp) must use the named strings instead. Pattern : "^(any\|tcp\|udp\|icmp\|(0\|[2-5]\|[7-9]\|1[0-6]\|1[89]\|[2-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5]))$" |
string |
| rule_desc optional |
The description of the rule. Length : 0 - 128 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| rule_name required |
The name of the rule. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ -]+$" |
string |
| src_ip optional |
< string > array | |
| src_port optional |
< integer > array | |
| tcp_flags optional |
< enum (r1, r2, r3, ns, cwr, ece, urg, ack, psh, rst, syn, fin) > array | |
| ttl optional |
The TTL of the rule. Minimum value : 0 Maximum value : 255 |
integer |
AclSetInput
| Name | Description | Schema |
|---|---|---|
| rule_set_desc optional |
The description of the rule set. Length : 0 - 128 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| rule_set_name required |
The name of the rule set. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ -]+$" |
string |
AclSetSummary
| Name | Description | Schema |
|---|---|---|
| ip_type optional |
IP address family, ipv4 or ipv6. | enum (ipv4, ipv6) |
| rule_set_desc optional |
string | |
| rule_set_id optional |
string | |
| rule_set_name optional |
string | |
| rules optional |
< AclRule > array |
AllowBlockListIpSet
Referenced IP set template details. Present when allow/block list mode is 2.
| Name | Description | Schema |
|---|---|---|
| ip_set_desc optional |
More details about the purpose of the policy. | string |
| ip_set_id optional |
Unique identifier of ip set. | string |
| ip_set_name optional |
The name of the policy. | string |
| source_countries optional |
< string > array | |
| source_ips optional |
< string > array |
AllowBlockListPolicy
Allow list and block list configuration for source traffic.
| Name | Description | Schema |
|---|---|---|
| allow_list optional |
Trusted sources permitted when allow-list policy is enabled. | allow_list |
| block_list optional |
Sources to block or rate-limit when block-list policy is enabled. | block_list |
| Name | Description | Schema |
|---|---|---|
| ip_set optional |
AllowBlockListIpSet | |
| mode optional |
Allow list mode: 0 = off; 1 = on (custom — user-defined entries); 2 = on using a specified template set. |
integer |
| source_countries optional |
String array of country or region codes for geo-based allow-list matching. Each item is one code (e.g. ISO 3166-1 alpha-2 such as US, CN; product-specific region codes may apply). | < enum (AF, AP, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RS, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TH, BS, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, PS, EH, YE, ZM, ZW) > array |
| source_ips optional |
List of source IPv4/IPv6 addresses or CIDR prefixes for this list. | < string > array |
| Name | Description | Schema |
|---|---|---|
| ip_set optional |
AllowBlockListIpSet | |
| mode optional |
Block list mode: 0 = off; 1 = on (custom — user-defined entries); 2 = on using a specified template set. |
integer |
| source_countries optional |
String array of country or region codes for geo-based block-list matching. Each item is one code (e.g. ISO 3166-1 alpha-2; product-specific region codes may apply). | < enum (AF, AP, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RS, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TH, BS, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, PS, EH, YE, ZM, ZW) > array |
| source_ips optional |
List of source IPv4/IPv6 addresses or CIDR prefixes for this list. | < string > array |
AllowBlockListPolicyInput
Allow/block list policy incremental update payload. Include only top-level fields or sub-objects to change; omitted fields are preserved.
| Name | Description | Schema |
|---|---|---|
| allow_list optional |
Trusted sources permitted when allow-list policy is enabled. | allow_list |
| block_list optional |
Sources to block or rate-limit when block-list policy is enabled. | block_list |
| Name | Description | Schema |
|---|---|---|
| ip_set_id optional |
Referenced IP set ID. | string |
| mode optional |
Allow list mode: 0 = off; 1 = on (custom — user-defined entries); 2 = on using a specified template set. |
integer |
| source_countries optional |
String array of country or region codes for geo-based allow-list matching. Each item is one code (e.g. ISO 3166-1 alpha-2 such as US, CN; product-specific region codes may apply). | < enum (AF, AP, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RS, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TH, BS, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, PS, EH, YE, ZM, ZW) > array |
| source_ips optional |
List of source IPv4/IPv6 addresses or CIDR prefixes for this list. | < string > array |
| Name | Description | Schema |
|---|---|---|
| ip_set_id optional |
Referenced IP set ID. | string |
| mode optional |
Block list mode: 0 = off; 1 = on (custom — user-defined entries); 2 = on using a specified template set. |
integer |
| source_countries optional |
String array of country or region codes for geo-based block-list matching. Each item is one code (e.g. ISO 3166-1 alpha-2; product-specific region codes may apply). | < enum (AF, AP, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RS, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TH, BS, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, PS, EH, YE, ZM, ZW) > array |
| source_ips optional |
List of source IPv4/IPv6 addresses or CIDR prefixes for this list. | < string > array |
AntiFloodL3L4IcmpPolicy
ICMP flood, fragmentation, and custom ICMP filters. IPv6 is not supported.
| Name | Description | Schema |
|---|---|---|
| all_icmp_packet optional |
Drop all ICMP traffic when enabled. | all_icmp_packet |
| icmp_custom_filter optional |
Custom ICMP type/code rules with a default profile. | icmp_custom_filter |
| icmp_fragmentation optional |
ICMP fragmentation handling. | icmp_fragmentation |
| large_ping optional |
Drop oversized ICMP echo requests. | large_ping |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = drop all ICMP traffic . | integer |
| Name | Description | Schema |
|---|---|---|
| default optional |
Default ICMP filter applied when no custom rule matches. | default |
| filters optional |
Custom ICMP filters. Managed via ICMP filter CRUD APIs. | < filters > array |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| action optional |
Mitigation action (e.g. ratelimit, pass). | enum (ratelimit, pass) |
| bps_limit optional |
Bandwidth cap as numeric string, optional K/M/G suffix.1-4000000000 or number with unit K/M/G (e.g. 1K, 2 M, 4 G). Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| filter_id required |
Unique filter profile ID. | string |
| filter_name optional |
Filter display or internal name. Can not be edited. Length : 1 - 40 Pattern : "^[A-Za-z0-9_.-]+$" |
string |
| icmp_length optional |
ICMP payload length threshold (bytes). Minimum value : 1 Maximum value : 1500 |
integer |
| pps_limit optional |
Packet rate cap as numeric string, optional K/M/G suffix.1-4000000000 or number with unit K/M/G (e.g. 1K, 2 M, 4 G). Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| Name | Description | Schema |
|---|---|---|
| action optional |
pass or ratelimit. | enum (pass, ratelimit) |
| bps_limit optional |
Rate limit in bits per second (bps). Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| filter_description optional |
Filter description. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| filter_id required |
Unique filter profile ID. | string |
| filter_name optional |
Filter display or internal name. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| icmp_length optional |
ICMP payload length to drop (bytes). Minimum value : 1 Maximum value : 1500 |
integer |
| icmp_type optional |
ICMP type number. Minimum value : 0 Maximum value : 31 |
integer |
| pps_limit optional |
Rate limit in packets per second (pps). Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
AntiFloodL3L4IcmpPolicyInput
ICMP anti-flood policy incremental update payload. Include only fields or sub-objects to change; omitted fields are preserved. Custom filters are managed via ICMP filter CRUD APIs; do not include icmp_custom_filter.filters in this request.
| Name | Description | Schema |
|---|---|---|
| all_icmp_packet optional |
Drop all ICMP traffic when enabled. | all_icmp_packet |
| icmp_custom_filter optional |
Custom ICMP type/code rules with a default profile. | icmp_custom_filter |
| icmp_fragmentation optional |
ICMP fragmentation handling. | icmp_fragmentation |
| large_ping optional |
Drop oversized ICMP echo requests. | large_ping |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = drop all ICMP traffic . | integer |
| Name | Description | Schema |
|---|---|---|
| default optional |
Default ICMP filter applied when no custom rule matches. | default |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| action optional |
Mitigation action (e.g. ratelimit, pass). | enum (ratelimit, pass) |
| bps_limit optional |
Bandwidth cap as numeric string, optional K/M/G suffix.1-4000000000 or number with unit K/M/G (e.g. 1K, 2 M, 4 G). Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| filter_id required |
Unique filter profile ID. | string |
| filter_name optional |
Filter display or internal name. Can not be edited. Length : 1 - 40 Pattern : "^[A-Za-z0-9_.-]+$" |
string |
| icmp_length optional |
ICMP payload length threshold (bytes). Minimum value : 1 Maximum value : 1500 |
integer |
| pps_limit optional |
Packet rate cap as numeric string, optional K/M/G suffix.1-4000000000 or number with unit K/M/G (e.g. 1K, 2 M, 4 G). Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
AntiFloodL3L4IpPolicy
IP-layer sanity and flood mitigation.
| Name | Description | Schema |
|---|---|---|
| custom_protocol_filter optional |
Filter on specific IP protocol numbers. | custom_protocol_filter |
| ip_fragmentation optional |
IP fragmentation handling. | ip_fragmentation |
| ip_invalid optional |
Drop packets failing basic IP validity checks. | ip_invalid |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| protocol_numbers optional |
Per-protocol aggregate rate limits at host scope. | < integer > array |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
AntiFloodL3L4IpPolicyInput
IP-layer anti-flood policy incremental update payload. Include only fields or sub-objects to change; omitted fields are preserved.
| Name | Description | Schema |
|---|---|---|
| custom_protocol_filter optional |
Filter on specific IP protocol numbers. | custom_protocol_filter |
| ip_fragmentation optional |
IP fragmentation handling. | ip_fragmentation |
| ip_invalid optional |
Drop packets failing basic IP validity checks. | ip_invalid |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| protocol_numbers optional |
Per-protocol aggregate rate limits at host scope. | < integer > array |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
AntiFloodL3L4TcpPolicy
TCP flood, malformed TCP, SYN flood, session protect, and custom TCP filters.
| Name | Description | Schema |
|---|---|---|
| tcp_fragmentation optional |
TCP fragmentation mitigation. | tcp_fragmentation |
| tcp_malformed optional |
Invalid TCP flags, SYN, and option handling. | tcp_malformed |
| tcp_rewrite_mss_size optional |
SYN MSS validation. | tcp_rewrite_mss_size |
| tcp_syn_anti_spoofing optional |
SYN flood protection: auth, trust, session limits, and SYN-ACK flood. | tcp_syn_anti_spoofing |
| tcp_syn_exclude_syn_ack_and_syn_ack_ecn optional |
Drop SYN-ACK and SYN-ACK-ECN packets. | tcp_syn_exclude_syn_ack_and_syn_ack_ecn |
| tcp_with_well_known_ports optional |
Drop invalid or sensitive destination-port packets. | tcp_with_well_known_ports |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| tcp_invalid_flags optional |
Illegal or suspicious TCP flag combinations. | tcp_invalid_flags |
| tcp_long_header optional |
Malformed or oversized SYN options. | tcp_long_header |
| tcp_syn_with_data optional |
SYN segments with non-zero payload. | tcp_syn_with_data |
| tcp_syn_with_reserved_flags optional |
Reserved TCP flag bits. | tcp_syn_with_reserved_flags |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| size optional |
Size threshold in bytes (meaning depends on parent module). Minimum value : 34 Maximum value : 1500 |
integer |
| Name | Description | Schema |
|---|---|---|
| graceful_challenges optional |
Graceful challenges. | graceful_challenges |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| rate_limit_per_connection optional |
Rate limit per connection. | rate_limit_per_connection |
| tcp_3_way_handshake_challenges optional |
TCP 3-way handshake challenges. | tcp_3_way_handshake_challenges |
| tcp_data optional |
TCP data validation. | tcp_data |
| tcp_retransmission optional |
TCP retransmission validation. | tcp_retransmission |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| duration optional |
Duration in seconds. Range: 10-150. Minimum value : 10 Maximum value : 150 |
integer |
| is_enabled optional |
0 = off, 1 = low rate_limit 500 pps, 2 = medium rate_limit 2000 pps, 3 = high rate_limit 4000 pps. | integer |
| timeout optional |
Timeout duration in seconds. Range: 60-600. Minimum value : 60 Maximum value : 600 |
integer |
tcp_3_way_handshake_challenges
| Name | Description | Schema |
|---|---|---|
| mode optional |
0 = tcp retransmission, 1 = tcp data, 2 = auto. | integer |
| Name | Description | Schema |
|---|---|---|
| server_ip_validation optional |
Server IP validation. | server_ip_validation |
| traffic_policing optional |
Traffic policing. | traffic_policing |
| Name | Description | Schema |
|---|---|---|
| bot_mitigation optional |
Bot mitigation validation. | bot_mitigation |
| spoofed_carpet_bombing_mitigation optional |
Spoofed carpet bombing mitigation validation. | spoofed_carpet_bombing_mitigation |
| tcp_fast_open optional |
TCP fast open validation. | tcp_fast_open |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
spoofed_carpet_bombing_mitigation
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| suspicious_receiver_ip_rate_limit optional |
Suspicious receiver IP rate limit in packets per second. Range: 100-4000000000. Must be less than or equal to total_rate_limit. Minimum value : 100 Maximum value : 4000000000 |
integer |
| total_rate_limit optional |
Total rate limit in packets per second. Range: 100-4000000000. Minimum value : 100 Maximum value : 4000000000 |
integer |
| validated_server_ip_rate_limit optional |
Validated server IP rate limit in packets per second. Range: 100-4000000000. Must be less than or equal to total_rate_limit. Minimum value : 100 Maximum value : 4000000000 |
integer |
| Name | Description | Schema |
|---|---|---|
| validation_mode optional |
0 = half open, 1 = full open. | integer |
| validation_trust_mode optional |
0 = host, 1 = network. | integer |
tcp_syn_exclude_syn_ack_and_syn_ack_ecn
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
AntiFloodL3L4TcpPolicyInput
TCP anti-flood policy incremental update payload. Include only fields or sub-objects to change; omitted fields are preserved.
| Name | Description | Schema |
|---|---|---|
| tcp_fragmentation optional |
TCP fragmentation mitigation. | tcp_fragmentation |
| tcp_malformed optional |
Invalid TCP flags, SYN, and option handling. | tcp_malformed |
| tcp_rewrite_mss_size optional |
SYN MSS validation. | tcp_rewrite_mss_size |
| tcp_syn_anti_spoofing optional |
SYN flood protection: auth, trust, session limits, and SYN-ACK flood. | tcp_syn_anti_spoofing |
| tcp_syn_exclude_syn_ack_and_syn_ack_ecn optional |
Drop SYN-ACK and SYN-ACK-ECN packets. | tcp_syn_exclude_syn_ack_and_syn_ack_ecn |
| tcp_with_well_known_ports optional |
Drop invalid or sensitive destination-port packets. | tcp_with_well_known_ports |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| tcp_invalid_flags optional |
Illegal or suspicious TCP flag combinations. | tcp_invalid_flags |
| tcp_long_header optional |
Malformed or oversized SYN options. | tcp_long_header |
| tcp_syn_with_data optional |
SYN segments with non-zero payload. | tcp_syn_with_data |
| tcp_syn_with_reserved_flags optional |
Reserved TCP flag bits. | tcp_syn_with_reserved_flags |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| size optional |
Size threshold in bytes (meaning depends on parent module). Minimum value : 34 Maximum value : 1500 |
integer |
| Name | Description | Schema |
|---|---|---|
| graceful_challenges optional |
Graceful challenges. | graceful_challenges |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| rate_limit_per_connection optional |
Rate limit per connection. | rate_limit_per_connection |
| tcp_3_way_handshake_challenges optional |
TCP 3-way handshake challenges. | tcp_3_way_handshake_challenges |
| tcp_data optional |
TCP data validation. | tcp_data |
| tcp_retransmission optional |
TCP retransmission validation. | tcp_retransmission |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| duration optional |
Duration in seconds. Range: 10-150. Minimum value : 10 Maximum value : 150 |
integer |
| is_enabled optional |
0 = off, 1 = low rate_limit 500 pps, 2 = medium rate_limit 2000 pps, 3 = high rate_limit 4000 pps. | integer |
| timeout optional |
Timeout duration in seconds. Range: 60-600. Minimum value : 60 Maximum value : 600 |
integer |
tcp_3_way_handshake_challenges
| Name | Description | Schema |
|---|---|---|
| mode optional |
0 = tcp retransmission, 1 = tcp data, 2 = auto. | integer |
| Name | Description | Schema |
|---|---|---|
| server_ip_validation optional |
Server IP validation. | server_ip_validation |
| traffic_policing optional |
Traffic policing. | traffic_policing |
| Name | Description | Schema |
|---|---|---|
| bot_mitigation optional |
Bot mitigation validation. | bot_mitigation |
| spoofed_carpet_bombing_mitigation optional |
Spoofed carpet bombing mitigation validation. | spoofed_carpet_bombing_mitigation |
| tcp_fast_open optional |
TCP fast open validation. | tcp_fast_open |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
spoofed_carpet_bombing_mitigation
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| suspicious_receiver_ip_rate_limit optional |
Suspicious receiver IP rate limit in packets per second. Range: 100-4000000000. Must be less than or equal to total_rate_limit. Minimum value : 100 Maximum value : 4000000000 |
integer |
| total_rate_limit optional |
Total rate limit in packets per second. Range: 100-4000000000. Minimum value : 100 Maximum value : 4000000000 |
integer |
| validated_server_ip_rate_limit optional |
Validated server IP rate limit in packets per second. Range: 100-4000000000. Must be less than or equal to total_rate_limit. Minimum value : 100 Maximum value : 4000000000 |
integer |
| Name | Description | Schema |
|---|---|---|
| validation_mode optional |
0 = half open, 1 = full open. | integer |
| validation_trust_mode optional |
0 = host, 1 = network. | integer |
tcp_syn_exclude_syn_ack_and_syn_ack_ecn
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
AntiFloodL3L4UdpPolicy
UDP flood amplification handling.
| Name | Description | Schema |
|---|---|---|
| ntp_amplification optional |
ntp_amplification | |
| snmp_amplification optional |
snmp_amplification | |
| ssdp_flood optional |
SSDP flood handling. | ssdp_flood |
| udp_contain_all_zero_data optional |
UDP contain all zero data handling. | udp_contain_all_zero_data |
| udp_flood_amplification optional |
udp_flood_amplification | |
| udp_fragmentation optional |
UDP fragmentation handling. | udp_fragmentation |
| udp_malformed optional |
UDP malformed handling. | udp_malformed |
| udp_with_port_number_lt_1024 optional |
UDP with port number less than 1024 handling. | udp_with_port_number_lt_1024 |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| ntp_response_length optional |
NTP response length handling. | ntp_response_length |
| ntp_response_monlist_drop optional |
NTP response MONLIST drop handling. | ntp_response_monlist_drop |
| ntp_response_rate_limit optional |
NTP response rate limit handling. | ntp_response_rate_limit |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| size optional |
The size of the NTP response. Minimum value : 42 Maximum value : 1500 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| bps_limit optional |
Bandwidth cap as numeric string, optional K/M/G suffix. Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| pps_limit optional |
Packet rate cap as numeric string, optional K/M/G suffix. Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| snmp_response_rate_limit optional |
SNMP response rate limit handling. | snmp_response_rate_limit |
| Name | Description | Schema |
|---|---|---|
| bps_limit optional |
Bandwidth cap as numeric string, optional K/M/G suffix. Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| pps_limit optional |
Packet rate cap as numeric string, optional K/M/G suffix. Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| zero_data_min_length optional |
The minimum length of the zero data payload. Minimum value : 42 Maximum value : 128 |
integer |
| Name | Description | Schema |
|---|---|---|
| dns_query_length optional |
DNS query length handling. | dns_query_length |
| dns_query_rate_limit optional |
DNS query rate limit handling. | dns_query_rate_limit |
| dns_response_length optional |
DNS response length handling. | dns_response_length |
| dns_response_rate_limit optional |
DNS response rate limit handling. | dns_response_rate_limit |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| size optional |
The size of the DNS query. Minimum value : 42 Maximum value : 1500 |
integer |
| Name | Description | Schema |
|---|---|---|
| bps_limit optional |
Bandwidth cap as numeric string, optional K/M/G suffix. Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| pps_limit optional |
Packet rate cap as numeric string, optional K/M/G suffix. Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| size optional |
The size of the DNS response. Minimum value : 42 Maximum value : 1500 |
integer |
| Name | Description | Schema |
|---|---|---|
| bps_limit optional |
Bandwidth cap as numeric string, optional K/M/G suffix. Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| pps_limit optional |
Packet rate cap as numeric string, optional K/M/G suffix. Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| udp_packet_contain_no_data optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
AntiFloodL3L4UdpPolicyInput
UDP anti-flood policy incremental update payload. Include only fields or sub-objects to change; omitted fields are preserved.
| Name | Description | Schema |
|---|---|---|
| ntp_amplification optional |
ntp_amplification | |
| snmp_amplification optional |
snmp_amplification | |
| ssdp_flood optional |
SSDP flood handling. | ssdp_flood |
| udp_contain_all_zero_data optional |
UDP contain all zero data handling. | udp_contain_all_zero_data |
| udp_flood_amplification optional |
udp_flood_amplification | |
| udp_fragmentation optional |
UDP fragmentation handling. | udp_fragmentation |
| udp_malformed optional |
UDP malformed handling. | udp_malformed |
| udp_with_port_number_lt_1024 optional |
UDP with port number less than 1024 handling. | udp_with_port_number_lt_1024 |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| ntp_response_length optional |
NTP response length handling. | ntp_response_length |
| ntp_response_monlist_drop optional |
NTP response MONLIST drop handling. | ntp_response_monlist_drop |
| ntp_response_rate_limit optional |
NTP response rate limit handling. | ntp_response_rate_limit |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| size optional |
The size of the NTP response. Minimum value : 42 Maximum value : 1500 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| bps_limit optional |
Bandwidth cap as numeric string, optional K/M/G suffix. Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| pps_limit optional |
Packet rate cap as numeric string, optional K/M/G suffix. Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| snmp_response_rate_limit optional |
SNMP response rate limit handling. | snmp_response_rate_limit |
| Name | Description | Schema |
|---|---|---|
| bps_limit optional |
Bandwidth cap as numeric string, optional K/M/G suffix. Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| pps_limit optional |
Packet rate cap as numeric string, optional K/M/G suffix. Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| zero_data_min_length optional |
The minimum length of the zero data payload. Minimum value : 42 Maximum value : 128 |
integer |
| Name | Description | Schema |
|---|---|---|
| dns_query_length optional |
DNS query length handling. | dns_query_length |
| dns_query_rate_limit optional |
DNS query rate limit handling. | dns_query_rate_limit |
| dns_response_length optional |
DNS response length handling. | dns_response_length |
| dns_response_rate_limit optional |
DNS response rate limit handling. | dns_response_rate_limit |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| size optional |
The size of the DNS query. Minimum value : 42 Maximum value : 1500 |
integer |
| Name | Description | Schema |
|---|---|---|
| bps_limit optional |
Bandwidth cap as numeric string, optional K/M/G suffix. Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| pps_limit optional |
Packet rate cap as numeric string, optional K/M/G suffix. Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| size optional |
The size of the DNS response. Minimum value : 42 Maximum value : 1500 |
integer |
| Name | Description | Schema |
|---|---|---|
| bps_limit optional |
Bandwidth cap as numeric string, optional K/M/G suffix. Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| pps_limit optional |
Packet rate cap as numeric string, optional K/M/G suffix. Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| udp_packet_contain_no_data optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
AntiFloodL7CustomPolicy
Custom L7 (TCP) filter profiles for this host.
| Name | Description | Schema |
|---|---|---|
| profile required |
List of Custom L7 (TCP) filter profile objects returned by policy APIs. | < profile > array |
| Name | Description | Schema |
|---|---|---|
| filter_description optional |
Filter description, length 0-100 characters. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| filter_id required |
Filter Profile ID. Length : 1 - 40 |
string |
| filter_name optional |
Filter name; letters, digits, underscore, hyphen, period, and space; length 1-40 characters. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| filter_port optional |
TCP Port list. | < integer > array |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| tcp_connection optional |
TCP Connection Module configuration | tcp_connection |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| slow_rate_connection optional |
Slow Rate Connection Module configuration | slow_rate_connection |
| source_ip_half_open_connection optional |
Source IP Half Open Connection Module configuration | source_ip_half_open_connection |
| source_ip_idle_connection optional |
Source IP Idle Connection Module configuration | source_ip_idle_connection |
| source_ip_new_connection optional |
Source IP New Connection Module configuration | source_ip_new_connection |
| total_connection optional |
Total Connection Module configuration | total_connection |
| Name | Description | Schema |
|---|---|---|
| avg_window_size optional |
Sessions per second, range (1-65535) Minimum value : 1 Maximum value : 65535 |
integer |
| block_duration optional |
Block duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = block. |
integer |
source_ip_half_open_connection
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| half_open_connection_per_second optional |
Half-open connections per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| idle_connection_per_second optional |
Idle connections per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| new_connection_per_second optional |
New connections per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit. |
integer |
| total_connection_per_second optional |
Sessions per second, range (100-4294967295) Minimum value : 100 Maximum value : 4294967295 |
integer |
AntiFloodL7HttpPolicy
HTTP-related options under TCP SYN flood (profiles, port limit). Supported when TCP Anti-Spoofing is enabled.
| Name | Schema |
|---|---|
| profile optional |
< profile > array |
| Name | Description | Schema |
|---|---|---|
| filter_description optional |
Filter description, length 0-100 characters. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| filter_id required |
Filter Profile ID. | string |
| filter_name optional |
Filter name; letters, digits, underscore, hyphen, period, and space; length 1-40 characters. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| filter_port optional |
TCP Port list. | < integer > array |
| http_authentication optional |
HTTP Authentication Module configuration | http_authentication |
| http_slow_rate optional |
HTTP Slow Rate Module configuration | http_slow_rate |
| is_enabled optional |
Filter status. Values: 0 = off, 1 = on. |
integer |
| tcp_connection optional |
TCP Connection Module configuration | tcp_connection |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| model optional |
Authentication mode. Values: 1 = HTTP ‘HTTP 302⁄307 Redirect’, 2 = HTTP ‘HTTP Meta Refresh’, 3 = JavaScript ‘JavaScript’. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (1-86400) Minimum value : 1 Maximum value : 86400 |
integer |
| body optional |
HTTP Slow Body Module configuration. | body |
| header optional |
HTTP Slow Header Module configuration. | header |
| new_session_per_minute optional |
New sessions per minute, range (1-65535). Minimum value : 1 Maximum value : 65535 |
integer |
| Name | Description | Schema |
|---|---|---|
| calc_avg_packet optional |
Number of TCP packets to carry a single HTTP request, range (3-20) Minimum value : 3 Maximum value : 20 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| min_avg_length optional |
Smallest allowed TCP packet size of a split HTTP request, range (1-1500) Minimum value : 1 Maximum value : 1500 |
integer |
| timeout_interval optional |
Time interval between two packets (milliseconds), range (1000-10000) Minimum value : 1000 Maximum value : 10000 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| packet_size optional |
Packet length (bytes), range (64-1500) Minimum value : 64 Maximum value : 1500 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| slow_rate_connection optional |
Slow Rate Connection Module configuration | slow_rate_connection |
| source_ip_half_open_connection optional |
Source IP Half Open Connection Module configuration | source_ip_half_open_connection |
| source_ip_idle_connection optional |
Source IP Idle Connection Module configuration | source_ip_idle_connection |
| source_ip_new_connection optional |
Source IP New Connection Module configuration | source_ip_new_connection |
| total_connection optional |
Total Connection Module configuration | total_connection |
| Name | Description | Schema |
|---|---|---|
| avg_window_size optional |
Sessions per second, range (1-65535) Minimum value : 1 Maximum value : 65535 |
integer |
| block_duration optional |
Block duration (seconds), range (10-60) Minimum value : 10 Maximum value : 60 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = block. |
integer |
source_ip_half_open_connection
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds) range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| half_open_connection_per_second optional |
Half-open connections per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| idle_connection_per_second optional |
Idle connections per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds) range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| new_connection_per_second optional |
New connections per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit. |
integer |
| total_connection_per_second optional |
Total connections per second, range (100-4294967295). Minimum value : 100 Maximum value : 4294967295 |
integer |
AntiFloodL7QuicPolicy
QUIC L7 filter profiles for this host.
| Name | Description | Schema |
|---|---|---|
| profile required |
List of L7 filter profile objects returned by policy APIs. | < profile > array |
| Name | Description | Schema |
|---|---|---|
| filter_description optional |
Filter description, length 0-100 characters. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| filter_id required |
Filter Profile ID. Length : 1 - 40 |
string |
| filter_name optional |
Filter name; letters, digits, underscore, hyphen, period, and space; length 1-40 characters. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| filter_port optional |
TCP Port list. | < integer > array |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| malformed optional |
QUIC Malformed Packet Detection configuration. | malformed |
| quic_flood_protection optional |
QUIC Session Protection configuration | quic_flood_protection |
| quic_ratelimit optional |
QUIC Ratelimit Module configuration | quic_ratelimit |
| Name | Description | Schema |
|---|---|---|
| handshake_min_len optional |
Minimum length (bytes) for handshake packets, range (10-65535). Minimum value : 10 Maximum value : 65535 |
integer |
| initial_min_len optional |
Minimum length (bytes) for initial packets, range (1200-65535). Minimum value : 1200 Maximum value : 65535 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = drop. |
integer |
| support_version optional |
Supported QUIC versions:[‘all’,‘v1’, ‘v2’, ‘draft27’,‘draft28’,‘draft29’,‘draft30’,‘draft31’,‘draft32’,‘draft33’,‘draft34’]. | < enum (all, v1, v2, draft27, draft28, draft29, draft30, draft31, draft32, draft33, draft34) > array |
| version_negotiation_min_len optional |
Minimum length (bytes) for version negotiation packets, range (12-65535). Minimum value : 12 Maximum value : 65535 |
integer |
| zero_rtt_min_len optional |
Minimum length (bytes) for 0-RTT packets, range (10-65535). Minimum value : 10 Maximum value : 65535 |
integer |
| Name | Description | Schema |
|---|---|---|
| 0rtt_replay_attack_protection optional |
0-RTT replay attack protection configuration. | 0rtt_replay_attack_protection |
| authentication optional |
Authentication configuration. | authentication |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| new_session_per_source_ip optional |
Session (Per source IP) Module configuration | new_session_per_source_ip |
| ratelimit_per_session optional |
Ratelimit (Per Session) Module configuration. | ratelimit_per_session |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (1-300). Minimum value : 1 Maximum value : 300 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = rate limit, 2 = block. |
integer |
| packet_per_second optional |
Packets per second threshold, range (1-65535). Minimum value : 1 Maximum value : 65535 |
integer |
| Name | Description | Schema |
|---|---|---|
| mode optional |
Authentication mode. Values: 0 = ‘Retransmission’, 1 = ‘Retry + Token’. |
integer |
| session_scope optional |
Session scope. 0 means ‘New Session Only’, 1 means ‘New andExisting Session’. | integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (1-300) Minimum value : 1 Maximum value : 300 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| new_session_per_second optional |
New sessions per second, range (1-65535) Minimum value : 1 Maximum value : 65535 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = low level, 2 = medium level, 3 = high level. |
integer |
| session_check_duration optional |
Session check duration (seconds), range (20-40) Minimum value : 20 Maximum value : 40 |
integer |
| session_timeout optional |
Idle session timeout (seconds), range (60-600) Minimum value : 60 Maximum value : 600 |
integer |
| Name | Description | Schema |
|---|---|---|
| bandwidth optional |
Bandwidth limit (Mbps), range (1-4095). Minimum value : 1 Maximum value : 4095 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| packets optional |
Packet rate limit (pps), range (1-1000000). Minimum value : 1 Maximum value : 1000000 |
integer |
AntiFloodL7SipPolicy
SIP L7 filter profiles for this host.
| Name | Description | Schema |
|---|---|---|
| profile required |
List of L7 filter profile objects returned by policy APIs. | < profile > array |
| Name | Description | Schema |
|---|---|---|
| filter_description optional |
Filter description, length 0-100 characters. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| filter_id required |
Filter Profile ID. Length : 1 - 40 |
string |
| filter_name optional |
Filter name; letters, digits, underscore, hyphen, period, and space; length 1-40 characters. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| filter_tcp_port optional |
TCP Port list. | < integer > array |
| filter_udp_port optional |
UDP Port list. | < integer > array |
| invite optional |
SIP INVITE message configuration. | invite |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| malformed_is_enabled optional |
SIP Malformed enable status. Values: 0 = off, 1 = drop. |
integer |
| register optional |
SIP REGISTER Requst message configuration. | register |
| retransmission_is_enabled optional |
UDP Retransmission Authentication enable status. Values: 0 = off, 1 = drop. |
integer |
| tcp_connection optional |
TCP Connection protection configuration | tcp_connection |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = rate limit. |
integer |
| tcp optional |
TCP message size limit, range (1-1000000). Minimum value : 1 Maximum value : 1000000 |
integer |
| udp optional |
UDP message size limit, range (1-1000000). Minimum value : 1 Maximum value : 1000000 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = rate limit. |
integer |
| tcp optional |
TCP message size limit, range (1-1000000). Minimum value : 1 Maximum value : 1000000 |
integer |
| udp optional |
UDP message size limit, range (1-1000000). Minimum value : 1 Maximum value : 1000000 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| slow_rate_connection optional |
Source IP average window size threshold | slow_rate_connection |
| source_ip_half_open_connection optional |
Source IP half-open connection rate limiting | source_ip_half_open_connection |
| source_ip_idle_connection optional |
Source IP idle connection rate limiting | source_ip_idle_connection |
| source_ip_new_connection optional |
Source IP connection rate limiting | source_ip_new_connection |
| total_connection optional |
Total connection rate limiting | total_connection |
| Name | Description | Schema |
|---|---|---|
| avg_window_size optional |
Sessions per second, range (1-65535) Minimum value : 1 Maximum value : 65535 |
integer |
| block_duration optional |
Block duration (seconds), range (10-60) Minimum value : 10 Maximum value : 60 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = block. |
integer |
source_ip_half_open_connection
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| half_open_connection_per_second optional |
Half-open connections per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| idle_connection_per_second optional |
Idle connections per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| new_connection_per_second optional |
New connections per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit. |
integer |
| total_connection_per_second optional |
Sessions per second, range (100-4294967295) Minimum value : 100 Maximum value : 4294967295 |
integer |
AntiFloodL7TlsPolicy
TLS L7 filter profiles for this host. Supported when TCP Anti-Spoofing is enabled.
| Name | Description | Schema |
|---|---|---|
| profile optional |
List of L7 filter profile objects returned by policy APIs. | < profile > array |
| Name | Description | Schema |
|---|---|---|
| filter_description optional |
Filter description, length 0-100 characters. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| filter_id required |
Filter Profile ID. Length : 1 - 40 |
string |
| filter_name optional |
Filter name; letters, digits, underscore, hyphen, period, and space; length 1-40 characters. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| filter_port optional |
TCP Port list. | < integer > array |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| malformed optional |
SSL/TLS Malformed Packet Detection configuration. | malformed |
| ratelimit optional |
SSL/TLS Ratelimit (Per Profile) configuration | ratelimit |
| renegotiation optional |
SSL/TLS Renegotiation configuration. | renegotiation |
| session optional |
SSL/TLS Session configuration. | session |
| tcp_connection optional |
Connection protection configuration | tcp_connection |
| Name | Description | Schema |
|---|---|---|
| clienthello_length_limit_non_v_1_3 optional |
ClientHello length (bytes) limit for non-TLS 1.3, range (64-1400). Minimum value : 64 Maximum value : 1400 |
integer |
| clienthello_length_limit_v_1_3 optional |
ClientHello length (bytes) limit for TLS 1.3, range (64-1400). Minimum value : 64 Maximum value : 1400 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| Name | Description | Schema |
|---|---|---|
| non_tls optional |
Ratelimit for non TLS1.2 and TLS1.3 traffic. | non_tls |
| tls optional |
Ratelimit for TLS1.2 and TLS1.3 traffic. | tls |
| Name | Description | Schema |
|---|---|---|
| bandwidth optional |
Bandwidth limit (Mbps), range (1-4095). Minimum value : 1 Maximum value : 4095 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| packet optional |
Packet rate limit (pps), range (1-1000000). Minimum value : 1 Maximum value : 1000000 |
integer |
| Name | Description | Schema |
|---|---|---|
| bandwidth optional |
Bandwidth limit (Mbps), range (1-4095). Minimum value : 1 Maximum value : 4095 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| packet optional |
Packet rate limit (pps), range (1-1000000). Minimum value : 1 Maximum value : 1000000 |
integer |
| Name | Description | Schema |
|---|---|---|
| blocklist_duration optional |
Blocklist duration (seconds), range (1-65535). Minimum value : 1 Maximum value : 65535 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = drop. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (1-300) Minimum value : 1 Maximum value : 300 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = block. |
integer |
| new_session_per_second optional |
New session per second, range (1-65535) Minimum value : 1 Maximum value : 65535 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Connection protection enable status. Values: 0 = off, 1 = on. |
integer |
| slow_rate_connection optional |
This rule checks for slow rate connections from the same source IP address | slow_rate_connection |
| source_ip_half_open_connection optional |
Source IP half-open connection rate limiting | source_ip_half_open_connection |
| source_ip_idle_connection optional |
Source IP idle connection rate limiting | source_ip_idle_connection |
| source_ip_new_connection optional |
Source IP connection rate limiting | source_ip_new_connection |
| total_connection optional |
Total connection rate limiting | total_connection |
| Name | Description | Schema |
|---|---|---|
| avg_window_size optional |
Average window Size (bytes), range (1-65535) Minimum value : 1 Maximum value : 65535 |
integer |
| block_duration optional |
Ban duration (seconds), range (10-60). Minimum value : 10 Maximum value : 60 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = block. |
integer |
source_ip_half_open_connection
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Ban duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| half_open_connection_per_second optional |
Sessions per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| is_enabled optional |
Source IP half-open connection rate limiting enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Ban duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| idle_connection_per_second optional |
Sessions per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| is_enabled optional |
Source IP idle connection rate limiting enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Ban duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| is_enabled optional |
Source IP connection rate limiting enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| new_connection_per_second optional |
Sessions per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit. |
integer |
| total_connection_per_second optional |
Sessions per second, range (100-4294967295) Minimum value : 100 Maximum value : 4294967295 |
integer |
BogonsPolicy
Bogon and invalid address protections.
| Name | Description | Schema |
|---|---|---|
| land_attack optional |
Mitigate LAND-style same src/dst attacks. | land_attack |
| martian_address optional |
Drop martian or reserved addresses. | martian_address |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
BogonsPolicyInput
Bogon and invalid address protection incremental update payload. Include only fields or sub-objects to change; omitted fields are preserved.
| Name | Description | Schema |
|---|---|---|
| land_attack optional |
Mitigate LAND-style same src/dst attacks. | land_attack |
| martian_address optional |
Drop martian or reserved addresses. | martian_address |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
CustomFilter
Custom Filter configuration.
| Name | Description | Schema |
|---|---|---|
| connection_protect optional |
TCP Connection Module configuration. | connection_protect |
| filter_desc optional |
Filter description, length 0-100 characters. | string |
| filter_id optional |
Filter Profile ID. Can be obtained by invoking this API for profile_id. | string |
| filter_name optional |
Filter name,contain only letters, digits, underscore and hyphen, length 1-40 characters. | string |
| filter_port optional |
TCP Port list. | < integer > array |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| src_ip_avg_window_size_threshold optional |
Slow Rate Connection Module configuration. | src_ip_avg_window_size_threshold |
| src_ip_connection_rate optional |
Source IP New Connection Module configuration. | src_ip_connection_rate |
| src_ip_half_open_rate optional |
Source IP Half Open Connection Module configuration. | src_ip_half_open_rate |
| src_ip_idle_connection_rate optional |
Source IP Idle Connection Module configuration. | src_ip_idle_connection_rate |
| total_connection_rate optional |
Total Connection Moudle configuration. | total_connection_rate |
src_ip_avg_window_size_threshold
| Name | Description | Schema |
|---|---|---|
| banned_period optional |
Block duration (seconds), range in (10-600). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = block. |
integer |
| session_per_second optional |
Sessions per second,range in (1-65535). | integer |
| Name | Description | Schema |
|---|---|---|
| banned_period optional |
Block duration (seconds), range in (10-600). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| session_per_second optional |
New connections per second,range in (5-1000). | integer |
| Name | Description | Schema |
|---|---|---|
| banned_period optional |
Block duration (seconds), range in (10-600). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| session_per_second optional |
Half-open connections per second,range in (5-1000). | integer |
| Name | Description | Schema |
|---|---|---|
| banned_period optional |
Block duration (seconds), range in (10-600). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| session_per_second optional |
Idle connections per second,range in (5-1000). | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit. |
integer |
| session_per_second optional |
Sessions per second,range in (100-4294967295). | integer |
CustomFilterInput
CustomFilter create payload.
| Name | Description | Schema |
|---|---|---|
| filter_description optional |
Filter description, length 0-100 characters. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| filter_name required |
Filter name; letters, digits, underscore, hyphen, period, and space; length 1-40 characters. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| filter_port required |
TCP Port list. | < integer > array |
CustomFilterV2
Custom Filter configuration.
| Name | Description | Schema |
|---|---|---|
| filter_description optional |
Filter description, length 0-100 characters. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| filter_id optional |
Filter Profile ID. Returned in GET responses. Optional in update request bodies; use the path parameter instead. | string |
| filter_name optional |
Filter name; letters, digits, underscore, hyphen, period, and space; length 1-40 characters. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| filter_port optional |
TCP Port list. | < integer > array |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| tcp_connection optional |
TCP Connection Module configuration | tcp_connection |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| slow_rate_connection optional |
Slow Rate Connection Module configuration | slow_rate_connection |
| source_ip_half_open_connection optional |
Source IP Half Open Connection Module configuration | source_ip_half_open_connection |
| source_ip_idle_connection optional |
Source IP Idle Connection Module configuration | source_ip_idle_connection |
| source_ip_new_connection optional |
Source IP New Connection Module configuration | source_ip_new_connection |
| total_connection optional |
Total Connection Module configuration | total_connection |
| Name | Description | Schema |
|---|---|---|
| avg_window_size optional |
Sessions per second, range (1-65535) Minimum value : 1 Maximum value : 65535 |
integer |
| block_duration optional |
Block duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = block. |
integer |
source_ip_half_open_connection
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| half_open_connection_per_second optional |
Half-open connections per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| idle_connection_per_second optional |
Idle connections per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| new_connection_per_second optional |
New connections per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit. |
integer |
| total_connection_per_second optional |
Sessions per second, range (100-4294967295) Minimum value : 100 Maximum value : 4294967295 |
integer |
FlexFilterAclCustomRule
Custom ACL filter rule attached to the profile.
| Name | Description | Schema |
|---|---|---|
| action optional |
The action of the rule. Allowed values: ratelimit, pass, drop. | enum (ratelimit, pass, drop) |
| bps_limit optional |
The rate limit in bps of the rule. Required when the action is ratelimit. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| dst_ip optional |
< string > array | |
| dst_port optional |
The destination port of the rule. Can be updated when the protocol is any, tcp or udp. | < integer > array |
| icmp_code optional |
The ICMP code of the rule. Valid only when protocol is icmp; ignored/rejected for other protocols. Minimum value : 0 Maximum value : 255 |
integer |
| icmp_type optional |
The ICMP type of the rule. Valid only when protocol is icmp; ignored/rejected for other protocols. Minimum value : 0 Maximum value : 31 |
integer |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| package_length optional |
The package length of the rule. Can be updated regardless of the selected protocol. | < string > array |
| pps_limit optional |
The rate limit in pps of the rule. Required when the action is ratelimit. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| protocol optional |
The protocol of the rule. Allowed values: any, tcp, udp, icmp, or a custom IANA protocol number as a decimal string (0-255). Numeric values 1 (icmp), 6 (tcp), and 17 (udp) must use the named strings instead. Pattern : "^(any\|tcp\|udp\|icmp\|(0\|[2-5]\|[7-9]\|1[0-6]\|1[89]\|[2-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5]))$" |
string |
| rule_desc optional |
The description of the rule. Length : 0 - 128 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| rule_id required |
The unique identifier of the rule. | string |
| rule_name optional |
The name of the rule. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ -]+$" |
string |
| sort_order optional |
The sort order of the rule. | integer |
| src_ip optional |
< string > array | |
| src_port optional |
< integer > array | |
| ttl optional |
The TTL of the rule. Minimum value : 0 Maximum value : 255 |
integer |
FlexFilterAclCustomRuleInput
FlexFilter ACL custom rule create payload.
| Name | Description | Schema |
|---|---|---|
| action required |
The action of the rule. Allowed values: ratelimit, pass, drop. | enum (ratelimit, pass, drop) |
| bps_limit optional |
The rate limit in bps of the rule. Required when the action is ratelimit. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| dst_ip optional |
< string > array | |
| dst_port optional |
The destination port of the rule. Can be updated when the protocol is any, tcp or udp. | < integer > array |
| icmp_code optional |
The ICMP code of the rule. Valid only when protocol is icmp; ignored/rejected for other protocols. Minimum value : 0 Maximum value : 255 |
integer |
| icmp_type optional |
The ICMP type of the rule. Valid only when protocol is icmp; ignored/rejected for other protocols. Minimum value : 0 Maximum value : 31 |
integer |
| package_length optional |
The package length of the rule. Can be updated regardless of the selected protocol. | < string > array |
| pps_limit optional |
The rate limit in pps of the rule. Required when the action is ratelimit. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| protocol required |
The protocol of the rule. Allowed values: any, tcp, udp, icmp, or a custom IANA protocol number as a decimal string (0-255). Numeric values 1 (icmp), 6 (tcp), and 17 (udp) must use the named strings instead. Pattern : "^(any\|tcp\|udp\|icmp\|(0\|[2-5]\|[7-9]\|1[0-6]\|1[89]\|[2-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5]))$" |
string |
| rule_desc optional |
The description of the rule. Length : 0 - 128 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| rule_name required |
The name of the rule. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ -]+$" |
string |
| sort_order optional |
The sort order of the rule. | integer |
| src_ip optional |
< string > array | |
| src_port optional |
< integer > array | |
| ttl optional |
The TTL of the rule. Minimum value : 0 Maximum value : 255 |
integer |
FlexFilterAclCustomRuleUpdateInput
FlexFilter ACL custom rule update payload.
| Name | Description | Schema |
|---|---|---|
| action required |
The action of the rule. Allowed values: ratelimit, pass, drop. | enum (ratelimit, pass, drop) |
| bps_limit optional |
The rate limit in bps of the rule. Required when the action is ratelimit. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| dst_ip optional |
< string > array | |
| dst_port optional |
The destination port of the rule. Can be updated when the protocol is any, tcp or udp. | < integer > array |
| icmp_code optional |
The ICMP code of the rule. Valid only when protocol is icmp; ignored/rejected for other protocols. Minimum value : 0 Maximum value : 255 |
integer |
| icmp_type optional |
The ICMP type of the rule. Valid only when protocol is icmp; ignored/rejected for other protocols. Minimum value : 0 Maximum value : 31 |
integer |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| package_length optional |
The package length of the rule. Can be updated regardless of the selected protocol. | < string > array |
| pps_limit optional |
The rate limit in pps of the rule. Required when the action is ratelimit. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| protocol required |
The protocol of the rule. Allowed values: any, tcp, udp, icmp, or a custom IANA protocol number as a decimal string (0-255). Numeric values 1 (icmp), 6 (tcp), and 17 (udp) must use the named strings instead. Pattern : "^(any\|tcp\|udp\|icmp\|(0\|[2-5]\|[7-9]\|1[0-6]\|1[89]\|[2-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5]))$" |
string |
| rule_desc optional |
The description of the rule. Length : 0 - 128 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| rule_name required |
The name of the rule. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ -]+$" |
string |
| sort_order optional |
The sort order of the rule. | integer |
| src_ip optional |
< string > array | |
| src_port optional |
< integer > array | |
| ttl optional |
The TTL of the rule. Minimum value : 0 Maximum value : 255 |
integer |
FlexFilterAclFilterPolicy
Site-level ACL common and custom rule sets.
| Name | Description | Schema |
|---|---|---|
| acl_filter_rules optional |
Site-specific custom ACL rules. | < acl_filter_rules > array |
| acl_filter_sets optional |
Site-level ACL filter sets attached to the profile. | < acl_filter_sets > array |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Description | Schema |
|---|---|---|
| action optional |
The action of the rule. Allowed values: ratelimit, pass, drop. | enum (ratelimit, pass, drop) |
| bps_limit optional |
The rate limit in bps of the rule. Required when the action is ratelimit. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| dst_ip optional |
< string > array | |
| dst_port optional |
The destination port of the rule. Can be updated when the protocol is any, tcp or udp. | < integer > array |
| icmp_code optional |
The ICMP code of the rule. Valid only when protocol is icmp; ignored/rejected for other protocols. Minimum value : 0 Maximum value : 255 |
integer |
| icmp_type optional |
The ICMP type of the rule. Valid only when protocol is icmp; ignored/rejected for other protocols. Minimum value : 0 Maximum value : 31 |
integer |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| package_length optional |
The package length of the rule. Can be updated regardless of the selected protocol. | < string > array |
| pps_limit optional |
The rate limit in pps of the rule. Required when the action is ratelimit. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| protocol optional |
The protocol of the rule. Allowed values: any, tcp, udp, icmp, or a custom IANA protocol number as a decimal string (0-255). Numeric values 1 (icmp), 6 (tcp), and 17 (udp) must use the named strings instead. Pattern : "^(any\|tcp\|udp\|icmp\|(0\|[2-5]\|[7-9]\|1[0-6]\|1[89]\|[2-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5]))$" |
string |
| rule_desc optional |
The description of the rule. Length : 0 - 128 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| rule_id required |
The unique identifier of the rule. | string |
| rule_name optional |
The name of the rule. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ -]+$" |
string |
| sort_order optional |
The sort order of the rule. | integer |
| src_ip optional |
< string > array | |
| src_port optional |
< integer > array | |
| ttl optional |
The TTL of the rule. Minimum value : 0 Maximum value : 255 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| rule_set_desc optional |
Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| rule_set_id required |
string | |
| rule_set_name optional |
Length : 1 - 40 Pattern : "^[A-Za-z0-9_ -]+$" |
string |
FlexFilterAclFilterPolicyInput
FlexFilter ACL filter policy incremental update payload. Include only fields to change; omitted fields are preserved. The acl_filter_sets array supports incremental attach/detach of site-level ACL template sets. Custom ACL rules are managed via custom-filter CRUD APIs; do not include acl_filter_rules in this request.
| Name | Description | Schema |
|---|---|---|
| acl_filter_sets optional |
Site-level ACL filter sets attached to the profile. | < acl_filter_sets > array |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Schema |
|---|---|
| rule_set_id required |
string |
FlexFilterPayloadFilterPolicy
Advanced payload filtering rules.
| Name | Description | Schema |
|---|---|---|
| filters optional |
List of payload filter rules. Managed via payload-filter CRUD APIs. | < filters > array |
| Name | Description | Schema |
|---|---|---|
| action optional |
An action will be taken when they match. Allowed values: ratelimit, pass, drop. | enum (ratelimit, pass, drop) |
| bps_limit optional |
ratelimit in bps. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| filter_id required |
Unique identifier of advanced rule. | string |
| filter_name optional |
The name of the policies. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| payload_string optional |
The string of the payload. | < string > array |
| port optional |
The lists of the port numbers. | < integer > array |
| pps_limit optional |
ratelimit in pps. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| protocol optional |
The protocol of the data packet. Allowed values: tcp, udp, ip, any. | enum (tcp, udp, ip, any) |
FlexZombieRule
Flex zombie rule.
| Name | Description | Schema |
|---|---|---|
| action optional |
The action of the rule. Allowed values: pass, ratelimit, block. | enum (pass, ratelimit, block) |
| block_duration optional |
The duration of the block in seconds. Required when the action is block. Minimum value : 10 Maximum value : 120 |
integer |
| bps_limit optional |
The rate limit in bps of the rule. Required when the action is ratelimit or block. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| dip_prefix optional |
Destination IP netmask for the rule. Required when zombie_mode is dip or dip_dport. Minimum value : 24 Maximum value : 32 |
integer |
| dst_ip optional |
< string > array | |
| dst_port optional |
< integer > array | |
| icmp_code optional |
The ICMP code of the rule. Valid only when protocol is icmp; ignored/rejected for other protocols. Minimum value : 0 Maximum value : 255 |
integer |
| icmp_type optional |
The ICMP type of the rule. Valid only when protocol is icmp; ignored/rejected for other protocols. Minimum value : 0 Maximum value : 31 |
integer |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| package_length optional |
The package length of the rule. Can be updated regardless of the selected protocol. | < string > array |
| pps_limit optional |
The rate limit in pps of the rule. Required when the action is ratelimit or block. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| protocol optional |
The protocol of the rule. Allowed values: any, tcp, udp, icmp, or a custom IANA protocol number as a decimal string (0-255). Numeric values 1 (icmp), 6 (tcp), and 17 (udp) must use the named strings instead. Pattern : "^(any\|tcp\|udp\|icmp\|(0\|[2-5]\|[7-9]\|1[0-6]\|1[89]\|[2-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5]))$" |
string |
| rule_desc optional |
The description of the rule. Length : 0 - 128 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| rule_id required |
The unique identifier of the rule. | string |
| rule_name optional |
The name of the rule. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ -]+$" |
string |
| sip_prefix optional |
Source IP netmask for the rule. Required when zombie_mode is sip, sip_sport, or sip_dport. Minimum value : 24 Maximum value : 32 |
integer |
| sort_order optional |
The sort order of the rule. | integer |
| src_ip optional |
< string > array | |
| src_port optional |
< integer > array | |
| tcp_flags optional |
< enum (r1, r2, r3, ns, cwr, ece, urg, ack, psh, rst, syn, fin) > array | |
| ttl optional |
The TTL of the rule. Minimum value : 0 Maximum value : 255 |
integer |
| zombie_mode optional |
The mode of the rule. Mode values: sip - Source IP, dip - Destination IP, sip_sport - Source IP and Source Port, dip_dport - Destination IP and Destination Port, sip_dport - Source IP and Destination Port. Required when the action is ratelimit or block. Default is sip. Default : "sip" |
enum (sip, dip, sip_sport, dip_dport, sip_dport) |
FlexZombieRuleInput
Flex zombie rule input for create and update.
| Name | Description | Schema |
|---|---|---|
| action required |
The action of the rule. Allowed values: pass, ratelimit, block. | enum (pass, ratelimit, block) |
| block_duration optional |
The duration of the block in seconds. Required when the action is block. Minimum value : 10 Maximum value : 120 |
integer |
| bps_limit optional |
The rate limit in bps of the rule. Required when the action is ratelimit or block. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| dip_prefix optional |
Destination IP netmask for the rule. Required when zombie_mode is dip or dip_dport. Minimum value : 24 Maximum value : 32 |
integer |
| dst_ip optional |
< string > array | |
| dst_port optional |
< integer > array | |
| icmp_code optional |
The ICMP code of the rule. Valid only when protocol is icmp; ignored/rejected for other protocols. Minimum value : 0 Maximum value : 255 |
integer |
| icmp_type optional |
The ICMP type of the rule. Valid only when protocol is icmp; ignored/rejected for other protocols. Minimum value : 0 Maximum value : 31 |
integer |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| package_length optional |
The package length of the rule. Can be updated regardless of the selected protocol. | < string > array |
| pps_limit optional |
The rate limit in pps of the rule. Required when the action is ratelimit or block. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| protocol required |
The protocol of the rule. Allowed values: any, tcp, udp, icmp, or a custom IANA protocol number as a decimal string (0-255). Numeric values 1 (icmp), 6 (tcp), and 17 (udp) must use the named strings instead. Pattern : "^(any\|tcp\|udp\|icmp\|(0\|[2-5]\|[7-9]\|1[0-6]\|1[89]\|[2-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5]))$" |
string |
| rule_desc optional |
The description of the rule. Length : 0 - 128 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| rule_name required |
The name of the rule. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ -]+$" |
string |
| sip_prefix optional |
Source IP netmask for the rule. Required when zombie_mode is sip, sip_sport, or sip_dport. Minimum value : 24 Maximum value : 32 |
integer |
| src_ip optional |
< string > array | |
| src_port optional |
< integer > array | |
| tcp_flags optional |
< enum (r1, r2, r3, ns, cwr, ece, urg, ack, psh, rst, syn, fin) > array | |
| ttl optional |
The TTL of the rule. Minimum value : 0 Maximum value : 255 |
integer |
| zombie_mode optional |
The mode of the rule. Mode values: sip - Source IP, dip - Destination IP, sip_sport - Source IP and Source Port, dip_dport - Destination IP and Destination Port, sip_dport - Source IP and Destination Port. Required when the action is ratelimit or block. Default is sip. Default : "sip" |
enum (sip, dip, sip_sport, dip_dport, sip_dport) |
HttpFilter
HTTP Filter configuration.
| Name | Description | Schema |
|---|---|---|
| authentication optional |
HTTP Authentication Module configuration. | authentication |
| connection_protect optional |
TCP Connection Module configuration. | connection_protect |
| filter_description optional |
Filter description, length 0-100 characters. | string |
| filter_id optional |
Filter Profile ID. Can be obtained by invoking this API for profile_id. | string |
| filter_name optional |
Filter name,contain only letters, digits, underscore and hyphen, length 1-40 characters. | string |
| filter_port required |
TCP Port list. | < integer > array |
| is_enabled optional |
Filter status. Values: 0 = off, 1 = on. |
integer |
| slow_attack optional |
HTTP Slow Rate Module configuration. | slow_attack |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| model optional |
Authentication mode. Values: 1 = HTTP ‘HTTP 302⁄307 Redirect’, 2 = HTTP ‘HTTP Meta Refresh’, 3 = JavaScript ‘JavaScript’. |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| src_ip_avg_window_size_threshold optional |
Slow Rate Connection Module configuration. | src_ip_avg_window_size_threshold |
| src_ip_connection_rate optional |
Source IP New Connection Module configuration. | src_ip_connection_rate |
| src_ip_half_open_rate optional |
Source IP Half Open Connection Module configuration. | src_ip_half_open_rate |
| src_ip_idle_connection_rate optional |
Source IP Idle Connection Module configuration. | src_ip_idle_connection_rate |
| total_connection_rate optional |
Total Connection Moudle configuration. | total_connection_rate |
src_ip_avg_window_size_threshold
| Name | Description | Schema |
|---|---|---|
| banned_period optional |
Block duration(seconds), range in (10-60). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = block. |
integer |
| session_per_second optional |
Sessions per second,range in (1-65535). | integer |
| Name | Description | Schema |
|---|---|---|
| banned_period optional |
Block duration(seconds) range in (10-600). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| session_per_second optional |
New connections per second,range in (5-1000). | integer |
| Name | Description | Schema |
|---|---|---|
| banned_period optional |
Block duration(seconds) range in (10-600). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| session_per_second optional |
Half-open connections per second,range in (5-1000). | integer |
| Name | Description | Schema |
|---|---|---|
| banned_period optional |
Block duration(seconds), range in (10-600). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| session_per_second optional |
Idle connections per second,range in (5-1000). | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit. |
integer |
| session_per_second optional |
Total Connection per second,range in (100 - 4294967295). | integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range in (1-86400). | integer |
| body optional |
HTTP Slow Body Module configuration. | body |
| header optional |
HTTP Slow Header Module configuration. | header |
| session_threshold optional |
New Session per minute,range in (1-65535). | integer |
| Name | Description | Schema |
|---|---|---|
| calc_avg_packet optional |
Number of TCP packets to carry a single HTTP request,range in (3-20). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| min_avg_length optional |
Smallest allowed TCP packet size of a splited HTTP request,range in (1-1500). | integer |
| timeout_interval optional |
Time interval between two packets (milliseconds),range in (1000-10000). | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| packet_size optional |
Packet length(bytes),range in (64-1500). | integer |
HttpFilterInput
HttpFilter create payload.
| Name | Description | Schema |
|---|---|---|
| filter_description optional |
Filter description, length 0-100 characters. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| filter_name required |
Filter name; letters, digits, underscore, hyphen, period, and space; length 1-40 characters. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| filter_port required |
TCP Port list. | < integer > array |
HttpFilterV2
Http L7 filter profile.
| Name | Description | Schema |
|---|---|---|
| filter_description optional |
Filter description, length 0-100 characters. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| filter_id optional |
Filter Profile ID. Returned in GET responses. Optional in update request bodies; use the path parameter instead. | string |
| filter_name optional |
Filter name; letters, digits, underscore, hyphen, period, and space; length 1-40 characters. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| filter_port optional |
TCP Port list. | < integer > array |
| http_authentication optional |
HTTP Authentication Module configuration | http_authentication |
| http_slow_rate optional |
HTTP Slow Rate Module configuration | http_slow_rate |
| is_enabled optional |
Filter status. Values: 0 = off, 1 = on. |
integer |
| tcp_connection optional |
TCP Connection Module configuration | tcp_connection |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| model optional |
Authentication mode. Values: 1 = HTTP ‘HTTP 302⁄307 Redirect’, 2 = HTTP ‘HTTP Meta Refresh’, 3 = JavaScript ‘JavaScript’. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (1-86400) Minimum value : 1 Maximum value : 86400 |
integer |
| body optional |
HTTP Slow Body Module configuration. | body |
| header optional |
HTTP Slow Header Module configuration. | header |
| is_enabled optional |
Enable status mode. Values: 1 = Block, 2 = Block RST. |
integer |
| new_session_per_minute optional |
New sessions per minute, range (1-65535). Minimum value : 1 Maximum value : 65535 |
integer |
| Name | Description | Schema |
|---|---|---|
| calc_avg_packet optional |
Number of TCP packets to carry a single HTTP request, range (3-20) Minimum value : 3 Maximum value : 20 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| min_avg_length optional |
Smallest allowed TCP packet size of a split HTTP request, range (1-1500) Minimum value : 1 Maximum value : 1500 |
integer |
| timeout_interval optional |
Time interval between two packets (milliseconds), range (1000-10000) Minimum value : 1000 Maximum value : 10000 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| packet_size optional |
Packet length (bytes), range (64-1500) Minimum value : 64 Maximum value : 1500 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| slow_rate_connection optional |
Slow Rate Connection Module configuration | slow_rate_connection |
| source_ip_half_open_connection optional |
Source IP Half Open Connection Module configuration | source_ip_half_open_connection |
| source_ip_idle_connection optional |
Source IP Idle Connection Module configuration | source_ip_idle_connection |
| source_ip_new_connection optional |
Source IP New Connection Module configuration | source_ip_new_connection |
| total_connection optional |
Total Connection Module configuration | total_connection |
| Name | Description | Schema |
|---|---|---|
| avg_window_size optional |
Sessions per second, range (1-65535) Minimum value : 1 Maximum value : 65535 |
integer |
| block_duration optional |
Block duration (seconds), range (10-60) Minimum value : 10 Maximum value : 60 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = block. |
integer |
source_ip_half_open_connection
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds) range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| half_open_connection_per_second optional |
Half-open connections per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| idle_connection_per_second optional |
Idle connections per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds) range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| new_connection_per_second optional |
New connections per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit. |
integer |
| total_connection_per_second optional |
Total connections per second, range (100-4294967295). Minimum value : 100 Maximum value : 4294967295 |
integer |
IcmpFilter
| Name | Description | Schema |
|---|---|---|
| action optional |
pass or ratelimit. | enum (pass, ratelimit) |
| bps_limit optional |
Rate limit in bits per second (bps). Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| filter_description optional |
Filter description. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| filter_id required |
Unique filter profile ID. | string |
| filter_name optional |
Filter display or internal name. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| icmp_length optional |
ICMP payload length to drop (bytes). Minimum value : 1 Maximum value : 1500 |
integer |
| icmp_type optional |
ICMP type number. Minimum value : 0 Maximum value : 31 |
integer |
| pps_limit optional |
Rate limit in packets per second (pps). Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
IcmpFilterInput
| Name | Description | Schema |
|---|---|---|
| action required |
Action when filter matches: pass or ratelimit. | enum (pass, ratelimit) |
| bps_limit optional |
Rate limit in bps must be 1-4000000000 or number with unit K/M/G (e.g. 1K, 2 M, 4G). Required when action is ratelimit. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| filter_name required |
Filter name. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| icmp_length required |
Packet size in bytes (1–1500). Minimum value : 1 Maximum value : 1500 |
integer |
| icmp_type required |
ICMP type number. Minimum value : 0 Maximum value : 31 |
integer |
| pps_limit optional |
Rate limit in pps must be 1-4000000000 or number with unit K/M/G (e.g. 1K, 2 M, 4G). Required when action is ratelimit. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
IpSetInput
| Name | Description | Schema |
|---|---|---|
| enable_country optional |
Source country enabled status. 0 = off, 1 = on. | integer |
| ip_set_desc optional |
Optional policy description. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| ip_set_name required |
Policy name. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ -]+$" |
string |
| ip_type required |
IP address family for the template, ipv4 or ipv6. | enum (ipv4, ipv6) |
| source_countries optional |
String array of country or region codes for geo-based allow-list matching. Each item is one code (e.g. ISO 3166-1 alpha-2 such as US, CN; product-specific region codes may apply). | < enum (AF, AP, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RS, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TH, BS, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, PS, EH, YE, ZM, ZW) > array |
| source_ips optional |
List of source IPv4/IPv6 addresses or CIDR prefixes for this list. | < string > array |
IpSetSummary
| Name | Description | Schema |
|---|---|---|
| enable_country optional |
Source country enabled status. 0 = off, 1 = on. | integer |
| ip_set_desc optional |
Optional policy description. | string |
| ip_set_id optional |
IP set ID. | string |
| ip_set_name optional |
Policy name. | string |
| ip_type optional |
IP address family for the template, ipv4 or ipv6. | enum (ipv4, ipv6) |
| source_countries optional |
String array of country or region codes for geo-based allow-list matching. Each item is one code (e.g. ISO 3166-1 alpha-2 such as US, CN; product-specific region codes may apply). | < enum (AF, AP, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RS, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TH, BS, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, PS, EH, YE, ZM, ZW) > array |
| source_ips optional |
List of source IPv4/IPv6 addresses or CIDR prefixes for this list. | < string > array |
| src_country_count optional |
integer | |
| src_ip_count optional |
integer |
NtifPolicy
Network Threat Intelligence Feed categories and actions. Not supported for IPv6.
| Name | Description | Schema |
|---|---|---|
| anonymizer optional |
Anonymizer / proxy NTIF subgroups. | anonymizer |
| botnet optional |
Botnet-related NTIF subgroups. | botnet |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Schema |
|---|---|
| proxy optional |
proxy |
| tor optional |
tor |
| Name | Description | Schema |
|---|---|---|
| action optional |
Mitigation action (e.g. off, monitor, drop). Allowed values: 0, 1, 2. | integer |
| Name | Description | Schema |
|---|---|---|
| action optional |
Mitigation action (e.g. off, monitor, drop). Allowed values: 0, 1, 2. | integer |
| Name | Schema |
|---|---|
| dark_spider optional |
dark_spider |
| ddos optional |
ddos |
| malware optional |
malware |
| reputation optional |
reputation |
| scanner optional |
scanner |
| spam optional |
spam |
| Name | Description | Schema |
|---|---|---|
| action optional |
Mitigation action (e.g. off, monitor, drop). Allowed values: 0, 1, 2. | integer |
| Name | Description | Schema |
|---|---|---|
| action optional |
Mitigation action (e.g. off, monitor, drop). Allowed values: 0, 1, 2. | integer |
| Name | Description | Schema |
|---|---|---|
| action optional |
Mitigation action (e.g. off, monitor, drop). Allowed values: 0, 1, 2. | integer |
| Name | Description | Schema |
|---|---|---|
| action optional |
Mitigation action (e.g. off, monitor, drop). Allowed values: 0, 1, 2. | integer |
| Name | Description | Schema |
|---|---|---|
| action optional |
Mitigation action (e.g. off, monitor, drop). Allowed values: 0, 1, 2. | integer |
| Name | Description | Schema |
|---|---|---|
| action optional |
Mitigation action (e.g. off, monitor, drop). Allowed values: 0, 1, 2. | integer |
NtifPolicyInput
NTIF policy incremental update payload. Include only fields or sub-objects to change; omitted fields are preserved. Not supported for IPv6.
| Name | Description | Schema |
|---|---|---|
| anonymizer optional |
Anonymizer / proxy NTIF subgroups. | anonymizer |
| botnet optional |
Botnet-related NTIF subgroups. | botnet |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| Name | Schema |
|---|---|
| proxy optional |
proxy |
| tor optional |
tor |
| Name | Description | Schema |
|---|---|---|
| action optional |
Mitigation action (e.g. off, monitor, drop). Allowed values: 0, 1, 2. | integer |
| Name | Description | Schema |
|---|---|---|
| action optional |
Mitigation action (e.g. off, monitor, drop). Allowed values: 0, 1, 2. | integer |
| Name | Schema |
|---|---|
| dark_spider optional |
dark_spider |
| ddos optional |
ddos |
| malware optional |
malware |
| reputation optional |
reputation |
| scanner optional |
scanner |
| spam optional |
spam |
| Name | Description | Schema |
|---|---|---|
| action optional |
Mitigation action (e.g. off, monitor, drop). Allowed values: 0, 1, 2. | integer |
| Name | Description | Schema |
|---|---|---|
| action optional |
Mitigation action (e.g. off, monitor, drop). Allowed values: 0, 1, 2. | integer |
| Name | Description | Schema |
|---|---|---|
| action optional |
Mitigation action (e.g. off, monitor, drop). Allowed values: 0, 1, 2. | integer |
| Name | Description | Schema |
|---|---|---|
| action optional |
Mitigation action (e.g. off, monitor, drop). Allowed values: 0, 1, 2. | integer |
| Name | Description | Schema |
|---|---|---|
| action optional |
Mitigation action (e.g. off, monitor, drop). Allowed values: 0, 1, 2. | integer |
| Name | Description | Schema |
|---|---|---|
| action optional |
Mitigation action (e.g. off, monitor, drop). Allowed values: 0, 1, 2. | integer |
PayloadFilter
Advanced payload filtering rule.
| Name | Description | Schema |
|---|---|---|
| action optional |
An action will be taken when they match. Allowed values: ratelimit, pass, drop. | enum (ratelimit, pass, drop) |
| bps_limit optional |
ratelimit in bps. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| filter_id required |
Unique identifier of advanced rule. | string |
| filter_name optional |
The name of the policies. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| payload_string optional |
The string of the payload. | < string > array |
| port optional |
The lists of the port numbers. | < integer > array |
| pps_limit optional |
ratelimit in pps. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| protocol optional |
The protocol of the data packet. Allowed values: tcp, udp, ip, any. | enum (tcp, udp, ip, any) |
PayloadFilterInput
Payload filter rule create/update payload.
| Name | Description | Schema |
|---|---|---|
| action required |
An action will be taken when they match. Allowed values: ratelimit, pass, drop. | enum (ratelimit, pass, drop) |
| bps_limit optional |
ratelimit in bps. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| filter_name required |
The name of the policies. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| payload_string optional |
The string of the payload. | < string > array |
| port optional |
The lists of the port numbers. | < integer > array |
| pps_limit optional |
ratelimit in pps. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| protocol optional |
The protocol of the data packet. Allowed values: tcp, udp, ip, any. | enum (tcp, udp, ip, any) |
QuicFilter
QUIC Filter configuration.
| Name | Description | Schema |
|---|---|---|
| filter_description optional |
Filter description, length 0-100 characters. | string |
| filter_id optional |
Filter Profile ID. Can be obtained by invoking this API for profile_id. | string |
| filter_name optional |
Filter name,contain only letters, digits, underscore and hyphen, length 1-40 characters. | string |
| filter_port optional |
TCP Port list. | < integer > array |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| malformed optional |
QUIC Malformed Packet Detection configuration. | malformed |
| protect optional |
QUIC Session Protection configuration. | protect |
| traffic_rate_limit optional |
QUIC Ratelimit Module configuration | traffic_rate_limit |
| Name | Description | Schema |
|---|---|---|
| handshake_min_len optional |
Minimum length (bytes) for handshake packets, range in (12-65535). | integer |
| initial_min_len optional |
Minimum length (bytes) for initial packets, range in (1200-65535). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = drop. |
integer |
| support_version optional |
Supported QUIC versions:[‘v1’, ‘v2’, ‘draft27’,‘draft28’,‘draft29’,‘draft30’,‘draft31’,‘draft32’,‘draft33’,‘draft34’] | < string > array |
| version_negotiation_min_len optional |
Minimum length (bytes) for version negotiation packets, range in (12-65535). | integer |
| zero_rtt_min_len optional |
Minimum length (bytes) for 0-RTT packets, range in (12-65535). | integer |
| Name | Description | Schema |
|---|---|---|
| 0rtt_replay_attack_protection optional |
0-RTT replay attack protection configuration | 0rtt_replay_attack_protection |
| authentication optional |
Authentication configuration. | authentication |
| five_tuple_session optional |
Ratelimit (Per Session) Module configuration. | five_tuple_session |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| new_session_limit optional |
Session (Per source IP) Module configuration. | new_session_limit |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range in (1-300). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = rate limit, 2 = block. |
integer |
| packet_per_second optional |
Packets per second threshold, range in (1-65535). | integer |
| Name | Description | Schema |
|---|---|---|
| mode optional |
Authentication mode. Values: 0 = ‘Retransmission’, 1 = ‘Retry + Token’. |
integer |
| session_scope optional |
Session scope. 0 means ‘New Session Only’, 1 means ‘New andExisting Session’. | integer |
| Name | Description | Schema |
|---|---|---|
| check_time optional |
Session check interval (seconds), range in (20-40). | integer |
| idle_session_timeout optional |
Idle session timeout (seconds), range in (60-600). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = low level, 2 = medium level, 3 = high level. |
integer |
| Name | Description | Schema |
|---|---|---|
| action_duration optional |
Block duration (seconds), range in (1-300). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| max_new_session optional |
Maximum new sessions per time range, range in (1-65535). | integer |
| max_new_session_time_range optional |
Time range (seconds), range in (1-65535). | integer |
| Name | Description | Schema |
|---|---|---|
| bandwidth optional |
Bandwidth limit (Mbps), range in (1-4095). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| packets optional |
Packet rate limit (pps), range in (1-1000000). | integer |
QuicFilterInput
QuicFilter create payload.
| Name | Description | Schema |
|---|---|---|
| filter_description optional |
Filter description, length 0-100 characters. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| filter_name required |
Filter name; letters, digits, underscore, hyphen, period, and space; length 1-40 characters. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| filter_port required |
UDP Port list. | < integer > array |
QuicFilterV2
QUIC Filter configuration.
| Name | Description | Schema |
|---|---|---|
| filter_description optional |
Filter description, length 0-100 characters. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| filter_id optional |
Filter Profile ID. Returned in GET responses. Optional in update request bodies; use the path parameter instead. Length : 1 - 40 |
string |
| filter_name optional |
Filter name; letters, digits, underscore, hyphen, period, and space; length 1-40 characters. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| filter_port optional |
UDP Port list. | < integer > array |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| malformed optional |
QUIC Malformed Packet Detection configuration. | malformed |
| quic_flood_protection optional |
QUIC Session Protection configuration | quic_flood_protection |
| quic_ratelimit optional |
QUIC Ratelimit Module configuration | quic_ratelimit |
| Name | Description | Schema |
|---|---|---|
| handshake_min_len optional |
Minimum length (bytes) for handshake packets, range (10-65535). Minimum value : 10 Maximum value : 65535 |
integer |
| initial_min_len optional |
Minimum length (bytes) for initial packets, range (1200-65535). Minimum value : 1200 Maximum value : 65535 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = drop. |
integer |
| support_version optional |
Supported QUIC versions:[‘all’,‘v1’, ‘v2’, ‘draft27’,‘draft28’,‘draft29’,‘draft30’,‘draft31’,‘draft32’,‘draft33’,‘draft34’]. | < enum (all, v1, v2, draft27, draft28, draft29, draft30, draft31, draft32, draft33, draft34) > array |
| version_negotiation_min_len optional |
Minimum length (bytes) for version negotiation packets, range (12-65535). Minimum value : 12 Maximum value : 65535 |
integer |
| zero_rtt_min_len optional |
Minimum length (bytes) for 0-RTT packets, range (10-65535). Minimum value : 10 Maximum value : 65535 |
integer |
| Name | Description | Schema |
|---|---|---|
| 0rtt_replay_attack_protection optional |
0-RTT replay attack protection configuration. | 0rtt_replay_attack_protection |
| authentication optional |
Authentication configuration. | authentication |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| new_session_per_source_ip optional |
Session (Per source IP) Module configuration | new_session_per_source_ip |
| ratelimit_per_session optional |
Ratelimit (Per Session) Module configuration. | ratelimit_per_session |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (1-300). Minimum value : 1 Maximum value : 300 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = rate limit, 2 = block. |
integer |
| packet_per_second optional |
Packets per second threshold, range (1-65535). Minimum value : 1 Maximum value : 65535 |
integer |
| Name | Description | Schema |
|---|---|---|
| mode optional |
Authentication mode. Values: 0 = ‘Retransmission’, 1 = ‘Retry + Token’. |
integer |
| session_scope optional |
Session scope. 0 means ‘New Session Only’, 1 means ‘New andExisting Session’. | integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (1-300) Minimum value : 1 Maximum value : 300 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| new_session_per_second optional |
New sessions per second, range (1-65535) Minimum value : 1 Maximum value : 65535 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = low level, 2 = medium level, 3 = high level. |
integer |
| session_check_duration optional |
Session check duration (seconds), range (20-40) Minimum value : 20 Maximum value : 40 |
integer |
| session_timeout optional |
Idle session timeout (seconds), range (60-600) Minimum value : 60 Maximum value : 600 |
integer |
| Name | Description | Schema |
|---|---|---|
| bandwidth optional |
Bandwidth limit (Mbps), range (1-4095). Minimum value : 1 Maximum value : 4095 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| packets optional |
Packet rate limit (pps), range (1-1000000). Minimum value : 1 Maximum value : 1000000 |
integer |
Result
The returned result.
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
Result data. | object |
SipFilter
SIP Filter configuration.
| Name | Description | Schema |
|---|---|---|
| connection_protect optional |
SIP Connection protection configuration. | connection_protect |
| filter_description optional |
Filter description, length 0-100 characters. | string |
| filter_id optional |
Filter Profile ID. Can be obtained by invoking this API for profile_id. | string |
| filter_name optional |
Filter name,contain only letters, digits, underscore and hyphen, length 1-40 characters. | string |
| filter_tcp_port optional |
TCP Port list. | < integer > array |
| filter_udp_port optional |
UDP Port list. | < integer > array |
| invite optional |
SIP INVITE message configuration | invite |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| malformed_is_enabled optional |
SIP Malformed enable status. Values: 0 = off, 1 = drop. |
integer |
| register optional |
SIP REGISTER Requst message configuration | register |
| retransmission_is_enabled optional |
UDP Retransmission Authentication enable status. Values: 0 = off, 1 = drop. |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| src_ip_avg_window_size_threshold optional |
Source IP average window size threshold. | src_ip_avg_window_size_threshold |
| src_ip_connection_rate optional |
Source IP connection rate limiting | src_ip_connection_rate |
| src_ip_half_open_rate optional |
Source IP half-open connection rate limiting. | src_ip_half_open_rate |
| src_ip_idle_connection_rate optional |
Source IP idle connection rate limiting. | src_ip_idle_connection_rate |
| total_connection_rate optional |
Total connection rate limiting. | total_connection_rate |
src_ip_avg_window_size_threshold
| Name | Description | Schema |
|---|---|---|
| banned_period optional |
Block duration (seconds), range in (10-60). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = block. |
integer |
| session_per_second optional |
Sessions per second,range in (1-65535). | integer |
| Name | Description | Schema |
|---|---|---|
| banned_period optional |
Block duration (seconds), range in (10-600). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| session_per_second optional |
New connections per second,range in (5-1000). | integer |
| Name | Description | Schema |
|---|---|---|
| banned_period optional |
Block duration (seconds), range in (10-600). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| session_per_second optional |
Half-open connections per second,range in (5-1000). | integer |
| Name | Description | Schema |
|---|---|---|
| banned_period optional |
Block duration (seconds), range in (10-600). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| session_per_second optional |
Idle connections per second,range in (5-1000). | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit. |
integer |
| session_per_second optional |
Sessions per second,range in (100-4294967295). | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = rate limit. |
integer |
| tcp optional |
TCP message size limit, range in (1-1000000). | integer |
| udp optional |
UDP message size limit, range in (1-1000000). | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = rate limit. |
integer |
| tcp optional |
TCP message size limit, range in (1-1000000). | integer |
| udp optional |
UDP message size limit, range in (1-1000000). | integer |
SipFilterInput
SipFilter create payload. At least one of filter_tcp_port or filter_udp_port is required.
| Name | Description | Schema |
|---|---|---|
| filter_description optional |
Filter description, length 0-100 characters. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| filter_name required |
Filter name; letters, digits, underscore, hyphen, period, and space; length 1-40 characters. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| filter_tcp_port optional |
TCP Port list. At least one of filter_tcp_port or filter_udp_port is required; when present, must be non-empty. | < integer > array |
| filter_udp_port optional |
UDP Port list. At least one of filter_tcp_port or filter_udp_port is required; when present, must be non-empty. | < integer > array |
SipFilterV2
SIP Filter configuration.
| Name | Description | Schema |
|---|---|---|
| filter_description optional |
Filter description, length 0-100 characters. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| filter_id optional |
Filter Profile ID. Returned in GET responses. Optional in update request bodies; use the path parameter instead. | string |
| filter_name optional |
Filter name; letters, digits, underscore, hyphen, period, and space; length 1-40 characters. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| filter_tcp_port optional |
TCP Port list. At least one of filter_tcp_port or filter_udp_port is required; when present, must be non-empty. | < integer > array |
| filter_udp_port optional |
UDP Port list. At least one of filter_tcp_port or filter_udp_port is required; when present, must be non-empty. | < integer > array |
| invite optional |
SIP INVITE message configuration. | invite |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| malformed_is_enabled optional |
SIP Malformed enable status. Values: 0 = off, 1 = drop. |
integer |
| register optional |
SIP REGISTER Requst message configuration. | register |
| retransmission_is_enabled optional |
UDP Retransmission Authentication enable status. Values: 0 = off, 1 = drop. |
integer |
| tcp_connection optional |
TCP Connection protection configuration | tcp_connection |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = rate limit. |
integer |
| tcp optional |
TCP message size limit, range (1-1000000). Minimum value : 1 Maximum value : 1000000 |
integer |
| udp optional |
UDP message size limit, range (1-1000000). Minimum value : 1 Maximum value : 1000000 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = rate limit. |
integer |
| tcp optional |
TCP message size limit, range (1-1000000). Minimum value : 1 Maximum value : 1000000 |
integer |
| udp optional |
UDP message size limit, range (1-1000000). Minimum value : 1 Maximum value : 1000000 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| slow_rate_connection optional |
Source IP average window size threshold | slow_rate_connection |
| source_ip_half_open_connection optional |
Source IP half-open connection rate limiting | source_ip_half_open_connection |
| source_ip_idle_connection optional |
Source IP idle connection rate limiting | source_ip_idle_connection |
| source_ip_new_connection optional |
Source IP connection rate limiting | source_ip_new_connection |
| total_connection optional |
Total connection rate limiting | total_connection |
| Name | Description | Schema |
|---|---|---|
| avg_window_size optional |
Sessions per second, range (1-65535) Minimum value : 1 Maximum value : 65535 |
integer |
| block_duration optional |
Block duration (seconds), range (10-60) Minimum value : 10 Maximum value : 60 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = block. |
integer |
source_ip_half_open_connection
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| half_open_connection_per_second optional |
Half-open connections per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| idle_connection_per_second optional |
Idle connections per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| new_connection_per_second optional |
New connections per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit. |
integer |
| total_connection_per_second optional |
Sessions per second, range (100-4294967295) Minimum value : 100 Maximum value : 4294967295 |
integer |
SmartFilterPolicy
Smart filter policy.
| Name | Description | Schema |
|---|---|---|
| amplification optional |
Amplification. | integer |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| threat_intelligence optional |
Threat intelligence. | integer |
| traffic_generator optional |
Traffic generator. | integer |
SmartFilterPolicyInput
Incremental smart filter policy update. Include only fields to change; omitted fields are preserved.
| Name | Description | Schema |
|---|---|---|
| amplification optional |
Amplification. | integer |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| threat_intelligence optional |
Threat intelligence. | integer |
| traffic_generator optional |
Traffic generator. | integer |
TlsFilter
SSL/TLS Filter configuration.
| Name | Description | Schema |
|---|---|---|
| connection_protect optional |
Connection protection configuration. | connection_protect |
| filter_description optional |
Filter description, length 0-100 characters. | string |
| filter_id optional |
Filter Profile ID. Can be obtained by invoking this API for profile_id. | string |
| filter_name optional |
Filter name,contain only letters, digits, underscore and hyphen, length 1-40 characters. | string |
| filter_port optional |
TCP Port list | < integer > array |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| malformed optional |
SSL/TLS Malformed Packet Detection configuration. | malformed |
| renegotiation optional |
SSL/TLS Renegotiation configuration. | renegotiation |
| session optional |
SSL/TLS Session configuration. | session |
| traffic_shaping optional |
SSL/TLS Ratelimit (Per Profile) configuration. | traffic_shaping |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Connection protection enable status. Values: 0 = off, 1 = on. |
integer |
| src_ip_avg_window_size_threshold optional |
Source IP average window size threshold. | src_ip_avg_window_size_threshold |
| src_ip_connection_rate optional |
Source IP connection rate limiting. | src_ip_connection_rate |
| src_ip_half_open_rate optional |
Source IP half-open connection rate limiting. | src_ip_half_open_rate |
| src_ip_idle_connection_rate optional |
Source IP idle connection rate limiting. | src_ip_idle_connection_rate |
| total_connection_rate optional |
Total connection rate limiting. | total_connection_rate |
src_ip_avg_window_size_threshold
| Name | Description | Schema |
|---|---|---|
| banned_period optional |
Ban duration (seconds), range in (10-60). | integer |
| is_enabled optional |
Source IP average window size threshold enable status. Values: 0 = off, 1 = monitor, 2 = block. |
integer |
| session_per_second optional |
Sessions per second,range in (1-65535). | integer |
| Name | Description | Schema |
|---|---|---|
| banned_period optional |
Ban duration (seconds), range in (10-600). | integer |
| is_enabled optional |
Source IP connection rate limiting enable status. Values: 0 = off, 1 = on. |
integer |
| session_per_second optional |
Sessions per second,range in (5-1000). | integer |
| Name | Description | Schema |
|---|---|---|
| banned_period optional |
Ban duration (seconds), range in (10-600). | integer |
| is_enabled optional |
Source IP half-open connection rate limiting enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| session_per_second optional |
Sessions per second,range in (5-1000). | integer |
| Name | Description | Schema |
|---|---|---|
| banned_period optional |
Ban duration (seconds), range in (10-600). | integer |
| is_enabled optional |
Source IP idle connection rate limiting enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| session_per_second optional |
Sessions per second,range in (5-1000). | integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Total connection rate limiting enable status. Values: 0 = off, 1 = monitor, 2 = rate limit. |
integer |
| session_per_second optional |
Sessions per second,range in (100-4294967295). | integer |
| Name | Description | Schema |
|---|---|---|
| clienthello_length_limit_non_v_1_3 optional |
ClientHello length (bytes) limit for non-TLS 1.3, range in (64-1400). | integer |
| clienthello_length_limit_v_1_3 optional |
ClientHello length (bytes) limit for TLS 1.3, range in (64-1400). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| Name | Description | Schema |
|---|---|---|
| blocklist_duration optional |
Blocklist duration (seconds), range in (1-65535). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = drop. |
integer |
| Name | Description | Schema |
|---|---|---|
| build_banned_period optional |
Block duration (seconds), range in (1-300). | integer |
| build_threshold optional |
New session per second, range in (1-65535). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = block. |
integer |
| Name | Description | Schema |
|---|---|---|
| non_tls optional |
Ratelimit for non TLS1.2 and TLS1.3 traffic. | non_tls |
| tls optional |
Ratelimit for TLS1.2 and TLS1.3 traffic. | tls |
| Name | Description | Schema |
|---|---|---|
| bandwidth optional |
Bandwidth limit (Mbps), range in (1-4095). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| packet optional |
Packet rate limit (pps), range in (1-1000000). | integer |
| Name | Description | Schema |
|---|---|---|
| bandwidth optional |
Bandwidth limit (Mbps), range in (1-4095). | integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| packet optional |
Packet rate limit (pps), range in (1-1000000). | integer |
TlsFilterInput
TlsFilter create payload.
| Name | Description | Schema |
|---|---|---|
| filter_description optional |
Filter description, length 0-100 characters. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| filter_name required |
Filter name; letters, digits, underscore, hyphen, period, and space; length 1-40 characters. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| filter_port required |
TCP Port list. | < integer > array |
TlsFilterV2
SSL/TLS Filter configuration.
| Name | Description | Schema |
|---|---|---|
| filter_description optional |
Filter description, length 0-100 characters. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| filter_id optional |
Filter Profile ID. Returned in GET responses. Optional in update request bodies; use the path parameter instead. | string |
| filter_name optional |
Filter name; letters, digits, underscore, hyphen, period, and space; length 1-40 characters. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ .-]+$" |
string |
| filter_port optional |
TCP Port list. | < integer > array |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| malformed optional |
SSL/TLS Malformed Packet Detection configuration. | malformed |
| ratelimit optional |
SSL/TLS Ratelimit (Per Profile) configuration | ratelimit |
| renegotiation optional |
SSL/TLS Renegotiation configuration. | renegotiation |
| session optional |
SSL/TLS Session configuration. | session |
| tcp_connection optional |
Connection protection configuration | tcp_connection |
| Name | Description | Schema |
|---|---|---|
| clienthello_length_limit_non_v_1_3 optional |
ClientHello length (bytes) limit for non-TLS 1.3, range (64-1400). Minimum value : 64 Maximum value : 1400 |
integer |
| clienthello_length_limit_v_1_3 optional |
ClientHello length (bytes) limit for TLS 1.3, range (64-1400). Minimum value : 64 Maximum value : 1400 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| Name | Description | Schema |
|---|---|---|
| non_tls optional |
Ratelimit for non TLS1.2 and TLS1.3 traffic. | non_tls |
| tls optional |
Ratelimit for TLS1.2 and TLS1.3 traffic. | tls |
| Name | Description | Schema |
|---|---|---|
| bandwidth optional |
Bandwidth limit (Mbps), range (1-4095). Minimum value : 1 Maximum value : 4095 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| packet optional |
Packet rate limit (pps), range (1-1000000). Minimum value : 1 Maximum value : 1000000 |
integer |
| Name | Description | Schema |
|---|---|---|
| bandwidth optional |
Bandwidth limit (Mbps), range (1-4095). Minimum value : 1 Maximum value : 4095 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = on. |
integer |
| packet optional |
Packet rate limit (pps), range (1-1000000). Minimum value : 1 Maximum value : 1000000 |
integer |
| Name | Description | Schema |
|---|---|---|
| blocklist_duration optional |
Blocklist duration (seconds), range (1-65535). Minimum value : 1 Maximum value : 65535 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = drop. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Block duration (seconds), range (1-300) Minimum value : 1 Maximum value : 300 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = block. |
integer |
| new_session_per_second optional |
New session per second, range (1-65535) Minimum value : 1 Maximum value : 65535 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Connection protection enable status. Values: 0 = off, 1 = on. |
integer |
| slow_rate_connection optional |
This rule checks for slow rate connections from the same source IP address | slow_rate_connection |
| source_ip_half_open_connection optional |
Source IP half-open connection rate limiting | source_ip_half_open_connection |
| source_ip_idle_connection optional |
Source IP idle connection rate limiting | source_ip_idle_connection |
| source_ip_new_connection optional |
Source IP connection rate limiting | source_ip_new_connection |
| total_connection optional |
Total connection rate limiting | total_connection |
| Name | Description | Schema |
|---|---|---|
| avg_window_size optional |
Average window Size (bytes), range (1-65535) Minimum value : 1 Maximum value : 65535 |
integer |
| block_duration optional |
Ban duration (seconds), range (10-60). Minimum value : 10 Maximum value : 60 |
integer |
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = block. |
integer |
source_ip_half_open_connection
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Ban duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| half_open_connection_per_second optional |
Sessions per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| is_enabled optional |
Source IP half-open connection rate limiting enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Ban duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| idle_connection_per_second optional |
Sessions per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| is_enabled optional |
Source IP idle connection rate limiting enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Ban duration (seconds), range (10-600) Minimum value : 10 Maximum value : 600 |
integer |
| is_enabled optional |
Source IP connection rate limiting enable status. Values: 0 = off, 1 = monitor, 2 = rate limit, 3 = block. |
integer |
| new_connection_per_second optional |
Sessions per second, range (5-1000) Minimum value : 5 Maximum value : 1000 |
integer |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
Enable status. Values: 0 = off, 1 = monitor, 2 = rate limit. |
integer |
| total_connection_per_second optional |
Sessions per second, range (100-4294967295) Minimum value : 100 Maximum value : 4294967295 |
integer |
TrafficPolicingPolicy
Traffic policing cap (bps/pps) for the host.
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| threshold_bps optional |
Trigger threshold in bps (string with optional K/M/G). Plain or K/M suffix: 1-4000000000; G suffix: 1G-4G only (e.g. 1K, 2 M, 4G, 4 G). Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| threshold_pps optional |
Trigger threshold in pps (string with optional K/M/G). Plain or K/M suffix: 1-4000000000; G suffix: 1G-4G only (e.g. 1K, 2 M, 4G, 4 G). Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
TrafficPolicingPolicyInput
Traffic policing cap incremental update payload. Include only fields to change; omitted fields are preserved.
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| threshold_bps optional |
Trigger threshold in bps (string with optional K/M/G). Plain or K/M suffix: 1-4000000000; G suffix: 1G-4G only (e.g. 1K, 2 M, 4G, 4 G). Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| threshold_pps optional |
Trigger threshold in pps (string with optional K/M/G). Plain or K/M suffix: 1-4000000000; G suffix: 1G-4G only (e.g. 1K, 2 M, 4G, 4 G). Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
ZombiePolicy
Zombie host detection (host vs network scope). Not supported for IPv6.
| Name | Description | Schema |
|---|---|---|
| flex_zombie optional |
Flex zombie rules attached to the profile. | < FlexZombieRule > array |
| is_enabled optional |
0 = off, 1 = on . | integer |
| zombie_host optional |
Per-host zombie thresholds and action. | zombie_host |
| zombie_network optional |
Per-network zombie thresholds and action. | zombie_network |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Blocklist duration in seconds after a trigger. Minimum value : 10 Maximum value : 120 |
integer |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| mode optional |
Mitigation action (e.g. ratelimit, block). | enum (ratelimit, block) |
| threshold_bps optional |
Trigger threshold in bps (string with optional K/M/G). Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| threshold_pps optional |
Trigger threshold in pps (string with optional K/M/G). Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Blocklist duration in seconds after a trigger. Minimum value : 10 Maximum value : 120 |
integer |
| is_enabled optional |
0 = off, 1 = on . | integer |
| mode optional |
Mitigation action (e.g. ratelimit, block). | enum (ratelimit, block) |
| threshold_bps optional |
Trigger threshold in bps (string with optional K/M/G). Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| threshold_pps optional |
Trigger threshold in pps (string with optional K/M/G). Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
ZombiePolicyInput
Zombie host detection policy incremental update payload. Include only fields or sub-objects to change; omitted fields are preserved. Flex zombie rules are managed via flex-zombie CRUD APIs; do not include flex_zombie in this request.
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 = off, 1 = on . | integer |
| zombie_host optional |
Per-host zombie thresholds and action. | zombie_host |
| zombie_network optional |
Per-network zombie thresholds and action. | zombie_network |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Blocklist duration in seconds after a trigger. Minimum value : 10 Maximum value : 120 |
integer |
| is_enabled optional |
0 = disabled, 1 = enabled. | integer |
| mode optional |
Mitigation action (e.g. ratelimit, block). | enum (ratelimit, block) |
| threshold_bps optional |
Trigger threshold in bps (string with optional K/M/G). Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| threshold_pps optional |
Trigger threshold in pps (string with optional K/M/G). Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| Name | Description | Schema |
|---|---|---|
| block_duration optional |
Blocklist duration in seconds after a trigger. Minimum value : 10 Maximum value : 120 |
integer |
| is_enabled optional |
0 = off, 1 = on . | integer |
| mode optional |
Mitigation action (e.g. ratelimit, block). | enum (ratelimit, block) |
| threshold_bps optional |
Trigger threshold in bps (string with optional K/M/G). Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| threshold_pps optional |
Trigger threshold in pps (string with optional K/M/G). Plain or K/M: 1-4000000000; G suffix: 1G-4G only. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
Security
ApiKeyAuth
Type : apiKey
Name : access_token
In : QUERY