Auto Mitigation
Site
Overview
Origin Protection Auto Mitigation API
Version information
Version : 1.0.0.BETA
License information
Terms of service : https://www.nexusguard.com/
URI scheme
Host : api.nexusguard.com
BasePath : /api
Schemes : HTTPS
Paths
Edits the profile name of the auto mitigation.
POST /specp/op/site/{site_id}/auto-mitigation/profile/{profile_id}
Description
Edits the profile name of the auto mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | profile_id required |
Unique identifier of a profile. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | profile_name required |
The name of the profile. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Gets the profile info of auto mitigation.
GET /specp/op/site/{site_id}/auto-mitigation/profile/{profile_id}
Description
Gets the profile info of auto mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | profile_id required |
Unique identifier of a profile. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the 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 | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| profile_id optional |
Unique identifier of a profile. | string |
| profile_name optional |
The name of the profile. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Deletes the profile for auto mitigation.
DELETE /specp/op/site/{site_id}/auto-mitigation/profile/{profile_id}
Description
Deletes the profile for auto mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | profile_id required |
Unique identifier of a profile. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Clones the profile of auto mitigation.
POST /specp/op/site/{site_id}/auto-mitigation/profile/{profile_id}/clone
Description
Clones the profile of auto mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | profile_id required |
Unique identifier of a profile. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get the profile list of auto mitigation.
GET /specp/op/site/{site_id}/auto-mitigation/profiles
Description
Get the profile list of auto mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | limit optional |
The page parameter. The default value of requesting the counts of index from the first index is 0,response code is 200.Response code will be 201 without default value.The max value of requesting the counts of index from the first index is 50. | integer |
| Query | start optional |
The default value of the first index of the page parameter value is 0. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| 201 | This is the returned result. | Response 201 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
< result > array |
| Name | Description | Schema |
|---|---|---|
| profile_id optional |
Unique identifier of a profile. | string |
| profile_name optional |
The name of the profile. | string |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| data optional |
< data > array | |
| limit optional |
Current page parameter value. | integer |
| start optional |
Current page parameter value. | integer |
| total optional |
Current site total | integer |
| Name | Description | Schema |
|---|---|---|
| profile_id optional |
Unique identifier of a profile. | string |
| profile_name optional |
The name of the profile. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Gets the info of FlexFilter/advanced payload filtering for mitigation.
GET /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/advanced-payload-filtering
Description
Gets the info of FlexFilter/advanced payload filtering for mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error 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 advanceed 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 the policies for the FlexFilter/advanced payload filtering.
POST /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/advanced-payload-filtering/filter
Description
Add the policies for the FlexFilter/advanced payload filtering.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | action required |
Action to take when a match is found. You can choose pass, drop and rateLimit.Selecting Rate Limit allows to define a limit of bandwidth all such data packets can use. | string |
| FormData | 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 |
| FormData | filter_name required |
The name of the policies created. | string |
| FormData | payload_string optional |
If the “payload_string_enabled” is switched on, the key word or phrase must be provided to be looked for in a payload. | < string > array |
| FormData | payload_string_enabled optional |
0 means the switch of the payload string is disabled whereas 1 means it is enabled. |
integer |
| FormData | port optional |
If the “port_enabled” is switched on, the port number either for the source or destination port of the data packet must be provided, with the exception of protocol is ‘ip’. | < integer > array |
| FormData | port_enabled optional |
0 means the port switch is disabled whereas 1 means it is enabled. |
integer |
| FormData | 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 |
| FormData | protocol optional |
If protocol_enabled is switched on, the type of protocol must be provided. Currently, tcp, udp and ip supported protocol for the data packet can be used. | string |
| FormData | protocol_enabled optional |
0 means the switch of the protocol is disabled whereas 1 means it is enabled. |
integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error 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
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Gets the info of policies for FlexFilter/advanced payload filtering for mitigation.
GET /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/advanced-payload-filtering/{filter_id}
Description
Gets the info of policies for FlexFilter/advanced payload filtering for mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | filter_id required |
Unique identifier of advanceed filter. | string |
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error 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 /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/advanced-payload-filtering/{filter_id}
Description
Edit FlexFilter/Advanced Payload Filtering.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | filter_id required |
Unique identifier of advanceed filter. | string |
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | 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 |
| FormData | 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 |
| FormData | filter_name required |
The name of the policies created. | string |
| FormData | 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 |
| FormData | payload_string_enabled optional |
0 means the switch for the payload string is disabled whereas 1 means it is enabled. |
integer |
| FormData | 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 |
| FormData | port_enabled optional |
0 means the port switch is disabled whereas 1 means it is enabled. |
integer |
| FormData | 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 |
| FormData | 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 |
| FormData | protocol_enabled optional |
0 means the switch for the protocol is disabled whereas 1 means it is enabled. |
integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete policies for FlexFilter/advanced payload filtering.
DELETE /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/advanced-payload-filtering/{filter_id}
Description
Delete policies for FlexFilter/advanced payload filtering.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | filter_id required |
Unique identifier of advanceed filter. | string |
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get the info of FlexFilter/basic network filtering for mitigation.
GET /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/basic-network-filtering
Description
Get the info of FlexFilter/basic network filtering for mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error 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 size of the data packet. | string |
| pps_limit optional |
ratelimit in pps. | string |
| protocol optional |
Protocol of the data packet. | integer |
| rule_desc optional |
More details about the purpose of the policy. | string |
| rule_id optional |
Unique identifier of custom rule. | integer |
| 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 rules for the FlexFilter/basic network filtering/ custom filters.
POST /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/basic-network-filtering/custom-filter
Description
Add rules for the FlexFilter/basic network filtering/ custom filters.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | 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 |
| FormData | 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 |
| FormData | dst_ip optional |
IP Address of the recipient. | < string > array |
| FormData | dst_port optional |
Port number to which the data packet is sent. | < integer > array |
| FormData | icmp_code optional |
When ICMP_type is 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 |
| FormData | icmp_type optional |
When the protocols value is required for ICMP, the value can be custom or from the filter_ICMP_type field that returns the result from config options. When custom, the range is an integer between 0 and 255. | string |
| FormData | package_length optional |
The size of the data packet. | < integer > array |
| FormData | 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 |
| FormData | protocol required |
Protocol of the data packet. Currently, tcp, udp and icmp are supported. | string |
| FormData | rule_desc optional |
More details about the purpose of the policy. | string |
| FormData | rule_name required |
The name of the policy created. | string |
| FormData | src_ip optional |
IP address of the sender, as it is shown in the data packet. | < string > array |
| FormData | src_port optional |
Port number from which the data packet is sent. | < integer > array |
| FormData | tcp_flags optional |
When the protocol is TCP, its value is retrieved from the filter_tcp_flags in the configuration options. | < string > array |
| FormData | 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 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| rule_id optional |
Rule ID, an unique identifier assigned to each FlexFilter Custom Filters. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get the info of the policy for flex filer/basic network filtering and custom filters for mitigation.
GET /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/basic-network-filtering/custom-filter/{rule_id}
Description
Get the info of the policy for flex filer/basic network filtering and custom filters for mitigation.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | rule_id required |
Unique identifier of custom rule. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error 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 size of the data packet. | < integer > array |
| pps_limit optional |
ratelimit in pps. | string |
| protocol optional |
Protocol of the data packet. | integer |
| rule_desc optional |
More details about the purpose of the policy. | string |
| rule_id optional |
Unique identifier of a policy. | integer |
| 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 the rules for FlexFilter/basic network filtering/custom filters.
PUT /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/basic-network-filtering/custom-filter/{rule_id}
Description
Edit the rules for FlexFilter/basic network filtering/custom filters.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | rule_id required |
Unique identifier of a rule. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | 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 |
| FormData | 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 |
| FormData | dst_ip optional |
IP Address of the recipient. | < string > array |
| FormData | dst_port optional |
Port number to which the data packet is sent. | < integer > array |
| FormData | icmp_code optional |
When ICMP_type is 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 |
| FormData | icmp_type optional |
When the protocols value is required for ICMP, the value can be custom or from the filter_ICMP_type field that returns the result from config options. When custom, the range is an integer between 0 and 255. | string |
| FormData | package_length optional |
The size of the data packet. | < integer > array |
| FormData | 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 |
| FormData | protocol required |
Protocol of the data packet. Currently, tcp, udp and icmp are supported. | string |
| FormData | rule_desc optional |
More details about the purpose of the policy. | string |
| FormData | rule_name required |
Unique identifier of a policy created. | string |
| FormData | src_ip optional |
IP address of the sender, as it is shown in the data packet. | < string > array |
| FormData | src_port optional |
Port number from which the data packet is sent. | < integer > array |
| FormData | tcp_flags optional |
When the protocol is TCP, its value is retrieved from the filter_tcp_flags in the configuration options. | < string > array |
| FormData | 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 sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Deletes FlexFilter/ basic network filtering/ custom filters.
DELETE /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/basic-network-filtering/custom-filter/{rule_id}
Description
Deletes FlexFilter/ basic network filtering/ custom filters.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | rule_id required |
Unique identifier of custom rule. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change the status of the switch of the FlexFilter/ basic network filtering/custom filters.
POST /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/basic-network-filtering/custom-filter/{rule_id}/switch
Description
Change the status of the switch of the FlexFilter/ basic network filtering/custom filters.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | rule_id required |
Unique identifier of custom rule. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | is_enabled required |
0 means the switch of basic network filtering is disabled whereas 1 means it is enabled. |
integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit the policy for the FlexFilter/filter sets.
POST /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/basic-network-filtering/filter-sets
Description
Edit the policy for the FlexFilter/filter sets.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | rule_set_id required |
Enter the rule id you want to add. | < string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Changes the status of the switch for the policies for FlexFilter/basic network filtering.
POST /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/basic-network-filtering/switch
Description
Changes the status of the switch for the policies for FlexFilter/basic network filtering.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | is_enabled required |
0 means the switch of the basic network filtering is disabled whereas 1 means it is enabled. |
integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
It is used to edit Traffic Policies.
POST /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/filter-policing
Description
It is used to edit Traffic Policies.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | 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 sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get auto mitigation traffic policing info.
GET /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/filter-policing
Description
Get auto mitigation traffic policing info.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| is_enabled optional |
0 means the auto 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 |
It is a switch to change the status of Traffic Policing/Filter Policing.
POST /specp/op/site/{site_id}/network/{network_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 | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | 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 sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get the info of the policy of ICMP flood.
GET /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/icmp-flood
Description
Get the info of the policy of ICMP flood.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error 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 filters for ICMP flood/Customizable protocol filters.
POST /specp/op/site/{site_id}/network/{network_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 | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | action required |
pass or ratelimit. | string |
| FormData | 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 |
| FormData | filter_name required |
The name of the filters. | string |
| FormData | icmp_length required |
The size of the data packet, must be 1-1500. | integer |
| FormData | icmp_type required |
The type of icmp, the value of “icmp_filter_types” is taken from configuration options. | integer |
| FormData | 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 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| filter_id optional |
Filter ID, an unique identifier assigned to each Custom ICMP Filter. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Gets the policies for the filters for ICMP flood/customizable ICMP.
GET /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/icmp-flood/icmp-filter/{filter_id}
Description
Gets the policies for the filters for ICMP flood/customizable ICMP.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | filter_id required |
Unique identifier of custom filter. | string |
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error 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 the policies of the filters for ICMP flood/Customizable protocol.
PUT /specp/op/site/{site_id}/network/{network_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 | filter_id required |
Unique identifier of custom filter. | string |
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | action required |
pass or ratelimit. | string |
| FormData | 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 |
| FormData | filter_name required |
The name of the filter. | string |
| FormData | icmp_length required |
The length of ICMP you can drop must range between 1 to 1500. | integer |
| FormData | icmp_type required |
The type of icmp, the value of “icmp_filter_types” is taken from configuration options. | integer |
| FormData | 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 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete the policies for the filter for ICMP flood/Customizable protocol.
DELETE /specp/op/site/{site_id}/network/{network_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 | filter_id required |
Unique identifier of custom filter. | string |
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Changes the status of the policy for ICMP flood.
POST /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/icmp-flood/switch
Description
Changes the status of the policy for ICMP flood.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | is_enabled required |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| FormData | module required |
The type of icmp flood includes icmp_fragmentation,custom_icmp_filter. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get the info of anti-flood and IP food.
GET /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/ip-flood
Description
Get the info of anti-flood and IP food.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| custom_protocol_filter optional |
The property of the customizable protocol filters. | custom_protocol_filter |
| 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 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 the policy for the customizable protocol filters.
POST /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/ip-flood/protocol
Description
Edit the policy for the customizable protocol filters.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | protocols required |
The value of “ip_protocol_number” you want to add is taken from the configuration options. | < integer > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Changes of the status of the policy for anti-flood/IP flood.
POST /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/ip-flood/switch
Description
Changes of the status of the policy for anti-flood/IP flood.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | is_enabled required |
0 means the switch for the policy for IP flood is disabled whereas 1 means it is enabled. |
integer |
| FormData | module required |
IP Flood type. in (ip_fragmentation,custom_protocol_filter). ip_fragmentation means it is IP Fragmentation and custom_protocol_filter means Custom Protocol Filter. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get the info of auto mitigation for TCP flood.
GET /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/tcp-flood
Description
Get the info of auto mitigation for TCP flood.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error 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. |
string |
| 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.
POST /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/tcp-flood/packets
Description
Edit TCP Flood/Malformed TCP packets.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | module required |
TCP flood/malformed TCP packets type. in (payload、option). | string |
| FormData | size required |
The size of string must range between 0 and 1500. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change the auto mitigation policy for TCP flood or malformed TCP packets.
POST /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/tcp-flood/packets/switch
Description
Change the auto mitigation policy for TCP flood or malformed TCP packets.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | is_enabled required |
0 means TCP flood switch is disabled whereas 1 mean it is 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 sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit TCP Flood/TCP rate limit.
POST /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/tcp-flood/rate-limit
Description
Edit TCP Flood/TCP rate limit.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | bps_limit required |
The ratelimit in bps.must be a number or K, M, G format. | string |
| FormData | pps_limit required |
The ratelimit in pps.must be a number or K, M, G format. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change the status of the policies for TCP flood.
POST /specp/op/site/{site_id}/network/{network_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 | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | is_enabled required |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
| FormData | module required |
The switch for the type of icmp flood includes tcp_rate_limit,tcp_fragmentation,tcp_syn_mss,tcp_syn_flood. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit TCP Flood/TCP SYN Flood.
POST /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/tcp-flood/syn-flood
Description
Edit TCP Flood/TCP SYN Flood.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | session_check_seconds optional |
The amount of time, in seconds, to wait before checking an SYN session. It is set to a value between 10 and 255. | integer |
| FormData | session_timeout_seconds optional |
The minimum time, in seconds, for the SYN-packet retransmission to consider the retransmission to be valid. It is set to a value between 60 and 600. | integer |
| FormData | strict_mode optional |
0 means the switch is disabled whereas 1 means it is enabled. |
integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit TCP Flood/TCP SYN MSS.
POST /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/tcp-flood/syn-mss
Description
Edit TCP Flood/TCP SYN MSS.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | size required |
The size of string must range between 34 and 1500. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Gets the info of the auto mitigation of TCP Flood.
GET /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/udp-flood
Description
Gets the info of the auto mitigation of TCP Flood.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error 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 the info of submodule of the UDP flood.
POST /specp/op/site/{site_id}/network/{network_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 & SNMP Amplification.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | bps_limit optional |
When the module is dns_query_rate_limit,udp_rate_limit or dns_response_rate_limit, the unit of rate limit must be K, M and 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, the unit of rate limit must be K, M and 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 sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change the auto mitigation policies for UDP flood submodule.
POST /specp/op/site/{site_id}/network/{network_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 | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | 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 sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change the auto mitigation policies for UDP flood.
POST /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/udp-flood/switch
Description
Change the auto mitigation policies for UDP flood.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | 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 sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit the policies for UDP flood/UDP zero data payload.
POST /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/udp-flood/zero-data-payload
Description
Edit the policies for UDP flood/UDP zero data payload.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | 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 sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
It is used to edit the filter for Zombie
POST /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/zombie
Description
It is used to edit the filter for Zombie
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
| FormData | action required |
ratelimit or blacklist. | string |
| FormData | blacklist_timeout required |
Blacklist timeout. | integer |
| 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 |
| FormData | zombie_type required |
Zombie level. zombie_host or zombie_network. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Gets the info of the policy for zombie.
GET /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/zombie
Description
Gets the info of the policy for zombie.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error 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 |
It is used to change the status of Zombie.
POST /specp/op/site/{site_id}/network/{network_id}/host/{host_id}/auto-mitigation/zombie/switch
Description
It is used to change the status of Zombie.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host. | string |
| Path | network_id required |
Unique identifier of a network. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | profile_id required |
Unique identifier of a profile. | 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 sent when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Definitions
Result
The returned result.
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
Security
ApiKeyAuth
Type : apiKey
Name : access_token
In : QUERY