☰
Navigation :

Dashboard

Common

Overview

Origin Protection Dashboard 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 the active mitigation.

GET /specp/op/dashboard/site/{site_id}/active_mitigation

Description

View current attack mitigation status.

Parameters

Type Name Description Schema
Path site_id
required		 Unique identifier of a site. It can be obtained by invoking this API for Application Protection sites and 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 when the API is successfully invoked. Response 200

Response 200

Name Description Schema
code
optional		 Error code integer
msg
optional		 Error message string
result
optional		 Historical DDoS event list. < result > array

result

Name Description Schema
bps
optional		 traffic in bps bps
cidr
optional		 cidr string
name
optional		 profile name 或 host name string
pps
optional		 trafffic in pps pps

bps

Name Description Schema
bot
optional		 bot traffic integer
clean
optional		 clean traffic integer

pps

Name Description Schema
bot
optional		 bot traffic integer
clean
optional		 clean traffic integer

Consumes

Produces

Security

Type Name
apiKey ApiKeyAuth

Get current traffic in bps.

GET /specp/op/dashboard/site/{site_id}/current_traffic

Description

View real-time traffic, measured in bps.

Parameters

Type Name Description Schema
Path site_id
required		 Unique identifier of a site. It can be obtained by invoking this API for Application Protection sites and 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 when the API is successfully invoked. Response 200

Response 200

Name Description Schema
code
optional		 Error code integer
msg
optional		 Error message string
result
optional		 Historical DDoS event list. result

result

Name Description Schema
bps_size
optional		 Current traffic in bps integer

Consumes

Produces

Security

Type Name
apiKey ApiKeyAuth

Get a event alert detail.

GET /specp/op/dashboard/site/{site_id}/ddos_event/{alert_id}

Description

Get a event alert detail.

Parameters

Type Name Description Schema
Path alert_id
required		 Alert ID 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

Response 200

Name Description Schema
code
optional		 Error code integer
msg
optional		 Error message string
result
optional		 Get historical DDoS event lists. result

result

Name Schema
attack_replay_traffic
optional		 attack_replay_traffic
attack_type_traffic
optional		 attack_type_traffic
top_country
optional		 top_country
top_ip
optional		 top_ip

attack_replay_traffic

Name Schema
bps
optional		 < bps > array
pps
optional		 < pps > array

bps

Name Description Schema
bot
optional		 Bot traffic during the timespan, measured in bps. < < integer > array > array
dropped_num
optional		 Traffic dropped, measured in bps. integer
human
optional		 Human traffic during the timespan, measured in bps. < < integer > array > array

pps

Name Description Schema
bot
optional		 Bot traffic during the timespan, measured in bps. < < integer > array > array
dropped_num
optional		 Traffic dropped, measured in bps. integer
human
optional		 Human traffic during the timespan, measured in bps. < < integer > array > array

attack_type_traffic

Name Schema
bps
optional		 < bps > array
pps
optional		 < pps > array

bps

