Methods

April 17, 2024

ID 206494

The Kaspersky DDoS Protection API provides the following methods for working with the System:

add_fine – charge fines to IP addresses

add_ip – add an IP address to the list of allowed or denied IP addresses.

add_ip_list – add a set of IP addresses to the list of allowed or denied IP addresses.

attack_active_list – get a list of all active attacks being conducted against Customer's Protected resources.

bwl_add_ipranges – add an IP address to the list of allowed or denied IP addresses

bwl_clear – clear a list of allowed or denied IP addresses

bwl_clear_list – clear a list of allowed or denied IP addresses

bwl_delete_ipranges – delete a set of IP addresses from the list of allowed or denied IP addresses.

bwl_list_v2 – display a list of allowed and denied IP addresses for a resource

bwl_show_ipranges – display a list of allowed and denied IP addresses

client_attack_list – display a list of only active attacks or all attacks during a certain period of time

client_resource_list – display a list of Customer's Protected resources

delete_ip – delete an IP address from the list of allowed or denied IP addresses.

delete_ip_list – delete a set of IP addresses from the list of allowed or denied IP addresses.

echo – verify authentication and text encoding operations.

get_api_version – get the current version of the API server and operating mode.

get_client_ips_geo_data – display data about IP addresses of clients who accessed the resource over a time period and their geo-properties

get_measured_parameter_data – get an array of all values of measured parameters configured for the specific Protected resource that are visible to the Customer.

get_measured_parameter_list – get a list of the measured parameters configured for the specific Protected resource that are visible to the Customer.

get_protocol_ratio – get the ratio of protocols in traffic for each minute of the specified interval.

get_resource_anomaly_list – get a list of anomalies in measured parameters configured for the specific Protected resource that are visible to the Customer

get_resource_geo_ratio – geographic distribution of traffic during the last 5 minutes.

get_resource_new_ip_blocks – get the number of new blockings of IP addresses for each minute of the specified interval.

ping – verify communication (correct operation) of transport between the Customer and the API.

resource_interface_distribution_show – get the distribution of traffic among interfaces of the Sensor for the specified period

show_active_blocks – display a list of currently blocked IP addresses

show_blocks_on_attack – display a list of IP addresses blocked by scrubbing facilities during an attack

show_resource_ip_status – get the status of the IP address on the specific Protected resource at the current time

Did you find this article helpful?
What can we do better?
Thank you for your feedback! You're helping us improve.
Thank you for your feedback! You're helping us improve.