This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

DNS

1: APIs

1.1: Activate Private DNS

1.1.1: 1.3

1.2: Create Hosted Zone

1.2.1: 1.3

1.3: Create Hosted Zone Record

1.3.1: 1.3

1.4: Create Private DNS

1.4.1: 1.3

1.5: Create Public Domain Name

1.5.1: 1.3

1.6: Delete Hosted Zone

1.6.1: 1.3

1.7: Delete Hosted Zone Record

1.7.1: 1.3

1.8: Delete Private DNS

1.8.1: 1.3

1.9: List Hosted Zone Records

1.9.1: 1.3

1.10: List Hosted Zones

1.10.1: 1.3

1.11: List Private DNS

1.11.1: 1.3

1.12: List Public Domain Names

1.12.1: 1.3

1.13: Set Hosted Zone

1.13.1: 1.3

1.14: Set Hosted Zone Record

1.14.1: 1.3

1.15: Set Private DNS

1.15.1: 1.3

1.16: Set Public Domain Name

1.16.1: 1.3

1.17: Set Public Domain Name Whois Info

1.17.1: 1.3

1.18: Show Hosted Zone

1.18.1: 1.3

1.19: Show Hosted Zone Record

1.19.1: 1.3

1.20: Show Private DNS

1.20.1: 1.3

1.21: Show Public Domain Name

1.21.1: 1.3

1.22: Transfer Public Domain Name

1.22.1: 1.3

2: Models

2.1: CreatePublicDomainRequest
2.2: CreatePublicDomainResponse
2.3: HostedZoneCreateRequestV1Dot3
2.4: HostedZoneListResponseV1Dot3
2.5: HostedZoneSetRequestV1Dot3
2.6: HostedZoneShowResponseV1Dot3
2.7: HostedZoneV1Dot3
2.8: PrivateDns
2.9: PrivateDnsActivateRequest
2.10: PrivateDnsCreateRequest
2.11: PrivateDnsListResponse
2.12: PrivateDnsSetRequest
2.13: PrivateDnsShowResponse
2.14: PubblicDomainWhoisInfoUpdateRequest
2.15: PublicDomainDetail
2.16: PublicDomainDetailResponse
2.17: PublicDomainListItem
2.18: PublicDomainListResponse
2.19: PublicDomainPartialUpdateRequest
2.20: PublicDomainPartialUpdateResponse
2.21: PublicDomainTransferRequest
2.22: PublicDomainTransferResponse
2.23: PublicDomainWhoisInfoUpdateResponse
2.24: Record
2.25: RecordCreateRequest
2.26: RecordCreateResponse
2.27: RecordListResponse
2.28: RecordSetRequest
2.29: RecordSetResponse
2.30: RecordShowResponse
2.31: Tag

Overview

Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of DNS service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Status	Not Before
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

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateDnsActivateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateDnsShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-dns/activate

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"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.2 - Create Hosted Zone

1.2.1 - 1.3

post /v1/hosted-zones

Description

Create a new hosted zone.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		HostedZoneCreateRequestV1Dot3

Responses

HTTP Code	Description	Schema
202	Accepted	HostedZoneShowResponseV1Dot3
400	Bad Request	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"

Request body

{
    "description": "This is description",
    "name": "my-zone.com",
    "private_dns_id": "10fjkewefprivatedns3193rud543",
    "tags": [],
    "type": "private"
}

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.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

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
body	body required		RecordCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	RecordCreateResponse
400	Bad Request	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"

Request body

{
    "description": "This is description",
    "name": "test.app",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "ttl": 3600,
    "type": "A"
}

Example HTTP response

Response 202

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

1.4 - Create Private DNS

1.4.1 - 1.3

post /v1/private-dns

Description

Create Private DNS

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateDnsCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateDnsShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-dns

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"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.5 - Create Public Domain Name

1.5.1 - 1.3

post /v1/public-domain-names

Description

Create a new Public Domain Name

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		CreatePublicDomainRequest

Responses

HTTP Code	Description	Schema
201	Created	CreatePublicDomainResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/public-domain-names

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"

Request body

