Overview
Overview
Overview
Application Protection Overview API
Version information
Version : 1.0.0.BETA
License information
Terms of service : https://www.nexusguard.com/
URI scheme
Host : api.nexusguard.com
BasePath : /api
Schemes : HTTPS
Paths
Updates the state of switches under Overview.
POST /spe/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/policy/switch
Description
This API updates the state of switches under Overview, 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 | status required |
State of the switch. 0 means it is disabled and 1 means enabled. |
integer |
| FormData | type required |
Switch name，in(is_derived, netshield, appshield, waf, cache). Is_derived is valid when the domain port level is currently in effect, netshield is not in effect. Is_derived is invalid when the site level is currently not in effect, netshield is in effect. | 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 the list of policy switches.
GET /spe/customer/{customer_id}/ap/site/{site_id}/domain-port/{domain_port_id}/policy/switch
Description
Obtain the list of switches for the Overview under this object.
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. When the domain_port_id value is 449cbcf57ff0ba74, it indicates that it is at the site level; otherwise, it indicates that it is at the domain level. | 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 Overview. | result |
| Name | Description | Schema |
|---|---|---|
| is_derived optional |
User-defined switch. 0 means that the switch state is inherited from the site and no switch field is displayed. 1 means that the switch field is displayed. This field exists when the object is a domain port. | integer |
| switch optional |
The state of all switches under Policy. | switch |
| Name | Description | Schema |
|---|---|---|
| appshield optional |
AppShield switch. 0 means it is disabled and 1 means enabled. |
integer |
| cache optional |
Cache switch. 0 means it is disabled and 1 means enabled. |
integer |
| netshield optional |
NetShield switch.0 means it is disabled and 1 means enabled. This field exists when the object is a site. |
integer |
| waf optional |
WAF switch.0 means it is disabled and 1 means enabled. |
integer |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Definitions
Result
The returned result.
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
Security
ApiKeyAuth
Type : apiKey
Name : access_token
In : QUERY