Name Description Schema
TCP ACK
optional		 Types of attacks during the timespan, measured in bps. (Mixed, TCP SYN, TCP ACK, TCP RST, TCP NULL, TCP Fragmentation, DNS Flood, DNS Amplification, NTP Amplification, SNMP Amplification, SSDP Amplification, UDP Fragmentation, UDP Total, CLDAP Reflection, ICMP Invalid, ICMP Total, IP Fragmentation, IP Bogons, IP Land, SIP Flood, HTTP Flood, HTTPS Flood, Total Traffic, TCP FIN-RST, TCP SYN-RST） < < integer > array > array

pps

Name Description Schema
TCP ACK
optional		 Types of attacks during the timespan. (Mixed, TCP SYN, TCP ACK, TCP RST, TCP NULL, TCP Fragmentation, DNS Flood, DNS Amplification, NTP Amplification, SNMP Amplification, SSDP Amplification, UDP Fragmentation, UDP Total, CLDAP Reflection, ICMP Invalid, ICMP Total, IP Fragmentation, IP Bogons, IP Land, SIP Flood, HTTP Flood, HTTPS Flood, Total Traffic, TCP FIN-RST, TCP SYN-RST） < < integer > array > array

top_country

Name Schema
bps
optional		 < bps > array
pps
optional		 < pps > array

bps

Name Description Schema
count
optional		 Attack counts integer
country
optional		 Traffic country string
percent
optional		 percent，without the percent sign. number
size
optional		 Traffic size integer

pps

Name Description Schema
count
optional		 Attack counts integer
country
optional		 traffic country string
percent
optional		 percent，without the percent sign. number
size
optional		 traffic size integer

top_ip

Name Schema
bps
optional		 < bps > array
pps
optional		 < pps > array

bps

Name Description Schema
count
optional		 Attack counts integer
ip
optional		 Traffic IP string
percent
optional		 percent，without the percent sign. number
size
optional		 Traffic size integer

pps

Name Description Schema
count
optional		 Attack counts integer
ip
optional		 Traffic IP string
percent
optional		 percent，without the percent sign. number
size
optional		 Traffic size integer

Consumes

Produces

Security

Type Name
apiKey ApiKeyAuth

Get historical DDoS events by specifying timestamps.

GET /specp/op/dashboard/site/{site_id}/ddos_events

Description

Retrieve historical DDoS events by selecting the time range.

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 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 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

Responses

HTTP Code Description Schema
200 Response when the API is successfully invoked. Response 200

Response 200

Name Description Schema
code
optional		 Error code integer
msg
optional		 Error message string
result
optional		 Historical DDoS event list. result

result

Name Description Schema
events
optional		 < events > array
total
optional		 Total no. of alarms in the query range. integer

events

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
profile_desc
optional		 Profile description string
profile_name
optional		 Profile name string
severity
optional		 Alert level: 0（Low); 1（High); 2（Medium) (Blackhole）. integer
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

Produces

Security

Type Name
apiKey ApiKeyAuth

Get ongoing Flow down events alert list including alert ID, router name, site and time.

GET /specp/op/dashboard/site/{site_id}/flow_down_events

Description

View current Flow down alerts, including alert IDs, router names, sites and dates/times of occurrences.

Parameters

Type Name Description Schema
Path site_id
required		 Unique identifier of a site. It can be obtained by invoking this API for Application Protection sites and this API for Origin Protection sites. 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 set at the current time. The time difference does not exceed 90 days. string
Query start_time
optional		 Start time, in 10-digit timestamp format. Default is set at 90 days to the current time. string
Query status
optional		 0 means ongoing. 1 means stopped. 2 means all. Default is 2. integer

Responses

HTTP Code Description Schema
200 This is the returned result. Response 200

Response 200

Name Description Schema
code
optional		 Error code integer
msg
optional		 Error message string
result
optional		 Return a Flow down alert event list. result

result

Name Description Schema
alert_id
optional		 Alert ID string
duration
optional		 Attack duration, measured in seconds. integer
end_time
optional		 The time when Flow service resumed, in 10-digit timestamp format. integer
router_name
optional		 Router name string
site
optional		 The name of the site to which Flow is down. string
start_time
optional		 The time when Flow began to go down, in 10-digit timestamp format. integer

Consumes

Produces

Security

Type Name
apiKey ApiKeyAuth

Get DDoS attack status.

GET /specp/op/dashboard/site/{site_id}/is_under_attack

Description

View DDoS attack status

Parameters

Type Name Description Schema
Path site_id
required		 Unique identifier of a site. It can be obtained by invoking this API for Application Protection sites and 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 when the API is successfully invoked. Response 200

Response 200

Name Description Schema
code
optional		 Error code integer
msg
optional		 Error message string
result
optional		 Historical DDoS event list. result

result

Name Description Schema
bps_size
optional		 When the status is 1, displayed is an ongoing attack. When the status is 0, displayed is the max attack traffic. integer
status
optional		 1 means ongoing. 0 means stopped. integer

Consumes

Produces

Security

Type Name
apiKey ApiKeyAuth

Get network summary.

GET /specp/op/dashboard/site/{site_id}/network_summary

Description

View network summary.

Parameters

Type Name Description Schema
Path site_id
required		 Unique identifier of a site. It can be obtained by invoking this API for Application Protection sites and this API for Origin Protection sites. string
Query access_token
required		 Access token used to authenticate your access to the API. string
Query range
optional		 hour，day，week，month. Default is hour. string
Query type
optional		 bps or pps. Default is bps. string

Responses

HTTP Code Description Schema
200 Response when the API is successfully invoked. Response 200

Response 200

Name Description Schema
code
optional		 Error code integer
msg
optional		 Error message string
result
optional		 Historical DDoS event list. result

result

Name Description Schema
app
optional		 Application < app > array
as_num
optional		 ASN < as_num > array
attack_type
optional		 Attack type (Mixed, TCP SYN, TCP ACK, TCP RST, TCP NULL, TCP Fragmentation, DNS Flood, DNS Amplification, NTP Amplification, SNMP Amplification, SSDP Amplification, UDP Fragmentation, UDP Total, CLDAP Reflection, ICMP Invalid, ICMP Total, IP Fragmentation, IP Bogons, IP Land, SIP Flood, HTTP Flood, HTTPS Flood, Total Traffic, TCP FIN-RST, TCP SYN-RST） < attack_type > array
country
optional		 Countries < country > array
ip
optional		 Visitor IP < ip > array
proto
optional		 Protocols，e.g. tcp，udp, etc. < proto > array

app

Name Description Schema
app
optional		 Application string
count
optional		 No. of alerts integer
size
optional		 traffic size integer

as_num

Name Description Schema
as
optional		 as number integer
count
optional		 No. of alerts integer
size
optional		 traffic size integer

attack_type

Name Description Schema
attack_type
optional		 Attack type string
size
optional		 Traffic size integer

country

Name Description Schema
country
optional		 Countries string
size
optional		 traffic size integer

ip

Name Description Schema
ip
optional		 Visitor IP string
size
optional		 traffic size integer

proto

Name Description Schema
count
optional		 No. of alerts integer
proto
optional		 Protocols，e.g. tcp，udp, etc. string
size
optional		 Traffic size integer

Consumes

Produces

Security

Type Name
apiKey ApiKeyAuth

Security

ApiKeyAuth

Type : apiKey
Name : access_token
In : QUERY