{
    "address_type": "DOMESTIC",
    "auto_extension": true,
    "description": "This is description",
    "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
    "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
    "domestic_second_address_en": "West Campus 1F",
    "domestic_second_address_ko": "서관 1층",
    "name": "example.com",
    "overseas_first_address": "123 Main St",
    "overseas_second_address": "New York",
    "overseas_third_address": "NY 10001",
    "postal_code": "12345",
    "register_email": "admin@example.com",
    "register_name_en": "Hong Gildong",
    "register_name_ko": "홍길동",
    "register_telno": "010-1234-5678",
    "tags": []
}

Example HTTP response

Response 201

{
    "public_domain_name": {
        "address_type": "DOMESTIC",
        "auto_extension": true,
        "created_at": "2025-09-08T03:43:57Z",
        "created_by": "504f24f8111e42e0578f367acd2a149f",
        "description": "This is description",
        "domestic_address_en": "West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층",
        "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
        "domestic_second_address_en": "West Campus 1F",
        "domestic_second_address_ko": "서관 1층",
        "expired_date": "2026-09-09T00:00:00Z",
        "id": "10fjkeweffpublicdomain3193rud543",
        "modified_at": "2026-02-09T08:00:40Z",
        "modified_by": "504f24f8111e42e0578f367acd2a149f",
        "name": "example.com",
        "overseas_address": "123 Main St, New York, NY 10001",
        "overseas_first_address": "123 Main St",
        "overseas_second_address": "New York",
        "overseas_third_address": "NY 10001",
        "postal_code": "12345",
        "register_email": "admin@example.com",
        "register_name_en": "Hong Gildong",
        "register_name_ko": "홍길동",
        "register_telno": "010-1234-5678",
        "start_date": "2025-09-09T00:00:00Z",
        "status": "REGISTERED"
    }
}

1.6 - Delete Hosted Zone

1.6.1 - 1.3

delete /v1/hosted-zones/{hosted_zone_id}

Description

Delete a hosted zone

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"

Example HTTP response

Response 202

1.7 - Delete Hosted Zone Record

1.7.1 - 1.3

delete /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Delete hosted zone record

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Hosted Zone ID Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
path	record_id required	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	RecordCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"

Example HTTP response

Response 202

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

1.8 - Delete Private DNS

1.8.1 - 1.3

delete /v1/private-dns/{private_dns_id}

Description

Delete Private DNS

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"

Example HTTP response

Response 202

1.9 - List Hosted Zone Records

1.9.1 - 1.3

get /v1/hosted-zones/{hosted_zone_id}/records

Description

Get record list in a hosted zone

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	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 : `test.app`	any of [string, null]	None
query	exact_name optional	name Example : `test.app`	any of [string, null]	None
query	type optional	Type of the record Example : `A`	any of [string, null]	None
query	data optional	Record data Example : `12345.ns.private.kr-west1.dev2.samsungsdscloud.com`	any of [string, null]	None
query	status optional	The status Example : `ACTIVE`	any of [string, null]	None
query	description optional	description Example : `This is description`	any of [string, null]	None
query	ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	RecordListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"

Example HTTP response

Response 200

{
    "count": 20,
    "links": "",
    "metadata": "",
    "records": [
        {
            "action": "CREATE",
            "created_at": "2025-09-08T03:43:57Z",
            "description": "This is description",
            "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
            "links": "",
            "name": "test.app",
            "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
            "records": [
                "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
            ],
            "status": "ACTIVE",
            "ttl": 3600,
            "type": "A",
            "updated_at": "2026-02-09T08:00:40Z",
            "version": 1,
            "zone_id": "3432012nfdksdf03ktrld9234lgfg",
            "zone_name": "my-zone.com"
        }
    ]
}

1.10 - List Hosted Zones

1.10.1 - 1.3

get /v1/hosted-zones

Description

Return list of hosted zones

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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

HTTP Code	Description	Schema
200	OK	HostedZoneListResponseV1Dot3
403	Forbidden	None

Example HTTP request

Request path

/v1/hosted-zones

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"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.11 - List Private DNS

1.11.1 - 1.3

get /v1/private-dns

Description

List all Private DNS

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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, PENDING), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateDnsListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-dns

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"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.12 - List Public Domain Names

1.12.1 - 1.3

get /v1/public-domain-names

Description

