Site
Site
Overview
CleanPipe Protection Site API
Version information
Version : 1.0.0.BETA
License information
Terms of service : https://www.nexusguard.com/
URI scheme
Host : api.nexusguard.com
BasePath : /api
Schemes : HTTPS
Paths
Retrieves mitigation group profile list.
GET /spe/customer/{customer_id}/cp/mitigation_group_profiles
Description
This API retrieves mitigation group profile list, used for create site in CleanPipe Protection. 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 | ip_type optional |
IP type of the site,should be ‘ipv4’ or ‘ipv6’,default value is ‘ipv4’. | 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 capture status and the address to download captured content. | < result > array |
| Name | Description | Schema |
|---|---|---|
| profile_id optional |
Unique identifier of the profile. | integer |
| profile_name optional |
Name of the profile. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves service plan list.
GET /spe/customer/{customer_id}/cp/service_plan
Description
This API retrieves service plan list, used for create site in CleanPipe Protection. 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 capture status and the address to download captured content. | < string > array |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Creates an CleanPipe Protection site.
POST /spe/customer/{customer_id}/cp/site
Description
Through this API, the site under CleanPipe Protection is created based on the user-provided information. Please see notes on individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Body | site optional |
Basic site information. | site |
| Name | Description | Schema |
|---|---|---|
| cidr required |
The network resources to be protected, in CIDR form. | < string > array |
| ip_type optional |
IP type of the site,should be ‘ipv4’ or ‘ipv6’,default value is ‘ipv4’ | string |
| mitigation_group_profile_id required |
The mitigation group profile id specified when creating site. | integer |
| site_desc optional |
The description of the site created can be added, limited 0 to 512 characters. | string |
| site_name required |
The site name which only allows letters, numbers and underscores, limited 2 to 32 characters. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| site_id optional |
Site ID, an unique identifier assigned to each Site. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get the Clean Pipe site report data.
GET /spe/customer/{customer_id}/cp/site-report
Description
Get the report data under site.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Query | access_token required |
Access token used to authenticate your access to the API | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Result |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves the properties of a site.
GET /spe/customer/{customer_id}/cp/site/{site_id}
Description
This API helps retrieve the info of a site under CleanPipe Protection using the Site ID provided. Please see notes of individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | site_id required |
Unique identifier of a site. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
Info of the site | result |
| Name | Description | Schema |
|---|---|---|
| cidr optional |
< string > array | |
| ip_type optional |
IP type of the site. | string |
| mitigation_group_profile_id optional |
The mitigation group profile id specified when creating site. | integer |
| service_plan optional |
The service plan the client has signed up for. | string |
| site_desc optional |
The description of the site created can be added. | string |
| site_name optional |
The site name which only allows letters, numbers and underscores, limited to 20 characters. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Update an CleanPipe Protection site.
PUT /spe/customer/{customer_id}/cp/site/{site_id}
Description
Through this API, the site under CleanPile Protection is updated based on the user-provided information. Please see notes on individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | site_id required |
Unique identifier of a site. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Body | site optional |
Basic site information. | site |
| Name | Description | Schema |
|---|---|---|
| cidr optional |
The network resources to be protected, in CIDR form. | < string > array |
| mitigation_group_profile_id optional |
The mitigation group profile id specified when creating site. | integer |
| site_desc optional |
The description of the site created can be added.limited 0 to 512 characters. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| site_id optional |
Site ID, an unique identifier assigned to each Site. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves the properties of a site.
DELETE /spe/customer/{customer_id}/cp/site/{site_id}
Description
Through this API, the site under CleanPipe Protection is deleted based on the user-provided information. Please see notes on individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | site_id required |
Unique identifier of a site. | 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 |
Creates a host.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host
Description
Through this API, the host of site under CleanPipe Protection is created based on the user-provided information. Please see notes on individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | site_id required |
Unique identifier of a site. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Body | host optional |
Basic site information. | host |
| Name | Description | Schema |
|---|---|---|
| cidr required |
The network resources to be protected in CIDR form, here only need to enter the IP address. | < string > array |
| host_desc optional |
The description of the host created can be added, limited 0 to 512 characters. | string |
| host_name required |
The host name which only allows letters, numbers and underscores, limited 2 to 32 characters. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| host_id optional |
Host ID, an unique identifier assigned to each Site. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves the properties of a host.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}
Description
This API helps retrieve the info of a host of site under CleanPipe Protection using the Site ID provided. Please see notes of individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | host_id required |
Unique identifier of a host. | string |
| Path | site_id required |
Unique identifier of a site. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
Info of the host | result |
| Name | Description | Schema |
|---|---|---|
| cidr optional |
< string > array | |
| host_desc optional |
The description of the host. | string |
| host_name optional |
The host name which only allows letters, numbers and underscores, limited to 20 characters. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Update a host.
PUT /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}
Description
Through this API, the host of site under CleanPipe Protection is updated based on the user-provided information. Please see notes on individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | host_id required |
Unique identifier of a host. | string |
| Path | site_id required |
Unique identifier of a site. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Body | host optional |
Basic site information. | host |
| Name | Description | Schema |
|---|---|---|
| cidr optional |
The network resources to be protected in CIDR form, here only need to enter the IP address. | < string > array |
| host_desc optional |
The description of the host created can be added, limited 0 to 512 characters. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| host_id optional |
Host ID, an unique identifier assigned to each Site. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete a host.
DELETE /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}
Description
Through this API, the host of site under CleanPipe Protection is deleted based on the user-provided information. Please see notes on individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | host_id required |
Unique identifier of a host. | string |
| Path | site_id required |
Unique identifier of a site. | 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/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves the list of a host.
GET /spe/customer/{customer_id}/cp/site/{site_id}/hosts
Description
This API helps retrieve the host list of site under CleanPipe Protection using the Site ID provided. Please see notes of individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Path | site_id required |
Unique identifier of a site. | 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 |
list of the host | < result > array |
| Name | Description | Schema |
|---|---|---|
| cidr optional |
< string > array | |
| host_desc optional |
The description of the host. | string |
| host_id optional |
Unique identifier of a host. | string |
| host_name optional |
The host name which only allows letters, numbers and underscores, limited to 20 characters. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Retrieves CleanPipe Protection site list by Customer ID.
GET /spe/customer/{customer_id}/cp/sites
Description
This API retrieves a complete list of sites under CleanPipe Protection associated with a certain Customer ID. This is Customer ID is a 3-digit integer in the Admin Portal and unique to each customer. In this context, what you get and give is an encoded string, e.g., 7423b77da0a97c33. See notes on individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
The list of CleanPipe Protection sites associated with the given Customer ID. | < result > array |
| Name | Description | Schema |
|---|---|---|
| cidr optional |
The network resources to be protected, in CIDR form. | < string > array |
| service_plan optional |
The service plan the client has signed up for. | string |
| site_desc optional |
Description about the site. | string |
| site_id optional |
Site ID, an unique identifier assigned to each Site. | string |
| site_name optional |
Site Name, name of the site. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Set params mode of site.
POST /spe/customer/{customer_id}/cp/smart-filter/params-mode
Description
Set customer’s smart filter params mode of site.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | params_mode optional |
The params mode of the site’s smart filter. | integer |
| Query | site_id optional |
Unique identifier of a site. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Set smart filter settings of site.
POST /spe/customer/{customer_id}/cp/smart-filter/site-settings
Description
Set customer’s smart filter settings of site.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | add_sites optional |
The site of add to smart filter. | < string > array |
| Query | del_sites optional |
The site of delete to smart filter. | < string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get smart filter policy
GET /spe/customer/{customer_id}/cp/smart-filter/smart-policy
Description
get customer’s smart filter policy by condition.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | customer_id required |
Unique identifier of a customer. Can be obtained by invoking this API. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | host_id optional |
Unique identifier of a host, default 0. | string |
| Query | is_network optional |
Is network. default 0, 1: is network, default 0. | integer |
| Query | network_id optional |
Unique identifier of a network, default 0. | string |
| Query | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for Cleanpipe Protection sites. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
policy information. | result |
| Name | Description | Schema |
|---|---|---|
| custom_threshold optional |
The description of the host. | custom_threshold |
| is_auto optional |
The name of the host. | string |
| Name | Description | Schema |
|---|---|---|
| high_bps optional |
high bps. | integer |
| high_pps optional |
hign pps. | integer |
| low_bps optional |
Low bps. | integer |
| low_pps optional |
Low pps. | integer |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Definitions
Result
The returned result.
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
Security
ApiKeyAuth
Type : apiKey
Name : access_token
In : QUERY