Site
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 packet capture data.
GET /spe/customer/{customer_id}/op/capture_package
Description
When the status of the capture task is completed, the URL of the captured file is returned when the task is completed.
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 | api_task_id required |
Task ID. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
The capture status and the address to download captured content. | result |
| Name | Description | Schema |
|---|---|---|
| package_url optional |
The address to download the captured file. | string |
| status optional |
0 means that the packet has been completed. 1 means task in the queue. 2 means capture in progress. | integer |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Gets the configuration options of the site under Origin Protection.
GET /spe/customer/{customer_id}/op/config_options
Description
Gets the configuration item for the site.
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 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
Router list. | result |
| Name | Description | Schema |
|---|---|---|
| collector_ip optional |
The collector ip used as a selected option to add/update the router. | < string > array |
| countries optional |
The parameter contains the list of countries.key and value, where the value is the country name. | object |
| filter_icmp_type optional |
The parameter contains ICMP Types.key and value, where the value is the name of type. | object |
| filter_tcp_flags optional |
TCP Flags. | filter_tcp_flags |
| icmp_filter_types optional |
The parameter contains the list of icmp filter type.key and value, where the value is the name of type. | object |
| idc_name optional |
The name list of IDC used as a selected option to add the tunnel. | < string > array |
| ip_protocol_number_list optional |
The parameter contains the list of ip protocol.key and value, where the value is the name of protocol. | object |
| Name | Description | Schema |
|---|---|---|
| other optional |
The parameter contains TCP reserved flags.key and value, where the value is the name of flag. | object |
| reserved optional |
The parameter contains TCP reserved flags.key and value, where the value is the name of flag. | object |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Creates an Origin Protection site.
POST /spe/customer/{customer_id}/op/site
Description
Through this API, the site under Origin Protection is created based on the user-provided information. Please see notes on individual parameters below.
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 |
| FormData | as_num required |
Autonomous System Number (ASN). Each site can only have one ASN. | integer |
| FormData | cidr required |
The network resources are protected in the CIDR list. IP addresses entered must belong to the previous ASN entered. The CIDR list for a Site must contain all IP addresses to be used by its member Networks and Hosts. | < string > array |
| FormData | site_desc optional |
The description of the site created can be added. | string |
| FormData | site_name required |
The site name which only allows letters, numbers and underscores, limited to 20 characters. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| site_id optional |
Site ID, an unique identifier assigned to each Site. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get the OP site report data.
GET /spe/customer/{customer_id}/op/site-report
Description
Get the report data under site.
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 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves the properties of a site.
GET /spe/customer/{customer_id}/op/site/{site_id}
Description
This API helps retrieve the info of a site under OP using the Site ID provided. Please see notes of individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | 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 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
Info of the site | < result > array |
| Name | Description | Schema |
|---|---|---|
| as_num optional |
Autonomous System Number. | integer |
| cidr optional |
Classless Inter-Domain Routing (CIDR) form where the network resources to be protected are included. | < string > array |
| service_plan optional |
The service plan the client has signed up for. | string |
| service_type optional |
The type of communication protocol established to link the customer networks to Partner’s/Nexusguard’s nodes. | string |
| site_desc optional |
The description of the site. | string |
| site_name optional |
The name of the site. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Updates on the details of the site under OP.
PUT /spe/customer/{customer_id}/op/site/{site_id}
Description
Through this API, you can provide information to update the details of the site under OP. See notes on individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | 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 | as_num required |
Autonomous System Number (ASN). Each site can only have one ASN. | integer |
| FormData | cidr required |
The network resources to be protected must be contained in CIDR form. IP addresses entered must belong to the previous ASN entered. The CIDR form for a Site must contain all IP addresses used by its member Networks and Hosts. | < string > array |
| FormData | site_desc optional |
The description of the site | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete the site under Origin Protection.
DELETE /spe/customer/{customer_id}/op/site/{site_id}
Description
Through this API, the site under Origin Protection can be deleted based on the user-provided information. Please see notes on individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | 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. | Result |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Dispatch capture package.
POST /spe/customer/{customer_id}/op/site/{site_id}/capture_package
Description
Dispatch capture package. It can only be used once in each minute. This is the unique ID of the task after the current task is completed.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | 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 | dest_ip required |
Destination IP. The format is CIDR or IP. | string |
| FormData | length optional |
Package length. Default is 128. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
The unique ID returned by the successfully dispatch a capture package task. | result |
| Name | Description | Schema |
|---|---|---|
| api_task_id optional |
Task ID, a unique identifier assigned to a capture package. | integer |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Creates a network.
POST /spe/customer/{customer_id}/op/site/{site_id}/network
Description
A Network is a group of IPs in the form of one or more than one /24 CIDRs.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | 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 | cidr required |
Only Class C IP addresses can be added to a network. | < string > array |
| FormData | network_desc optional |
The description of the network. | string |
| FormData | network_name required |
The name of the network. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| network_id optional |
Network ID, an unique identifier assigned to each Network. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Gets the info of a network.
GET /spe/customer/{customer_id}/op/site/{site_id}/network/{network_id}
Description
Gets the inf of the network for the site.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | 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 | This is the result returned. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
Network list. | result |
| Name | Description | Schema |
|---|---|---|
| cidr optional |
The CIDR list of the IP address added to the network. | < string > array |
| network_desc optional |
The description of the network. | string |
| network_name optional |
The name of the network. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Update the details of a network for Origin Protection.
PUT /spe/customer/{customer_id}/op/site/{site_id}/network/{network_id}
Description
Update the details of a network for Origin Protection.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | 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 | cidr required |
The CIDR list of the IP addresses added to the network. Only Class C IP addresses can be added to a network. | < string > array |
| FormData | network_desc optional |
The description of the network. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete a Class C network from being protected by Origin Protection.
DELETE /spe/customer/{customer_id}/op/site/{site_id}/network/{network_id}
Description
Delete a Class C network from being protected by Origin Protection.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | 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. | Result |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Creates a host.
POST /spe/customer/{customer_id}/op/site/{site_id}/network/{network_id}/host
Description
A Host is a collection of one or more than one individual IPs in the form of /32 CIDRs.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | 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 | cidr required |
The list of IP address added to the host profile to which Only /32, or an individual IP addresses can be added. | < string > array |
| FormData | host_desc optional |
The description of the host. | string |
| FormData | host_name required |
The name of the host. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| host_id optional |
Unique identifier assigned to each Host. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get a host info.
GET /spe/customer/{customer_id}/op/site/{site_id}/network/{network_id}/host/{host_id}
Description
Gets the host information for a network.
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 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
Host list. | result |
| Name | Description | Schema |
|---|---|---|
| cidr optional |
IP address contained by CIDR list can be added to the host. | < string > array |
| host_desc optional |
The description of the host. | string |
| host_name optional |
The name of the host. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit the info of the host under Origin Protection.
PUT /spe/customer/{customer_id}/op/site/{site_id}/network/{network_id}/host/{host_id}
Description
Update the info of the host under Origin Protection.
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 | cidr required |
Only /32 or an individual IP addresses contained by CIDR list can be added to a host. | < string > array |
| FormData | host_desc optional |
The description of the host. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete a host.
DELETE /spe/customer/{customer_id}/op/site/{site_id}/network/{network_id}/host/{host_id}
Description
Delete a Host.
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. | Result |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get a host list.
GET /spe/customer/{customer_id}/op/site/{site_id}/network/{network_id}/hosts
Description
Gets the host list for a network.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | 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 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
Host list. | < result > array |
| Name | Description | Schema |
|---|---|---|
| cidr optional |
IP address added to the host. | < string > array |
| host_desc optional |
The description of the host. | string |
| host_id optional |
Unique identifier of a host. | string |
| host_name optional |
The name of the host. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Gets a network list.
GET /spe/customer/{customer_id}/op/site/{site_id}/networks
Description
Gets the network list for the site under Origin Protection.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | 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 |
| Query | limit optional |
The page parameter. The default value of requesting the counts of index from the first index is 0,response code is 200.Response code will be 201 without default value.The max value of requesting the counts of index from the first index is 50. | integer |
| Query | start optional |
The default value of the first index of the page parameter value is 0. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| 201 | This is the returned result. | Response 201 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
Network list. | < result > array |
| Name | Description | Schema |
|---|---|---|
| cidr optional |
The list of IP addresses added to the network. | < string > array |
| network_desc optional |
The description of the network. | string |
| network_id optional |
Unique identifier of a network. | string |
| network_name optional |
The name of the network. | string |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| data optional |
Network list. | < data > array |
| limit optional |
Current page parameter value. | integer |
| start optional |
Current page parameter value. | integer |
| total optional |
Current site total | integer |
| Name | Description | Schema |
|---|---|---|
| cidr optional |
The list of IP addresses added to the network. | < string > array |
| network_desc optional |
The description of the network. | string |
| network_id optional |
Unique identifier of a network. | string |
| network_name optional |
The name of the network. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Add the router details for OP.
POST /spe/customer/{customer_id}/op/site/{site_id}/router
Description
A router provides details of the router and tunnel settings in order to organize routing to redirect customer traffic to our scrubbing centers.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | 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 | alert_is_enabled optional |
0 means the flow down alert is switched on whereas 1 means it is switched off. |
integer |
| FormData | alert_timeout optional |
if alert_is_enabled is switched on, the time for this timeout alert to be switched must be provided. | integer |
| FormData | collector_ip optional |
If alert_is_enabled is switched on, the value of collector_ip is taken from the returned configuration options. | string |
| FormData | export_ip optional |
The IP address of the Flow server. | string |
| FormData | model required |
The model of the router. | string |
| FormData | remote_monitor optional |
0 means remote_monitor is switched on whereas 1 means it is switched off. |
integer |
| FormData | router_desc optional |
The description of the router. | string |
| FormData | router_name required |
The name of the router you want to create. | string |
| FormData | sample_rate optional |
If sample_type is set to custom, the sample rate must be provided. | string |
| FormData | sample_type optional |
The sampling type is set to auto or custom. | string |
| FormData | version optional |
The version of the Flow protocol in (netflow_v5, netflow_v9, sflow_v5, ipfix). | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| router_id optional |
Router ID, an unique identifier assigned to each Router. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get the info of the router under OP.
GET /spe/customer/{customer_id}/op/site/{site_id}/router/{router_id}
Description
Get the router info from the site under OP.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | router_id required |
Unique identifier of a router. | 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 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
Router list. | < result > array |
| Name | Description | Schema |
|---|---|---|
| alert_is_enabled optional |
0 means the flow down alert is switched on whereas 1 means it is switched off. |
integer |
| alert_timeout optional |
The flow-down alert is run overtime. | integer |
| collector_ip optional |
IP of the collector for remote DDoS monitoring. | string |
| collector_port optional |
The port number of Collector. | string |
| export_ip optional |
The IP address of the Flow server. | string |
| model optional |
It is about the model of the router. | string |
| remote_monitor optional |
0 means remote DDoS attack monitoring is switched on whereas 1 means it is switched off. |
integer |
| router_desc optional |
It is about the description of the router. | string |
| router_id optional |
Router ID is an unique identifier assigned to each router. | string |
| router_name optional |
It represents the name of the router. | string |
| sample_rate optional |
If the type is set to auto, the rate is default. If the type is set to custom, the rate is customizable. | integer |
| sample_type optional |
The sampling type can be set to auto or custom. | string |
| version optional |
The version of the Flow protocol. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Update the details of a router.
PUT /spe/customer/{customer_id}/op/site/{site_id}/router/{router_id}
Description
Update the details of a router for Origin Protection.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | router_id required |
Unique identifier of a router. | 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 | alert_is_enabled optional |
0 means the flow down alert is switched on whereas 1 means it is switched off. |
integer |
| FormData | alert_timeout optional |
When “alert_is_enabled” is switched on , the alert_timeout must be provided. | integer |
| FormData | collector_ip optional |
When “alert_is_enabled” is switched on, the Collector IP must be provided. The value of “collector_ip” is taken from configuration options. | string |
| FormData | export_ip optional |
The IP address of the flow server. | string |
| FormData | model required |
The model of the router. | string |
| FormData | remote_monitor optional |
0 means the remote DDoS monitoring is switched on whereas 1 means it is switched off. |
integer |
| FormData | router_desc optional |
The description of the router. | string |
| FormData | sample_rate optional |
If the sample type is set to custom, the sample rate must be provided. | string |
| FormData | sample_type optional |
The sampling type can be set to auto or custom. | string |
| FormData | version optional |
The version of the flow protocol such as netflow_v5, netflow_v9, sflow_v5, ipfix. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Deleting a router for Origin Protection.
DELETE /spe/customer/{customer_id}/op/site/{site_id}/router/{router_id}
Description
Deleting a router for Origin Protection.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | router_id required |
Unique identifier of a router. | 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. | Result |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Creates a tunnel.
POST /spe/customer/{customer_id}/op/site/{site_id}/router/{router_id}/tunnel
Description
A Tunnel in this context refers to an IP tunnel, specifically, a GRE tunnel, which is a dedicated channel to transmit data between the customer and scrubbing networks.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | router_id required |
Unique identifier of a router. | 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 | rate_limit_bps optional |
The maximum bandwidth of the tunnel in bps. | string |
| FormData | rate_limit_pps optional |
The maximum bandwidth of the GRE tunnel in pps. | string |
| FormData | remote_as_num required |
The ASN of the customer network. | integer |
| FormData | tunnel_dest_ip required |
The public IP address of the server of the GRE tunnel at the customer site. | string |
| FormData | tunnel_idc required |
IDC is one end of the channel. The value of “idc_name is taken from configuration options. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| tunnel_id optional |
Tunnel ID, an unique identifier assigned to each Tunnel. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Gets the info of a tunnel.
GET /spe/customer/{customer_id}/op/site/{site_id}/router/{router_id}/tunnel/{tunnel_id}
Description
Gets the information of the tunnel for a router.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | router_id required |
Unique identifier of a router. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Path | tunnel_id required |
Unique identifier of a tunnel. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
Tunnel Info. | result |
| Name | Description | Schema |
|---|---|---|
| limit_bps optional |
Maximum bandwidth of the tunnel in bps. | string |
| limit_pps optional |
Maximum bandwidth of the tunnel in pps. | string |
| local_as_num optional |
AS number of the scrubbing center. | integer |
| remote_as_num optional |
AS number of the customer network. | string |
| tunnel_dest_ip optional |
The public IP address of the tunnel server at the customer site. | string |
| tunnel_idc optional |
IDC that is one end of the channel. | string |
| tunnel_local_ip optional |
The public IP address of the tunnel server at the scrubbing center. | string |
| tunnel_remote_ip optional |
The internal IP addresses assigned to the tunnel server at the customer site. | string |
| tunnel_source_ip optional |
The internal IP addresses assigned to the tunnel server at the scrubbing center. | string |
| tunnel_type optional |
The type of GRE-supporting tunnel to be established. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Update a tunnel.
PUT /spe/customer/{customer_id}/op/site/{site_id}/router/{router_id}/tunnel/{tunnel_id}
Description
To update a tunnel.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | router_id required |
Unique identifier of a router. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Path | tunnel_id required |
Unique identifier of a tunnel. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | rate_limit_bps optional |
Maximum bandwidth of the tunnel in bps. | string |
| FormData | rate_limit_pps optional |
Maximum bandwidth of the tunnel in pps. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete a tunnel.
DELETE /spe/customer/{customer_id}/op/site/{site_id}/router/{router_id}/tunnel/{tunnel_id}
Description
To delete a tunnel.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | router_id required |
Unique identifier of a router. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
| Path | tunnel_id required |
Unique identifier of a tunnel. | 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. | Result |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get a list of GRE tunnels for BGP routing for OP.
GET /spe/customer/{customer_id}/op/site/{site_id}/router/{router_id}/tunnels
Description
Gets a list of GRE tunnels to your router.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | router_id required |
Unique identifier of a router. | 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 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
The list of GRE tunnels. | < result > array |
| Name | Description | Schema |
|---|---|---|
| limit_bps optional |
Maximum bandwidth of the tunnel in bps. | string |
| limit_pps optional |
Maximum bandwidth of the tunnel in pps. | string |
| local_as_num optional |
AS number of the scrubbing center. | integer |
| remote_as_num optional |
AS number of the customer network. | string |
| tunnel_dest_ip optional |
The public IP address of the tunnel server at the customer site. | string |
| tunnel_id optional |
The tunnel ID is an unique identifier assigned to each tunnel. | string |
| tunnel_idc optional |
IDC name of the GRE tunnel. | string |
| tunnel_local_ip optional |
The public IP address of the tunnel server at the scrubbing center. | string |
| tunnel_remote_ip optional |
Internal IP addresses assigned to the tunnel server at the customer. | string |
| tunnel_source_ip optional |
An internal IP address assigned to the tunnel server at the scrubbing center. | string |
| tunnel_type optional |
The type of GRE-supported tunnel is established. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get a router list.
GET /spe/customer/{customer_id}/op/site/{site_id}/routers
Description
Gets the router list for the site under Origin Protection.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | 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 |
| Query | limit optional |
The page parameter. The default value of requesting the counts of index from the first index is 0,response code is 200.Response code will be 201 without default value.The max value of requesting the counts of index from the first index is 50. | integer |
| Query | start optional |
The default value of the first index of the page parameter value is 0. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| 201 | This is the returned result. | Response 201 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
Router list. | < result > array |
| Name | Description | Schema |
|---|---|---|
| alert_is_enabled optional |
The flow down alert which is switched on when it is 0 whereas switched off when it is 1. |
integer |
| alert_timeout optional |
The time for the alert overtime to become invalid. | integer |
| collector_ip optional |
Collector ip. | string |
| collector_port optional |
Collector port. | string |
| export_ip optional |
The IP address of the flow server. | string |
| model optional |
The model of the router. | string |
| remote_monitor optional |
0 means the remote DDoS monitoring is disabled whereas 1 means it is enabled. |
string |
| router_desc optional |
The description about the router. | string |
| router_id optional |
Router ID is an unique identifier assigned to each router. | string |
| router_name optional |
The name of the router. | string |
| sample_rate optional |
If the type is set to auto, the rate is default. If the type is set to custom, the rate is customizable. | integer |
| sample_type optional |
The sampling type which is automatic or customizable. | string |
| version optional |
The version of the flow protocol. | string |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| data optional |
Router list. | < data > array |
| Name | Description | Schema |
|---|---|---|
| alert_is_enabled optional |
The flow down alert which is switched on when it is 0 whereas switched off when it is 1. |
integer |
| alert_timeout optional |
The time for the alert overtime to become invalid. | integer |
| collector_ip optional |
Collector ip. | string |
| collector_port optional |
Collector port. | string |
| export_ip optional |
The IP address of the flow server. | string |
| model optional |
The model of the router. | string |
| remote_monitor optional |
0 means the remote DDoS monitoring is disabled whereas 1 means it is enabled. |
integer |
| router_desc optional |
The description about the router. | string |
| router_id optional |
Router ID is an unique identifier assigned to each router. | string |
| router_name optional |
The name of the router. | string |
| sample_rate optional |
If the type is set to auto, the rate is default. If the type is set to custom, the rate is customizable. | integer |
| sample_type optional |
The sampling type which is automatic or customizable. | string |
| version optional |
The version of the flow protocol. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves Origin Protection site list by Customer ID.
GET /spe/customer/{customer_id}/op/sites
Description
This API retrieves a complete list of sites under Origin Protection associated with a certain Customer ID. This is Customer ID is a 3-digit integer in the Admin Portal and unique to each customer. In this context, what you get and give is an encoded string, e.g., 7423b77da0a97c33. See notes on individual parameters below.
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 | limit optional |
The page parameter. The default value of requesting the counts of index from the first index is 0,response code is 200.Response code will be 201 without default value.The max value of requesting the counts of index from the first index is 50. | integer |
| Query | start optional |
The default value of the first index of the page parameter value is 0. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| 201 | This is the returned result with pagination. | Response 201 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
The list of Origin Protection sites associated with the given Customer ID. | < result > array |
| Name | Description | Schema |
|---|---|---|
| as_num optional |
Autonomous System Number. | integer |
| cidr optional |
The network resources to be protected, in CIDR form. | < string > array |
| service_plan optional |
The service plan the client has signed up for. | integer |
| service_type optional |
The type of communication protocol established to link the customer network to Partner’s / Nexusguard’s nodes. | string |
| site_desc optional |
Description about the site. | string |
| site_id optional |
Site ID, an unique identifier assigned to each Site. | string |
| site_name optional |
Site Name, name of the site. | string |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| data optional |
The list of Origin Protection sites associated with the given Customer ID. | < data > array |
| limit optional |
Current page parameter value. | integer |
| start optional |
Current page parameter value. | integer |
| total optional |
Current site total | integer |
| Name | Description | Schema |
|---|---|---|
| as_num optional |
Autonomous System Number. | integer |
| cidr optional |
The network resources to be protected, in CIDR form. | < string > array |
| service_plan optional |
The service plan the client has signed up for. | integer |
| service_type optional |
The type of communication protocol established to link the customer network to Partner’s / Nexusguard’s nodes. | string |
| site_desc optional |
Description about the site. | string |
| site_id optional |
Site ID, an unique identifier assigned to each Site. | string |
| site_name optional |
Site Name, name of the site. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Set params mode of site.
POST /spe/customer/{customer_id}/op/smart-filter/params-mode
Description
Set customer’s smart filter params mode of site.
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 | params_mode optional |
The params mode of the site’s smart filter. | integer |
| Query | site_id optional |
Unique identifier of a site. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Set smart filter settings of site.
POST /spe/customer/{customer_id}/op/smart-filter/site-settings
Description
Set customer’s smart filter settings of site.
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 | add_sites optional |
The site of add to smart filter. | < string > array |
| Query | del_sites optional |
The site of delete to smart filter. | < string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get smart filter policy
GET /spe/customer/{customer_id}/op/smart-filter/smart-policy
Description
get customer’s smart filter policy by condition.
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 | host_id optional |
Unique identifier of a host, default 0. | string |
| Query | is_network optional |
Is network. default 0, 1: is network, default 0. | integer |
| Query | network_id optional |
Unique identifier of a network, default 0. | string |
| Query | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
policy information. | result |
| Name | Description | Schema |
|---|---|---|
| custom_threshold optional |
The description of the host. | custom_threshold |
| is_auto optional |
The name of the host. | string |
| Name | Description | Schema |
|---|---|---|
| high_bps optional |
high bps. | integer |
| high_pps optional |
hign pps. | integer |
| low_bps optional |
Low bps. | integer |
| low_pps optional |
Low pps. | integer |
Consumes
application/x-www-form-urlencoded
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