Navigation :

Detection

Site

Overview

Origin Protection Detection 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

Updates the detection mode.

POST /spe/customer/{customer_id}/op/site/{site_id}/network/{network_id}/host/{host_id}/detection/mode

Description

Updates the detection mode.

Parameters

Type	Name	Description	Schema
Path	customer_id required	Unique identifier of a customer. Can be obtained by invoking this API.	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
FormData	model required	In the detection mode, “0” represents normal mode whereas “1” represents rapid mode.	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

Sets the detection policy.

POST /spe/customer/{customer_id}/op/site/{site_id}/network/{network_id}/host/{host_id}/detection/policy

Description

Sets the detection policy.

Parameters

Type	Name	Description	Schema
Path	customer_id required	Unique identifier of a customer. Can be obtained by invoking this API.	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
FormData	blackhole_bps optional	The blackhole value in bps. must be a number or K, M, G format. If the name is set to total_traffic, the blackhole_bps must be provided.	string
FormData	blackhole_pps optional	The blackhole value in bps. must be a number or K, M, G format. If the name is set to total_traffic, the blackhole_pps must be provided.	string
FormData	blackhole_time optional	The period of time for which the Blackhole mode is active. If the name is set to total_traffic, the blackhole_time must be provided.	integer
FormData	high_bps optional	The high end of threshold value in bps. must be a number or K, M, G format. If the name is set to total_traffic, the high_bps must be provided.	string
FormData	high_pps required	The high end of threshold value in pps. must be a number or K, M, G format.	string
FormData	is_enabled required	policy switch. `0` means it is disabled and `1` means enabled..	string
FormData	low_bps optional	The low end of threshold value in bps. must be a number or K, M, G format. If the name is set to total_traffic, the low_bps must be provided.	string
FormData	low_pps required	The low end of threshold value in pps. must be a number or K, M, G format.	string
FormData	name required	Protocol name. Protocol type property, e.g.,tcp_syn and tcp_ack. Can be obtained by invoking interface of get detection policy.	string
FormData	type required	The type of protocol includes tcp,udp,ip,sip,http,total_traffic.	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 detection policies.

GET /spe/customer/{customer_id}/op/site/{site_id}/network/{network_id}/host/{host_id}/detection/policy

Description

Gets the info of detection policies.

Parameters

Type	Name	Description	Schema
Path	customer_id required	Unique identifier of a customer. Can be obtained by invoking this API.	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

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	Detection properties. is_enabled – policy switch, `0` means it is disabled and `1` means enabled.. low – The low end of threshold value. Once traffic volume reaches this value, in pps or bps,an alert is sent and logged. high – The high end of threshold value. Once traffic volume reaches this value, in pps or bps, a severe alert is sent and logged. direction – Direction of the traffic volume being monitored.blackhole – When bandwidth usage reaches the defined threshold value, all traffic is dropped, or blackholed. This mode is useful only when attack size is overwhelmingly large that it threatens to cause collateral damage. Use it with caution, and do so after exhausting other options.blackhole_time – The period of time for which the Blackhole mode is active.	result

result

Name	Description	Schema
http optional	HTTP-based data packets.	http
icmp optional	ICMP-based data packet detection.	icmp
ip optional	IP-based data packets.	ip
model optional	For the detection mode, “0” represents normal mode whereas “1” represents rapid mode.	integer
sip optional	SIP-based data packets.	sip
tcp optional	It represents the TCP-based data packet detection.	tcp
total_traffic optional	Overall traffic to or from a Site or Network.	total_traffic
udp optional	UDP-based data packet detection.	udp

http

Name	Description	Schema
http_flood optional	HTTP flood data packets.	http_flood
https_flood optional	HTTPS flood data packets.	https_flood

http_flood

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

https_flood

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

icmp

Name	Description	Schema
icmp_fragmentation optional	Fragmented ICMP data packets.	icmp_fragmentation
icmp_invalid optional	Invalid ICMP data packets.	icmp_invalid
icmp_total optional	ICMP data packets in total.	icmp_total

icmp_fragmentation

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

icmp_invalid

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

icmp_total

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

Name	Description	Schema
ip_bogons optional	Bogus IP data packets.	ip_bogons
ip_fragmentation optional	Fragmented IP data packets.	ip_fragmentation
ip_land optional	IP land data packets.	ip_land

ip_bogons

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

ip_fragmentation

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

ip_land

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

sip

Name	Description	Schema
sip_flood optional	SIP flood data packets.	sip_flood

sip_flood

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

tcp

Name	Description	Schema
tcp_ack optional	TCP Acknowledgement response. This is sent as part of the TCP SYN-ACK process.	tcp_ack
tcp_fragmentation optional	Fragmented TCP data packets.	tcp_fragmentation
tcp_invalid optional	Invalid TCP data packets.	tcp_invalid
tcp_rst optional	TCP Reset responses.	tcp_rst
tcp_syn optional	TCP SYN requests.	tcp_syn

tcp_ack

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

tcp_fragmentation

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

tcp_invalid

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

tcp_rst

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

tcp_syn

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

total_traffic

Name	Description	Schema
total_traffic optional	Total traffic data packets.	total_traffic

total_traffic

Name	Schema
blackhole_bps optional	string
blackhole_pps optional	string
blackhole_time optional	integer
direction_bps optional	string
direction_pps optional	string
high_bps optional	string
high_pps optional	string
is_enabled optional	integer
low_bps optional	string
low_pps optional	string

udp

Name	Description	Schema
chargen_amplification optional	Chargen amplification data packets.	chargen_amplification
cldap_reflection optional	Cldap reflection data packets.	cldap_reflection
dns_amplification optional	DNS amplification data packets.	dns_amplification
dns_flood optional	DNS flood data packets.	dns_flood
l2tp_amplification optional	L2TP amplification data packets.	l2tp_amplification
mdns_amplification optional	Fragmented TCP data packets.	mdns_amplification
memcached_amplification optional	Memcached amplification data packets.	memcached_amplification
ms_sql_rs_amplification optional	MS SQL RS amplification data packets.	ms_sql_rs_amplification
ntp_amplification optional	NTP amplification data packets.	ntp_amplification
ripv1_amplification optional	RIPV1 amplification data packets.	ripv1_amplification
rpcbind_amplification optional	RPCBIND amplification data packets.	rpcbind_amplification
snmp_amplification optional	SNMP amplification data packets.	snmp_amplification
ssdp_amplification optional	SSDP fragmentation data packets.	ssdp_amplification
udp_fragmentation optional	UDP fragmentation data packets.	udp_fragmentation
udp_total optional	UDP total data packets.	udp_total

chargen_amplification

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

cldap_reflection

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

dns_amplification

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

dns_flood

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

l2tp_amplification

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

mdns_amplification

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

memcached_amplification

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

ms_sql_rs_amplification

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

ntp_amplification

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

ripv1_amplification

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

rpcbind_amplification

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

snmp_amplification

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

ssdp_amplification

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

udp_fragmentation

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

udp_total

Name	Schema
direction_pps optional	string
high_pps optional	string
is_enabled optional	integer
low_pps optional	string

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