Return list of Public Domain Names

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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	Public Domain Name Example : `example.com`	any of [string, null]	None
query	created_by optional	Created By_ Example : `504f24f8111e42e0578f367acd2a149f`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/public-domain-names

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "public_domain_names": [
        {
            "created_at": "2025-09-08T03:43:57Z",
            "created_by": "504f24f8111e42e0578f367acd2a149f",
            "expired_date": "2026-09-09T00:00:00Z",
            "id": "10fjkeweffpublicdomain3193rud543",
            "modified_at": "2026-02-09T08:00:40Z",
            "modified_by": "504f24f8111e42e0578f367acd2a149f",
            "name": "example.com",
            "register_email": "admin@example.com",
            "start_date": "2025-09-09T00:00:00Z",
            "status": "REGISTERED"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.13 - Set Hosted Zone

1.13.1 - 1.3

put /v1/hosted-zones/{hosted_zone_id}

Description

Update Hosted Zone

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
body	body required		HostedZoneSetRequestV1Dot3

Responses

HTTP Code	Description	Schema
202	Accepted	HostedZoneShowResponseV1Dot3
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"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.14 - Set Hosted Zone Record

1.14.1 - 1.3

put /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Update Hosted Zone record

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Hosted Zone ID Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
path	record_id required	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	string	None
body	body required		RecordSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	RecordSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"

Request body

{
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "ttl": 3600
}

Example HTTP response

Response 202

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

1.15 - Set Private DNS

1.15.1 - 1.3

put /v1/private-dns/{private_dns_id}

Description

Update Private DNS

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None
body	body required		PrivateDnsSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateDnsShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-dns/{private_dns_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"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.16 - Set Public Domain Name

1.16.1 - 1.3

put /v1/public-domain-names/{public_domain_id}

Description

Update Public Domain Name

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string	None
body	body required		PublicDomainPartialUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainPartialUpdateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"

Request body

{
    "auto_extension": true,
    "description": "This is description"
}

Example HTTP response

Response 200

{
    "auto_extension": true,
    "description": "This is description",
    "id": "10fjkeweffpublicdomain3193rud543"
}

1.17 - Set Public Domain Name Whois Info

1.17.1 - 1.3

put /v1/public-domain-names/{public_domain_id}/information

Description

Update Public Domain Name Whois Info

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string	None
body	body required		PubblicDomainWhoisInfoUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainWhoisInfoUpdateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_id}/information

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"

Request body

{
    "address_type": "DOMESTIC",
    "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
    "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
    "domestic_second_address_en": "West Campus 1F",
    "domestic_second_address_ko": "서관 1층",
    "overseas_first_address": "123 Main St",
    "overseas_second_address": "New York",
    "overseas_third_address": "NY 10001",
    "postal_code": "12345",
    "register_email": "admin@example.com",
    "register_telno": "010-1234-5678"
}

Example HTTP response

Response 200

{
    "address_type": "DOMESTIC",
    "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
    "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
    "domestic_second_address_en": "West Campus 1F",
    "domestic_second_address_ko": "서관 1층",
    "name": "example.com",
    "overseas_first_address": "123 Main St",
    "overseas_second_address": "New York",
    "overseas_third_address": "NY 10001",
    "postal_code": "12345",
    "register_email": "admin@example.com",
    "register_name_en": "Hong Gildong",
    "register_name_ko": "홍길동",
    "register_telno": "010-1234-5678"
}

1.18 - Show Hosted Zone

1.18.1 - 1.3

get /v1/hosted-zones/{hosted_zone_id}

Description

Return details of a hosted zone.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string	None

Responses

HTTP Code	Description	Schema
200	OK	HostedZoneShowResponseV1Dot3
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"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.19 - Show Hosted Zone Record

1.19.1 - 1.3

get /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Get details of a hosted zone record

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Hosted Zone ID Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
path	record_id required	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	string	None

Responses

HTTP Code	Description	Schema
200	OK	RecordShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"

Example HTTP response

Response 200

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

1.20 - Show Private DNS

1.20.1 - 1.3

get /v1/private-dns/{private_dns_id}

Description

Show Private DNS

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateDnsShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-dns/{private_dns_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"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.21 - Show Public Domain Name

1.21.1 - 1.3

get /v1/public-domain-names/{public_domain_id}

Description

Return details of a public domain name

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string	None

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainDetailResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"

Example HTTP response

Response 200

{
    "public_domain_name": {
        "address_type": "DOMESTIC",
        "auto_extension": true,
        "created_at": "2025-09-08T03:43:57Z",
        "created_by": "504f24f8111e42e0578f367acd2a149f",
        "description": "This is description",
        "domestic_address_en": "West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층",
        "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
        "domestic_second_address_en": "West Campus 1F",
        "domestic_second_address_ko": "서관 1층",
        "expired_date": "2026-09-09T00:00:00Z",
        "id": "10fjkeweffpublicdomain3193rud543",
        "modified_at": "2026-02-09T08:00:40Z",
        "modified_by": "504f24f8111e42e0578f367acd2a149f",
        "name": "example.com",
        "overseas_address": "123 Main St, New York, NY 10001",
        "overseas_first_address": "123 Main St",
        "overseas_second_address": "New York",
        "overseas_third_address": "NY 10001",
        "postal_code": "12345",
        "register_email": "admin@example.com",
        "register_name_en": "Hong Gildong",
        "register_name_ko": "홍길동",
        "register_telno": "010-1234-5678",
        "start_date": "2025-09-09T00:00:00Z",
        "status": "REGISTERED"
    }
}

1.22 - Transfer Public Domain Name

1.22.1 - 1.3

post /v1/public-domain-names/{public_domain_id}/transfer

Description

Transfer Public Domain Name

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string	None
body	body required		PublicDomainTransferRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainTransferResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_id}/transfer

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"

Request body

{
    "target_account_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "type": "REQUEST"
}

Example HTTP response

Response 200

{
    "auto_extension": true,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "description": "This is description",
    "expired_date": "2026-09-09T00:00:00Z",
    "id": "10fjkeweffpublicdomain3193rud543",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "example.com",
    "start_date": "2025-09-09T00:00:00Z",
    "state": "TRANSFER_REQUESTED"
}

2 - Models

2.1 - CreatePublicDomainRequest

Name	Description	Schema	Default
address_type required	Address type Example : `DOMESTIC`	string
auto_extension optional	Auto extension flag Example : `True`	any of [boolean, null]	True
description optional	description Example : `This is description`	any of [string, null]
domestic_first_address_en required	Domestic first address (EN) Example : `125 Olympic-ro 35-gil, Songpa-gu, Seoul`	any of [string, null]
domestic_first_address_ko required	Domestic first address (KO) Example : `서울특별시 송파구 올림픽로35길 125 (신천동)`	any of [string, null]
domestic_second_address_en required	Domestic second address (EN) Example : `West Campus 1F`	any of [string, null]
domestic_second_address_ko required	Domestic second address (KO) Example : `서관 1층` Maximum length : `16`	string
name required	Public Domain Name Example : `example.com`	string
overseas_first_address required	Overseas address - Address Example : `123 Main St`	any of [string, null]
overseas_second_address required	Overseas address - City Example : `New York`	any of [string, null]
overseas_third_address required	Overseas address - State & Country Example : `NY 10001`	any of [string, null]
postal_code required	Postal code Example : `12345` Maximum length : `6`	string
register_email required	Register email Example : `admin@example.com`	string
register_name_en required	Register Name Overseas Example : `Hong Gildong` Maximum length : `30`	string
register_name_ko required	Register Name Domestic Example : `홍길동` Maximum length : `30`	string
register_telno required	Register telephone number Example : `010-1234-5678`	string
tags optional	Tag List	array[Tag]

2.2 - CreatePublicDomainResponse

Name	Description	Schema	Default
public_domain_name required		PublicDomainDetail

2.3 - HostedZoneCreateRequestV1Dot3

Name	Description	Schema
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 : `10fjkewefprivatedns3193rud543`	any of [string, null]
tags optional	Tag List	array[Tag]
type required	Type of zone Example : `private`	enum (public, private)

2.4 - HostedZoneListResponseV1Dot3

Name	Description	Schema
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.5 - HostedZoneSetRequestV1Dot3

Name	Description	Schema	Default
description optional	description Example : `This is description`	any of [string, null]

2.6 - HostedZoneShowResponseV1Dot3

Name	Description	Schema
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.7 - HostedZoneV1Dot3

Name	Description	Schema
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.8 - PrivateDns

Name	Description	Schema
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, PENDING)

2.9 - 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.10 - PrivateDnsCreateRequest

Name	Description	Schema
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.11 - PrivateDnsListResponse

Name	Description	Schema
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.12 - 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.13 - PrivateDnsShowResponse

Name	Description	Schema	Default
private_dns required		PrivateDns

2.14 - PubblicDomainWhoisInfoUpdateRequest

Name	Description	Schema
address_type required	Address type Example : `DOMESTIC`	string
domestic_first_address_en required	Domestic first address (EN) Example : `125 Olympic-ro 35-gil, Songpa-gu, Seoul`	string
domestic_first_address_ko required	Domestic first address (KO) Example : `서울특별시 송파구 올림픽로35길 125 (신천동)`	string
domestic_second_address_en required	Domestic second address (EN) Example : `West Campus 1F`	any of [string, null]
domestic_second_address_ko required	Domestic second address (KO) Example : `서관 1층` Maximum length : `16`	string
overseas_first_address required	Overseas address - Address Example : `123 Main St`	any of [string, null]
overseas_second_address required	Overseas address - City Example : `New York`	any of [string, null]
overseas_third_address required	Overseas address - State & Country Example : `NY 10001`	any of [string, null]
postal_code required	Postal code Example : `12345` Maximum length : `6`	string
register_email required	Register email Example : `admin@example.com`	string
register_telno required	Register telephone number Example : `010-1234-5678`	string

2.15 - PublicDomainDetail

Name	Description	Schema
address_type required	Address type Example : `DOMESTIC`	string
auto_extension required	Auto extension flag Example : `True`	boolean
created_at required	Created Date Example : `2025-09-08T03:43:57Z`	string
created_by required	Created By_ Example : `504f24f8111e42e0578f367acd2a149f`	string
description optional	description Example : `This is description`	any of [string, null]
domestic_address_en required	Domestic Address (EN) Example : `West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul`	string
domestic_address_ko required	Domestic Address (KO) Example : `서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층`	string
domestic_first_address_en required	Domestic first address (EN) Example : `125 Olympic-ro 35-gil, Songpa-gu, Seoul`	string
domestic_first_address_ko required	Domestic first address (KO) Example : `서울특별시 송파구 올림픽로35길 125 (신천동)`	string
domestic_second_address_en required	Domestic second address (EN) Example : `West Campus 1F`	string
domestic_second_address_ko required	Domestic second address (KO) Example : `서관 1층`	string
expired_date required	Expired date Example : `2026-09-09T00:00:00Z`	string
id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string
modified_at required	Modified Date Example : `2026-02-09T08:00:40Z`	string
modified_by required	Modified By_ Example : `504f24f8111e42e0578f367acd2a149f`	string
name required	Public Domain Name Example : `example.com`	string
overseas_address optional	Overseas Address Example : `123 Main St, New York, NY 10001`	string
overseas_first_address required	Overseas address - Address Example : `123 Main St`	string
overseas_second_address required	Overseas address - City Example : `New York`	string
overseas_third_address required	Overseas address - State & Country Example : `NY 10001`	string
postal_code required	Postal code Example : `12345`	string
register_email required	Register email Example : `admin@example.com`	string
register_name_en required	Register Name Overseas Example : `Hong Gildong`	string
register_name_ko required	Register Name Domestic Example : `홍길동`	string
register_telno required	Register telephone number Example : `010-1234-5678`	string
start_date required	Start date Example : `2025-09-09T00:00:00Z`	string
status required	The status Example : `REGISTERED`	string

2.16 - PublicDomainDetailResponse

Name	Description	Schema	Default
public_domain_name required		PublicDomainDetail

2.17 - PublicDomainListItem

Name	Description	Schema
created_at required	Created Date Example : `2025-09-08T03:43:57Z`	string
created_by required	Start date Example : `504f24f8111e42e0578f367acd2a149f`	string
expired_date required	Expired date Example : `2026-09-09T00:00:00Z`	string
id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string
modified_at required	Modified Date Example : `2026-02-09T08:00:40Z`	string
modified_by required	Modified By_ Example : `504f24f8111e42e0578f367acd2a149f`	string
name required	Public Domain Name Example : `example.com`	string
register_email required	Register email Example : `admin@example.com`	string
start_date required	Start date Example : `2025-09-09T00:00:00Z`	string
status required	The status Example : `REGISTERED`	string

2.18 - PublicDomainListResponse

Name	Description	Schema
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.19 - PublicDomainPartialUpdateRequest

Name	Description	Schema	Default
auto_extension optional	Auto extension flag Example : `True`	any of [boolean, null]
description optional	description Example : `This is description`	any of [string, null]

2.20 - PublicDomainPartialUpdateResponse

Name	Description	Schema
auto_extension optional	Auto extension flag Example : `True`	any of [boolean, null]
description optional	description Example : `This is description`	any of [string, null]
id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string

2.21 - PublicDomainTransferRequest

Name	Description	Schema	Default
target_account_id optional	Target account id (required when type=REQUEST) Example : `003dffc50eb123a1cbf4f2e5c71d4f15`	any of [string, null]
type required	Transfer operation type Example : `REQUEST`	enum (REQUEST, CANCEL, APPROVE, REJECT)

2.22 - PublicDomainTransferResponse

Name	Description	Schema
auto_extension required	Auto extension flag Example : `True`	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 : `This is description`	any of [string, null]
expired_date required	Expired date Example : `2026-09-09T00:00:00Z`	string (date-time)
id required	ID Example : `10fjkeweffpublicdomain3193rud543`	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 : `example.com`	string
start_date required	Start date Example : `2025-09-09T00:00:00Z`	string (date-time)
state required	State Example : `TRANSFER_REQUESTED`	enum (CREATING, REGISTERED, EXPIRED, DELETED, TRANSFER_REQUESTING, TRANSFER_REQUESTED, DELETING)

2.23 - PublicDomainWhoisInfoUpdateResponse

Name	Description	Schema
address_type required	Address type Example : `DOMESTIC`	string
domestic_first_address_en required	Domestic first address (EN) Example : `125 Olympic-ro 35-gil, Songpa-gu, Seoul`	string
domestic_first_address_ko required	Domestic first address (KO) Example : `서울특별시 송파구 올림픽로35길 125 (신천동)`	string
domestic_second_address_en required	Domestic second address (EN) Example : `West Campus 1F`	any of [string, null]
domestic_second_address_ko required	Domestic second address (KO) Example : `서관 1층` Maximum length : `16`	string
name required	Public Domain Name Example : `example.com`	string
overseas_first_address required	Overseas address - Address Example : `123 Main St`	any of [string, null]
overseas_second_address required	Overseas address - City Example : `New York`	any of [string, null]
overseas_third_address required	Overseas address - State & Country Example : `NY 10001`	any of [string, null]
postal_code required	Postal code Example : `12345` Maximum length : `6`	string
register_email required	Register email Example : `admin@example.com`	string
register_name_en required	Register Name Overseas Example : `Hong Gildong`	string
register_name_ko required	Register Name Domestic Example : `홍길동`	string
register_telno required	Register telephone number Example : `010-1234-5678`	string

2.24 - Record

Name	Description	Schema
action optional	current action in progress Example : `CREATE`	any of [string, null]
created_at optional	Created Date Example : `2025-09-08T03:43:57Z`	any of [string, null]
description optional	description Example : `This is description`	any of [string, null]
id optional	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	any of [string, null]
links optional	Links to resource Example :	any of [object, null]
name optional	name Example : `test.app`	any of [string, null]
project_id optional	ProjectID Example : `003dffc50eb123a1cbf4f2e5c71d4f15`	any of [string, null]
records optional	A list of data for this record Example : `['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']`	any of [array[string], null]
status optional	The status Example : `ACTIVE`	any of [string, null]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]
type optional	Type of the record Example : `A`	any of [string, null]
updated_at optional	Updated Date Example : `2026-02-09T08:00:40Z`	any of [string, null]
version optional	Version Example : `1`	any of [integer, null]
zone_id optional	ID for the zone that contains this record Example : `3432012nfdksdf03ktrld9234lgfg`	any of [string, null]
zone_name optional	The name of the zone that contains this record Example : `my-zone.com`	any of [string, null]

