Zone
Zone
Overview
DNS Protection Zone API
Version information
Version : 2.0.0
License information
Terms of service : https://www.nexusguard.com/
URI scheme
Host : api.nexusguard.com
BasePath : /api
Schemes : HTTPS
Paths
Retrieves zone list.
GET /specp/dp/v2/zones
Description
This API retrieves a complete list of zone. See notes on individual parameters below.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
Access token used to authenticate your access to the API | string |
| Query | page_index required |
Page index of zone data page. | integer |
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 data of zones. | result |
| Name | Description | Schema |
|---|---|---|
| total_count optional |
Total number of zones. | integer |
| total_page optional |
Total page of zones data. | integer |
| zones optional |
< zones > array |
| Name | Description | Schema |
|---|---|---|
| enable_dnssec optional |
Is dnssec enabled. | boolean |
| enable_root_cname optional |
Is root cname enabled. | boolean |
| id optional |
ID of the zone. | string |
| is_zone_transfer optional |
Is zone transfer. | boolean |
| zone_name optional |
Name of the zone. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Delete a zone
POST /specp/dp/v2/zones/delete
Description
Delete the zone with the corresponding zone name
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Body | body optional |
request body for zone delete | body |
| Name | Description | Schema |
|---|---|---|
| zone_name required |
Zone name | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | Response 200 |
| 500 | Internal Server Error | Response 500 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code, response 0 if successful, response otherwise if failed (ex: 42232422) | integer |
| msg optional |
Message | string |
| result optional |
the result of zone delete | result |
| Name | Description | Schema |
|---|---|---|
| zone_name optional |
Zone name | string |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Message | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Update Zone Setting
PUT /specp/dp/v2/zones/setting
Description
Update zone settings, all fields except for zone_name are optional
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Body | body optional |
request body for update zone setting | ZoneSetting |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | ZoneSettingResult |
| 500 | Internal Server Error | Response 500 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Message | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
create a standard zone
POST /specp/dp/v2/zones/standard
Description
create a standard zone
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Body | body optional |
request body for standard zone create | body |
| Name | Description | Schema |
|---|---|---|
| dnssec_multi_signer optional |
Multi-Signer Configuration | dnssec_multi_signer |
| enable_dnssec required |
enable DNS SEC, can not be true if enable root cname is true Default : false |
boolean |
| enable_root_cname required |
enable root cname Default : false |
boolean |
| zone_name required |
Zone name | string |
| Name | Description | Schema |
|---|---|---|
| enabled optional |
enable Multi-Signer, can be turned on only if DNSSEC is turned on | boolean |
| ip optional |
The list of Multi-Signer IP address | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | Response 200 |
| 500 | Internal Server Error | Response 500 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code, response 0 if successful, response otherwise if failed (ex: 42232422) | integer |
| msg optional |
Message | string |
| result optional |
the result of zone create | result |
| Name | Description | Schema |
|---|---|---|
| enable_dnssec optional |
id enable DNS SEC Default : false |
boolean |
| enable_root_cname optional |
is enable root cname Default : false |
boolean |
| id optional |
id of zone | string |
| name optional |
name of zone | string |
| origin_name optional |
zone name before Punycode encode | string |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Message | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Get Zone deploy status
POST /specp/dp/v2/zones/status/deploy
Description
Get the deploy status for a single zone.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Body | body optional |
request body for get deploy status | body |
| Name | Description | Schema |
|---|---|---|
| zone_name required |
Zone name | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | Response 200 |
| 500 | Internal Server Error | Response 500 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code, response 0 if successful, response otherwise if failed (ex: 42232422) | integer |
| msg optional |
Message | string |
| result optional |
the result of zone delete | result |
| Name | Description | Schema |
|---|---|---|
| test_zone_name optional |
Deploy status | string |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Message | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Create a zone transfer zone
POST /specp/dp/v2/zones/zonetransfer
Description
Create a new zone for zone transfer
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Body | body optional |
request body for zone create. | body |
| Name | Description | Schema |
|---|---|---|
| dnssec_multi_signer optional |
Multi-Signer Configuration | dnssec_multi_signer |
| enable_dnssec optional |
enable DNS SEC, can not be true if enable root cname is true Default : false |
boolean |
| enable_root_cname optional |
Enable root cname. | string |
| zone_name required |
Zone name. | string |
| Name | Description | Schema |
|---|---|---|
| enabled optional |
enable Multi-Signer, can be turned on only if DNSSEC is turned on | boolean |
| ip optional |
The list of Multi-Signer IP address | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | ZoneTransferResult |
| 500 | Internal Server Error | Response 500 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Message | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Add one or more additional master server configs
POST /specp/dp/v2/zones/zonetransfer/master_servers
Description
Add one or more additional master server configs, for zone transfer only
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Body | body optional |
request body for master servers create | MasterServers |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | MasterServersResult |
| 500 | Internal Server Error | Response 500 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Message | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Replace all master server configs
PUT /specp/dp/v2/zones/zonetransfer/master_servers
Description
Replace all master server configs, for zone transfer only
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Body | body optional |
request body for master servers replace | MasterServers |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | MasterServersResult |
| 500 | Internal Server Error | Response 500 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Message | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Remove one or more master server configurations specified by IP
POST /specp/dp/v2/zones/zonetransfer/master_servers/delete
Description
Remove one or more master server configs, for zone transfer only
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | access_token required |
Access token used to authenticate your access to the API. | string |
| Body | body optional |
request body for master servers delete | body |
| Name | Description | Schema |
|---|---|---|
| master_server_ips optional |
Master server IP; the corresponding master server configuration will be removed | < string > array |
| zone_name required |
Zone name | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | Response 200 |
| 500 | Internal Server Error | Response 500 |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code, response 0 if successful, response otherwise if failed (ex: 42232422) | integer |
| master_server_ips optional |
Master server IP; the corresponding master server configuration will be removed | < string > array |
| msg optional |
Message | string |
| zone_name required |
Zone name | string |
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code | integer |
| msg optional |
Message | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Definitions
MasterServers
| Name | Description | Schema |
|---|---|---|
| master_servers required |
Master server information. | < master_servers > array |
| zone_name required |
Zone name. | string |
| Name | Description | Schema |
|---|---|---|
| algorithm optional |
Algorithm name. (hmac-sha512、hmac-sha384、hmac-sha256、hmac-sha224、hmac-sha1、hmac-md5) | string |
| ip optional |
IP address. | string |
| key_name optional |
TSIG key name. | string |
| secret optional |
TSIG key content. | string |
MasterServersResult
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code, response 0 if successful, response otherwise if failed (ex: 42232422) | integer |
| msg optional |
Message | string |
| result optional |
MasterServers |
StandardZone
| Name | Description | Schema |
|---|---|---|
| enable_dnssec required |
Enable DNS SEC. Can not be true if enableRootCname is true. Default : false |
boolean |
| enable_root_cname required |
Enable root cname. Can not be true if enableDnssec is true. Default : false |
boolean |
| zone_name required |
Zone name. | string |
ZoneSetting
| Name | Description | Schema |
|---|---|---|
| dnssec_multi_signer optional |
Multi-Signer Configuration | dnssec_multi_signer |
| enable_dnssec optional |
enable DNSSEC, can not be true if enable_root_cname is true | boolean |
| enable_root_cname optional |
enable root cname, can not be true if enable_dnssec is true | boolean |
| zone_name required |
Zone name | string |
| Name | Description | Schema |
|---|---|---|
| enabled optional |
enable Multi-Signer, can be turned on only if DNSSEC is turned on | boolean |
| ip optional |
The list of Multi-Signer IP address | string |
ZoneSettingResult
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code, response 0 if successful, response otherwise if failed (ex: 42232422) | integer |
| msg optional |
Message | string |
| result optional |
ZoneSetting |
ZoneTransfer
| Name | Description | Schema |
|---|---|---|
| enable_root_cname optional |
Enable root cname. | string |
| master_servers required |
Master server information. | < master_servers > array |
| zone_name required |
Zone name. | string |
| Name | Description | Schema |
|---|---|---|
| algorithm optional |
Algorithm name. (hmac-sha512、hmac-sha384、hmac-sha256、hmac-sha224、hmac-sha1、hmac-md5) | string |
| ip optional |
IP address. | string |
| key_name optional |
TSIG key name. | string |
| secret optional |
TSIG key content. | string |
ZoneTransferResult
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code, response 0 if successful, response otherwise if failed (ex: 42232422) | integer |
| msg optional |
Message | string |
| result optional |
ZoneTransfer |
Security
ApiKeyAuth
Type : apiKey
Name : access_token
In : QUERY