DNS
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.
본 가이드는 DNS 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다.
API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.
Version
| Version | Status | Supported Until |
|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | DEPRECATED | 20260331 |
| 1.2 | DEPRECATED | 20260331 |
| 1.3 | CURRENT | - |
OpenAPI URL
https://dns.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
1 - APIs
1.1 - Activate Private DNS
1.1.1 - 1.3
post /v1/private-dns/activate
Description
Activate Private DNS
상태
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/private-dns/activate
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Request body
{
"name": "private-dns01"
}
Example HTTP response
Response 202
{
"private_dns": {
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
}
1.1.2 - 1.2
post /v1/private-dns/activate
Description
Activate Private DNS
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/private-dns/activate
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Request body
{
"name": "private-dns01"
}
Example HTTP response
Response 202
{
"private_dns": {
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
}
1.1.3 - 1.1
post /v1/private-dns/activate
Description
Activate Private DNS
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/private-dns/activate
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Request body
{
"name": "private-dns01"
}
Example HTTP response
Response 202
{
"private_dns": {
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
}
1.1.4 - 1.0
post /v1/private-dns/activate
Description
Activate Private DNS
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/private-dns/activate
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Request body
{
"name": "private-dns01"
}
Example HTTP response
Response 202
{
"private_dns": {
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
}
1.2 - Create Hosted Zone
1.2.1 - 1.3
post /v1/hosted-zones
Description
Create a new hosted zone.
상태
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/hosted-zones
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Request body
{
"description": "This is description",
"name": "my-zone.com",
"private_dns_id": "",
"tags": [],
"type": "public"
}
Example HTTP response
Response 202
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"hosted_zone_type": "public",
"id": "3432012nfdksdf03ktrld9234lgfg",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "my-zone.com",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"private_dns_id": "10fjkewefprivatedns3193rud543",
"private_dns_name": "private-dns01",
"status": "CREATING",
"ttl": "3600"
}
1.2.2 - 1.2
post /v1/hosted-zones
Description
Create a new hosted zone.
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/hosted-zones
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Request body
{
"description": "",
"email": "",
"name": "",
"private_dns_id": "",
"tags": [],
"type": ""
}
Example HTTP response
Response 202
{
"action": "",
"attributes": "",
"created_at": "",
"description": "",
"email": "",
"hosted_zone_type": "",
"id": "",
"links": "",
"masters": [
""
],
"name": "",
"pool_id": "",
"private_dns_id": "",
"private_dns_name": "",
"project_id": "",
"serial": "",
"shared": "",
"status": "",
"transferred_at": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": ""
}
1.2.3 - 1.1
post /v1/hosted-zones
Description
Create a new hosted zone
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/hosted-zones
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Request body
{
"description": "",
"email": "",
"name": "",
"tags": [],
"type": ""
}
Example HTTP response
Response 202
{
"action": "",
"attributes": "",
"created_at": "",
"description": "",
"email": "",
"hosted_zone_type": "",
"id": "",
"links": "",
"masters": [
""
],
"name": "",
"pool_id": "",
"project_id": "",
"serial": "",
"shared": "",
"status": "",
"transferred_at": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": ""
}
1.2.4 - 1.0
post /v1/hosted-zones
Description
Create a new hosted zone
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/hosted-zones
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Request body
{
"description": "",
"email": "",
"name": "",
"tags": [],
"type": ""
}
Example HTTP response
Response 202
{
"action": "",
"attributes": "",
"created_at": "",
"description": "",
"email": "",
"hosted_zone_type": "",
"id": "",
"links": "",
"masters": [
""
],
"name": "",
"pool_id": "",
"project_id": "",
"serial": "",
"shared": "",
"status": "",
"transferred_at": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": ""
}
1.3 - Create Hosted Zone Record
1.3.1 - 1.3
post /v1/hosted-zones/{hosted_zone_id}/records
Description
Create a new recordset in the hosted zone
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Id Example :
| string | None |
| body | body required |
| RecordCreateRequest | |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Request body
{
"description": "",
"name": "",
"records": [
{}
],
"ttl": "",
"type": ""
}
Example HTTP response
Response 202
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
1.4 - Create Private DNS
1.4.1 - 1.3
post /v1/private-dns
Description
Create Private DNS
상태
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/private-dns
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Request body
{
"connected_vpc_ids": [],
"description": "This is description",
"name": "private-dns01",
"tags": [
{
"key": "",
"value": ""
}
]
}
Example HTTP response
Response 202
{
"private_dns": {
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
}
1.4.2 - 1.2
post /v1/private-dns
Description
Create Private DNS
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/private-dns
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Request body
{
"connected_vpc_ids": [],
"description": "This is description",
"name": "private-dns01",
"tags": [
{
"key": "",
"value": ""
}
]
}
Example HTTP response
Response 202
{
"private_dns": {
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
}
1.4.3 - 1.1
post /v1/private-dns
Description
Create Private DNS
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/private-dns
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Request body
{
"connected_vpc_ids": [],
"description": "This is description",
"name": "private-dns01",
"tags": [
{
"key": "",
"value": ""
}
]
}
Example HTTP response
Response 202
{
"private_dns": {
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
}
1.4.4 - 1.0
post /v1/private-dns
Description
Create Private DNS
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/private-dns
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Request body
{
"connected_vpc_ids": [],
"description": "This is description",
"name": "private-dns01",
"tags": [
{
"key": "",
"value": ""
}
]
}
Example HTTP response
Response 202
{
"private_dns": {
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
}
1.5 - Create Public Domain
1.5.1 - 1.2
post /v1/public-domain-names
Description
Create a new Public Domain record
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/public-domain-names
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Request body
{
"address_type": "",
"auto_extension": true,
"description": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"name": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_name_en": "",
"register_name_ko": "",
"register_telno": "",
"tags": []
}
Example HTTP response
Response 201
{
"public_domain_name": {
"address_type": "",
"auto_extension": "",
"created_at": "",
"created_by": "",
"description": "",
"domestic_address_en": "",
"domestic_address_ko": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"expired_date": "",
"id": "",
"modified_at": "",
"modified_by": "",
"name": "",
"overseas_address": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_name_en": "",
"register_name_ko": "",
"register_telno": "",
"start_date": "",
"status": ""
}
}
1.5.2 - 1.1
post /v1/public-domain-names
Description
Create a new Public Domain record
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/public-domain-names
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Request body
{
"address_type": "",
"auto_extension": true,
"description": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"name": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_name_en": "",
"register_name_ko": "",
"register_telno": "",
"tags": []
}
Example HTTP response
Response 201
{
"public_domain_name": {
"address_type": "",
"auto_extension": "",
"created_at": "",
"created_by": "",
"description": "",
"domestic_address_en": "",
"domestic_address_ko": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"expired_date": "",
"id": "",
"modified_at": "",
"modified_by": "",
"name": "",
"overseas_address": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_name_en": "",
"register_name_ko": "",
"register_telno": "",
"start_date": "",
"status": ""
}
}
1.5.3 - 1.0
post /v1/public-domain-names
Description
Create a new Public Domain record
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/public-domain-names
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Request body
{
"address_type": "",
"auto_extension": true,
"description": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"name": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_name_en": "",
"register_name_ko": "",
"register_telno": "",
"tags": []
}
Example HTTP response
Response 201
{
"public_domain_name": {
"address_type": "",
"auto_extension": "",
"created_at": "",
"created_by": "",
"description": "",
"domestic_address_en": "",
"domestic_address_ko": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"expired_date": "",
"id": "",
"modified_at": "",
"modified_by": "",
"name": "",
"overseas_address": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_name_en": "",
"register_name_ko": "",
"register_telno": "",
"start_date": "",
"status": ""
}
}
1.6 - Create Public Domain Name
1.6.1 - 1.3
post /v1/public-domain-names
Description
Create a new Public Domain Name
상태
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/public-domain-names
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Request body
{
"address_type": "",
"auto_extension": true,
"description": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"name": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_name_en": "",
"register_name_ko": "",
"register_telno": "",
"tags": []
}
Example HTTP response
Response 201
{
"public_domain_name": {
"address_type": "",
"auto_extension": "",
"created_at": "",
"created_by": "",
"description": "",
"domestic_address_en": "",
"domestic_address_ko": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"expired_date": "",
"id": "",
"modified_at": "",
"modified_by": "",
"name": "",
"overseas_address": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_name_en": "",
"register_name_ko": "",
"register_telno": "",
"start_date": "",
"status": ""
}
}
1.7 - Create Record
1.7.1 - 1.2
post /v1/hosted-zones/{hosted_zone_id}/records
Description
Create a new recordset in the hosted zone
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Request body
{
"description": "",
"name": "",
"records": [
{}
],
"ttl": "",
"type": ""
}
Example HTTP response
Response 202
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
1.7.2 - 1.1
post /v1/hosted-zones/{hosted_zone_id}/records
Description
Create a new recordset in the hosted zone
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Request body
{
"description": "",
"name": "",
"records": [
{}
],
"ttl": "",
"type": ""
}
Example HTTP response
Response 202
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
1.7.3 - 1.0
post /v1/hosted-zones/{hosted_zone_id}/records
Description
Create a new recordset in the hosted zone
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Request body
{
"description": "",
"name": "",
"records": [
{}
],
"ttl": "",
"type": ""
}
Example HTTP response
Response 202
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
1.8 - Delete Hosted Zone
1.8.1 - 1.3
delete /v1/hosted-zones/{hosted_zone_id}
Description
Delete a hosted zone
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Id Example :
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 202
1.8.2 - 1.2
delete /v1/hosted-zones/{hosted_zone_id}
Description
Delete a hosted zone
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Id Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Example HTTP response
Response 202
{
"action": "",
"attributes": "",
"created_at": "",
"description": "",
"email": "",
"hosted_zone_type": "",
"id": "",
"links": "",
"masters": [
""
],
"name": "",
"pool_id": "",
"private_dns_id": "",
"private_dns_name": "",
"project_id": "",
"serial": "",
"shared": "",
"status": "",
"transferred_at": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": ""
}
1.8.3 - 1.1
delete /v1/hosted-zones/{hosted_zone_id}
Description
Delete a hosted zone
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Id Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Example HTTP response
Response 202
{
"action": "",
"attributes": "",
"created_at": "",
"description": "",
"email": "",
"hosted_zone_type": "",
"id": "",
"links": "",
"masters": [
""
],
"name": "",
"pool_id": "",
"project_id": "",
"serial": "",
"shared": "",
"status": "",
"transferred_at": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": ""
}
1.8.4 - 1.0
delete /v1/hosted-zones/{hosted_zone_id}
Description
Delete a hosted zone
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Id Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Example HTTP response
Response 202
{
"action": "",
"attributes": "",
"created_at": "",
"description": "",
"email": "",
"hosted_zone_type": "",
"id": "",
"links": "",
"masters": [
""
],
"name": "",
"pool_id": "",
"project_id": "",
"serial": "",
"shared": "",
"status": "",
"transferred_at": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": ""
}
1.9 - Delete Hosted Zone Record
1.9.1 - 1.3
delete /v1/hosted-zones/{hosted_zone_id}/records/{record_id}
Description
Delete hosted zone record
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Zone ID Example :
| string | None |
| path | record_id required | Record ID Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records/{record_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 202
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
1.10 - Delete Private DNS
1.10.1 - 1.3
delete /v1/private-dns/{private_dns_id}
Description
Delete Private DNS
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | private_dns_id required | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/private-dns/{private_dns_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 202
1.10.2 - 1.2
delete /v1/private-dns/{private_dns_id}
Description
Delete Private DNS
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | private_dns_id required | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/private-dns/{private_dns_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Example HTTP response
Response 202
1.10.3 - 1.1
delete /v1/private-dns/{private_dns_id}
Description
Delete Private DNS
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | private_dns_id required | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/private-dns/{private_dns_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Example HTTP response
Response 202
1.10.4 - 1.0
delete /v1/private-dns/{private_dns_id}
Description
Delete Private DNS
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | private_dns_id required | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/private-dns/{private_dns_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Example HTTP response
Response 202
1.11 - Delete Record
1.11.1 - 1.2
delete /v1/hosted-zones/{hosted_zone_id}/records/{record_id}
Description
Delete a recordset
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Zone ID Example :
| string | None |
| path | record_id required | Record ID Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records/{record_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Example HTTP response
Response 202
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
1.11.2 - 1.1
delete /v1/hosted-zones/{hosted_zone_id}/records/{record_id}
Description
Delete a recordset
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Zone ID Example :
| string | None |
| path | record_id required | Record ID Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records/{record_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Example HTTP response
Response 202
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
1.11.3 - 1.0
delete /v1/hosted-zones/{hosted_zone_id}/records/{record_id}
Description
Delete a recordset
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Zone ID Example :
| string | None |
| path | record_id required | Record ID Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records/{record_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Example HTTP response
Response 202
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
1.12 - Get Public Domain Detail
1.12.1 - 1.2
get /v1/public-domain-names/{public_domain_id}
Description
Retrieve detailed information for a specific public domain by ID
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | public_domain_id required | Id Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/public-domain-names/{public_domain_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Example HTTP response
Response 200
{
"public_domain_name": {
"address_type": "",
"auto_extension": "",
"created_at": "",
"created_by": "",
"description": "",
"domestic_address_en": "",
"domestic_address_ko": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"expired_date": "",
"id": "",
"modified_at": "",
"modified_by": "",
"name": "",
"overseas_address": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_name_en": "",
"register_name_ko": "",
"register_telno": "",
"start_date": "",
"status": ""
}
}
1.12.2 - 1.1
get /v1/public-domain-names/{public_domain_id}
Description
Retrieve detailed information for a specific public domain by ID
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | public_domain_id required | Id Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/public-domain-names/{public_domain_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Example HTTP response
Response 200
{
"public_domain_name": {
"address_type": "",
"auto_extension": "",
"created_at": "",
"created_by": "",
"description": "",
"domestic_address_en": "",
"domestic_address_ko": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"expired_date": "",
"id": "",
"modified_at": "",
"modified_by": "",
"name": "",
"overseas_address": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_name_en": "",
"register_name_ko": "",
"register_telno": "",
"start_date": "",
"status": ""
}
}
1.12.3 - 1.0
get /v1/public-domain-names/{public_domain_id}
Description
Retrieve detailed information for a specific public domain by ID
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | public_domain_id required | Id Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/public-domain-names/{public_domain_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Example HTTP response
Response 200
{
"public_domain_name": {
"address_type": "",
"auto_extension": "",
"created_at": "",
"created_by": "",
"description": "",
"domestic_address_en": "",
"domestic_address_ko": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"expired_date": "",
"id": "",
"modified_at": "",
"modified_by": "",
"name": "",
"overseas_address": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_name_en": "",
"register_name_ko": "",
"register_telno": "",
"start_date": "",
"status": ""
}
}
1.13 - List Hosted Zone Records
1.13.1 - 1.3
get /v1/hosted-zones/{hosted_zone_id}/records
Description
Get record list in a hosted zone
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Id Example :
| string | None |
| query | limit optional | limit Example :
| any of [integer, null] | None |
| query | marker optional | marker Example :
| any of [string, null] | None |
| query | sort_dir optional | sort direction Example :
| any of [string, null] | None |
| query | sort_key optional | sort key Example :
| any of [string, null] | None |
| query | name optional | name Example :
| any of [string, null] | None |
| query | exact_name optional | name Example :
| any of [string, null] | None |
| query | type optional | Type of the record Example :
| any of [string, null] | None |
| query | data optional | Record data Example :
| any of [string, null] | None |
| query | status optional | The status Example :
| any of [string, null] | None |
| query | description optional | description Example :
| any of [string, null] | None |
| query | ttl optional | TTL for the zone. Example :
| any of [integer, null] | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 200
{
"count": 20,
"links": "",
"metadata": "",
"records": [
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
]
}
1.14 - List Hosted Zones
1.14.1 - 1.3
get /v1/hosted-zones
Description
Return list of hosted zones
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | name optional | name Example : my-zone.com
| any of [string, null] | None |
| query | type optional | Type of zone Example :
| any of [enum (public, private), null] | None |
| query | status optional | The status Example :
| any of [enum (CREATING, EDITING, ACTIVE, DELETING, DELETED, ERROR, PENDING, UNKNOWN), null] | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 200
{
"count": 20,
"hosted_zones": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"hosted_zone_type": "public",
"id": "3432012nfdksdf03ktrld9234lgfg",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "my-zone.com",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"private_dns_id": "10fjkewefprivatedns3193rud543",
"private_dns_name": "private-dns01",
"status": "CREATING",
"ttl": "3600"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
1.14.2 - 1.2
get /v1/hosted-zones
Description
Return list of hosted zones
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | name optional | name Example :
| any of [string, null] | None |
| query | exact_name optional | name Example :
| any of [string, null] | None |
| query | type optional | Type of zone Example :
| any of [string, null] | None |
| query | email optional | email Example :
| any of [string, null] | None |
| query | status optional | The status Example :
| any of [string, null] | None |
| query | description optional | description Example :
| any of [string, null] | None |
| query | ttl optional | TTL for the zone. Example :
| any of [integer, null] | None |
| query | page optional | Page Example : 0
| any of [integer, null] | 0 |
| query | size optional | Size Example : 20
| any of [integer, null] | 20 |
| query | sort optional | Sort Example : name:asc
| any of [string, null] | name:asc |
Responses
Example HTTP request
Request path
/v1/hosted-zones
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Example HTTP response
Response 200
{
"count": "",
"hosted_zones": [
{
"action": "",
"attributes": "",
"created_at": "",
"description": "",
"email": "",
"hosted_zone_type": "",
"id": "",
"links": "",
"masters": [
""
],
"name": "",
"pool_id": "",
"private_dns_id": "",
"private_dns_name": "",
"project_id": "",
"serial": "",
"shared": "",
"status": "",
"transferred_at": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": ""
}
],
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
],
"page": "",
"size": "",
"sort": ""
}
1.14.3 - 1.1
get /v1/hosted-zones
Description
Return list of hosted zones
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | name optional | name Example :
| any of [string, null] | None |
| query | exact_name optional | name Example :
| any of [string, null] | None |
| query | type optional | Type of zone Example :
| any of [string, null] | None |
| query | email optional | email Example :
| any of [string, null] | None |
| query | status optional | The status Example :
| any of [string, null] | None |
| query | description optional | description Example :
| any of [string, null] | None |
| query | ttl optional | TTL for the zone. Example :
| any of [integer, null] | None |
| query | page optional | Page Example : 0
| any of [integer, null] | 0 |
| query | size optional | Size Example : 20
| any of [integer, null] | 20 |
| query | sort optional | Sort Example : name:asc
| any of [string, null] | name:asc |
Responses
Example HTTP request
Request path
/v1/hosted-zones
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Example HTTP response
Response 200
{
"count": "",
"hosted_zones": [
{
"action": "",
"attributes": "",
"created_at": "",
"description": "",
"email": "",
"hosted_zone_type": "",
"id": "",
"links": "",
"masters": [
""
],
"name": "",
"pool_id": "",
"project_id": "",
"serial": "",
"shared": "",
"status": "",
"transferred_at": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": ""
}
],
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
],
"page": "",
"size": "",
"sort": ""
}
1.14.4 - 1.0
get /v1/hosted-zones
Description
Return list of hosted zones
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | limit optional | limit Example :
| any of [integer, null] | None |
| query | marker optional | marker Example :
| any of [string, null] | None |
| query | sort_dir optional | sort direction Example :
| any of [string, null] | None |
| query | sort_key optional | sort key Example :
| any of [string, null] | None |
| query | name optional | name Example :
| any of [string, null] | None |
| query | exact_name optional | name Example :
| any of [string, null] | None |
| query | type optional | Type of zone Example :
| any of [string, null] | None |
| query | email optional | email Example :
| any of [string, null] | None |
| query | status optional | The status Example :
| any of [string, null] | None |
| query | description optional | description Example :
| any of [string, null] | None |
| query | ttl optional | TTL for the zone. Example :
| any of [integer, null] | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Example HTTP response
Response 200
{
"count": 20,
"links": "",
"metadata": "",
"zones": [
{
"action": "",
"attributes": "",
"created_at": "",
"description": "",
"email": "",
"hosted_zone_type": "",
"id": "",
"links": "",
"masters": [
""
],
"name": "",
"pool_id": "",
"project_id": "",
"serial": "",
"shared": "",
"status": "",
"transferred_at": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": ""
}
]
}
1.15 - List Private DNS
1.15.1 - 1.3
get /v1/private-dns
Description
List all Private DNS
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | id optional | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| any of [string, null] | None |
| query | name optional | Private DNS Name Example :
| any of [string, null] | None |
| query | vpc_id optional | Connected VPC ID Example : 7df8abb4912e4709b1cb237daccca7a8
| any of [string, null] | None |
| query | state optional | State Example : ACTIVE
| any of [enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR), null] | None |
Responses
Example HTTP request
Request path
/v1/private-dns
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"private_dns": [
{
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
1.15.2 - 1.2
get /v1/private-dns
Description
List all Private DNS
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | id optional | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| any of [string, null] | None |
| query | name optional | Private DNS Name Example :
| any of [string, null] | None |
| query | vpc_id optional | Connected VPC ID Example : 7df8abb4912e4709b1cb237daccca7a8
| any of [string, null] | None |
| query | state optional | State Example : ACTIVE
| any of [enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR), null] | None |
Responses
Example HTTP request
Request path
/v1/private-dns
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"private_dns": [
{
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
1.15.3 - 1.1
get /v1/private-dns
Description
List all Private DNS
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | id optional | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| any of [string, null] | None |
| query | name optional | Private DNS Name Example :
| any of [string, null] | None |
| query | vpc_id optional | Connected VPC ID Example : 7df8abb4912e4709b1cb237daccca7a8
| any of [string, null] | None |
| query | state optional | State Example : ACTIVE
| any of [enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR), null] | None |
Responses
Example HTTP request
Request path
/v1/private-dns
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"private_dns": [
{
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
1.15.4 - 1.0
get /v1/private-dns
Description
List all Private DNS
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | id optional | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| any of [string, null] | None |
| query | name optional | Private DNS Name Example :
| any of [string, null] | None |
| query | vpc_id optional | Connected VPC ID Example : 7df8abb4912e4709b1cb237daccca7a8
| any of [string, null] | None |
| query | state optional | State Example : ACTIVE
| any of [enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR), null] | None |
Responses
Example HTTP request
Request path
/v1/private-dns
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"private_dns": [
{
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
1.16 - List Public Domain Names
1.16.1 - 1.3
get /v1/public-domain-names
Description
Return list of Public Domain Names
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | name optional | name Example :
| any of [string, null] | None |
| query | created_by optional | Created By_ Example :
| any of [string, null] | None |
Responses
Example HTTP request
Request path
/v1/public-domain-names
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"public_domain_names": [
{
"created_at": "",
"created_by": "",
"expired_date": "",
"id": "",
"modified_at": "",
"modified_by": "",
"name": "",
"register_email": "",
"start_date": "",
"status": ""
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
1.17 - List Public Domains
1.17.1 - 1.2
get /v1/public-domain-names
Description
List all Public Domains
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | name optional | name Example :
| any of [string, null] | None |
| query | created_by optional | Created By_ Example :
| any of [string, null] | None |
Responses
Example HTTP request
Request path
/v1/public-domain-names
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"public_domain_names": [
{
"created_at": "",
"created_by": "",
"expired_date": "",
"id": "",
"modified_at": "",
"modified_by": "",
"name": "",
"register_email": "",
"start_date": "",
"status": ""
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
1.17.2 - 1.1
get /v1/public-domain-names
Description
List all Public Domains
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | name optional | name Example :
| any of [string, null] | None |
| query | created_by optional | Created By_ Example :
| any of [string, null] | None |
Responses
Example HTTP request
Request path
/v1/public-domain-names
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"public_domain_names": [
{
"created_at": "",
"created_by": "",
"expired_date": "",
"id": "",
"modified_at": "",
"modified_by": "",
"name": "",
"register_email": "",
"start_date": "",
"status": ""
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
1.17.3 - 1.0
get /v1/public-domain-names
Description
List all Public Domains
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | name optional | name Example :
| any of [string, null] | None |
| query | created_by optional | Created By_ Example :
| any of [string, null] | None |
Responses
Example HTTP request
Request path
/v1/public-domain-names
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"public_domain_names": [
{
"created_at": "",
"created_by": "",
"expired_date": "",
"id": "",
"modified_at": "",
"modified_by": "",
"name": "",
"register_email": "",
"start_date": "",
"status": ""
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
1.18 - List Records
1.18.1 - 1.2
get /v1/hosted-zones/{hosted_zone_id}/records
Description
Get recordset list in a hosted zone
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Id Example :
| string | None |
| query | limit optional | limit Example :
| any of [integer, null] | None |
| query | marker optional | marker Example :
| any of [string, null] | None |
| query | sort_dir optional | sort direction Example :
| any of [string, null] | None |
| query | sort_key optional | sort key Example :
| any of [string, null] | None |
| query | name optional | name Example :
| any of [string, null] | None |
| query | exact_name optional | name Example :
| any of [string, null] | None |
| query | type optional | Type of the record Example :
| any of [string, null] | None |
| query | data optional | Record data Example :
| any of [string, null] | None |
| query | status optional | The status Example :
| any of [string, null] | None |
| query | description optional | description Example :
| any of [string, null] | None |
| query | ttl optional | TTL for the zone. Example :
| any of [integer, null] | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Example HTTP response
Response 200
{
"count": 20,
"links": "",
"metadata": "",
"records": [
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
]
}
1.18.2 - 1.1
get /v1/hosted-zones/{hosted_zone_id}/records
Description
Get recordset list in a hosted zone
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Id Example :
| string | None |
| query | limit optional | limit Example :
| any of [integer, null] | None |
| query | marker optional | marker Example :
| any of [string, null] | None |
| query | sort_dir optional | sort direction Example :
| any of [string, null] | None |
| query | sort_key optional | sort key Example :
| any of [string, null] | None |
| query | name optional | name Example :
| any of [string, null] | None |
| query | exact_name optional | name Example :
| any of [string, null] | None |
| query | type optional | Type of the record Example :
| any of [string, null] | None |
| query | data optional | Record data Example :
| any of [string, null] | None |
| query | status optional | The status Example :
| any of [string, null] | None |
| query | description optional | description Example :
| any of [string, null] | None |
| query | ttl optional | TTL for the zone. Example :
| any of [integer, null] | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Example HTTP response
Response 200
{
"count": 20,
"links": "",
"metadata": "",
"records": [
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
]
}
1.18.3 - 1.0
get /v1/hosted-zones/{hosted_zone_id}/records
Description
Get recordset list in a hosted zone
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Id Example :
| string | None |
| query | limit optional | limit Example :
| any of [integer, null] | None |
| query | marker optional | marker Example :
| any of [string, null] | None |
| query | sort_dir optional | sort direction Example :
| any of [string, null] | None |
| query | sort_key optional | sort key Example :
| any of [string, null] | None |
| query | name optional | name Example :
| any of [string, null] | None |
| query | exact_name optional | name Example :
| any of [string, null] | None |
| query | type optional | Type of the record Example :
| any of [string, null] | None |
| query | data optional | Record data Example :
| any of [string, null] | None |
| query | status optional | The status Example :
| any of [string, null] | None |
| query | description optional | description Example :
| any of [string, null] | None |
| query | ttl optional | TTL for the zone. Example :
| any of [integer, null] | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Example HTTP response
Response 200
{
"count": 20,
"links": "",
"metadata": "",
"records": [
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
]
}
1.19 - Set Hosted Zone Record
1.19.1 - 1.3
put /v1/hosted-zones/{hosted_zone_id}/records/{record_id}
Description
Update Hosted Zone record
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Zone ID Example :
| string | None |
| path | record_id required | Record ID Example :
| string | None |
| body | body required |
| RecordSetRequest | |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records/{record_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Request body
{
"records": "",
"ttl": ""
}
Example HTTP response
Response 202
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
1.20 - Set Private DNS
1.20.1 - 1.3
put /v1/private-dns/{private_dns_id}
Description
Update Private DNS
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | private_dns_id required | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| string | None |
| body | body required |
| PrivateDnsSetRequest | |
Responses
Example HTTP request
Request path
/v1/private-dns/{private_dns_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Request body
{
"connected_vpc_ids": [
""
],
"description": "This is description"
}
Example HTTP response
Response 202
{
"private_dns": {
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
}
1.20.2 - 1.2
put /v1/private-dns/{private_dns_id}
Description
Update Private DNS
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | private_dns_id required | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| string | None |
| body | body required |
| PrivateDnsSetRequest | |
Responses
Example HTTP request
Request path
/v1/private-dns/{private_dns_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Request body
{
"connected_vpc_ids": [
""
],
"description": "This is description"
}
Example HTTP response
Response 202
{
"private_dns": {
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
}
1.20.3 - 1.1
put /v1/private-dns/{private_dns_id}
Description
Update Private DNS
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | private_dns_id required | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| string | None |
| body | body required |
| PrivateDnsSetRequest | |
Responses
Example HTTP request
Request path
/v1/private-dns/{private_dns_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Request body
{
"connected_vpc_ids": [
""
],
"description": "This is description"
}
Example HTTP response
Response 202
{
"private_dns": {
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
}
1.20.4 - 1.0
put /v1/private-dns/{private_dns_id}
Description
Update Private DNS
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | private_dns_id required | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| string | None |
| body | body required |
| PrivateDnsSetRequest | |
Responses
Example HTTP request
Request path
/v1/private-dns/{private_dns_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Request body
{
"connected_vpc_ids": [
""
],
"description": "This is description"
}
Example HTTP response
Response 202
{
"private_dns": {
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
}
1.21 - Set Public Domain Name
1.21.1 - 1.3
put /v1/public-domain-names/{public_domain_id}
Description
Update Public Domain Name
상태
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/public-domain-names/{public_domain_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Request body
{
"auto_extension": "",
"description": ""
}
Example HTTP response
Response 200
{
"auto_extension": "",
"description": "",
"id": ""
}
1.22 - Set Public Domain Name Whois Info
1.22.1 - 1.3
put /v1/public-domain-names/{public_domain_id}/information
Description
Update Public Domain Name Whois Info
상태
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/public-domain-names/{public_domain_id}/information
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Request body
{
"address_type": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_telno": ""
}
Example HTTP response
Response 200
{
"address_type": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"name": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_name_en": "",
"register_name_ko": "",
"register_telno": ""
}
1.23 - Show Hosted Zone
1.23.1 - 1.3
get /v1/hosted-zones/{hosted_zone_id}
Description
Return details of a hosted zone.
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Id Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 200
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"hosted_zone_type": "public",
"id": "3432012nfdksdf03ktrld9234lgfg",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "my-zone.com",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"private_dns_id": "10fjkewefprivatedns3193rud543",
"private_dns_name": "private-dns01",
"status": "CREATING",
"ttl": "3600"
}
1.23.2 - 1.2
get /v1/hosted-zones/{hosted_zone_id}
Description
Return details of a hosted zone.
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Id Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Example HTTP response
Response 200
{
"action": "",
"attributes": "",
"created_at": "",
"description": "",
"email": "",
"hosted_zone_type": "",
"id": "",
"links": "",
"masters": [
""
],
"name": "",
"pool_id": "",
"private_dns_id": "",
"private_dns_name": "",
"project_id": "",
"serial": "",
"shared": "",
"status": "",
"transferred_at": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": ""
}
1.23.3 - 1.1
get /v1/hosted-zones/{hosted_zone_id}
Description
Return details of a hosted zone
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Id Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Example HTTP response
Response 200
{
"action": "",
"attributes": "",
"created_at": "",
"description": "",
"email": "",
"hosted_zone_type": "",
"id": "",
"links": "",
"masters": [
""
],
"name": "",
"pool_id": "",
"project_id": "",
"serial": "",
"shared": "",
"status": "",
"transferred_at": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": ""
}
1.23.4 - 1.0
get /v1/hosted-zones/{hosted_zone_id}
Description
Return details of a hosted zone
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Id Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Example HTTP response
Response 200
{
"action": "",
"attributes": "",
"created_at": "",
"description": "",
"email": "",
"hosted_zone_type": "",
"id": "",
"links": "",
"masters": [
""
],
"name": "",
"pool_id": "",
"project_id": "",
"serial": "",
"shared": "",
"status": "",
"transferred_at": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": ""
}
1.24 - Show Hosted Zone Record
1.24.1 - 1.3
get /v1/hosted-zones/{hosted_zone_id}/records/{record_id}
Description
Get details of a hosted zone record
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Zone ID Example :
| string | None |
| path | record_id required | Record ID Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records/{record_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 200
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
1.25 - Show Private DNS
1.25.1 - 1.3
get /v1/private-dns/{private_dns_id}
Description
Show Private DNS
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | private_dns_id required | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| string | None |
Responses
Example HTTP request
Request path
/v1/private-dns/{private_dns_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 200
{
"private_dns": {
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
}
1.25.2 - 1.2
get /v1/private-dns/{private_dns_id}
Description
Show Private DNS
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | private_dns_id required | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| string | None |
Responses
Example HTTP request
Request path
/v1/private-dns/{private_dns_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Example HTTP response
Response 200
{
"private_dns": {
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
}
1.25.3 - 1.1
get /v1/private-dns/{private_dns_id}
Description
Show Private DNS
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | private_dns_id required | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| string | None |
Responses
Example HTTP request
Request path
/v1/private-dns/{private_dns_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Example HTTP response
Response 200
{
"private_dns": {
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
}
1.25.4 - 1.0
get /v1/private-dns/{private_dns_id}
Description
Show Private DNS
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | private_dns_id required | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| string | None |
Responses
Example HTTP request
Request path
/v1/private-dns/{private_dns_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Example HTTP response
Response 200
{
"private_dns": {
"auth_dns_name": "",
"connected_vpc_ids": [
""
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "10fjkewefprivatedns3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"pool_name": "",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "",
"state": "CREATING"
}
}
1.26 - Show Public Domain Name
1.26.1 - 1.3
get /v1/public-domain-names/{public_domain_id}
Description
Return details of a public domain name
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | public_domain_id required | Id Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/public-domain-names/{public_domain_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 200
{
"public_domain_name": {
"address_type": "",
"auto_extension": "",
"created_at": "",
"created_by": "",
"description": "",
"domestic_address_en": "",
"domestic_address_ko": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"expired_date": "",
"id": "",
"modified_at": "",
"modified_by": "",
"name": "",
"overseas_address": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_name_en": "",
"register_name_ko": "",
"register_telno": "",
"start_date": "",
"status": ""
}
}
1.27 - Show Record
1.27.1 - 1.2
get /v1/hosted-zones/{hosted_zone_id}/records/{record_id}
Description
Get details of a recordset
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Zone ID Example :
| string | None |
| path | record_id required | Record ID Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records/{record_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Example HTTP response
Response 200
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
1.27.2 - 1.1
get /v1/hosted-zones/{hosted_zone_id}/records/{record_id}
Description
Get details of a recordset
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Zone ID Example :
| string | None |
| path | record_id required | Record ID Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records/{record_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Example HTTP response
Response 200
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
1.27.3 - 1.0
get /v1/hosted-zones/{hosted_zone_id}/records/{record_id}
Description
Get details of a recordset
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Zone ID Example :
| string | None |
| path | record_id required | Record ID Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records/{record_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Example HTTP response
Response 200
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
1.28 - Transfer Public Domain Name
1.28.1 - 1.3
post /v1/public-domain-names/{public_domain_id}/transfer
Description
Transfer Public Domain Name
상태
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/public-domain-names/{public_domain_id}/transfer
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Request body
{
"target_account_id": "",
"type": "REQUEST"
}
Example HTTP response
Response 200
{
"auto_extension": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"expired_date": "2026-02-11T06:41:41.289Z",
"id": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"start_date": "2026-02-11T06:41:41.289Z",
"state": "ACTIVE"
}
1.29 - Update auto_extension or description
1.29.1 - 1.2
put /v1/public-domain-names/{public_domain_id}
Description
Update auto_extension or description of a Public Domain
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/public-domain-names/{public_domain_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Request body
{
"auto_extension": "",
"description": ""
}
Example HTTP response
Response 200
{
"auto_extension": "",
"description": "",
"id": ""
}
1.29.2 - 1.1
put /v1/public-domain-names/{public_domain_id}
Description
Update auto_extension or description of a Public Domain
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/public-domain-names/{public_domain_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Request body
{
"auto_extension": "",
"description": ""
}
Example HTTP response
Response 200
{
"auto_extension": "",
"description": "",
"id": ""
}
1.29.3 - 1.0
put /v1/public-domain-names/{public_domain_id}
Description
Update auto_extension or description of a Public Domain
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/public-domain-names/{public_domain_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Request body
{
"auto_extension": "",
"description": ""
}
Example HTTP response
Response 200
{
"auto_extension": "",
"description": "",
"id": ""
}
1.30 - Update Hosted Zone
1.30.1 - 1.3
put /v1/hosted-zones/{hosted_zone_id}
Description
Update a hosted zone.
상태
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"
Request body
{
"description": "This is description"
}
Example HTTP response
Response 202
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"hosted_zone_type": "public",
"id": "3432012nfdksdf03ktrld9234lgfg",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "my-zone.com",
"pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
"private_dns_id": "10fjkewefprivatedns3193rud543",
"private_dns_name": "private-dns01",
"status": "CREATING",
"ttl": "3600"
}
1.30.2 - 1.2
put /v1/hosted-zones/{hosted_zone_id}
Description
Update a hosted zone.
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Id Example :
| string | None |
| body | body required |
| HostedZoneSetRequest | |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Request body
{
"description": "",
"email": ""
}
Example HTTP response
Response 202
{
"action": "",
"attributes": "",
"created_at": "",
"description": "",
"email": "",
"hosted_zone_type": "",
"id": "",
"links": "",
"masters": [
""
],
"name": "",
"pool_id": "",
"private_dns_id": "",
"private_dns_name": "",
"project_id": "",
"serial": "",
"shared": "",
"status": "",
"transferred_at": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": ""
}
1.30.3 - 1.1
put /v1/hosted-zones/{hosted_zone_id}
Description
Update a hosted zone
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Id Example :
| string | None |
| body | body required |
| HostedZoneSetRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | HostedZoneSetResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Request body
{
"description": "",
"email": ""
}
Example HTTP response
Response 202
{
"action": "",
"attributes": "",
"created_at": "",
"description": "",
"email": "",
"hosted_zone_type": "",
"id": "",
"links": "",
"masters": [
""
],
"name": "",
"pool_id": "",
"project_id": "",
"serial": "",
"shared": "",
"status": "",
"transferred_at": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": ""
}
1.30.4 - 1.0
put /v1/hosted-zones/{hosted_zone_id}
Description
Update a hosted zone
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Id Example :
| string | None |
| body | body required |
| HostedZoneSetRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | HostedZoneSetResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Request body
{
"description": "",
"email": ""
}
Example HTTP response
Response 202
{
"action": "",
"attributes": "",
"created_at": "",
"description": "",
"email": "",
"hosted_zone_type": "",
"id": "",
"links": "",
"masters": [
""
],
"name": "",
"pool_id": "",
"project_id": "",
"serial": "",
"shared": "",
"status": "",
"transferred_at": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": ""
}
1.31 - Update Record
1.31.1 - 1.2
put /v1/hosted-zones/{hosted_zone_id}/records/{record_id}
Description
Update a recordset
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Zone ID Example :
| string | None |
| path | record_id required | Record ID Example :
| string | None |
| body | body required |
| RecordSetRequest | |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records/{record_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Request body
{
"records": "",
"ttl": ""
}
Example HTTP response
Response 202
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
1.31.2 - 1.1
put /v1/hosted-zones/{hosted_zone_id}/records/{record_id}
Description
Update a recordset
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Zone ID Example :
| string | None |
| path | record_id required | Record ID Example :
| string | None |
| body | body required |
| RecordSetRequest | |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records/{record_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Request body
{
"records": "",
"ttl": ""
}
Example HTTP response
Response 202
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
1.31.3 - 1.0
put /v1/hosted-zones/{hosted_zone_id}/records/{record_id}
Description
Update a recordset
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | hosted_zone_id required | Zone ID Example :
| string | None |
| path | record_id required | Record ID Example :
| string | None |
| body | body required |
| RecordSetRequest | |
Responses
Example HTTP request
Request path
/v1/hosted-zones/{hosted_zone_id}/records/{record_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Request body
{
"records": "",
"ttl": ""
}
Example HTTP response
Response 202
{
"action": "",
"created_at": "",
"description": "",
"id": "",
"links": "",
"name": "",
"project_id": "",
"records": [
""
],
"status": "",
"ttl": "",
"type": "",
"updated_at": "",
"version": "",
"zone_id": "",
"zone_name": ""
}
1.32 - Update WHOIS info for Public Domain
1.32.1 - 1.2
put /v1/public-domain-names/{public_domain_id}/information
Description
Update WHOIS information and sync with DB for a public domain
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/public-domain-names/{public_domain_id}/information
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"
Request body
{
"address_type": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_telno": ""
}
Example HTTP response
Response 200
{
"address_type": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"name": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_name_en": "",
"register_name_ko": "",
"register_telno": ""
}
1.32.2 - 1.1
put /v1/public-domain-names/{public_domain_id}/information
Description
Update WHOIS information and sync with DB for a public domain
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/public-domain-names/{public_domain_id}/information
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"
Request body
{
"address_type": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_telno": ""
}
Example HTTP response
Response 200
{
"address_type": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"name": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_name_en": "",
"register_name_ko": "",
"register_telno": ""
}
1.32.3 - 1.0
put /v1/public-domain-names/{public_domain_id}/information
Description
Update WHOIS information and sync with DB for a public domain
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/public-domain-names/{public_domain_id}/information
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"
Request body
{
"address_type": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_telno": ""
}
Example HTTP response
Response 200
{
"address_type": "",
"domestic_first_address_en": "",
"domestic_first_address_ko": "",
"domestic_second_address_en": "",
"domestic_second_address_ko": "",
"name": "",
"overseas_first_address": "",
"overseas_second_address": "",
"overseas_third_address": "",
"postal_code": "",
"register_email": "",
"register_name_en": "",
"register_name_ko": "",
"register_telno": ""
}
2 - Models
2.1 - CreatePublicDomainRequest
| Name | Description | Schema | Default |
|---|
address_type required | Address type Example :
| string | |
auto_extension optional | Auto extension flag Example : True
| any of [boolean, null] | True |
description optional | description Example :
| any of [string, null] | |
domestic_first_address_en required | Domestic first address (EN) Example :
| any of [string, null] | |
domestic_first_address_ko required | Domestic first address (KO) Example :
| any of [string, null] | |
domestic_second_address_en required | Domestic second address (EN) Example :
| any of [string, null] | |
domestic_second_address_ko required | Domestic second address (KO) Example : Maximum length : 16
| string | |
name required | name Example :
| string | |
overseas_first_address required | Overseas address - Address Example :
| any of [string, null] | |
overseas_second_address required | Overseas address - City Example :
| any of [string, null] | |
overseas_third_address required | Overseas address - State & Country Example :
| any of [string, null] | |
postal_code required | Postal code Example : Maximum length : 6
| string | |
register_email required | Register email Example :
| string | |
register_name_en required | Register Name Overseas Example : Maximum length : 30
| string | |
register_name_ko required | Register Name Domestic Example : Maximum length : 30
| string | |
register_telno required | Register telephone number Example :
| string | |
tags optional | Tag List
| array[Tag] | |
2.2 - CreatePublicDomainResponse
2.3 - HostedZone
| Name | Description | Schema | Default |
|---|
action required | current action in progress Example :
| string | |
attributes optional | Key:Value pairs of information about this zone Example :
| any of [object, null] | |
created_at optional | Created Date Example :
| any of [string, null] | |
description optional | description Example :
| any of [string, null] | |
email required | email Example :
| string | |
hosted_zone_type optional | Hosted Zone type Example :
| any of [string, null] | |
id required | Id Example :
| string | |
links optional | Links to resource Example :
| any of [object, null] | |
masters optional | The servers to slave from to get DNS information Example :
| any of [array[string], null] | |
name required | name Example :
| string | |
pool_id required | Designate Pool ID Example :
| string | |
project_id required | ProjectID Example :
| string | |
serial required | serial number Example :
| integer | |
shared optional | True if the zone is shared with another account Example :
| any of [boolean, null] | |
status required | The status Example :
| string | |
transferred_at optional | The last time an update was retrieved from the master servers Example :
| any of [string, null] | |
ttl optional | TTL for the zone. Example :
| any of [integer, null] | |
type optional | Type of zone Example :
| any of [string, null] | |
updated_at optional | Updated Date Example :
| any of [string, null] | |
version optional | Version Example :
| any of [integer, null] | |
2.4 - HostedZoneCreateRequest
| Name | Description | Schema | Default |
|---|
description optional | description Example :
| any of [string, null] | |
email required | email Example :
| string | |
name required | name Example :
| string | |
tags optional | Tag List
| array[Tag] | |
type optional | Type of zone Example : Pattern : ^(public|private)$
| any of [string, null] | |
2.5 - HostedZoneCreateRequestV1Dot2
| Name | Description | Schema | Default |
|---|
description optional | description Example :
| any of [string, null] | |
email required | email Example :
| string | |
name required | name Example :
| string | |
private_dns_id optional | Private DNS ID Example :
| any of [string, null] | |
tags optional | Tag List
| array[Tag] | |
type optional | Type of zone Example : Pattern : ^(public|private)$
| any of [string, null] | |
2.6 - HostedZoneCreateRequestV1Dot3
| Name | Description | Schema | Default |
|---|
description optional | description Example : This is description
| any of [string, null] | |
name required | name Example : my-zone.com
| string | |
private_dns_id optional | Private DNS ID Example :
| any of [string, null] | |
tags optional | Tag List
| array[Tag] | |
type required | Type of zone Example : public
| enum (public, private) | |
2.7 - HostedZoneCreateResponse
| Name | Description | Schema | Default |
|---|
action required | current action in progress Example :
| string | |
attributes optional | Key:Value pairs of information about this zone Example :
| any of [object, null] | |
created_at optional | Created Date Example :
| any of [string, null] | |
description optional | description Example :
| any of [string, null] | |
email required | email Example :
| string | |
hosted_zone_type optional | Hosted Zone type Example :
| any of [string, null] | |
id required | Id Example :
| string | |
links optional | Links to resource Example :
| any of [object, null] | |
masters optional | The servers to slave from to get DNS information Example :
| any of [array[string], null] | |
name required | name Example :
| string | |
pool_id required | Designate Pool ID Example :
| string | |
project_id required | ProjectID Example :
| string | |
serial required | serial number Example :
| integer | |
shared optional | True if the zone is shared with another account Example :
| any of [boolean, null] | |
status required | The status Example :
| string | |
transferred_at optional | The last time an update was retrieved from the master servers Example :
| any of [string, null] | |
ttl optional | TTL for the zone. Example :
| any of [integer, null] | |
type optional | Type of zone Example :
| any of [string, null] | |
updated_at optional | Updated Date Example :
| any of [string, null] | |
version optional | Version Example :
| any of [integer, null] | |
2.8 - HostedZoneDeleteResponse
| Name | Description | Schema | Default |
|---|
action required | current action in progress Example :
| string | |
attributes optional | Key:Value pairs of information about this zone Example :
| any of [object, null] | |
created_at optional | Created Date Example :
| any of [string, null] | |
description optional | description Example :
| any of [string, null] | |
email required | email Example :
| string | |
hosted_zone_type optional | Hosted Zone type Example :
| any of [string, null] | |
id required | Id Example :
| string | |
links optional | Links to resource Example :
| any of [object, null] | |
masters optional | The servers to slave from to get DNS information Example :
| any of [array[string], null] | |
name required | name Example :
| string | |
pool_id required | Designate Pool ID Example :
| string | |
project_id required | ProjectID Example :
| string | |
serial required | serial number Example :
| integer | |
shared optional | True if the zone is shared with another account Example :
| any of [boolean, null] | |
status required | The status Example :
| string | |
transferred_at optional | The last time an update was retrieved from the master servers Example :
| any of [string, null] | |
ttl optional | TTL for the zone. Example :
| any of [integer, null] | |
type optional | Type of zone Example :
| any of [string, null] | |
updated_at optional | Updated Date Example :
| any of [string, null] | |
version optional | Version Example :
| any of [integer, null] | |
2.9 - HostedZoneListResponse
| Name | Description | Schema | Default |
|---|
count optional | total count Example : 20
| any of [integer, null] | |
links optional | Links to resource Example :
| any of [object, null] | |
metadata optional | Total Count Example :
| any of [object, null] | |
zones required | Hosted Zone LIST
| array[HostedZone] | |
2.10 - HostedZoneListResponseV1Dot1
| Name | Description | Schema | Default |
|---|
count required | Count Example :
| integer | |
hosted_zones required | Hosted Zone LIST
| array[HostedZone] | |
links optional | links Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
| any of [array[object], null] | |
page required | Page Example :
| integer | |
size required | Size Example :
| integer | |
sort required | Sort Example :
| string | |
2.11 - HostedZoneListResponseV1Dot2
| Name | Description | Schema | Default |
|---|
count required | Count Example :
| integer | |
hosted_zones required | Hosted Zone LIST
| array[HostedZoneV1Dot2] | |
links optional | links Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
| any of [array[object], null] | |
page required | Page Example :
| integer | |
size required | Size Example :
| integer | |
sort required | Sort Example :
| string | |
2.12 - HostedZoneListResponseV1Dot3
| Name | Description | Schema | Default |
|---|
count required | count Example : 20
| integer | |
hosted_zones required | Hosted Zone LIST
| array[HostedZoneV1Dot3] | |
page required | page Example : 0
| integer | |
size required | size Example : 20
| integer | |
sort optional | sort Example : ['created_at:asc']
| any of [array[string], null] | |
2.13 - HostedZoneSetRequest
| Name | Description | Schema | Default |
|---|
description optional | description Example :
| any of [string, null] | |
email optional | email Example :
| any of [string, null] | |
2.14 - HostedZoneSetRequestV1Dot3
| Name | Description | Schema | Default |
|---|
description optional | description Example : This is description
| any of [string, null] | |
2.15 - HostedZoneSetResponse
| Name | Description | Schema | Default |
|---|
action required | current action in progress Example :
| string | |
attributes optional | Key:Value pairs of information about this zone Example :
| any of [object, null] | |
created_at optional | Created Date Example :
| any of [string, null] | |
description optional | description Example :
| any of [string, null] | |
email required | email Example :
| string | |
hosted_zone_type optional | Hosted Zone type Example :
| any of [string, null] | |
id required | Id Example :
| string | |
links optional | Links to resource Example :
| any of [object, null] | |
masters optional | The servers to slave from to get DNS information Example :
| any of [array[string], null] | |
name required | name Example :
| string | |
pool_id required | Designate Pool ID Example :
| string | |
project_id required | ProjectID Example :
| string | |
serial required | serial number Example :
| integer | |
shared optional | True if the zone is shared with another account Example :
| any of [boolean, null] | |
status required | The status Example :
| string | |
transferred_at optional | The last time an update was retrieved from the master servers Example :
| any of [string, null] | |
ttl optional | TTL for the zone. Example :
| any of [integer, null] | |
type optional | Type of zone Example :
| any of [string, null] | |
updated_at optional | Updated Date Example :
| any of [string, null] | |
version optional | Version Example :
| any of [integer, null] | |
2.16 - HostedZoneShowResponse
| Name | Description | Schema | Default |
|---|
action required | current action in progress Example :
| string | |
attributes optional | Key:Value pairs of information about this zone Example :
| any of [object, null] | |
created_at optional | Created Date Example :
| any of [string, null] | |
description optional | description Example :
| any of [string, null] | |
email required | email Example :
| string | |
hosted_zone_type optional | Hosted Zone type Example :
| any of [string, null] | |
id required | Id Example :
| string | |
links optional | Links to resource Example :
| any of [object, null] | |
masters optional | The servers to slave from to get DNS information Example :
| any of [array[string], null] | |
name required | name Example :
| string | |
pool_id required | Designate Pool ID Example :
| string | |
project_id required | ProjectID Example :
| string | |
serial required | serial number Example :
| integer | |
shared optional | True if the zone is shared with another account Example :
| any of [boolean, null] | |
status required | The status Example :
| string | |
transferred_at optional | The last time an update was retrieved from the master servers Example :
| any of [string, null] | |
ttl optional | TTL for the zone. Example :
| any of [integer, null] | |
type optional | Type of zone Example :
| any of [string, null] | |
updated_at optional | Updated Date Example :
| any of [string, null] | |
version optional | Version Example :
| any of [integer, null] | |
2.17 - HostedZoneShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|
action required | current action in progress Example :
| string | |
attributes optional | Key:Value pairs of information about this zone Example :
| any of [object, null] | |
created_at optional | Created Date Example :
| any of [string, null] | |
description optional | description Example :
| any of [string, null] | |
email required | email Example :
| string | |
hosted_zone_type optional | Hosted Zone type Example :
| any of [string, null] | |
id required | Id Example :
| string | |
links optional | Links to resource Example :
| any of [object, null] | |
masters optional | The servers to slave from to get DNS information Example :
| any of [array[string], null] | |
name required | name Example :
| string | |
pool_id required | Designate Pool ID Example :
| string | |
private_dns_id optional | Private DNS ID Example :
| any of [string, null] | |
private_dns_name optional | Private DNS Name Example :
| any of [string, null] | |
project_id required | ProjectID Example :
| string | |
serial required | serial number Example :
| integer | |
shared optional | True if the zone is shared with another account Example :
| any of [boolean, null] | |
status required | The status Example :
| string | |
transferred_at optional | The last time an update was retrieved from the master servers Example :
| any of [string, null] | |
ttl optional | TTL for the zone. Example :
| any of [integer, null] | |
type optional | Type of zone Example :
| any of [string, null] | |
updated_at optional | Updated Date Example :
| any of [string, null] | |
version optional | Version Example :
| any of [integer, null] | |
2.18 - HostedZoneShowResponseV1Dot3
| Name | Description | Schema | Default |
|---|
created_at required | Created At Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
description required | description Example : This is description
| any of [string, null] | |
hosted_zone_type optional | Hosted Zone type Example : public
| enum (public, private) | |
id required | Hosted Zone ID Example : 3432012nfdksdf03ktrld9234lgfg
| string | |
modified_at required | Modified At Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name required | Hosted Zone Name Example : my-zone.com
| string | |
pool_id required | Designate Pool ID Example : 10fjksdpooliddfsi12389esfdslkdsr32
| string | |
private_dns_id optional | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| any of [string, null] | |
private_dns_name optional | Private DNS Name Example : private-dns01
| any of [string, null] | |
status required | State Example : CREATING
| enum (CREATING, EDITING, ACTIVE, DELETING, DELETED, ERROR, PENDING, UNKNOWN) | |
ttl optional | TTL for the zone. Example : 3600
| any of [integer, null] | |
2.19 - HostedZoneV1Dot2
| Name | Description | Schema | Default |
|---|
action required | current action in progress Example :
| string | |
attributes optional | Key:Value pairs of information about this zone Example :
| any of [object, null] | |
created_at optional | Created Date Example :
| any of [string, null] | |
description optional | description Example :
| any of [string, null] | |
email required | email Example :
| string | |
hosted_zone_type optional | Hosted Zone type Example :
| any of [string, null] | |
id required | Id Example :
| string | |
links optional | Links to resource Example :
| any of [object, null] | |
masters optional | The servers to slave from to get DNS information Example :
| any of [array[string], null] | |
name required | name Example :
| string | |
pool_id required | Designate Pool ID Example :
| string | |
private_dns_id optional | Private DNS ID Example :
| any of [string, null] | |
private_dns_name optional | Private DNS Name Example :
| any of [string, null] | |
project_id required | ProjectID Example :
| string | |
serial required | serial number Example :
| integer | |
shared optional | True if the zone is shared with another account Example :
| any of [boolean, null] | |
status required | The status Example :
| string | |
transferred_at optional | The last time an update was retrieved from the master servers Example :
| any of [string, null] | |
ttl optional | TTL for the zone. Example :
| any of [integer, null] | |
type optional | Type of zone Example :
| any of [string, null] | |
updated_at optional | Updated Date Example :
| any of [string, null] | |
version optional | Version Example :
| any of [integer, null] | |
2.20 - HostedZoneV1Dot3
| Name | Description | Schema | Default |
|---|
created_at required | Created At Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
description required | description Example : This is description
| any of [string, null] | |
hosted_zone_type optional | Hosted Zone type Example : public
| enum (public, private) | |
id required | Hosted Zone ID Example : 3432012nfdksdf03ktrld9234lgfg
| string | |
modified_at required | Modified At Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name required | Hosted Zone Name Example : my-zone.com
| string | |
pool_id required | Designate Pool ID Example : 10fjksdpooliddfsi12389esfdslkdsr32
| string | |
private_dns_id optional | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| any of [string, null] | |
private_dns_name optional | Private DNS Name Example : private-dns01
| any of [string, null] | |
status required | State Example : CREATING
| enum (CREATING, EDITING, ACTIVE, DELETING, DELETED, ERROR, PENDING, UNKNOWN) | |
ttl optional | TTL for the zone. Example : 3600
| any of [integer, null] | |
2.21 - PrivateDns
| Name | Description | Schema | Default |
|---|
auth_dns_name required | Auth DNS Name Example :
| any of [string, null] | |
connected_vpc_ids optional | Connected VPC ID
| array[string] | |
created_at required | Created At Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
description required | description Example : This is description
| any of [string, null] | |
id required | Private DNS ID Example : 10fjkewefprivatedns3193rud543
| string | |
modified_at required | Modified At Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name required | Private DNS Name Example : private-dns01
| string | |
pool_id required | Designate Pool ID Example : 10fjksdpooliddfsi12389esfdslkdsr32
| any of [string, null] | |
pool_name required | Pool Name Example :
| any of [string, null] | |
registered_region required | Registered Region Example : KR-WEST1
| any of [string, null] | |
resolver_ip required | Private DNS Resolver IP Example : 198.19.0.101
| any of [string, null] | |
resolver_name required | Private DNS Resolver Name Example :
| any of [string, null] | |
state required | State Example : CREATING
| enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR) | |
2.22 - PrivateDnsActivateRequest
| Name | Description | Schema | Default |
|---|
name required | Private DNS Name Example : private-dns01 Pattern : ^[a-zA-Z0-9-]*$ Minimum length : 3 Maximum length : 20
| string | |
2.23 - PrivateDnsCreateRequest
| Name | Description | Schema | Default |
|---|
connected_vpc_ids optional | Connected VPC ID
| array[string] | |
description optional | description Example : This is description
| any of [string, null] | |
name required | Private DNS Name Example : private-dns01 Pattern : ^[a-zA-Z0-9-]*$ Minimum length : 3 Maximum length : 20
| string | |
tags optional |
| any of [array[Tag], null] | |
2.24 - PrivateDnsListResponse
| Name | Description | Schema | Default |
|---|
count required | count Example : 20
| integer | |
page required | page Example : 0
| integer | |
private_dns required |
| array[PrivateDns] | |
size required | size Example : 20
| integer | |
sort optional | sort Example : ['created_at:asc']
| any of [array[string], null] | |
2.25 - PrivateDnsSetRequest
| Name | Description | Schema | Default |
|---|
connected_vpc_ids optional | Connected VPC ID Example :
| any of [array[string], null] | |
description optional | description Example : This is description
| any of [string, null] | |
2.26 - PrivateDnsShowResponse
| Name | Description | Schema | Default |
|---|
private_dns required |
| PrivateDns | |
2.27 - PubblicDomainWhoisInfoUpdateRequest
| Name | Description | Schema | Default |
|---|
address_type required | Address type Example :
| string | |
domestic_first_address_en required | Domestic first address (EN) Example :
| string | |
domestic_first_address_ko required | Domestic first address (KO) Example :
| string | |
domestic_second_address_en required | Domestic second address (EN) Example :
| any of [string, null] | |
domestic_second_address_ko required | Domestic second address (KO) Example : Maximum length : 16
| string | |
overseas_first_address required | Overseas address - Address Example :
| any of [string, null] | |
overseas_second_address required | Overseas address - City Example :
| any of [string, null] | |
overseas_third_address required | Overseas address - State & Country Example :
| any of [string, null] | |
postal_code required | Postal code Example : Maximum length : 6
| string | |
register_email required | Register email Example :
| string | |
register_telno required | Register telephone number Example :
| string | |
2.28 - PublicDomainDetail
| Name | Description | Schema | Default |
|---|
address_type required | Address type Example :
| string | |
auto_extension required | Auto extension flag Example :
| boolean | |
created_at required | Created Date Example :
| string | |
created_by required | Created By_ Example :
| string | |
description optional | description Example :
| any of [string, null] | |
domestic_address_en required | Domestic Address (EN) Example :
| string | |
domestic_address_ko required | Domestic Address (KO) Example :
| string | |
domestic_first_address_en required | Domestic first address (EN) Example :
| string | |
domestic_first_address_ko required | Domestic first address (KO) Example :
| string | |
domestic_second_address_en required | Domestic second address (EN) Example :
| string | |
domestic_second_address_ko required | Domestic second address (KO) Example :
| string | |
expired_date required | Expired date Example :
| string | |
id required | ID Example :
| string | |
modified_at required | Modified Date Example :
| string | |
modified_by required | Modified By_ Example :
| string | |
name required | Public Domain Name Example :
| string | |
overseas_address optional | Overseas Address Example :
| string | |
overseas_first_address required | Overseas address - Address Example :
| string | |
overseas_second_address required | Overseas address - City Example :
| string | |
overseas_third_address required | Overseas address - State & Country Example :
| string | |
postal_code required | Postal code Example :
| string | |
register_email required | Register email Example :
| string | |
register_name_en required | Register Name Overseas Example :
| string | |
register_name_ko required | Register Name Domestic Example :
| string | |
register_telno required | Register telephone number Example :
| string | |
start_date required | Start date Example :
| string | |
status required | The status Example :
| string | |
2.29 - PublicDomainDetailResponse
2.30 - PublicDomainListItem
| Name | Description | Schema | Default |
|---|
created_at required | Start date Example :
| string | |
created_by required | Start date Example :
| string | |
expired_date required | Expired date Example :
| string | |
id required | Id Example :
| string | |
modified_at required | Start date Example :
| string | |
modified_by required | Start date Example :
| string | |
name required | name Example :
| string | |
register_email required | Register email Example :
| string | |
start_date required | Start date Example :
| string | |
status required | The status Example :
| string | |
2.31 - PublicDomainListResponse
| Name | Description | Schema | Default |
|---|
count required | count Example : 20
| integer | |
page required | page Example : 0
| integer | |
public_domain_names required |
| array[PublicDomainListItem] | |
size required | size Example : 20
| integer | |
sort optional | sort Example : ['created_at:asc']
| any of [array[string], null] | |
2.32 - PublicDomainPartialUpdateRequest
| Name | Description | Schema | Default |
|---|
auto_extension optional | Auto extension flag Example :
| any of [boolean, null] | |
description optional | description Example :
| any of [string, null] | |
2.33 - PublicDomainPartialUpdateResponse
| Name | Description | Schema | Default |
|---|
auto_extension optional | Auto extension flag Example :
| any of [boolean, null] | |
description optional | description Example :
| any of [string, null] | |
id required | Id Example :
| string | |
2.34 - PublicDomainTransferRequest
| Name | Description | Schema | Default |
|---|
target_account_id optional | Target account id (required when type=REQUEST) Example :
| any of [string, null] | |
type required | Transfer operation type Example : REQUEST
| enum (REQUEST, CANCEL, APPROVE, REJECT) | |
2.35 - PublicDomainTransferResponse
| Name | Description | Schema | Default |
|---|
auto_extension required | Auto extension flag Example :
| boolean | |
created_at required | Created At Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
description required | description Example :
| any of [string, null] | |
expired_date required | Expired date Example : 2026-02-11T06:41:41.289Z
| string (date-time) | |
id required | ID Example :
| string | |
modified_at required | Modified At Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name required | Public Domain Name Example :
| string | |
start_date required | Start date Example : 2026-02-11T06:41:41.289Z
| string (date-time) | |
state required | State Example : ACTIVE
| enum (ACTIVE, CREATING, REGISTERED, EXPIRED, DELETED, TRANSFER_REQUESTING, TRANSFER_REQUESTED, DELETING) | |
2.36 - PublicDomainWhoisInfoUpdateResponse
| Name | Description | Schema | Default |
|---|
address_type required | Address type Example :
| string | |
domestic_first_address_en required | Domestic first address (EN) Example :
| string | |
domestic_first_address_ko required | Domestic first address (KO) Example :
| string | |
domestic_second_address_en required | Domestic second address (EN) Example :
| any of [string, null] | |
domestic_second_address_ko required | Domestic second address (KO) Example : Maximum length : 16
| string | |
name required | name Example :
| string | |
overseas_first_address required | Overseas address - Address Example :
| any of [string, null] | |
overseas_second_address required | Overseas address - City Example :
| any of [string, null] | |
overseas_third_address required | Overseas address - State & Country Example :
| any of [string, null] | |
postal_code required | Postal code Example : Maximum length : 6
| string | |
register_email required | Register email Example :
| string | |
register_name_en required | Register Name Overseas Example :
| string | |
register_name_ko required | Register Name Domestic Example :
| string | |
register_telno required | Register telephone number Example :
| string | |
2.37 - Record
| Name | Description | Schema | Default |
|---|
action optional | current action in progress Example :
| any of [string, null] | |
created_at optional | Created Date Example :
| any of [string, null] | |
description optional | description Example :
| any of [string, null] | |
id optional | Id Example :
| any of [string, null] | |
links optional | Links to resource Example :
| any of [object, null] | |
name optional | name Example :
| any of [string, null] | |
project_id optional | ProjectID Example :
| any of [string, null] | |
records optional | A list of data for this record Example :
| any of [array[string], null] | |
status optional | The status Example :
| any of [string, null] | |
ttl optional | TTL for the zone. Example :
| any of [integer, null] | |
type optional | Type of the record Example :
| any of [string, null] | |
updated_at optional | Updated Date Example :
| any of [string, null] | |
version optional | Version Example :
| any of [integer, null] | |
zone_id optional | ID for the zone that contains this record Example :
| any of [string, null] | |
zone_name optional | The name of the zone that contains this record Example :
| any of [string, null] | |
2.38 - RecordCreateRequest
| Name | Description | Schema | Default |
|---|
description optional | description Example :
| any of [string, null] | |
name required | name Example :
| string | |
records required | A list of data for this record
| array[object] | |
ttl optional | TTL for the zone. Example :
| any of [integer, null] | |
type required | Type of the record Example :
| string | |
2.39 - RecordCreateRequestV1Dot0To1Dot2
| Name | Description | Schema | Default |
|---|
description optional | description Example :
| any of [string, null] | |
name required | name Example :
| string | |
records required | A list of data for this record
| array[object] | |
ttl optional | TTL for the zone. Example :
| any of [integer, null] | |
type required | Type of the record Example :
| string | |
2.40 - RecordCreateResponse
| Name | Description | Schema | Default |
|---|
action optional | current action in progress Example :
| any of [string, null] | |
created_at optional | Created Date Example :
| any of [string, null] | |
description optional | description Example :
| any of [string, null] | |
id optional | Id Example :
| any of [string, null] | |
links optional | Links to resource Example :
| any of [object, null] | |
name optional | name Example :
| any of [string, null] | |
project_id optional | ProjectID Example :
| any of [string, null] | |
records optional | records for the record Example :
| any of [array[string], null] | |
status optional | The status Example :
| any of [string, null] | |
ttl optional | TTL for the zone. Example :
| any of [integer, null] | |
type optional | Type of the record Example :
| any of [string, null] | |
updated_at optional | Updated Date Example :
| any of [string, null] | |
version optional | Version Example :
| any of [integer, null] | |
zone_id optional | ID for the zone that contains this record Example :
| any of [string, null] | |
zone_name optional | The name of the zone that contains this record Example :
| any of [string, null] | |
2.41 - RecordListResponse
| Name | Description | Schema | Default |
|---|
count optional | total count Example : 20
| any of [integer, null] | |
links optional | Links to resource Example :
| any of [object, null] | |
metadata optional | the total count Example :
| any of [object, null] | |
records required | record list
| array[Record] | |
2.42 - RecordSetRequest
| Name | Description | Schema | Default |
|---|
records optional | A list of data for this record Example :
| any of [array[object], null] | |
ttl optional | TTL for the record Example :
| any of [integer, null] | |
2.43 - RecordSetResponse
| Name | Description | Schema | Default |
|---|
action optional | current action in progress Example :
| any of [string, null] | |
created_at optional | Created Date Example :
| any of [string, null] | |
description optional | description Example :
| any of [string, null] | |
id optional | Id Example :
| any of [string, null] | |
links optional | Links to resource Example :
| any of [object, null] | |
name optional | name Example :
| any of [string, null] | |
project_id optional | ProjectID Example :
| any of [string, null] | |
records optional | records for the record Example :
| any of [array[string], null] | |
status optional | The status Example :
| any of [string, null] | |
ttl optional | TTL for the zone. Example :
| any of [integer, null] | |
type optional | Type of the record Example :
| any of [string, null] | |
updated_at optional | Updated Date Example :
| any of [string, null] | |
version optional | Version Example :
| any of [integer, null] | |
zone_id optional | ID for the zone that contains this record Example :
| any of [string, null] | |
zone_name optional | The name of the zone that contains this record Example :
| any of [string, null] | |
2.44 - RecordShowResponse
| Name | Description | Schema | Default |
|---|
action optional | current action in progress Example :
| any of [string, null] | |
created_at optional | Created Date Example :
| any of [string, null] | |
description optional | description Example :
| any of [string, null] | |
id optional | Id Example :
| any of [string, null] | |
links optional | Links to resource Example :
| any of [object, null] | |
name optional | name Example :
| any of [string, null] | |
project_id optional | ProjectID Example :
| any of [string, null] | |
records optional | records for the record. Example :
| any of [array[string], null] | |
status optional | The status Example :
| any of [string, null] | |
ttl optional | TTL for the zone. Example :
| any of [integer, null] | |
type optional | Type of the record Example :
| any of [string, null] | |
updated_at optional | Updated Date Example :
| any of [string, null] | |
version optional | Version Example :
| any of [integer, null] | |
zone_id optional | ID for the zone that contains this record Example :
| any of [string, null] | |
zone_name optional | The name of the zone that contains this record Example :
| any of [string, null] | |
2.45 - Tag
| Name | Description | Schema | Default |
|---|
key required | tag key Example :
| string | |
value required | tag value Example :
| string | |