2.25 - RecordCreateRequest

Name	Description	Schema
description optional	description Example : `This is description`	any of [string, null]
name required	name Example : `test.app`	string
records required	A list of data for this record Example : `['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']`	array[object]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]
type required	Type of the record Example : `A`	string

2.26 - RecordCreateResponse

Name	Description	Schema
action optional	current action in progress Example : `CREATE`	any of [string, null]
created_at optional	Created Date Example : `2025-09-08T03:43:57Z`	any of [string, null]
description optional	description Example : `This is description`	any of [string, null]
id optional	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	any of [string, null]
links optional	Links to resource Example :	any of [object, null]
name optional	name Example : `test.app`	any of [string, null]
project_id optional	ProjectID Example : `003dffc50eb123a1cbf4f2e5c71d4f15`	any of [string, null]
records optional	A list of data for this record Example : `['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']`	any of [array[string], null]
status optional	The status Example : `ACTIVE`	any of [string, null]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]
type optional	Type of the record Example : `A`	any of [string, null]
updated_at optional	Updated Date Example : `2026-02-09T08:00:40Z`	any of [string, null]
version optional	Version Example : `1`	any of [integer, null]
zone_id optional	ID for the zone that contains this record Example : `3432012nfdksdf03ktrld9234lgfg`	any of [string, null]
zone_name optional	The name of the zone that contains this record Example : `my-zone.com`	any of [string, null]

