Common
Common
Overview
Common 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
Retrieves all sites associated with the specified customers.
GET /app/ap/sites
Description
This API retrieves all site associated with the specified customers, using the provided Customer IDs. See notes on individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | < 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 |
| result optional |
All sites associated with the specified customers. | result |
| Name | Description | Schema |
|---|---|---|
| create_time optional |
Create a timestamp of the site. | integer |
| customer_id optional |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| policy_host optional |
All domains associated with the site. | < string > array |
| site_id optional |
Unique identifier of a site. Can be obtained by invoking this API for Application Protection sites and this API for Origin Protection sites. | string |
| site_name optional |
Site Name, name of the site. | string |
| tcp_pipe_ports optional |
Port numbers configured for TCP Forwarding in Pip mode. | < integer > array |
| tcp_stream_ports optional |
Port numbers configured for TCP Forwarding in Stream mode. | < integer > array |
| udp_stream_ports optional |
tcp forwarding udp stream port list | < integer > array |
| vip optional |
VIP pool for the site. | < string > array |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves Baseline Data
GET /baseline/baseline-data
Description
This API retrieves current customer baseline data.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | algo required |
Baseline algorithm. It should be 3sigma or LSTM | string |
| Query | end_time required |
End time of the query. It is Baseline generation timestamp. | integer |
| Query | mo_id required |
Managed object id | string |
| Query | signature required |
Signature name: tcp_syn, tcp_ack, tcp_rst, tcp_invalid, 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. Send the signature names you want using array. | < string > array |
| Query | start_time required |
Start time of the query. It is Baseline generation timestamp. | integer |
| Query | unit required |
Traffic unit. 0: bps 1: pps | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
The returned result. | result |
| Name | Schema |
|---|---|
| detect_option optional |
detect_option |
| detect_policy optional |
string |
| Name | Schema |
|---|---|
| total optional |
total |
| Name | Schema |
|---|---|
| timestamp optional |
timestamp |
| Name | Schema |
|---|---|
| cldap_reflection optional |
integer |
| dns_amplification optional |
integer |
| dns_flood optional |
integer |
| http_flood optional |
integer |
| https_flood optional |
integer |
| icmp_invalid optional |
integer |
| icmp_total optional |
integer |
| ip_bogons optional |
integer |
| ip_fragmentation optional |
integer |
| ip_land optional |
integer |
| ntp_amplification optional |
integer |
| sip_flood optional |
integer |
| snmp_amplification optional |
integer |
| ssdp_amplification optional |
integer |
| tcp_ack optional |
integer |
| tcp_fragmentation optional |
integer |
| tcp_invalid optional |
integer |
| tcp_rst optional |
integer |
| tcp_syn optional |
integer |
| total_traffic optional |
integer |
| udp_fragmentation optional |
integer |
| udp_total optional |
integer |
Consumes
multipart/form-data
Produces
application/json
Tags
- OP Baseline
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get the Managed Object Policy
GET /baseline/customer/{customer_id}/mo-policy/{mo_id}
Description
Get the policy info of mo_id. MO means managed object. It can be site,network or host
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | mo_id required |
Managed object id | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | mo_type required |
It can be site, network or host. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
The returned result. | result |
| Name | Schema |
|---|---|
| detect_option optional |
detect_option |
| detect_policy optional |
detect_policy |
| Name | Schema |
|---|---|
| http optional |
http |
| icmp optional |
icmp |
| ip optional |
ip |
| sip optional |
sip |
| tcp optional |
tcp |
| total optional |
total |
| udp optional |
udp |
| Name | Schema |
|---|---|
| http_flood optional |
string |
| https_flood optional |
string |
| Name | Schema |
|---|---|
| icmp_invalid optional |
string |
| icmp_total optional |
string |
| Name | Schema |
|---|---|
| ip_bogons optional |
string |
| ip_fragmentation optional |
string |
| ip_land optional |
string |
| Name | Schema |
|---|---|
| sip_flood optional |
string |
| Name | Schema |
|---|---|
| tcp_ack optional |
string |
| tcp_fragmentation optional |
string |
| tcp_invalid optional |
string |
| tcp_rst optional |
string |
| tcp_syn optional |
string |
| Name | Schema |
|---|---|
| total_traffic optional |
string |
| Name | Schema |
|---|---|
| cldap_reflection optional |
string |
| dns_amplification optional |
string |
| dns_flood optional |
string |
| ntp_amplification optional |
string |
| snmp_amplification optional |
string |
| ssdp_amplification optional |
string |
| udp_fragmentation optional |
string |
| udp_total optional |
string |
| Name | Schema |
|---|---|
| http optional |
http |
| icmp optional |
icmp |
| ip optional |
ip |
| sip optional |
sip |
| tcp optional |
tcp |
| total_traffic optional |
total_traffic |
| udp optional |
udp |
| Name | Schema |
|---|---|
| http_flood optional |
http_flood |
| https_flood optional |
https_flood |
| is_enabled optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| icmp_fragmentation optional |
icmp_fragmentation |
| icmp_invalid optional |
icmp_invalid |
| icmp_total optional |
icmp_total |
| is_enabled optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| ip_bogons optional |
ip_bogons |
| ip_fragmentation optional |
ip_fragmentation |
| ip_land optional |
ip_land |
| is_enabled optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| is_enabled optional |
integer |
| sip_flood optional |
sip_flood |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| is_enabled optional |
integer |
| tcp_ack optional |
tcp_ack |
| tcp_fragmentation optional |
tcp_fragmentation |
| tcp_invalid optional |
tcp_invalid |
| tcp_rst optional |
tcp_rst |
| tcp_syn optional |
tcp_syn |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| is_enabled optional |
integer |
| total_traffic optional |
total_traffic |
| Name | Schema |
|---|---|
| blackhole_bps optional |
integer |
| blackhole_pps optional |
integer |
| blackhole_time optional |
integer |
| direction_pps optional |
string |
| high_bps optional |
integer |
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_bps optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| cldap_reflection optional |
cldap_reflection |
| dns_amplification optional |
dns_amplification |
| dns_flood optional |
dns_flood |
| is_enabled optional |
integer |
| ntp_amplification optional |
ntp_amplification |
| snmp_amplification optional |
snmp_amplification |
| ssdp_amplification optional |
ssdp_amplification |
| udp_fragmentation optional |
udp_fragmentation |
| udp_total optional |
udp_total |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
| Name | Schema |
|---|---|
| high_pps optional |
integer |
| is_enabled optional |
integer |
| low_pps optional |
integer |
Consumes
multipart/form-data
Produces
application/json
Tags
- OP Baseline
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves Customer Proflie
GET /baseline/customer/{customer_id}/profile
Description
This API retrieves customer proflie, including customer info and customer site/network/host.
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 | OK | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
The returned result. | result |
| Name | Description | Schema |
|---|---|---|
| customer_name optional |
Name of the customer, e.g. SPE-738927-NRP. | string |
| op_sites optional |
OP site info | < op_sites > array |
| Name | Description | Schema |
|---|---|---|
| mode optional |
string | |
| moid optional |
Managed object id | string |
| networks optional |
Network info | < networks > array |
| site_name optional |
Site Name, name of the site. | string |
| Name | Description | Schema |
|---|---|---|
| hosts optional |
Host info | < hosts > array |
| moid optional |
string | |
| network_name optional |
Network name | integer |
| Name | Description | Schema |
|---|---|---|
| host_name optional |
Host name | integer |
| moid optional |
Managed object id | integer |
Consumes
multipart/form-data
Produces
application/json
Tags
- OP Baseline
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves Traffic Data
GET /baseline/traffic-data
Description
This API retrieves current customer traffic data.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | end_time required |
End time of the query. It is traffic generation timestamp. | integer |
| Query | mo_id required |
Managed object id | string |
| Query | period required |
Time granularity: 1h/3h/30m, integer in front, followed by H (hour) or m (minute). | string |
| Query | signature required |
Signature name: tcp_syn, tcp_ack, tcp_rst, tcp_invalid, 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. Send the signature names you want using array. | < string > array |
| Query | start_time required |
Start time of the query. It is traffic generation timestamp. | integer |
| Query | unit required |
Traffic unit, bps or pps | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
The returned result. | result |
| Name | Schema |
|---|---|
| detect_option optional |
detect_option |
| detect_policy optional |
string |
| Name | Schema |
|---|---|
| total optional |
total |
| Name | Schema |
|---|---|
| timestamp optional |
timestamp |
| Name | Schema |
|---|---|
| cldap_reflection optional |
integer |
| dns_amplification optional |
integer |
| dns_flood optional |
integer |
| http_flood optional |
integer |
| https_flood optional |
integer |
| icmp_invalid optional |
integer |
| icmp_total optional |
integer |
| ip_bogons optional |
integer |
| ip_fragmentation optional |
integer |
| ip_land optional |
integer |
| ntp_amplification optional |
integer |
| sip_flood optional |
integer |
| snmp_amplification optional |
integer |
| ssdp_amplification optional |
integer |
| tcp_ack optional |
integer |
| tcp_fragmentation optional |
integer |
| tcp_invalid optional |
integer |
| tcp_rst optional |
integer |
| tcp_syn optional |
integer |
| total_traffic optional |
integer |
| udp_fragmentation optional |
integer |
| udp_total optional |
integer |
Consumes
multipart/form-data
Produces
application/json
Tags
- OP Baseline
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves all actions in the commit queue that belongs to a certain site.
GET /dispatch/log/customer/{customer_id}/site/{site_id}/log-type/{log_type}
Description
This API retrieves all actions that have been saved, but have yet to be committed, of a site, using the provided Customer ID, and Site ID. This is the commit queue of a site that shows details such as username, detailed action, time, etc.. It is not to be confused with the commit queue of the portal which shows the number of actions by service category of all sites in the portal. 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 | log_type required |
Service category. Actions are categorized according to the service they modify. Two valid values are supported. One is ap. It means the actions belong to Application Protection service. And another one is op. It means the actions belong to Origin Protection service. | string |
| Path | site_id required |
Unique identifier of a site. 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. | DispatchLogResponse |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Commits actions in the commit queue.
POST /dispatch/log/customer/{customer_id}/site/{site_id}/log-type/{log_type}/commit
Description
This API commits actions associated with a site in the commit queue.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | log_type required |
Service category. Actions are categorized according to the service they modify. Three valid values are supported. One is ap. It means the actions belong to Application Protection service. One is op. It means the actions belong to Origin Protection service. And another one is cp. It means the actions belong to CleanPipe Protection service. | string |
| Path | site_id required |
Unique identifier of a site. 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 |
| FormData | dispatch_msg required |
Commit message. Usually a short description of the changes made. | 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 |
Get customer access log.
GET /spe/common/activity/customer/{customer_id}/access_log
Description
This API is used to Get customer access log.
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 required |
End time of the log create time. Date format is yyyy-MM-dd. | integer |
| Query | over_limit optional |
over limit. | integer |
| Query | page optional |
Unique identifier of a report file. | string |
| Query | start_time required |
Start time of the log create time. Date format is yyyy-MM-dd. | 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 |
result |
| Name | Description | Schema |
|---|---|---|
| logs optional |
customer access logs. | < logs > array |
| page optional |
page number. | integer |
| pages optional |
page total count. | integer |
| Name | Description | Schema |
|---|---|---|
| action optional |
customer access action. | string |
| ctime optional |
access log create time as 2023-07-18 12:58:08. | string |
| login_ip optional |
ip of user agent. | string |
| origin_ip optional |
< string > array | |
| result optional |
customer access result. | string |
| role optional |
spe use account role. | string |
| spe_uid optional |
spe user account id. | integer |
| time optional |
access log create time as timestamp. | integer |
| type optional |
customer access type. | string |
| username optional |
spe user account name. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get customer audit log.
GET /spe/common/activity/customer/{customer_id}/audit_log
Description
This API is used to Get customer activity audit log list.
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 required |
End time of the log create time. Date format is yyyy-MM-dd. | integer |
| Query | over_limit optional |
over_limit | integer |
| Query | page optional |
page | integer |
| Query | start_time required |
Start time of the log create time. Date format is yyyy-MM-dd. | 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 |
result |
| Name | Description | Schema |
|---|---|---|
| logs optional |
customer audit logs. | < logs > array |
| page optional |
page number. | integer |
| pages optional |
page total count. | integer |
| Name | Description | Schema |
|---|---|---|
| action optional |
operation audit action. | string |
| comment optional |
operation audit comment. | string |
| ctime optional |
operation audit create time as 2023-07-18 12:58:08. | string |
| customer_id optional |
customer id. | string |
| module optional |
operation audit module. | string |
| obj_id optional |
operation audit obj id. | integer |
| result optional |
operation audit result. | string |
| spe_uid optional |
spe user account id. | integer |
| spe_user_type optional |
spe user account user type. | string |
| spe_username optional |
spe user account user name. | string |
| time optional |
operation audit create time as timestamp. | integer |
| username optional |
customer name. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves Agent list by Customer ID.
GET /spe/common/customer/{customer_id}/notifier-agent
Description
This API retrieves a complete list of Agent with a certain Customer ID.
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 |
Agent List. | < result > array |
| Name | Description | Schema |
|---|---|---|
| agent_id optional |
Agent ID, an unique identifier assigned to each agent. | integer |
| agent_ip optional |
Agent ip, ip of the agent. | string |
| agent_name optional |
Agent Name, name of the agent. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Post test email of customer.
POST /spe/common/customer/{customer_id}/notifier-alert-email-test
Description
This API is used to post test email to the notifier app.
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 | email required |
Email address. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response when the API is successfully invoked. | Result |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit profile of customer by profile id.
POST /spe/common/customer/{customer_id}/notifier-sync-profile/{profile_id}
Description
This API is used to update profile to the notifier app by profile id.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | profile_id required |
Unique identifier of a profile. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Body | body required |
body |
| Name | Description | Schema |
|---|---|---|
| alert_level optional |
Alert level of email. | alert_level |
| custom_alert_times optional |
Custom alert time. default 0. | custom_alert_times |
| custom_time_enabled required |
Custom time enabled. | integer |
| delete optional |
Profile status. 0 means normal, 1 means delete | integer |
| profile_name required |
Name of profile. | string |
| Name | Description | Schema |
|---|---|---|
| ap_ddos required |
Application Protection DDoS Alert. -1 means disable, 0 means all, 1 means medium & high and 2 means high. |
integer |
| ap_waf required |
Application Protection WAF Alert. -1 means disable, 0 means all, 1 means medium & high and 2 means high. |
integer |
| cp_ddos required |
Clean Pipe DDoS Alert. -1 means disable, 0 means all, 1 means medium & high and 2 means high. |
integer |
| op_cd required |
Cloud Diversion Attack Alert. -1 means disable, 0 means all. |
integer |
| op_ddos required |
Origin Protection DDoS Alert. -1 means disable, 0 means all, 1 means medium & high and 2 means high. |
integer |
| op_flow required |
Origin Protection Flow Alert. -1 means disable, 0 means all. |
integer |
| op_td required |
Route Change Notification. -1 means disable, 0 means all. |
integer |
| Name | Description | Schema |
|---|---|---|
| time_zone optional |
Time zone. default 0. | string |
| times optional |
< times > array |
| Name | Description | Schema |
|---|---|---|
| days optional |
Cycle time. eg: 1,2,3. | < integer > array |
| is_enabled optional |
Custom time switch. 0 means disable, 1 means enable. | integer |
| time_range optional |
Time range. eg: 00:00 - 24:00. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response when the API is successfully invoked. | Result |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Synchronize settings configuration data.
POST /spe/common/customer/{customer_id}/notifier-sync-settings
Description
This API Synchronize settings configuration data with a certain Customer ID.
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 |
| Body | settings required |
settings |
| Name | Description | Schema |
|---|---|---|
| ctime optional |
Create time. | integer |
| email_limit required |
Total number of messages received per month. | string |
| month_amount required |
Total number of messages sent per month. | integer |
| mtime optional |
Update time. | integer |
| snmp_trap_agent_id required |
Agent ID of all SNMP traps. | string |
| snmp_trap_enabled required |
Master switch of all SNMP traps. 0 is off and 1 is on. |
string |
| syslog_agent_id required |
Agent ID of all syslog. | string |
| syslog_enabled required |
Master switch of all syslog. 0 is off and 1 is on. |
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 |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Synchronize syslog profile configuration data.
POST /spe/common/customer/{customer_id}/notifier-sync-syslog-profile/{profile_id}
Description
Synchronize current customer syslog profile configuration data.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | profile_id required |
Profile ID, an unique identifier assigned to each profile. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Body | profile required |
profile |
| Name | Description | Schema |
|---|---|---|
| alert_level required |
Alert level. | alert_level |
| ctime optional |
Create time. | integer |
| delete required |
Status of current profile. 0 means normal 1 means delete. |
integer |
| is_enabled required |
Is enable syslog profile. 0 means disable，1 means enable. |
integer |
| mtime optional |
Update time. | integer |
| profile_name optional |
Profile name. | string |
| syslog_server required |
syslog_server |
| Name | Description | Schema |
|---|---|---|
| ap_ddos required |
Application Protection DDoS Alert. -1 means disable, 0 means all, 1 means medium & high and 2 means high. |
integer |
| ap_waf required |
Application Protection WAF Alert. -1 means disable, 0 means all, 1 means medium & high and 2 means high. |
integer |
| cp_ddos required |
Clean Pipe DDoS Alert. -1 means disable, 0 means all, 1 means medium & high and 2 means high. |
integer |
| op_cd required |
Cloud Diversion Attack Alert. -1 means disable, 0 means all. |
integer |
| op_ddos required |
Origin Protection DDoS Alert. -1 means disable, 0 means all, 1 means medium & high and 2 means high. |
integer |
| op_flow required |
Origin Protection Flow Alert. -1 means disable, 0 means all. |
integer |
| op_td required |
Route Change Notification. -1 means disable, 0 means all. |
integer |
| Name | Description | Schema |
|---|---|---|
| address required |
Syslog server address. | string |
| facility required |
Syslog server facility. | string |
| name required |
Syslog server name. | string |
| port required |
Syslog server port. | 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/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Synchronize SNMP Trap Profile.
POST /spe/common/customer/{customer_id}/notifier-sync-trap-profile/{profile_id}
Description
This API Synchronize SNMP Trap Profile with a certain Customer ID.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | profile_id required |
Profile ID, an unique identifier assigned to each profile. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Body | profile required |
profile |
| Name | Description | Schema |
|---|---|---|
| alert_level required |
Alert level. | alert_level |
| ctime optional |
Create time. | integer |
| delete required |
Status of current profile. 0 means normal 1 means delete. |
integer |
| is_enabled required |
Is enable SNMP Trap. 0 means disable，1 means enable. |
integer |
| mtime optional |
Update time. | integer |
| profile_name optional |
Profile name. | string |
| snmp_trap_server required |
SNMP Trap Server. | snmp_trap_server |
| Name | Description | Schema |
|---|---|---|
| ap_ddos required |
Application Protection DDoS Alert. -1 means disable, 0 means all, 1 means medium & high and 2 means high. |
integer |
| ap_waf required |
Application Protection WAF Alert. -1 means disable, 0 means all, 1 means medium & high and 2 means high. |
integer |
| cp_ddos required |
Clean Pipe DDoS Alert. -1 means disable, 0 means all, 1 means medium & high and 2 means high. |
integer |
| op_cd required |
Cloud Diversion Attack Alert. -1 means disable, 0 means all. |
integer |
| op_ddos required |
Origin Protection DDoS Alert. -1 means disable, 0 means all, 1 means medium & high and 2 means high. |
integer |
| op_flow required |
Origin Protection Flow Alert. -1 means disable, 0 means all. |
integer |
| op_td required |
Route Change Notification. -1 means disable, 0 means all. |
integer |
| Name | Description | Schema |
|---|---|---|
| address required |
SNMP Trap Server address. | string |
| community required |
SNMP Trap Server community. | string |
| name required |
SNMP Trap Server name. | string |
| port required |
SNMP Trap Server port. | integer |
| version required |
SNMP Trap Server version. | 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/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Send test message.
POST /spe/common/customer/{customer_id}/notifier-test-message/{profile_id}/{profile_type}
Description
This API is used to send test messages with a certain Customer ID.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | profile_id required |
Profile ID. | integer |
| Path | profile_type required |
Profile type. (snmp_trap or syslog) | 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 |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit email template of the notifier app.
POST /spe/common/customer/{customer_id}/notifier/edit-email-template
Description
This API is used to edit email template of the notifier app.
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 | attackType required |
Type of attack,for example AP/OP/CP/FLOW/OP_CD/OP_TD | enum (AP, OP, CP, FLOW, OP_CD, OP_TD) |
| FormData | closing required |
Email closing. | string |
| FormData | logoFile optional |
Email logo file. | file |
| FormData | salutation optional |
Email salutation. | string |
| FormData | signature required |
Email signature. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response when the API is successfully invoked. | Result |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Reset email template of the notifier app.
POST /spe/common/customer/{customer_id}/notifier/reset-email-template
Description
This API is used to reset email template of the notifier app.
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 | attackType required |
Type of attack,for example AP/OP/CP/FLOW/OP_CD/OP_TD | enum (AP, OP, CP, FLOW, OP_CD, OP_TD) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response when the API is successfully invoked. | Result |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get bgp status.
GET /spe/common/customer/{customer_id}/on-net-bgp-status
Description
This API is used to Get customer bgp status.
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 |
|---|---|---|
| peers optional |
BGP peers | < peers > array |
| Name | Description | Schema |
|---|---|---|
| peer_id optional |
Unique identifier of a BGP peer. | string |
| status optional |
BGP status,will be UP or Down. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get customer Service Report for month.
GET /spe/common/customer/{customer_id}/report
Description
This API is used to Get customer service Report for month.
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 | num optional |
Page item count. | integer |
| Query | search_key optional |
Search by report file name. | string |
| Query | service_type optional |
Service Type.For example:all,ap,cp,op,dp | string |
| Query | start optional |
Page number. | integer |
| Query | time_range optional |
Time Range,1 means last 3 month,2 means last 6 month,3 means last year,default is 1. | 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 |
Result Data | result |
| Name | Description | Schema |
|---|---|---|
| num optional |
integer | |
| report_files optional |
report file info array. | < report_files > array |
| start optional |
integer |
| Name | Description | Schema |
|---|---|---|
| download_count optional |
Download count of the report file. | integer |
| report_id optional |
ID of the report file. | string |
| report_name optional |
Name of the report. | string |
| report_time optional |
Report time of the report file. | number |
| service_type optional |
Service type of the report file. | string |
| status optional |
The status of the report file. 1 means loading,2 means file created,3 means file created failed | integer |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get customer Service Report statistics.
GET /spe/common/customer/{customer_id}/report/statistics
Description
This API is used to Get customer service Report statistics.
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 |
result |
| Name | Description | Schema |
|---|---|---|
| series optional |
Report file statistics | series |
| time optional |
Report files produce date in every month. | < integer > array |
| Name | Description | Schema |
|---|---|---|
| ap optional |
Application Protection report file count every month. | ap |
| cp optional |
Cleanpipe Protection report file count every month. | cp |
| dp optional |
DNS Protection report file count every month. | dp |
| op optional |
Origin Protection report file count every month. | op |
| Name | Schema |
|---|---|
| data optional |
< integer > array |
| Name | Schema |
|---|---|
| data optional |
< integer > array |
| Name | Schema |
|---|---|
| data optional |
< integer > array |
| Name | Schema |
|---|---|
| data optional |
< integer > array |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get customer Service Report summary.
GET /spe/common/customer/{customer_id}/report/summary
Description
This API is used to Get customer service Report summary.
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 |
result |
| Name | Description | Schema |
|---|---|---|
| ap_report_count optional |
Application Protection report file count. | integer |
| cp_report_count optional |
Cleanpipe Protection report file count. | integer |
| dp_report_count optional |
DNS Protection report file count. | integer |
| op_report_count optional |
Origin Protection report file count. | integer |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get customer Service Report File for month.
GET /spe/common/customer/{customer_id}/report/{report_id}/download
Description
This API is used to Get customer service Report File for month.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | report_id required |
Unique identifier of a report file. | 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 |
result |
| Name | Description | Schema |
|---|---|---|
| download_url optional |
Visit this url to get report file. | string |
Consumes
application/octet-stream
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get partner detail.
GET /spe/common/partner/{spe_gid}
Description
Get partner detail.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | spe_gid required |
Unique identifier of a partner. | 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 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
Properties of the partner. | < result > array |
| Name | Description | Schema |
|---|---|---|
| as_number optional |
Autonomous System (AS) Numbers. | string |
| spe_gid optional |
Unique identifier of a partner. | string |
| spe_group_desc optional |
Partner group description. | string |
| spe_group_name optional |
Partner group name. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
.
POST /spe/common/partner/{spe_gid}/billing/records
Description
.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | spe_gid required |
Unique identifier of a partner. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Body | body optional |
body |
| Name | Description | Schema |
|---|---|---|
| ctime optional |
Records the date of upload, format for example: 2024-08-18 10:18:59 | string |
| customer_id required |
Unique identifier of a customer. | string |
| exinfo required |
The specific content of the order record is customized by the partner. | < object > array |
| record_type optional |
Records type.It is recommended to use occupation/release. | string |
| resource_type optional |
Resource type.It is recommended to use site/domain/bandwidth. | string |
| 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 |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| records_id optional |
Unique identifier of a billing record. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Adds, updates, or deletes an entry to, on, or from the notification email address list.
POST /spe/common/partner/{spe_gid}/notifier-email
Description
Depending on the parameter passed, this API would perform one of the following operations. If the ID does not exist, the entry is added. If the ID already exists, and delete is set to 0, then the entry is updated. If the ID already exists, and delete is set to 1, the entry is delete. See notes on individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | spe_gid required |
Unique identifier of a partner. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | email required |
The newly added email address and its settings, which include its ID, which types of notification emails it receives, whether it is enabled, and whether it is deleted. | 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 |
Edit profile of customer by profile id.
POST /spe/common/partner/{spe_gid}/notifier-sync-profile/{profile_id}
Description
This API is used to update profile to the notifier app by profile id.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | profile_id required |
Unique identifier of a profile. | string |
| Path | spe_gid required |
Unique identifier of a partner. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Body | body required |
body |
| Name | Description | Schema |
|---|---|---|
| alert_level optional |
Alert level of email. | alert_level |
| custom_alert_times optional |
Custom alert time. default 0. | custom_alert_times |
| custom_time_enabled required |
Custom time enabled. | integer |
| delete optional |
Profile status. 0 means normal, 1 means delete | integer |
| profile_name required |
Name of profile. | string |
| Name | Description | Schema |
|---|---|---|
| ap_ddos required |
Application Protection DDoS Alert. -1 means disable, 0 means all, 1 means medium & high and 2 means high. |
integer |
| ap_waf required |
Application Protection WAF Alert. -1 means disable, 0 means all, 1 means medium & high and 2 means high. |
integer |
| cp_ddos required |
Clean Pipe DDoS Alert. -1 means disable, 0 means all, 1 means medium & high and 2 means high. |
integer |
| op_cd required |
Cloud Diversion Attack Alert. -1 means disable, 0 means all. |
integer |
| op_ddos required |
Origin Protection DDoS Alert. -1 means disable, 0 means all, 1 means medium & high and 2 means high. |
integer |
| op_flow required |
Origin Protection Flow Alert. -1 means disable, 0 means all. |
integer |
| op_td required |
Route Change Notification. -1 means disable, 0 means all. |
integer |
| Name | Description | Schema |
|---|---|---|
| time_zone optional |
Time zone. default 0. | string |
| times optional |
< times > array |
| Name | Description | Schema |
|---|---|---|
| days optional |
Cycle time. eg: 1,2,3. | < integer > array |
| is_enabled optional |
Custom time switch. 0 means disable, 1 means enable. | integer |
| time_range optional |
Time range. eg: 00:00 - 24:00. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response when the API is successfully invoked. | Result |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Adds, updates, or deletes an entry to, on, or from the notification email address list.
POST /spe/common/partner/{spe_gid}/sync-sender-email
Description
Depending on the parameter passed, this API would perform one of the following operations. If the ID does not exist, the entry is added. If the ID already exists, and delete is set to 0, then the entry is updated. If the ID already exists, and delete is set to 1, the entry is delete. See notes on individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | spe_gid required |
Unique identifier of a partner. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | sender_email required |
The newly added email address and its settings, which include its ID, which types of notification emails it receives, whether it is enabled, and whether it is deleted. | 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 |
Get partner list.
GET /spe/common/partners
Description
Get All partner.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| 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 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
Properties of the partner. | < result > array |
| Name | Description | Schema |
|---|---|---|
| spe_gid optional |
Unique identifier of a partner. | string |
| spe_group_desc optional |
Partner group description. | string |
| spe_group_name optional |
Partner group name. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves a notification email template according to attack event type.
GET /spe/customer/{customer_id}/email-template
Description
This API retrieves a notification email template, using the provided Customer ID and attack event type. 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 | attack_type required |
Attack event type. Possible values are: ap_ddos, ap_waf, op_ddos, and op_flow. |
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 | result |
| Name | Description | Schema |
|---|---|---|
| closing optional |
Sign-off part of the email message. | string |
| imgurl optional |
URL to the logo image in the email. | string |
| salutation optional |
Salutation part of the email message. | string |
| signature optional |
Signature part of the email message. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Adds, updates, or deletes an entry to, on, or from the notification email address list.
POST /spe/customer/{customer_id}/notifier-email
Description
Depending on the parameter passed, this API would perform one of the following operations. If the ID does not exist, the entry is added. If the ID already exists, and delete is set to 0, then the entry is updated. If the ID already exists, and delete is set to 1, the entry is delete. 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 | email required |
The newly added email address and its settings, which include its ID, which types of notification emails it receives, whether it is enabled, and whether it is deleted. | 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 |
Retrieves a list of emails addresses set to receive notification emails.
GET /spe/customer/{customer_id}/notifier-email
Description
This is is used by Nexusguard Event Notifier to retrieve a list of emails addresses set to receive notification emails, including those that have been disabled at the time of the retrieval, using the provided Customer ID. 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 |
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 returned list of email addresses, along with its ID and the number of notification emails sent to date. | < result > array |
| Name | Description | Schema |
|---|---|---|
| count optional |
Number of notification emails sent to the email address to date. | integer |
| email_address optional |
Email address. | string |
| id optional |
Unique identifier for the email address. | integer |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves monthly email and attack events statistics.
GET /spe/customer/{customer_id}/notifier-stat-by-month
Description
This API retrieves monthly email and attack events statistics, using the provided Customer ID. 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 | month required |
An integer that defines how many calendar months’ worth of stats should be retrieved. The default value is 12, which means the last 12 calendar months’ (including the current one) numbers are retrieved. | 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 |
Returned monthly event numbers along with additional information, categorized by attack type. | result |
| Name | Description | Schema |
|---|---|---|
| ap_ddos optional |
Attack event type: AP DDoS | < ap_ddos > array |
| ap_waf optional |
Attack event type: AP WAF | < ap_waf > array |
| op_ddos optional |
Attack event type: OP DDoS | < op_ddos > array |
| op_flow optional |
Attack event type: OP Flow | < op_flow > array |
| Name | Description | Schema |
|---|---|---|
| email_count optional |
Total number of emails sent within the month. | integer |
| event_count optional |
Total number of AP DDoS attack events occurred within the month. | integer |
| time optional |
Timestamp that mark the start of each calendar month, in Unix time format. If the numbers belongs to June, 2018, then this timestamp would be 1527724800. | integer |
| Name | Description | Schema |
|---|---|---|
| email_count optional |
Total number of emails sent within the month. | integer |
| event_count optional |
Total number of attack events occurred within the month. | integer |
| time optional |
Timestamp that mark the start of each calendar month, in Unix time format. If the numbers belongs to June, 2018, then this timestamp would be 1527724800. | integer |
| Name | Description | Schema |
|---|---|---|
| email_count optional |
Total number of emails sent within the month. | integer |
| event_count optional |
Total number of attack events occurred within the month. | integer |
| time optional |
Timestamp that mark the start of each calendar month, in Unix time format. If the numbers belongs to June, 2018, then this timestamp would be 1527724800. | integer |
| Name | Description | Schema |
|---|---|---|
| email_count optional |
Total number of emails sent within the month. | integer |
| event_count optional |
Total number of attack events occurred within the month. | integer |
| time optional |
Timestamp that mark the start of each calendar month, in Unix time format. If the numbers belongs to June, 2018, then this timestamp would be 1527724800. | integer |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get resource limit
GET /spe/customer/{customer_id}/resource-limit
Description
This API retrieves current customer resource limit.
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 | app_name required |
The name of app. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
The returned result. | result |
| Name | Description | Schema |
|---|---|---|
| limit_profile_num optional |
Limit profile number. | integer |
| limit_router_num optional |
Limit router number. | integer |
| limit_rule_num_per_profile optional |
Limit rule number per profile. | integer |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get SSO login URL to access customer portal.
GET /spe/sso_login_url/unique_customer_id/{customer_id}/account_id/{account_id}/email/{email_address}
Description
You can get an SSO login URL and let the partner account directly access the customer portal through this URL.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | account_id required |
Unique identifier of a account. | string |
| Path | customer_id required |
Unique identifier of a customer. | string |
| Path | email_address required |
Unique identifier of a email. | 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 |
result |
| Name | Description | Schema |
|---|---|---|
| sso_login_url optional |
A sso login url, allowing the partner to directly access the customer portal through this url. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Definitions
DispatchLogResponse
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
The returned result. | result |
| Name | Description | Schema |
|---|---|---|
| auditlog optional |
< auditlog > array | |
| customer_id optional |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| dsp_num optional |
Total number of actions in the commit queue. | integer |
| site_id optional |
string |
| Name | Description | Schema |
|---|---|---|
| ctime optional |
Time of the action. | string (date-time) |
| log_action optional |
An auto generated description of the action, e.g., Update whitelist & blacklist policy of AppShield. | string |
| log_obj_name optional |
Name of the site to which the site belong. | string |
| username optional |
The user that took the action. | string |
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