Navigation :

Dashboard

Site

Overview

Origin 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 DDoS event detail.

GET /spe/customer/{customer_id}/op/dashboard/ddos_event/{event_id}/detail

Description

Retrieve DDoS event detail by event ID.

Parameters

Type	Name	Description	Schema
Path	customer_id required	Unique identifier of a customer. Can be obtained by invoking this API.	string
Path	event_id required	Unique identifier of a DDoS event. Can be obtained by invoking this API.	string
Query	access_token required	Access token used to authenticate your access to the API.Can be obtained by invoking this API.	string
Query	module required	Module type. traffic, characterization, traffic_patterns, threat_map,	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	DDoS event detail.	result

result

Name	Schema
characterization optional	< characterization > array
threat_map optional	threat_map
traffic optional	traffic
traffic_patterns optional	< traffic_patterns > array

characterization

Name	Description	Schema
country optional	Country code.	string
element optional	Event characterization item element.	string
item optional	Event characterization item name.	string
percent optional	Event characterization item percentage.	integer
value optional	Event characterization item value.	string

threat_map

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

bps

Name	Description	Schema
code optional	Country code.	string
country optional	Country name.	string
ip optional	IP address.	string
latitude optional	Latitude.	number
longitude optional	Longitude.	number
org optional	Organization name.	string
percent optional	Percentage.	integer
size optional	Traffic size.	string

pps

Name	Description	Schema
code optional	Country code.	string
country optional	Country name.	string
ip optional	IP address.	string
latitude optional	Latitude.	number
longitude optional	Longitude.	number
org optional	Organization name.	string
percent optional	Percentage.	integer
size optional	Traffic size.	string

traffic

Name	Schema
bps optional	< string, < < integer > array > array > map
pps optional	< string, < < integer > array > array > map

traffic_patterns

Name	Description	Schema
asn optional	ASN number.	integer
attack_type optional		< attack_type > array
average optional		average
cidr optional	CIDR notation.	string
dest_port optional	Destination port.	string
flags optional	Traffic flags.	string
max optional		max
protocol optional	Protocol type.	string
router optional	Router IP address.	string
src_port optional	Source port.	string
total optional		total

attack_type

Name	Description	Schema
attackType optional	Attack type name.	string
percent optional	Attack type percentage.	integer

average

Name	Description	Schema
bps optional	Average bits per second.	integer
pps optional	Average packets per second.	integer

max

Name	Description	Schema
bps optional	Maximum bits per second.	integer
pps optional	Maximum packets per second.	integer

total

Name	Description	Schema
byte optional	Total bytes.	integer
packet optional	Total packets.	integer

Security

Type	Name
apiKey	ApiKeyAuth

Get historical DDoS events by specifying timestamps.

GET /spe/customer/{customer_id}/op/dashboard/ddos_events

Description

Retrieve 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.Can be obtained by invoking this API.	string
Query	alert_id optional	Unique identifier of a event.	string
Query	end_time optional	End time, Format: ‘year-month-day hour:minute:second’，eg: ‘2021-06-01 20:10:00’. 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 Origin 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, Format: ‘year-month-day hour:minute:second’，eg: ‘2021-06-01 20:10:00’. 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

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
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(Medium); 3(High); 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 Dashboard policy data.

GET /spe/customer/{customer_id}/op/dashboard/policy

Description

Retrieve 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.Can be obtained by invoking this 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

Response 200

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

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

Security

ApiKeyAuth

Type : apiKey
Name : access_token
In : QUERY