Navigation :

Overview

Site

Overview

Origin 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

Select the auto template for the host profile.

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

Description

If the detection is set to auto, a template from auto mitigation must be selected for the the host profile.

Parameters

Type	Name	Description	Schema
Path	customer_id required	Unique identifier of a customer. Can be obtained by invoking this API.	string
Path	host_id required	Unique identifier of the combination of a host. Can be obtained by invoking this API. When the host_id value is 0, it indicates that it is at the network level; otherwise, it indicates that it is at the host level.	string
Path	network_id required	Unique identifier of the combination of a network. Can be obtained by invoking this API. When the network_id value is 0, it indicates that it is at the site level; otherwise, it indicates that it is at the network level.	string
Path	site_id required	Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites.	string
Query	access_token required	Access token used to authenticate your access to the API.	string
FormData	profile_id required	The template id of auto mitigation is selected in the list of auto mitigation.	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

Updates the customized policies under Overview.

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

Description

Customer ID, site ID, network ID and host ID can be provided to update the status of the switch under Overview.

Parameters

Type	Name	Description	Schema
Path	customer_id required	Unique identifier of a customer. Can be obtained by invoking this API.	string
Path	host_id required	Unique identifier of the combination of a host. Can be obtained by invoking this API. When the host_id value is 0, it indicates that it is at the network level; otherwise, it indicates that it is at the host level.	string
Path	network_id required	Unique identifier of the combination of a network. Can be obtained by invoking this API. When the network_id value is 0, it indicates that it is at the site level; otherwise, it indicates that it is at the network level.	string
Path	site_id required	Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites.	string
Query	access_token required	Access token used to authenticate your access to the API.	string
FormData	is_enable required	When “switch_type” is set to custom, “1” means it is switched on whereas “0” means it is off. When “switch_type” is at the network level, “0” means it is switched off whereas “1” means it is switched on. When “switch_type” is set to mitigation and at the host level, “0” means it is switched off, “1” means it is switched on.	integer
FormData	switch_type required	The switch types consist of custom, mitigation and detection. The site-level switch type supports detection mode whereas the network-level and host-level one supports custom and mitigation modes.	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}/op/site/{site_id}/network/{network_id}/host/{host_id}/policy/switch

Description

Obtains the list of policies you can switch based on your security need.

Parameters

Type	Name	Description	Schema
Path	customer_id required	Unique identifier of a customer. Can be obtained by invoking this API.	string
Path	host_id required	Unique identifier of the combination of a host. Can be obtained by invoking this API. When the host_id value is 0, it indicates that it is at the network level; otherwise, it indicates that it is at the host level.	string
Path	network_id required	Unique identifier of the combination of a network. Can be obtained by invoking this API. When the network_id value is 0, it indicates that it is at the site level; otherwise, it indicates that it is at the network level.	string
Path	site_id required	Unique identifier of a site. Can be obtained by invoking this API for Origin Protection sites.	string
Query	access_token required	Access token used to authenticate your access to the API.	string

Responses

HTTP Code	Description	Schema
200	Response sent when the API is successfully invoked.	Response 200

Response 200

Name	Description	Schema
code optional	Error code	integer
msg optional	Error message	string
result optional	The state of all switches under Overview.	result

result

Name	Description	Schema
auto_profile optional	Mitigation is in auto mode.	string
detection_mode optional	`0` means the detection policy model mitigation is switched off whereas it is switched on `2` means it is in auto mode.	integer
is_customize optional	When the host_id value is 0, it indicates that it is at the network level; otherwise, it indicates that it is at the host level.	integer
mitigation_mode optional	`0` means the mitigation policy model is switched off whereas it is switched on.	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