Record overview

Prev Next

Overview

This feature allows you to call the features provided by Global DNS for creating, editing, and deleting domains and records using the specified API.
You must use the authorized API key issued from the dashboard to make these calls.

Common Global DNS settings

The following describes commonly used request and response formats in Global DNS APIs.

Request

The following describes the common request format.

API URL

The request API URL is as follows:

https://globaldns.apigw.ntruss.com

Request headers

The following describes the headers.

Field Required Description
x-ncp-apigw-timestamp Required This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
  • Request is considered invalid if the timestamp differs from the current time by more than 5 minutes.
  • Unix timestamp format.
x-ncp-iam-access-key Required Access key issued on NAVER Cloud Platform
x-ncp-apigw-signature-v2 Required Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256)

Response

The following describes the common response format.

Response body

The response body includes the following data:

error
error defines the API call failure information. The following describes error.

Field Type Required Description
result String - API call results
  • FAIL: Display when the call fails.
error Object - Error code and message
  • Displayed if success is false
error.errorCode Integer - Error code
error.message String - Error message

Response status codes

Global DNS APIs use NAVER Cloud Platform's common response status codes. For information about the HTTP status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

For response examples when a call is successful, see each API specification. The following is a sample response upon a failed call.

{
    "result": "FAIL",
    "error": {
        "errorCode": "X00006",
        "message": "You do not have permissions.",
        "devMessage": "You do not have permissions."
    }
}