Dashboard
Site
Overview
CleanPipe Protection Site 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
Get CleanPipe historical DDoS events by specifying timestamps.
GET /spe/customer/{customer_id}/cp/dashboard/ddos_events
Description
Retrieve CleanPipe historical DDoS events by selecting the time range.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | alert_id optional |
Unique identifier of a event. | string |
| Query | end_time optional |
End time, in 10-digit timestamp format. Default is the 31st day after the start time. The maximum span is 31 days. | string |
| Query | num optional |
Quantity. Default is 10. | string |
| Query | site_id optional |
Unique identifier of a site. Can be obtained by invoking this API for Cleanpipe Protection sites. | < string > array |
| Query | site_ip optional |
Site ip. | string |
| Query | site_name optional |
Site Name. | string |
| Query | start optional |
Starting position. Default is 0. | string |
| Query | start_time optional |
Start time, in 10-digit timestamp format. Default is the first day of the current month. | string |
| Query | status optional |
Event status: all/stopped/ongoing. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
Historical DDoS event list. | result |
| Name | Description | Schema |
|---|---|---|
| events optional |
< events > array | |
| total optional |
Total no. of alarms in the query range. | integer |
| Name | Description | Schema |
|---|---|---|
| alert_id optional |
Alert ID | string |
| attack_type optional |
Attack type | string |
| duration optional |
Alert duration, measured in seconds. | integer |
| end_time optional |
Alert’s end time, in 10-digit timestamp format. | integer |
| max_bps optional |
Max bps | integer |
| max_pps optional |
Max pps | integer |
| p_type optional |
Policy type: 0, Alert from Mitigation; 1, Alert from Auto Mitigation | integer |
| profile_desc optional |
Profile description | string |
| profile_name optional |
Profile name | string |
| severity optional |
Alert level: 1（Low); 2（High); 3（Medium); 4(Blackhole）. | integer |
| severity_level optional |
Level of severity: Alert or Auto Mitigation or Auto Blackhole. | string |
| site_ip optional |
Site IP | string |
| site_name optional |
Site name | string |
| start_time optional |
Alert’s start time, in 10-digit timestamp format. | integer |
| status optional |
1 means ongoing. 0 means stopped. | integer |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get CleanPipe Dashboard policy data.
GET /spe/customer/{customer_id}/cp/dashboard/policy
Description
Retrieve CleanPipe dashboard policy data by selecting the time range.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | end_time optional |
End time, in 10-digit timestamp format. Default is the 31st day after the start time. The maximum span is 31 days. | string |
| Query | ips optional |
< string > array | |
| Query | policy_type optional |
string | |
| Query | start_time optional |
Start time, in 10-digit timestamp format. Default is the first day of the current month. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
Historical DDoS event list. | result |
| Name | Schema |
|---|---|
| drop_bps optional |
< < integer > array > array |
| drop_pps optional |
< < integer > array > array |
| pass_bps optional |
< < integer > array > array |
| pass_pps optional |
< < integer > array > array |
Consumes
application/json
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