AppShield
AppShield
Overview
Application Protection AppShield 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
Adds a new entry to the IP Blacklist under AppShield.
POST /policy/appshield/customer/{customer_id}/site/{site_id}/domain-port/{domain_port_id}/ip-black-list
Description
This API adds a new entry to the IP Blacklist under AppShield, using the provided Customer ID, Site ID, Domain Port ID and Policy 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 |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | ip_black_list optional |
Entry to be added to the IP Blacklist, in the form of IP ranges, e.g., 1.1.1.1-1.1.1.255. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | IpBlackListResponse |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves IPs on the IP Blacklist under AppShield.
GET /policy/appshield/customer/{customer_id}/site/{site_id}/domain-port/{domain_port_id}/ip-black-list
Description
This API retrieves the IPs on the IP Blacklist under AppShield, using the provided Customer ID, Site ID, and Domain Port 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 |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application 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. | IpBlackListResponse |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Deletes entries from the IP Blacklist under AppShield.
DELETE /policy/appshield/customer/{customer_id}/site/{site_id}/domain-port/{domain_port_id}/ip-black-list
Description
This API deletes entries from the IP Blacklist, using the provided Customer ID, Site ID, Domain Port ID and Policy 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 |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | ip_black_list optional |
Entries to be deleted to the IP Blacklist, in the form of IP ranges, e.g., 1.1.1.1-1.1.1.255. Multiple entries should be separated using ,. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Result |
Consumes
multipart/x-www-form-urlencode
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Adds a new entry to the IP Whitelist.
POST /policy/appshield/customer/{customer_id}/site/{site_id}/domain-port/{domain_port_id}/ip-white-list
Description
This API adds a new entry to the IP Whitelist under AppShield, using the provided Customer ID, Site ID, Domain Port ID and Policy 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 |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | ip_white_list required |
Entry to be added to the IP Whitelist, in the form of IP ranges, e.g., 1.1.1.1-1.1.1.255. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | IpWhiteListResponse |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves the IPs on the IP whitelist.
GET /policy/appshield/customer/{customer_id}/site/{site_id}/domain-port/{domain_port_id}/ip-white-list
Description
This API retrieves the IPs on the IP Whitelist, using the provided Customer ID, Site ID and Domain Port ID. Traffic from IPs on the whitelist bypasses protection policies.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application 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. | IpWhiteListResponse |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Deletes entries from the IP Whitelist.
DELETE /policy/appshield/customer/{customer_id}/site/{site_id}/domain-port/{domain_port_id}/ip-white-list
Description
This API deletes entries from the IP Whitelist, using the provided Customer ID, Site ID, Domain Port ID and Policy 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 |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | ip_white_list required |
Entries to be deleted to the IP Whitelist, in the form of IP ranges, e.g., 1.1.1.1-1.1.1.255. Multiple entries should be separated using ,. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Result |
Consumes
multipart/x-www-form-urlencode
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Adds an entry to the Status Code Overwrite list.
POST /policy/appshield/customer/{customer_id}/site/{site_id}/domain-port/{domain_port_id}/status-code
Description
This API adds an entry to the Status Overwrite list, using the provided Customer ID. Status Code Overwrite custom status pages instead of stock status pages and supports the overwriting of HTTP status code 400-417 and 500-505 to anything between 100 and 999. 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 | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | error_code required |
The status code you want to overwrite. | integer |
| FormData | error_code_rewrite required |
The status code you want to overwrite to. | integer |
| FormData | error_page_info optional |
This parameter is required when 2 or Custom status pages is selected for error_page_type. This is the URL to the status page to display. |
string |
| FormData | error_page_type required |
The type of status page to display. There are 3 types of pages. 0 means Default - Rewrites one status code to another and displays stock HTTP status page. 1 means NXG status pages - Rewrites one status code to another and displays Nexusguard customized status pages. 2 means Custom status pages - Rewrites one status code to another and displays a custom status page using a URL. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | StatusCodeResponse |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Updates an entry on the Status Code Overwrite list.
PUT /policy/appshield/customer/{customer_id}/site/{site_id}/domain-port/{domain_port_id}/status-code
Description
This API updates an entry on the Status Code Overwrite list, using the provided Customer ID and Status Code. 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 | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | error_code required |
An existing status code on the list. This is used to match the entry to update. | integer |
| FormData | error_code_rewrite required |
The new status code you want to overwrite to. | integer |
| FormData | error_page_info optional |
This parameter is required when 2 or Custom status pages is selected for error_page_type. This is the URL to the status page to display. |
string |
| FormData | error_page_type required |
The new type of status page to display. There are 3 types of pages. 0 means Default - Rewrites one status code to another and displays stock HTTP status page. 1 means NXG status pages - Rewrites one status code to another and displays Nexusguard customized status pages. 2 means Custom status pages - Rewrites one status code to another and displays a custom status page using a URL. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | StatusCodeResponse |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Deletes an entry on the Status Code Overwrite list.
DELETE /policy/appshield/customer/{customer_id}/site/{site_id}/domain-port/{domain_port_id}/status-code
Description
This API deletes an entry on the Status Code Overwrite list, using the provided Customer ID and Status Code. 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 | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | error_code required |
An existing status code on the list. This is used to match the entry to delete. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Result |
Consumes
multipart/x-www-form-urlencode
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieve entries on the Status Code Overwrite list.
GET /policy/appshield/customer/{customer_id}/site/{site_id}/domain-port/{domain_port_id}/status-codes
Description
This API retrieves entries on the Status Code Overwrite list, using the provides Customer ID, Site ID, and Domain Port 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 |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application 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. | StatusCodeResponse |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Updates the state of switches under AppShield.
POST /policy/appshield/customer/{customer_id}/site/{site_id}/domain-port/{domain_port_id}/switch
Description
This API updates the state of switches under AppShield, using the provided Customer ID, Site ID, and Domain Port ID.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | enable required |
State of the switch. 0 means it is disabled and 1 means enabled. |
integer |
| FormData | name required |
Policy name | 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 |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves the state of all switches under AppShield.
GET /policy/appshield/customer/{customer_id}/site/{site_id}/domain-port/{domain_port_id}/switches
Description
This API retrieves the state of all switches under AppShield, using provided Customer ID, Site ID, and Domain Port 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 |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
The state of all switches under AppShield. | result |
| Name | Description | Schema |
|---|---|---|
| p_auth optional |
HTTP Authentication Policy switch | p_auth |
| p_error_rewrite optional |
Status Code Overwrite switch | p_error_rewrite |
| p_filt optional |
HTTP Filter Policy switch | p_filt |
| p_malf optional |
HTTP Compliance Policy switch | p_malf |
| p_wbl optional |
The state of all switches under Whitelist & Blacklist Policy. | p_wbl |
| Name | Description | Schema |
|---|---|---|
| enable optional |
State of the switch. 0 means it is disabled and 1 means enabled. |
integer |
| name optional |
Policy name | string |
| Name | Description | Schema |
|---|---|---|
| enable optional |
State of the switch. 0 means it is disabled and 1 means enabled. |
integer |
| name optional |
Policy name | string |
| Name | Description | Schema |
|---|---|---|
| enable optional |
State of the switch. 0 means it is disabled and 1 means enabled. |
integer |
| name optional |
Policy name | string |
| Name | Description | Schema |
|---|---|---|
| accept_invalid_http_request optional |
Allow Non-ASCII encoding In URI switch | accept_invalid_http_request |
| advanced optional |
Advanced HTTP Header Policy switch | advanced |
| enable optional |
State of the switch. 0 means it is disabled and 1 means enabled. |
integer |
| name optional |
Policy name | string |
| Name | Description | Schema |
|---|---|---|
| enable optional |
State of the switch. 0 means it is disabled and 1 means enabled. |
integer |
| name optional |
Policy name | string |
| Name | Description | Schema |
|---|---|---|
| enable optional |
State of the switch. 0 means it is disabled and 1 means enabled. |
integer |
| name optional |
Policy name | string |
| Name | Description | Schema |
|---|---|---|
| api optional |
URL Bypass switch | api |
| bypass optional |
File Extension Bypass switch | bypass |
| enable optional |
State of the switch. 0 means it is disabled and 1 means enabled. |
integer |
| mobile optional |
Mobile Bypass switch | mobile |
| name optional |
Policy name | string |
| spider optional |
Spider Bypass switch | spider |
| ua_black_list optional |
UA Blacklist switch | ua_black_list |
| Name | Description | Schema |
|---|---|---|
| enable optional |
State of the switch. 0 means it is disabled and 1 means enabled. |
integer |
| name optional |
Policy name | string |
| Name | Description | Schema |
|---|---|---|
| enable optional |
State of the switch. 0 means it is disabled and 1 means enabled. |
integer |
| name optional |
Policy name | string |
| Name | Description | Schema |
|---|---|---|
| enable optional |
State of the switch. 0 means it is disabled and 1 means enabled. |
integer |
| name optional |
Policy name | string |
| Name | Description | Schema |
|---|---|---|
| enable optional |
State of the switch. 0 means it is disabled and 1 means enabled. |
integer |
| name optional |
Policy name | string |
| Name | Description | Schema |
|---|---|---|
| enable optional |
State of the switch. 0 means it is disabled and 1 means enabled. |
integer |
| name optional |
Policy name | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Adds entries to the UA Blacklist.
POST /policy/appshield/customer/{customer_id}/site/{site_id}/domain-port/{domain_port_id}/ua-black-list
Description
This API adds entries to the UA Blacklist under AppShield, using the provided Customer ID, Site ID, and Domain Port 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 |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | ua_regex required |
Entries to be added to the UA Blacklist. Regular expression is supported and multiple entries should be separated by ,. |
< string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UaBlackResponse |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves entries on the UA Blacklist.
GET /policy/appshield/customer/{customer_id}/site/{site_id}/domain-port/{domain_port_id}/ua-black-list
Description
This API retrieves all entries on the UA Blacklist under AppShield, using the provided Customer ID, Site ID, and Domain Port 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 |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application 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. | UaBlackResponse |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Deletes entries from the UA Blacklist.
DELETE /policy/appshield/customer/{customer_id}/site/{site_id}/domain-port/{domain_port_id}/ua-black-list
Description
This API deletes entries to the UA Blacklist under AppShield, using the provided Customer ID, Site ID, and Domain Port 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 |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | ua_regex optional |
Entries on the UA Blacklist. These should be exactly as they appear on the list in order for the action to succeed. | < string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Result |
Consumes
multipart/x-www-form-urlencode
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Modify Authentication Policy/Auto Mitigation configuration.
POST /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/authentication/base
Description
Modify Authentication Policy/Auto Mitigation Threshold and End Time configuration.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | duration required |
End Time. Unit is sec. | integer |
| FormData | threshold_tps required |
Auto Mitigation Threshold value. Unit is req/s. | integer |
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 |
Obtain Authentication Policy/Auto Mitigation info.
GET /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/authentication/base
Description
Obtain Authentication Policy/Auto Mitigation Threshold, Start Time and End Time configuration info.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| duration optional |
End Time. Unit is sec. | integer |
| recaptcha_per_ip_tps optional |
Start Time. Unit is sec. | integer |
| threshold_tps optional |
Auto Mitigation Threshold值. Unit is req/s. | integer |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Add Authentication Policy/HTTP Authentication/Bypass List.
POST /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/authentication/bypass
Description
Add Authentication Policy/HTTP Authentication/Bypass List configuration.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | host required |
Host name. | string |
| FormData | scheme required |
http or https. | string |
| FormData | uri required |
uri. | 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 |
Obtain Authentication Policy/HTTP Authentication/Bypass List info.
GET /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/authentication/bypass
Description
Obtain Authentication Policy/HTTP Authentication/Bypass List configuration info list.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
< result > array |
| Name | Description | Schema |
|---|---|---|
| host optional |
Host name | string |
| scheme optional |
http or https | string |
| uri optional |
uri | string |
| url_id optional |
Unique ID | integer |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete Authentication Policy/HTTP Authentication/Bypass List.
DELETE /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/authentication/bypass/{url_id}
Description
Delete an Authentication Policy/HTTP Authentication/Bypass List record.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Path | url_id required |
The unique ID of bypass records. | integer |
| 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
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit Authentication Policy/HTTP Authentication.
POST /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/authentication/http
Description
Edit Authentication Policy/HTTP Authentication switch status and configuration.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | enforce_protect required |
Protection mode. 1 is low. 2 is medium. 3 is high. It takes effect when protection mode is on. | integer |
| FormData | max_http_request required |
Max HTTP Requests per user. Unit is reqs/min. | integer |
| FormData | mode required |
Switch status. 0 is off. 1 is on. 2 is auto. When the status is on or auto, the remaining parameters take effect. | integer |
| FormData | p3p_enabled required |
P3P Support switch status. 0 is off. 1 is on. | integer |
| FormData | p3p_string optional |
p3p info, which takes effect when P3P Support is enabled. | integer |
| FormData | trust_duration required |
Trust Duration. Unit is sec. | integer |
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 |
Obtain Authentication Policy/HTTP Authentication.
GET /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/authentication/http
Description
Obtain Authentication Policy/HTTP Authentication switch status and configuration information.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| enforce_protect optional |
Protection mode. 1 is low. 2 is medium. 3 is high. | integer |
| max_http_request optional |
Max HTTP Requests per user. Unit is reqs/min. | integer |
| mode optional |
Switch status. 0 is off. 1 is on. 2 is auto. | integer |
| p3p_enabled optional |
P3P Support switch status. 0 is off. 1 is on. | integer |
| p3p_string optional |
p3p info, which takes effect when P3P Support is enabled. | string |
| trust_duration optional |
Trust Duration. Unit is sec. | integer |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Modify Authentication Policy/IP Authentication.
POST /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/authentication/ip
Description
Modify Authentication Policy/IP Authentication switch status and configuration.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Body | body required |
Pet object that needs to be added to the store | body |
| Name | Description | Schema |
|---|---|---|
| action required |
Source IP Authentication Action,in (ratelimit 、blacklist、ratelimit_blacklist). When action is ratelimit, you can only set the threshold of action_ratelimit. When action is blacklist, you can only set the threshold of action_blacklist. When action is ratelimit_blacklist, you can only set the threshold of action_ratelimit_blacklist. | string |
| action_blacklist optional |
Blacklist threshold info. | action_blacklist |
| action_ratelimit optional |
Rate Limit threshold info. | action_ratelimit |
| action_ratelimit_blacklist optional |
Rate Limit & Blacklist threshold info. | action_ratelimit_blacklist |
| enable required |
IP Authentication switch status. 0 is off. 1 is on. 2 is auto. | integer |
| mode required |
Source IP Authentication switch status. 0 is off. 1 is monitor. 2 is block. | integer |
| Name | Description | Schema |
|---|---|---|
| duration optional |
Duration threshold value. Unit is sec. | integer |
| threshold_rps optional |
Attack threshold value. Unit is req/s. | integer |
| Name | Description | Schema |
|---|---|---|
| duration optional |
Duration threshold value. Unit is sec. | integer |
| ratelimit_rps optional |
Ratelimit to threshold value. Unit is req/s. | integer |
| threshold_rps optional |
Attack threshold value. Unit is req/s. | integer |
| Name | Description | Schema |
|---|---|---|
| blacklist_threshold_rps optional |
Blacklist/Attack threshold value. Unit is req/s. | integer |
| duration optional |
Blacklist/Duration threshold value. Unit is sec. | integer |
| ratelimit_rps optional |
Rate Limit/Ratelimit to threshold value. Unit is req/s. | integer |
| ratelimit_threshold_rps optional |
Rate Limit/Attack threshold value. Unit is req/s. | integer |
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 |
Obtain Authentication Policy/IP Authentication info.
GET /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/authentication/ip
Description
Obtain Authentication Policy/IP Authentication switch status and configuration info.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| action optional |
Source IP Authentication Action. | string |
| action_blacklist optional |
Blacklist threshold info. | action_blacklist |
| action_ratelimit optional |
Rate Limit threshold info. | action_ratelimit |
| action_ratelimit_blacklist optional |
Rate Limit & Blacklist threshold info. | action_ratelimit_blacklist |
| enable optional |
IP Authentication switch status. 0 is off. 1 is on. 2 is auto. | integer |
| mode optional |
Source IP Authentication on/off status. 0 is off. 1 is monitor. 2 is block. | integer |
| Name | Description | Schema |
|---|---|---|
| duration optional |
Duration threshold value. Unit is sec. | integer |
| threshold_rps optional |
Attack threshold value. Unit is req/s. | integer |
| Name | Description | Schema |
|---|---|---|
| duration optional |
Duration threshold value. Unit is sec. | integer |
| ratelimit_rps optional |
Ratelimit to threshold value. Unit is req/s. | integer |
| threshold_rps optional |
Attack threshold value. Unit is req/s. | integer |
| Name | Description | Schema |
|---|---|---|
| blacklist_threshold_rps optional |
Blacklist/Attack threshold value. Unit is req/s. | integer |
| duration optional |
Blacklist/Duration threshold value. Unit is sec. | integer |
| ratelimit_rps optional |
Rate Limit/Ratelimit to threshold value. Unit is req/s. | integer |
| ratelimit_threshold_rps optional |
Rate Limit/Attack threshold value. Unit is req/s. | integer |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Modify Required Header switch status.
POST /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/compliance/request-header
Description
Modify required header switch status under HTTP Compliance Policy.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | http_type required |
Protocol version，in (http09 http10 http11). | string |
| FormData | name required |
Switch name，in (host_required,user_agent_required,accept_required,connection_required,accept_encoding_required). | string |
| FormData | value required |
Switch status. 0 is off. 1 is on. | integer |
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 |
Obtain Required Header switch list.
GET /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/compliance/request-header
Description
Obtain the list of Required Header switches under HTTP Compliance Policy.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| http09 optional |
HTTP0.9 switch status. | http09 |
| http10 optional |
HTTP1.0 switch status. | http10 |
| http11 optional |
HTTP1.1 switch status. | http11 |
| Name | Description | Schema |
|---|---|---|
| accept_encoding_required optional |
Accept-Encoding switch status. 0 is off. 1 is on. | integer |
| accept_required optional |
Accept switch status. 0 is off. 1 is on. | integer |
| connection_required optional |
Connection switch status. 0 is off. 1 is on. | integer |
| host_required optional |
Host switch status. 0 is off. 1 is on. | integer |
| user_agent_required optional |
User-Agent switch status. 0 is off. 1 is on. | integer |
| Name | Description | Schema |
|---|---|---|
| accept_encoding_required optional |
The Accept-Encoding switch status. 0 is off. 1 is on. | integer |
| accept_required optional |
Accept switch status. 0 is off. 1 is on. | integer |
| connection_required optional |
Connection switch status. 0 is off. 1 is on. | integer |
| host_required optional |
Host switch status. 0 is off. 1 is on. | integer |
| user_agent_required optional |
User-Agent switch status. 0 is off. 1 is on. | integer |
| Name | Description | Schema |
|---|---|---|
| accept_encoding_required optional |
Accept-Encoding switch status. 0 is off. 1 is on. | integer |
| accept_required optional |
Accept switch status. 0 is off. 1 is on. | integer |
| connection_required optional |
Connection switch status. 0 is off. 1 is on. | integer |
| host_required optional |
Host switch state. 0 is off. 1 is on. | integer |
| user_agent_required optional |
User-Agent switch status. 0 is off. 1 is on. | integer |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Add HTTP Filter Policy.
POST /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/http-filter
Description
Add HTTP Filter Policy. Concurrency is not supported.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | action required |
Actions to take when a match is found.in (ACCEPT, BLOCK_HTTP, PASS, BUSY_PAGE, URL_REDIRECTION, DOMAIN_REDIRECTION). When Action is URL_REDIRECTION, rp_code, scheme, redirect_host and redirect_url must be filled. When Action is DOMAIN_REDIRECTION, rp_code, scheme and redirect_host must be filled. When Action is BUSY_PAGE, page must be filled. | string |
| FormData | host required |
Host name | string |
| FormData | methods optional |
Request method list，in (GET, POST, PUT, DELETE, HEAD, OPTIONS, TRACE, CONNECTION, OTHER). | < string > array |
| FormData | other_iprange optional |
Source IP Range,eg: 1.1.1.1-1.1.1.254.The maximum number of ips is 256. | < string > array |
| FormData | p_desc optional |
Policy description | string |
| FormData | p_name required |
Policy name | string |
| FormData | page optional |
page. Please refer to the configuration of the UI, which were dynamically assigned by the administrator. | string |
| FormData | redirect_host optional |
redirect host. | string |
| FormData | redirect_url optional |
redirect URI. | string |
| FormData | rp_code optional |
response code （301 or 302）. | integer |
| FormData | scheme optional |
scheme （http or https）. | string |
| FormData | uri required |
Path name. Regular expressions supported. | 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 |
|---|---|---|
| p_flag_id optional |
Filter policy ID, an unique identifier assigned to each Filter policy. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Obtain the HTTP Filter Policy list.
GET /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/http-filter
Description
Obtain the HTTP Filter Policy list.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
< result > array |
| Name | Description | Schema |
|---|---|---|
| action optional |
Actions to take when a match is found,in (ACCEPT、BLOCK HTTP、PASS、BUSY PAGE、URL REDIRECTION、DOMAIN REDIRECTION). | < string > array |
| action_annex optional |
action: Extended configuration | action_annex |
| methods optional |
HTTP method list, range list (GET, POST, PUT, DELETE, HEAD, OPTIONS, TRACE, CONNECTION, OTHER). | < string > array |
| other_iprange optional |
IP range. | < other_iprange > array |
| p_desc optional |
Policy description. | string |
| p_flag_id optional |
The unique ID of the policy. | string |
| p_name optional |
Policy name. | string |
| url optional |
Composed of host and uri. | string |
| Name | Description | Schema |
|---|---|---|
| http_code optional |
Response Code. This field exists when action is URL_REDIRECTION or DOMAIN_REDIRECTION. | integer |
| page optional |
Page. This field exists when action is BUSY_PAGE. | string |
| url optional |
URL. This field exists when action is URL_REDIRECTION or DOMAIN_REDIRECTION. | string |
| Name | Description | Schema |
|---|---|---|
| end_ip optional |
End IP of the IP range. | string |
| start_ip optional |
Start IP of the IP range. | string |
| type optional |
Input type of IP | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Obtain the specified HTTP Filter Policy information.
GET /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/http-filter/{p_flag_id}
Description
Obtain the details of the specified HTTP Filter Policy.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. Can be obtained by invoking this API. | string |
| Path | p_flag_id required |
The unique ID corresponding to the HTTP Filter Policy list. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| action optional |
Actions to take when a match is found,in (ACCEPT、BLOCK HTTP、PASS、BUSY PAGE、URL REDIRECTION、DOMAIN REDIRECTION). | < string > array |
| action_annex optional |
action extended configuration | action_annex |
| methods optional |
HTTP method list, range list (GET, POST, PUT, DELETE, HEAD, OPTIONS, TRACE, CONNECTION, OTHER). | < string > array |
| other_iprange optional |
IP range | < other_iprange > array |
| p_desc optional |
Policy description | string |
| p_name optional |
Policy name | string |
| url optional |
Composed of host and uri. | string |
| Name | Description | Schema |
|---|---|---|
| http_code optional |
Response Code. This field exists when action is URL_REDIRECTION or DOMAIN_REDIRECTION. | integer |
| page optional |
page. This field exists when action is BUSY_PAGE. | string |
| url optional |
URL. This field exists when action is URL_REDIRECTION or DOMAIN_REDIRECTION. | string |
| Name | Description | Schema |
|---|---|---|
| end_ip optional |
End IP of the IP range. | string |
| start_ip optional |
Start IP of the IP range. | string |
| type optional |
Input type of IP | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit HTTP Filter Policy.
PUT /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/http-filter/{p_flag_id}
Description
Edit HTTP Filter Policy，Concurrency is not supported.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. Can be obtained by invoking this API. | string |
| Path | p_flag_id required |
The unique ID corresponding to the HTTP Filter Policy list. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | action required |
Actions to take when a match is found.in (ACCEPT, BLOCK_HTTP, PASS, BUSY_PAGE, URL_REDIRECTION, DOMAIN_REDIRECTION). When Action is URL_REDIRECTION, rp_code, scheme, redirect_host and redirect_url must be filled. When Action is DOMAIN_REDIRECTION, rp_code, scheme and redirect_host must be filled. When Action is BUSY_PAGE, page must be filled. | string |
| FormData | host required |
Host name | string |
| FormData | methods optional |
Request method list，in (GET, POST, PUT, DELETE, HEAD, OPTIONS, TRACE, CONNECTION, OTHER). | < string > array |
| FormData | other_iprange optional |
Source IP Range,eg: 1.1.1.1-1.1.1.254.The maximum number of ips is 256. | < string > array |
| FormData | p_desc optional |
Policy description | string |
| FormData | p_name required |
Policy name | string |
| FormData | page optional |
page. Please refer to the configuration of the UI, which were dynamically assigned by the administrator. | string |
| FormData | redirect_host optional |
redirect host. | string |
| FormData | redirect_url optional |
redirect URI. | string |
| FormData | rp_code optional |
response code （301 or 302）. | integer |
| FormData | scheme optional |
scheme （http or https）. | string |
| FormData | uri required |
Path name. Regular expressions supported. | 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 |
Delete HTTP Filter Policy.
DELETE /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/http-filter/{p_flag_id}
Description
Delete HTTP Filter Policy.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. Can be obtained by invoking this API. | string |
| Path | p_flag_id required |
The unique ID corresponding to the HTTP Filter Policy list. | string |
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Application 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
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit X-Forwarded-For policy.
POST /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/request-header/x-forward-for
Description
Edit X-Forwarded-For policy.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | mode required |
Policy mode in (secure,append,reset,insert).When your portal version is upgraded to 2023.2.6, the mode range becomes (append, reset, insert) ,default mode is insert. | string |
| FormData | name optional |
Policy name, which must be filled when mode is selected as Secure. | 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 |
Obtain X-Forwarded-For policy.
GET /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/request-header/x-forward-for
Description
Obtain the X-Forwarded-For policy under the HTTP Request Header.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| mode optional |
Policy mode in (secure,append,reset,insert).When your portal version is upgraded to 2023.2.6, the mode range becomes (append, reset, insert), default mode is insert. | string |
| name optional |
Policy name. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Create URL Bypass.
POST /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/url-bypass
Description
Create Whitelist & Blacklist Policy/URL Bypass configuration.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | url_bypass required |
Updated url list, e.g. To bypass directory / abc, please use ‘abc’. | < string > array |
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 |
Obtain the list of URL Bypass.
GET /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/url-bypass
Description
Obtain the Whitelist & Blacklist Policy / URL Bypass list.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| url_bypass optional |
URL Bypass list. | < string > array |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Remove URL Bypass.
DELETE /spe/policy/appshield/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/url-bypass
Description
Delete Whitelist & Blacklist Policy / URL Bypass list in batch.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | domain_port_id required |
Unique identifier of the combination of a domain and a port number. 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 Application Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | url_bypass required |
The list of deleted URLs. If the deleted value does not exist, it will not be processed. | < string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
multipart/x-www-form-urlencode
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Definitions
IpBlackListResponse
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
The returned result. | result |
| Name | Description | Schema |
|---|---|---|
| p_info optional |
Properties of the policy, in this case, the start and end IP of the IP range. | p_info |
| Name | Description | Schema |
|---|---|---|
| enable optional |
Status of the IP Blacklist policy. 0 means enabled and 1 means it is disabled. |
integer |
| ipv4 optional |
ipv4 |
| Name | Schema |
|---|---|
| black_soc optional |
< black_soc > array |
| Name | Description | Schema |
|---|---|---|
| end_ip optional |
End IP of the IP range. | string |
| ip optional |
Network IP of the IP range. | string |
| start_ip optional |
Start IP of the IP range. | string |
| type optional |
Input type of IP . ‘range’ means there are ‘start_ip’ and ‘end_ip’ in array and ‘network means only ‘ip’ in array | string |
IpWhiteListResponse
| Name | Description | Schema |
|---|---|---|
| code optional |
integer | |
| msg optional |
Error message | string |
| result optional |
The returned result. | result |
| Name | Description | Schema |
|---|---|---|
| p_info optional |
Properties of the policy, in this case, the start and end IP of the IP range. | p_info |
| Name | Description | Schema |
|---|---|---|
| enable optional |
Status of the IP Whitelist policy. 0 means enabled and 1 means it is disabled. |
integer |
| ipv4 optional |
ipv4 |
| Name | Schema |
|---|---|
| white_soc optional |
< white_soc > array |
| Name | Description | Schema |
|---|---|---|
| end_ip optional |
End IP of the IP range. | string |
| ip optional |
Network IP of the IP range. | string |
| start_ip optional |
Start IP of the IP range. | string |
| type optional |
Input type of IP . ‘range’ means there are ‘start_ip’ and ‘end_ip’ in array and ‘network means only ‘ip’ in array | string |
Result
The returned result.
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
StatusCodeResponse
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
UaBlackResponse
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
The returned result. | result |
| Name | Description | Schema |
|---|---|---|
| p_info optional |
Properties of the policy, in this case, the start and end IP of the IP range. | p_info |
| Name | Description | Schema |
|---|---|---|
| enable optional |
policy enable status | integer |
| ua_black_list optional |
ua_black_list |
| Name | Description | Schema |
|---|---|---|
| action optional |
This is the returned result. | string |
| action_annex_page optional |
This is the returned result. | string |
| enable optional |
ua black enable status | integer |
| ua_regex optional |
Entries to be added to the UA Blacklist. Multiple entries are separated by ,. |
< string > array |
Security
ApiKeyAuth
Type : apiKey
Name : access_token
In : QUERY