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 : {your_basic_domain}
BasePath : /api
Schemes : HTTPS
Paths
List mitigation group profiles.
GET /specp/cp/mitigation_group_profiles
Description
Returns available mitigation group profiles used when creating or configuring CleanPipe Protection sites.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
API access token for authentication. | string |
| Query | ip_type optional |
IP address family for the site: ipv4 or ipv6. Default: ipv4. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
Array of mitigation group profiles. | < result > array |
| Name | Description | Schema |
|---|---|---|
| profile_id optional |
Unique ID of the mitigation group profile. | integer |
| profile_name optional |
Display name of the mitigation group profile. | string |
| scope optional |
Scope type (global or pop) | enum (global, pop) |
| scope_pop_list optional |
IDC/PoP List when scope is pop. | < scope_pop_list > array |
| Name | Description | Schema |
|---|---|---|
| idc optional |
IDC/PoP identifier. | string |
| name optional |
IDC/PoP name. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
List service plans.
GET /specp/cp/service_plan
Description
Returns available service plans (e.g., Basic, Enterprise) for CleanPipe Protection sites.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
API access token for authentication. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
Available service plan names (e.g., Basic, Enterprise, Premium). | < string > array |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Create CleanPipe Protection site.
POST /specp/cp/site
Description
Creates a new CleanPipe Protection site with the given name, CIDR ranges, and mitigation profile.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
API access token for authentication. | string |
| Body | site optional |
Site creation payload: name, optional description, CIDR ranges, and mitigation profile. | site |
| Name | Description | Schema |
|---|---|---|
| cidr required |
Protected IP ranges in CIDR notation (e.g., 192.168.1.0/24). | < string > array |
| ip_type optional |
IP address family for the site: ipv4 or ipv6. Default: ipv4. |
string |
| mitigation_group_profile_id required |
ID of the mitigation group profile to apply to this site. Can be obtained by invoking this API for mitigation_group_profile_id. | integer |
| site_desc optional |
Optional site description. Maximum length: 512 characters. | string |
| site_name required |
Site name. Allowed characters: letters, numbers, and underscores. Length: 2–32 characters. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| site_id optional |
Unique identifier of the created site. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get site details.
GET /specp/cp/site/{site_id}
Description
Returns details of a single CleanPipe Protection site by site ID.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | site_id required |
Unique identifier of a site.Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
Site details. | result |
| Name | Description | Schema |
|---|---|---|
| cidr optional |
Protected IP ranges in CIDR notation (e.g., 192.168.1.0/24). | < string > array |
| ip_type optional |
IP address family for the site: ipv4 or ipv6. |
string |
| mitigation_group_profile_id optional |
ID of the mitigation group profile to apply to this site. | integer |
| service_plan optional |
Service plan the client has subscribed to. | string |
| site_desc optional |
Optional description of the site. Maximum length: 512 characters. | string |
| site_name optional |
Site name. Allowed characters: letters, numbers, and underscores. Range length: 2-32 characters. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Update CleanPipe Protection site.
PUT /specp/cp/site/{site_id}
Description
Updates an existing site’s description, CIDR ranges, or mitigation profile.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | site_id required |
Unique identifier of a site. | string |
| Query | access_token required |
API access token for authentication. | string |
| Body | site optional |
Fields to update: description, CIDR list, or mitigation profile ID. | site |
| Name | Description | Schema |
|---|---|---|
| cidr optional |
Protected IP ranges in CIDR notation (e.g. 192.168.1.0/24). | < string > array |
| mitigation_group_profile_id optional |
ID of the mitigation group profile to apply to this site. Obtain from the mitigation profile list API. | integer |
| site_desc optional |
Optional site description. Length: 0–512 characters. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| site_id optional |
Unique identifier of the site. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete CleanPipe Protection site.
DELETE /specp/cp/site/{site_id}
Description
Permanently deletes a CleanPipe Protection site by site ID.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | site_id required |
Unique identifier of a site.Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Add acl filter rule for site.
POST /specp/cp/site/{site_id}/acl-filter-rule
Description
This API helps add the acl filter rule of site under CleanPipe Protection using the Site ID provided. Please see notes of individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | site_id required |
Unique identifier of a site.Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Body | body required |
FlexFilter/Custom filter rule configuration. | body |
| Name | Description | Schema |
|---|---|---|
| action required |
Either rate limiting, dropping or letting the traffic pass are taken. | string |
| bps_limit optional |
The rate limit in bps of the rule. Required when the action is ratelimit. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| dst_ip optional |
IP Address of the recipient. | < string > array |
| dst_port optional |
Port number to which the data packet is sent. Each item is one port from 0–65535, or an inclusive range low-high with both ends in 0–65535 (e.g. 80, 80-90). | < string > array |
| icmp_code optional |
When icmp_type is ICMP-unreach, ICMP-Redirect or ICMP-Paramprob, when ICMP-unreach is 0-15, ICMP-redirect is 0-3, and ICMP-paramprob is 0-2. | string |
| icmp_type optional |
When the protocol is ICMP, the value can be custom or from the filter_ICMP_type field that returns the result from config options. When custom, the range is an integer between 0 and 255. | string |
| package_length optional |
The package length of the rule. Can be updated regardless of the selected protocol. | < string > array |
| pps_limit optional |
The rate limit in pps of the rule. Required when the action is ratelimit. Pattern : "^(?:(?:(?:4000000000)\|(?:[1-3][0-9]{9})\|(?:[1-9][0-9]{0,8}))(?:[KMkm]\|\\s+[KMkm])?\|[1-4](?:[Gg]\|\\s+[Gg]))$" |
string |
| protocol required |
Protocol of the data packet. Currently, any, tcp, udp, icmp and custom are supported. Pattern : "^[A-Za-z0-9]*$" |
string |
| rule_desc optional |
Optional policy description. Length : 0 - 100 Pattern : "^[A-Za-z0-9_ -]*$" |
string |
| rule_mode optional |
Rule Mode. | string |
| rule_name required |
The name of the policy created. Length : 2 - 40 Pattern : "^[A-Za-z0-9_ -]+$" |
string |
| src_ip optional |
IP address of the sender, as it is shown in the data packet. | < string > array |
| src_port optional |
Port number from which the data packet is sent. Each item is one port from 0–65535, or an inclusive range low-high with both ends in 0–65535 (e.g. 80, 80-90). | < string > array |
| tcp_flags optional |
In TCP connection, flags are used to indicate a particular state of connection or to provide some additional useful information. | < string > array |
| ttl optional |
Time-to-live (TTL) is a value in an IP packet that tells a network router whether or not the packet has been in the network too long and should be discarded. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| rule_id optional |
Rule ID, an unique identifier assigned to each FlexFilter Custom Filters. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Edit acl filter rule for site.
POST /specp/cp/site/{site_id}/acl-filter-rule/{rule_id}
Description
This API helps edit the acl filter rule of site under CleanPipe Protection using the Site ID provided. Please see notes of individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | rule_id required |
Unique identifier of a rule. | string |
| Path | site_id required |
Unique identifier of a site.Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Body | body required |
FlexFilter/Custom filter rule configuration. | body |
| Name | Description | Schema |
|---|---|---|
| action required |
Either rate limiting, dropping or letting the traffic pass are taken. | string |
| bps_limit optional |
ratelimit in bps. | string |
| dst_ip optional |
IP Address of the recipient. | < string > array |
| dst_port optional |
Port number to which the data packet is sent. Each item is one port from 0–65535, or an inclusive range low-high with both ends in 0–65535 (e.g. 80, 80-90). | < string > array |
| icmp_code optional |
When icmp_type is ICMP-unreach, ICMP-Redirect or ICMP-Paramprob, when ICMP-unreach is 0-15, ICMP-redirect is 0-3, and ICMP-paramprob is 0-2. | string |
| icmp_type optional |
When the protocol is ICMP, the value can be custom or from the filter_ICMP_type field that returns the result from config options. When custom, the range is an integer between 0 and 255. | string |
| package_length optional |
The package length of the rule. Can be updated regardless of the selected protocol. | < string > array |
| pps_limit optional |
ratelimit in pps. | string |
| protocol required |
Protocol of the data packet. Currently, tcp, udp, icmp, any or 0-255 are supported. | string |
| rule_desc optional |
Optional policy description. | string |
| rule_mode optional |
Rule Mode. | string |
| rule_name required |
The name of the policy created. | string |
| src_ip optional |
IP address of the sender, as it is shown in the data packet. | < string > array |
| src_port optional |
Port number from which the data packet is sent. Each item is one port from 0–65535, or an inclusive range low-high with both ends in 0–65535 (e.g. 80, 80-90). | < string > array |
| tcp_flags optional |
In TCP connection, flags are used to indicate a particular state of connection or to provide some additional useful information. | < string > array |
| ttl optional |
Time-to-live (TTL) is a value in an IP packet that tells a network router whether or not the packet has been in the network too long and should be discarded. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete acl filter rule for site.
DELETE /specp/cp/site/{site_id}/acl-filter-rule/{rule_id}
Description
This API helps delete the acl filter rule of site under CleanPipe Protection using the Site ID provided. Please see notes of individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | rule_id required |
Unique identifier of a rule. | string |
| Path | site_id required |
Unique identifier of a site.Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Switch acl filter rule for site.
POST /specp/cp/site/{site_id}/acl-filter-rule/{rule_id}/switch
Description
Enable or disable an acl filter rule for a CleanPipe Protection site.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | rule_id required |
Filter rule ID. Can be obtained by invoking this API for rule_id. | string |
| Path | site_id required |
Unique identifier of a site.Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| FormData | is_enabled required |
0 means disabled and 1 means enabled. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
List acl filter rules for site.
GET /specp/cp/site/{site_id}/acl-filter-rules
Description
This API helps retrieve the acl filter rules list of site under CleanPipe Protection using the Site ID provided. Please see notes of individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | site_id required |
Unique identifier of a site.Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | 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 acl filter rules | < result > array |
| Name | Description | Schema |
|---|---|---|
| action optional |
Either rate limiting, dropping or letting the traffic pass are taken. | string |
| bps_limit optional |
ratelimit in bps. | string |
| dst_ip optional |
IP Address of the recipient. | < string > array |
| dst_port optional |
Port number to which the data packet is sent. Each item is one port from 0–65535, or an inclusive range low-high with both ends in 0–65535 (e.g. 80, 80-90). | < string > array |
| is_enabled optional |
0 means it is disabled and 1 means enabled. | integer |
| package_length optional |
The package length of the rule. Can be updated regardless of the selected protocol. | < string > array |
| pps_limit optional |
ratelimit in pps. | string |
| protocol optional |
Protocol of the data packet. Returned as a string such as tcp, udp, icmp, any, or an IANA protocol number (0-255) written as a decimal string (for example 47). | string |
| rule_desc optional |
Optional policy description. | string |
| rule_id optional |
Filter rule ID, a unique identifier assigned to each acl filter rule. | string |
| rule_mode optional |
Rule Mode. | string |
| rule_name optional |
The name of the policy | string |
| sort_order optional |
Priority order of rules. | integer |
| src_ip optional |
IP address of the sender, as it is shown in the data packet. | < string > array |
| src_port optional |
Port number from which the data packet is sent. Each item is one port from 0–65535, or an inclusive range low-high with both ends in 0–65535 (e.g. 80, 80-90). | < string > array |
| tcp_flags optional |
In TCP connection, flags are used to indicate a particular state of connection or to provide some additional useful information. | < string > array |
| ttl optional |
Time-to-live (TTL) is a value in an IP packet that tells a network router whether or not the packet has been in the network too long and should be discarded. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Sort acl filter rules for site.
POST /specp/cp/site/{site_id}/acl-filter-rules/sort
Description
Update the priority order of acl filter rules for a CleanPipe Protection site. Rules are sorted in ascending order based on their position in the rule_list array.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | site_id required |
Unique identifier of a site.Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Body | body required |
Ordered list of acl filter rule IDs. | body |
| Name | Description | Schema |
|---|---|---|
| rule_list required |
Ordered list of rule IDs. Rules are applied in ascending order by array position. Example [“fb48aa15dd7abf34”, “da48aa15dd7abf22”] means the first ID has the highest priority. | < string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Creates a cidr.
POST /specp/cp/site/{site_id}/cidrs
Description
A CIDR defines a contiguous IP address range, supporting both IPv4 and IPv6 address formats. Multiple CIDR entries are allowed.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for CleanPipe Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | cidr required |
Only Class C IP addresses can be added to a site. | < string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| 201 | This is the returned result. | Response 201 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| 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 |
Gets a cidr list.
GET /specp/cp/site/{site_id}/cidrs
Description
Gets the cidr list of the site under CleanPipe Protection.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for CleanPipe Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Query | limit optional |
The page parameter. The default value of requesting the counts of index from the first index is 0,response code is 200.Response code will be 201 without default value.The max value of requesting the counts of index from the first index is 50. | integer |
| Query | start optional |
The default value of the first index of the page parameter value is 0. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| 201 | This is the returned result. | Response 201 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
Site cidr list. | < result > array |
| Name | Description | Schema |
|---|---|---|
| cidr optional |
The list of IP addresses added to the cidr. | < string > array |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| data optional |
Site cidr list. | < data > array |
| limit optional |
Current page parameter value. | integer |
| start optional |
Current page parameter value. | integer |
| total optional |
Current site cidr counts | integer |
| Name | Description | Schema |
|---|---|---|
| cidr optional |
The list of IP addresses added to the cidr. | < string > array |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Deletes cidrs.
DELETE /specp/cp/site/{site_id}/cidrs
Description
Deletes cidrs from the site.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for CleanPipe Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | cidrs required |
The list of cidrs to be deleted. | < string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| 201 | This is the returned result. | Response 201 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Create host.
POST /specp/cp/site/{site_id}/host
Description
Creates a new host under a CleanPipe Protection site with the given name and protected IP/CIDR ranges.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | site_id required |
Unique identifier of a site. | string |
| Query | access_token required |
API access token for authentication. | string |
| Body | host optional |
Host information. | host |
| Name | Description | Schema |
|---|---|---|
| cidr required |
Protected IP ranges in CIDR notation (e.g., 192.168.1.0/24). | < string > array |
| host_desc optional |
Optional host description. Maximum length: 512 characters. | string |
| host_name required |
Host name. Allowed characters: letters, numbers, and underscores. Length: 2–32 characters. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| host_id optional |
Unique identifier of the created host. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get host details.
GET /specp/cp/site/{site_id}/host/{host_id}
Description
Returns details of a single host by site ID and host ID.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host.Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Unique identifier of a site.Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
Host details. | result |
| Name | Description | Schema |
|---|---|---|
| cidr optional |
Protected IP ranges in CIDR notation (e.g., 192.168.1.0/24). | < string > array |
| host_desc optional |
Description of the host. | string |
| host_name optional |
Host name. Allowed characters: letters, numbers, and underscores. Range length: 2-32 characters. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Update host.
PUT /specp/cp/site/{site_id}/host/{host_id}
Description
Updates an existing host’s description or protected CIDR ranges.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host.Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Unique identifier of a site.Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
| Body | host optional |
Host information to update. | host |
| Name | Description | Schema |
|---|---|---|
| cidr optional |
Protected IP ranges in CIDR notation (e.g., 192.168.1.0/24). | < string > array |
| host_desc optional |
Optional host description. Range length: 2-32 characters. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| host_id optional |
Unique identifier of the host. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete host.
DELETE /specp/cp/site/{site_id}/host/{host_id}
Description
Permanently deletes a host by site ID and host ID.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | host_id required |
Unique identifier of a host.Can be obtained by invoking this API for host_id. | string |
| Path | site_id required |
Unique identifier of a site.Can be obtained by invoking this API for site_id. | string |
| Query | access_token required |
API access token for authentication. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
List hosts for site.
GET /specp/cp/site/{site_id}/hosts
Description
Returns the list of hosts belonging to the specified site.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | site_id required |
Unique identifier of a site. | string |
| Query | access_token required |
API access token for authentication. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
List of hosts. | < object > array |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Upload CIDRs via file.
POST /specp/cp/site/{site_id}/upload-cidrs
Description
Upload CIDR list by file (TXT/CSV only, max 10MB). IPv4 & IPv6 CIDRs supported.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | site_id required |
Unique identifier of a site. Can be obtained by invoking this API for CleanPipe Protection sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| FormData | file required |
TXT or CSV files smaller than 10MB are allowed. | file |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | This is the returned result. | Response 200 |
| 201 | This is the returned result. | Response 201 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Error message | string |
| 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 |
List sites for customer.
GET /specp/cp/sites
Description
Returns all CleanPipe Protection sites for the authenticated customer (Customer ID is implied by the access token).
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
API access token for authentication. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response body with result data or error information. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
| result optional |
List of CleanPipe Protection sites associated with the authenticated customer. | < result > array |
| Name | Description | Schema |
|---|---|---|
| cidr optional |
Protected IP ranges in CIDR notation (e.g., 192.168.1.0/24). | < string > array |
| service_plan optional |
Service plan the client has subscribed to. | string |
| site_desc optional |
Description of the site. | string |
| site_id optional |
Unique identifier of the site. | string |
| site_name optional |
Name of the site. | string |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Definitions
Result
The returned result.
| Name | Description | Schema |
|---|---|---|
| code optional |
Numeric error code; 0 indicates success. | integer |
| msg optional |
Human-readable error or status message. | string |
Security
ApiKeyAuth
Type : apiKey
Name : access_token
In : QUERY