Site
Site
Overview
Network Protection API under /spe/np.
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
List options for creating or editing a Network Protection site.
GET /spe/np/site-options
Description
Returns service plans, mitigation group profiles (IPv4/IPv6), and supported site IP types for Network Protection. Context is taken from the access token.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this 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. 0 indicates success. | integer |
| msg optional |
Error message. | string |
| result optional |
Response payload. | result |
| Name | Description | Schema |
|---|---|---|
| mitigation_profiles optional |
Map of mitigation group profile id to display name. Values come from the mitigation group profiles configured under Bastions / Mitigation Group (see GET /spe/bastions/mitigation_profile/mitigation_groups with ip_type=ipv4). | < string, string > map |
| mitigation_profiles_ipv6 optional |
Map of mitigation group profile id to display name. Values come from the mitigation group profiles configured under Bastions / Mitigation Group (see GET /spe/bastions/mitigation_profile/mitigation_groups with ip_type=ipv6). | < string, string > map |
| service_plan_help optional |
Help text describing service plans. | string |
| service_plans optional |
Map of id to display name. | < string, string > map |
| site_types optional |
Supported site IP types. Key is the type id submitted when creating a site; value is the display label. ipv4 is always present; ipv6 is included only when IPv6 is enabled for the partner. | site_types |
| Name | Description | Schema |
|---|---|---|
| ipv4 required |
IPv4 site type (fixed label). | enum (IPv4) |
| ipv6 optional |
IPv6 site type (fixed label; omitted when IPv6 is disabled). | enum (IPv6) |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Create a Network Protection site.
POST /spe/np/sites
Description
Creates a partner-level Network Protection site (direct circuit). Initializes detection and auto-mitigation policies and syncs collectors for the partner.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this API. | string |
| Body | site optional |
Site creation parameters. | site |
| Name | Description | Schema |
|---|---|---|
| mitigation_profile required |
Mitigation group profile id from /spe/np/site-options. | integer |
| service_plan required |
Service plan id from /spe/np/site-options. | integer |
| site_desc optional |
Optional description. | string |
| site_name required |
Site name (letters, numbers, underscores; length per platform validation). | string |
| type optional |
IP type of the site. Use ipv4 or ipv6. | enum (ipv4, ipv6) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code. 0 indicates success. | integer |
| msg optional |
Error message. | string |
| result optional |
Response payload. | result |
| Name | Description | Schema |
|---|---|---|
| site_id optional |
Identifier of the created site. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
List Network Protection sites.
GET /spe/np/sites
Description
Retrieves Network Protection (global/partner-level Clean Pipe) sites for the current partner. Supports optional IP type(IPv4/IPv6), pagination and search keyword. Response partner sites.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this API. | string |
| Query | ip_type optional |
IP type of the site. Use ipv4 or ipv6. Default ipv4. | enum (ipv4, ipv6) |
| Query | limit optional |
Maximum number of sites to return. Default 0, means all sites. | integer |
| Query | skey optional |
Search keyword to filter sites by name. Default empty. | string |
| Query | start optional |
Site list offset for pagination. Default 0. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code. 0 indicates success. | integer |
| msg optional |
Error message. | string |
| result optional |
Response payload. | result |
| Name | Description | Schema |
|---|---|---|
| limit optional |
Page size returned. | integer |
| site_list optional |
Sites. | < site_list > array |
| start optional |
Site list offset. | integer |
| total optional |
Total site count when paginated. | integer |
| Name | Description | Schema |
|---|---|---|
| as_number optional |
Comma-separated AS numbers from IDC configuration. | string |
| mitigation_profile optional |
Mitigation profile. | integer |
| service_plan optional |
Service plan. | integer |
| service_type optional |
Site service type (e.g. directcircuit). | enum (directcircuit) |
| site_desc optional |
Site desc. | string |
| site_id optional |
Site ID. | string |
| site_name optional |
Site name. | string |
| type optional |
Site IP type. | enum (ipv4, ipv6) |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get Network Protection site information.
GET /spe/np/sites/{site_id}
Description
Returns site metadata, network space (all, excluded, assigned to customers), AS numbers from IDC config, and network space counts.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | site_id required |
Network Protection site identifier from GET /spe/np/sites. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this 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. 0 indicates success. | integer |
| msg optional |
Error message. | string |
| result optional |
Response payload. | result |
| Name | Description | Schema |
|---|---|---|
| as_number optional |
Comma-separated AS numbers from IDC configuration. | string |
| mitigation_profile optional |
Mitigation group profile id. | integer |
| network_space optional |
Partner network space CIDR allocation. | network_space |
| service_plan optional |
Service plan id. | integer |
| site_desc optional |
Site desc. | string |
| site_id optional |
Site ID. | string |
| site_name optional |
Site name. | string |
| type optional |
Site IP type. | enum (ipv4, ipv6) |
| Name | Description | Schema |
|---|---|---|
| all optional |
All partner network CIDR blocks. | < string > array |
| assigned_to_customer optional |
Customer CIDRs contained in network_space.all. | < string > array |
| excluded optional |
Excluded CIDR blocks within network space. | < string > array |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Update a Network Protection site.
PUT /spe/np/sites/{site_id}
Description
Updates site name, description, service plan, and mitigation group profile.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | site_id required |
Network Protection site identifier. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this API. | string |
| Body | site optional |
site |
| Name | Description | Schema |
|---|---|---|
| mitigation_profile required |
Mitigation profile id from /spe/np/site-options. | integer |
| service_plan required |
Service plan id from /spe/np/site-options. | integer |
| site_desc optional |
Site desc. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | SuccessResponse |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete a Network Protection site.
DELETE /spe/np/sites/{site_id}
Description
Deletes the site and triggers configuration dispatch when successful. Requires that none of the site’s CIDR Network Space is assigned to a customer site.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | site_id required |
Network Protection site identifier. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this API. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | SuccessResponse |
Consumes
application/x-www-form-urlencoded
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Add or remove CIDRs from Network Space (all).
POST /spe/np/sites/{site_id}/network_space/all
Description
Adds or deletes CIDRs in network_space.all. On add, validates CIDR format and overlap. On delete, ensures CIDR is not in excluded list and not assigned to a customer site.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | site_id required |
Network Protection site identifier. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this API. | string |
| Body | body optional |
body |
| Name | Description | Schema |
|---|---|---|
| action required |
add or delete. | enum (add, delete) |
| cidr required |
One or more CIDR strings. | < string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | SuccessResponse |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Add or remove CIDRs from Network Space (excluded).
POST /spe/np/sites/{site_id}/network_space/excluded
Description
Adds or deletes CIDRs in network_space.excluded. Delete requires the CIDR to exist in the excluded list.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | site_id required |
Network Protection site identifier. | string |
| Query | access_token required |
Access token used to authenticate your access to the API. Can be obtained by invoking this API. | string |
| Body | body optional |
body |
| Name | Description | Schema |
|---|---|---|
| action required |
Action. | enum (add, delete) |
| cidr required |
CIDR. | < string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Response sent when the API is successfully invoked. | SuccessResponse |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Definitions
SuccessResponse
Success response without business payload.
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code. 0 indicates success. | integer |
| msg optional |
Error message. | string |
Security
ApiKeyAuth
Type : apiKey
Name : access_token
In : QUERY