Record
Record
Overview
DNS Protection Record 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
Add records
POST /specp/dp/v2/record
Description
Add records with array, do not support ANAME
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 record create | body |
| Name | Description | Schema |
|---|---|---|
| records required |
< Record > array | |
| zone required |
Which zone is record in. Needs to be in FQDN format. EX: nexusguard.com. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | Result |
| 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 |
update records
PUT /specp/dp/v2/record
Description
update records with array, do not support ANAME
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 record update | body |
| Name | Description | Schema |
|---|---|---|
| records required |
< UpdateRecord > array | |
| zone required |
Which zone is record in. Needs to be in FQDN format. EX: nexusguard.com. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | Result |
| 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 |
Delete records
POST /specp/dp/v2/record/delete
Description
Delete records with array, do not support ANAME
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 record delete. | body |
| Name | Description | Schema |
|---|---|---|
| records required |
< records > array | |
| zone required |
Which zone is record in. Needs to be in FQDN format. EX: nexusguard.com. | string |
| Name | Description | Schema |
|---|---|---|
| data optional |
record data | string |
| name optional |
record name, input only the subdomain. Use ‘@’ to refer to the root domain | string |
| pri optional |
record pri, optional, only need if type is SRV or MX | string |
| type optional |
record type | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | Result |
| 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 |
Retrieves record list.
POST /specp/dp/v2/record/list
Description
This API retrieves a complete list of record. 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 |
| Body | body required |
Request body parameters, status and mode can be configured on your needs. They are unnecessarily given. | body |
| Name | Description | Schema |
|---|---|---|
| pageIndex required |
Page index of record data page. | integer |
| zone optional |
Zone name of the record property. | 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 data of records. | result |
| Name | Description | Schema |
|---|---|---|
| records optional |
< records > array | |
| totalCount optional |
Total number of records. | integer |
| totalPage optional |
Total page of records data. | integer |
| Name | Description | Schema |
|---|---|---|
| data optional |
Data of the record. | string |
| name optional |
Name of the record. | string |
| pri optional |
Pri of the record. | string |
| ttl optional |
TTL of the record. | string |
| type optional |
Type of the record. | string |
Consumes
application/json
Produces
application/json
Security
| Type | Name |
|---|---|
| apiKey | ApiKeyAuth |
Definitions
Record
| Name | Description | Schema |
|---|---|---|
| data required |
record data | string |
| name required |
record name, input only the subdomain. Use ‘@’ to refer to the root domain | string |
| pri optional |
record pri, optional, only need if type is SRV or MX | string |
| ttl required |
record ttl | string |
| type required |
record type | string |
Result
| Name | Description | Schema |
|---|---|---|
| code optional |
Error code, response 0 if successful, response otherwise if failed (ex: 42232422) | integer |
| msg optional |
Message | string |
| result optional |
result |
| Name | Description | Schema |
|---|---|---|
| data optional |
Error message, response if API failed | string |
| failedRecord optional |
The record which is failed, response if API failed | failedRecord |
| zone optional |
Which zone is record in, response if API successful | string |
| Name | Description | Schema |
|---|---|---|
| data optional |
record data | string |
| name optional |
record name | string |
| pri optional |
record pri, optional, only need if type is SRV or MX | string |
| ttl optional |
record ttl | string |
| type optional |
record type | string |
UpdateRecord
| Name | Description | Schema |
|---|---|---|
| new_record required |
new record data | < new_record > array |
| record required |
record be update | < record > array |
| Name | Description | Schema |
|---|---|---|
| data required |
record data | string |
| name required |
record name, input only the subdomain. Use ‘@’ to refer to the root domain | string |
| pri optional |
record pri, optional, only need if type is SRV or MX | string |
| ttl required |
record ttl | string |
| type required |
record type | string |
| Name | Description | Schema |
|---|---|---|
| data required |
record data | string |
| name required |
record name, input only the subdomain. Use ‘@’ to refer to the root domain | string |
| pri optional |
record pri, optional, only need if type is SRV or MX | string |
| type required |
record type | string |
Security
ApiKeyAuth
Type : apiKey
Name : access_token
In : QUERY