Mitigation
Mitigation
Overview
Clean Pipe Mitigation 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
Edit content for allow list or block list of host.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/mitigation/allow-block-list
Description
Edit content for allow list or block list of host.
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 | cp_mitigation_allow-block-list_service optional |
cp mitigation allow-block-list information. | cp_mitigation_allow-block-list_service |
cp_mitigation_allow-block-list_service
| Name | Description | Schema |
|---|---|---|
| source_countries optional |
country code list for allow_list or block_list content, such as ‘Asia/Pacific Region’. | < string > array |
| source_ips optional |
ip list for allow_list or block_list content. | < string > array |
| type required |
allow list/block list type. in (allow_list, block_list). | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Result |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get content for allow list or block list of host
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/mitigation/allow-block-list
Description
Get content for allow list or block list of host
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 |
| Query | type required |
‘allow_list’ or ‘block_list’. | 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 |
|---|---|---|
| is_enabled optional |
Status of the tcp option filter. ‘0’ means off, ‘1’ means on. | integer |
| source_countries optional |
The source countries of traffic. | < string > array |
| source_ips optional |
Source IP. | < string > array |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change the mitigation policy for allow list or block list of host.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/mitigation/allow-block-list/switch
Description
Change the mitigation policy for allow list or block list of host.
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 | cp_mitigation_allow-block-list_service optional |
cp mitigation allow-block-list information. | cp_mitigation_allow-block-list_service |
cp_mitigation_allow-block-list_service
| Name | Description | Schema |
|---|---|---|
| is_enabled required |
0 means the switch of the basic network filtering is disabled whereas 1 means it is enabled. |
integer |
| type required |
allow list/block list type. in (allow_list, block_list). | 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 |
Edit the policy for the FlexFilter/tcp option filter sets.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/mitigation/tcp-option/filter-sets
Description
Edit the policy for the FlexFilter/tcp option filter sets.
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. 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 | filter_set_id required |
Enter the filter set id you want to add.Currently only supports adding one option. | < 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 |
Edit the policy for the FlexFilter/tcp option filter sets.
GET /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/mitigation/tcp-option/policy
Description
Edit the policy for the FlexFilter/tcp option filter sets.
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 |
result |
| Name | Description | Schema |
|---|---|---|
| filter_sets optional |
< filter_sets > array | |
| is_enabled optional |
Status of the tcp option filter. ‘0’ means off, ‘1’ means on. | integer |
| Name | Description | Schema |
|---|---|---|
| filter_set_desc optional |
More details about the purpose of the policy. | string |
| filter_set_id optional |
Unique identifier of filter set. | string |
| filter_set_name optional |
The name of the policy. | string |
Consumes
multipart/form-data
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit the policy for the FlexFilter/tcp option filter sets.
POST /spe/customer/{customer_id}/cp/site/{site_id}/host/{host_id}/mitigation/tcp-option/switch
Description
Edit the policy for the FlexFilter/tcp option filter sets.
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 |
| FormData | is_enabled required |
0 means the switch of the basic network filtering is disabled whereas 1 means it is enabled. |
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 |
Edit content for allow list or block list of site.
POST /spe/customer/{customer_id}/cp/site/{site_id}/mitigation/allow-block-list
Description
Edit content for allow list or block list of site.
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 | cp_mitigation_allow-block-list_service optional |
cp mitigation allow-block-list information. | cp_mitigation_allow-block-list_service |
cp_mitigation_allow-block-list_service
| Name | Description | Schema |
|---|---|---|
| source_countries optional |
country code list for allow_list or block_list content, such as ‘Asia/Pacific Region’. | < string > array |
| source_ips optional |
ip list for allow_list or block_list content. | < string > array |
| type required |
allow list/block list type. in (allow_list, block_list). | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Result |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get content for allow list or block list of site.
GET /spe/customer/{customer_id}/cp/site/{site_id}/mitigation/allow-block-list
Description
Get content for allow list or block list of site.
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 |
| Query | type required |
‘allow_list’ or ‘block_list’. | 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 |
|---|---|---|
| is_enabled optional |
Status of the tcp option filter. ‘0’ means off, ‘1’ means on. | integer |
| source_countries optional |
The source countries of traffic. | < string > array |
| source_ips optional |
Source IP. | < string > array |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Change the mitigation policy for allow list or block list of site.
POST /spe/customer/{customer_id}/cp/site/{site_id}/mitigation/allow-block-list/switch
Description
Change the mitigation policy for allow list or block list of site.
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 | cp_mitigation_allow-block-list_service optional |
cp mitigation allow-block-list information. | cp_mitigation_allow-block-list_service |
cp_mitigation_allow-block-list_service
| Name | Description | Schema |
|---|---|---|
| is_enabled required |
0 means the switch of the basic network filtering is disabled whereas 1 means it is enabled. |
integer |
| type required |
allow list/block list type. in (allow_list, block_list). | 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 |
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