2.27 - RecordListResponse

Name	Description	Schema
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]
records required	Record list	array[Record]

2.28 - RecordSetRequest

Name	Description	Schema	Default
records optional	A list of data for this record Example : `['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']`	any of [array[object], null]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]

2.29 - RecordSetResponse

Name	Description	Schema
action optional	current action in progress Example : `CREATE`	any of [string, null]
created_at optional	Created Date Example : `2025-09-08T03:43:57Z`	any of [string, null]
description optional	description Example : `This is description`	any of [string, null]
id optional	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	any of [string, null]
links optional	Links to resource Example :	any of [object, null]
name optional	name Example : `test.app`	any of [string, null]
project_id optional	ProjectID Example : `003dffc50eb123a1cbf4f2e5c71d4f15`	any of [string, null]
records optional	A list of data for this record Example : `['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']`	any of [array[string], null]
status optional	The status Example : `ACTIVE`	any of [string, null]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]
type optional	Type of the record Example : `A`	any of [string, null]
updated_at optional	Updated Date Example : `2026-02-09T08:00:40Z`	any of [string, null]
version optional	Version Example : `1`	any of [integer, null]
zone_id optional	ID for the zone that contains this record Example : `3432012nfdksdf03ktrld9234lgfg`	any of [string, null]
zone_name optional	The name of the zone that contains this record Example : `my-zone.com`	any of [string, null]

2.30 - RecordShowResponse

Name	Description	Schema
action optional	current action in progress Example : `CREATE`	any of [string, null]
created_at optional	Created Date Example : `2025-09-08T03:43:57Z`	any of [string, null]
description optional	description Example : `This is description`	any of [string, null]
id optional	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	any of [string, null]
links optional	Links to resource Example :	any of [object, null]
name optional	name Example : `test.app`	any of [string, null]
project_id optional	ProjectID Example : `003dffc50eb123a1cbf4f2e5c71d4f15`	any of [string, null]
records optional	A list of data for this record Example : `['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']`	any of [array[string], null]
status optional	The status Example : `ACTIVE`	any of [string, null]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]
type optional	Type of the record Example : `A`	any of [string, null]
updated_at optional	Updated Date Example : `2026-02-09T08:00:40Z`	any of [string, null]
version optional	Version Example : `1`	any of [integer, null]
zone_id optional	ID for the zone that contains this record Example : `3432012nfdksdf03ktrld9234lgfg`	any of [string, null]
zone_name optional	The name of the zone that contains this record Example : `my-zone.com`	any of [string, null]

2.31 - Tag

Name	Description	Schema	Default
key required	tag key Example :	string
value required	tag value Example :	string