이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.

이 페이지의 일반 화면으로 돌아가기.

DNS

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 DNS 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

VersionStatusNot Before
1.3CURRENT-

OpenAPI URL

https://dns.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environmentregion
skr-west1
skr-east1
gkr-south1
gkr-south2
gkr-south3
ekr-west1
ekr-east1

1 - APIs

1.1 - Activate Private DNS

1.1.1 - 1.3

post /v1/private-dns/activate

Description

Private DNS 활성화

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
PrivateDnsActivateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedPrivateDnsShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = 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.2 - Create Hosted Zone

1.2.1 - 1.3

post /v1/hosted-zones

Description

Hosted zone 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
HostedZoneCreateRequestV1Dot3

Responses

HTTP CodeDescriptionSchema
202AcceptedHostedZoneShowResponseV1Dot3
400Bad RequestNone
403ForbiddenNone
409ConflictNone

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 = ko-KR",
"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

Hosted zone record 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathhosted_zone_id
required		아이디
Example : 3432012nfdksdf03ktrld9234lgfg
stringNone
bodybody
required
RecordCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedRecordCreateResponse
400Bad RequestNone
403ForbiddenNone
409ConflictNone

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 = ko-KR",
"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

Private DNS 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
PrivateDnsCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedPrivateDnsShowResponse
400Bad RequestNone
403ForbiddenNone

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 = 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.5 - Create Public Domain Name

1.5.1 - 1.3

post /v1/public-domain-names

Description

Public Domain Name 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
CreatePublicDomainRequest

Responses

HTTP CodeDescriptionSchema
201CreatedCreatePublicDomainResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"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

Hosted zone 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathhosted_zone_id
required		아이디
Example : 3432012nfdksdf03ktrld9234lgfg
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = ko-KR",
"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

Hosted zone record 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathhosted_zone_id
required		호스티드 존 ID
Example : 3432012nfdksdf03ktrld9234lgfg
stringNone
pathrecord_id
required		레코드 ID
Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedRecordCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = ko-KR",
"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

Private DNS 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_dns_id
required		프라이빗 DNS ID
Example : 10fjkewefprivatedns3193rud543
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = ko-KR",
"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

Hosted zone record 목록

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathhosted_zone_id
required		아이디
Example : 3432012nfdksdf03ktrld9234lgfg
stringNone
querylimit
optional		한도
Example :
any of [integer, null]None
querymarker
optional		마커
Example :
any of [string, null]None
querysort_dir
optional		정렬 방향
Example :
any of [string, null]None
querysort_key
optional		정렬 키
Example :
any of [string, null]None
queryname
optional		이름
Example : test.app
any of [string, null]None
queryexact_name
optional		이름
Example : test.app
any of [string, null]None
querytype
optional		레코드 유형
Example : A
any of [string, null]None
querydata
optional		레코드 데이터
Example : 12345.ns.private.kr-west1.dev2.samsungsdscloud.com
any of [string, null]None
querystatus
optional		상태
Example : ACTIVE
any of [string, null]None
querydescription
optional		설명
Example : This is description
any of [string, null]None
queryttl
optional		존의 TTL.
Example : 3600
any of [integer, null]None

Responses

HTTP CodeDescriptionSchema
200OKRecordListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = ko-KR",
"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

Hosted zone 목록

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		이름
Example : my-zone.com
any of [string, null]None
querytype
optional		존 유형
Example :
any of [enum (public, private), null]None
querystatus
optional		상태
Example :
any of [enum (CREATING, EDITING, ACTIVE, DELETING, DELETED, ERROR, PENDING, UNKNOWN), null]None

Responses

HTTP CodeDescriptionSchema
200OKHostedZoneListResponseV1Dot3
403ForbiddenNone

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 = 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.11 - List Private DNS

1.11.1 - 1.3

get /v1/private-dns

Description

Private DNS 목록

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryid
optional		프라이빗 DNS ID
Example : 10fjkewefprivatedns3193rud543
any of [string, null]None
queryname
optional		프라이빗 DNS 이름
Example :
any of [string, null]None
queryvpc_id
optional		연결된 VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
querystate
optional		상태
Example : ACTIVE
any of [enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR, PENDING), null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateDnsListResponse
400Bad RequestNone
403ForbiddenNone

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 = 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.12 - List Public Domain Names

1.12.1 - 1.3

get /v1/public-domain-names

Description

Public Domain Name 목록

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		퍼블릭 도메인 이름
Example : example.com
any of [string, null]None
querycreated_by
optional		생성자
Example : 504f24f8111e42e0578f367acd2a149f
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKPublicDomainListResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"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

Hosted zone 업데이트

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathhosted_zone_id
required		아이디
Example : 3432012nfdksdf03ktrld9234lgfg
stringNone
bodybody
required
HostedZoneSetRequestV1Dot3

Responses

HTTP CodeDescriptionSchema
202AcceptedHostedZoneShowResponseV1Dot3
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = 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.14 - Set Hosted Zone Record

1.14.1 - 1.3

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

Description

Hosted zone record 업데이트

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathhosted_zone_id
required		호스티드 존 ID
Example : 3432012nfdksdf03ktrld9234lgfg
stringNone
pathrecord_id
required		레코드 ID
Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
stringNone
bodybody
required
RecordSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedRecordSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = ko-KR",
"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

Private DNS 업데이트

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_dns_id
required		프라이빗 DNS ID
Example : 10fjkewefprivatedns3193rud543
stringNone
bodybody
required
PrivateDnsSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedPrivateDnsShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = 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.16 - Set Public Domain Name

1.16.1 - 1.3

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

Description

Public Domain Name 업데이트

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathpublic_domain_id
required		ID
Example : 10fjkeweffpublicdomain3193rud543
stringNone
bodybody
required
PublicDomainPartialUpdateRequest

Responses

HTTP CodeDescriptionSchema
200OKPublicDomainPartialUpdateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = ko-KR",
"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

Public Domain Name Whois 정보 업데이트

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathpublic_domain_id
required		ID
Example : 10fjkeweffpublicdomain3193rud543
stringNone
bodybody
required
PubblicDomainWhoisInfoUpdateRequest

Responses

HTTP CodeDescriptionSchema
200OKPublicDomainWhoisInfoUpdateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
500Internal Server ErrorNone

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 = ko-KR",
"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

Hosted zone 상세

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathhosted_zone_id
required		아이디
Example : 3432012nfdksdf03ktrld9234lgfg
stringNone

Responses

HTTP CodeDescriptionSchema
200OKHostedZoneShowResponseV1Dot3
403ForbiddenNone
404Not FoundNone

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 = 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.19 - Show Hosted Zone Record

1.19.1 - 1.3

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

Description

Hosted zone record 상세

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathhosted_zone_id
required		호스티드 존 ID
Example : 3432012nfdksdf03ktrld9234lgfg
stringNone
pathrecord_id
required		레코드 ID
Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
stringNone

Responses

HTTP CodeDescriptionSchema
200OKRecordShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = ko-KR",
"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

Private DNS 상세

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_dns_id
required		프라이빗 DNS ID
Example : 10fjkewefprivatedns3193rud543
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPrivateDnsShowResponse
403ForbiddenNone
404Not FoundNone

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 = 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.21 - Show Public Domain Name

1.21.1 - 1.3

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

Description

Public Domain Name 상세

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathpublic_domain_id
required		ID
Example : 10fjkeweffpublicdomain3193rud543
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPublicDomainDetailResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = ko-KR",
"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

Public Domain Name 이관

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathpublic_domain_id
required		ID
Example : 10fjkeweffpublicdomain3193rud543
stringNone
bodybody
required
PublicDomainTransferRequest

Responses

HTTP CodeDescriptionSchema
200OKPublicDomainTransferResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = ko-KR",
"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

NameDescriptionSchemaDefault
address_type
required		주소 유형
Example : DOMESTIC
string
auto_extension
optional		자동 연장 플래그
Example : True
any of [boolean, null]True
description
optional		설명
Example : This is description
any of [string, null]
domestic_first_address_en
required		국내 주소 1 (EN)
Example : 125 Olympic-ro 35-gil, Songpa-gu, Seoul
any of [string, null]
domestic_first_address_ko
required		국내 주소 1 (KO)
Example : 서울특별시 송파구 올림픽로35길 125 (신천동)
any of [string, null]
domestic_second_address_en
required		국내 주소 2 (EN)
Example : West Campus 1F
any of [string, null]
domestic_second_address_ko
required		국내 주소 2 (KO)
Example : 서관 1층
Maximum length : 16
string
name
required		퍼블릭 도메인 이름
Example : example.com
string
overseas_first_address
required		해외 주소 - 주소
Example : 123 Main St
any of [string, null]
overseas_second_address
required		해외 주소 - 도시
Example : New York
any of [string, null]
overseas_third_address
required		해외 주소 - 주 및 국가
Example : NY 10001
any of [string, null]
postal_code
required		우편번호
Example : 12345
Maximum length : 6
string
register_email
required		등록 이메일
Example : admin@example.com
string
register_name_en
required		해외 등록 이름
Example : Hong Gildong
Maximum length : 30
string
register_name_ko
required		국내 등록 이름
Example : 홍길동
Maximum length : 30
string
register_telno
required		등록 전화번호
Example : 010-1234-5678
string
tags
optional		태그 목록
array[Tag]

2.2 - CreatePublicDomainResponse

NameDescriptionSchemaDefault
public_domain_name
required
PublicDomainDetail

2.3 - HostedZoneCreateRequestV1Dot3

NameDescriptionSchemaDefault
description
optional		설명
Example : This is description
any of [string, null]
name
required		이름
Example : my-zone.com
string
private_dns_id
optional		프라이빗 DNS ID
Example : 10fjkewefprivatedns3193rud543
any of [string, null]
tags
optional		태그 목록
array[Tag]
type
required		존 유형
Example : private
enum (public, private)

2.4 - HostedZoneListResponseV1Dot3

NameDescriptionSchemaDefault
count
required		count
Example : 20
integer
hosted_zones
required		호스티드 존 목록
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

NameDescriptionSchemaDefault
description
optional		설명
Example : This is description
any of [string, null]

2.6 - HostedZoneShowResponseV1Dot3

NameDescriptionSchemaDefault
created_at
required		생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required		설명
Example : This is description
any of [string, null]
hosted_zone_type
optional		호스티드 존 유형
Example : public
enum (public, private)
id
required		호스티드 존 ID
Example : 3432012nfdksdf03ktrld9234lgfg
string
modified_at
required		수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		호스티드 존 이름
Example : my-zone.com
string
pool_id
required		풀 ID 지정
Example : 10fjksdpooliddfsi12389esfdslkdsr32
string
private_dns_id
optional		프라이빗 DNS ID
Example : 10fjkewefprivatedns3193rud543
any of [string, null]
private_dns_name
optional		프라이빗 DNS 이름
Example : private-dns01
any of [string, null]
status
required		상태
Example : CREATING
enum (CREATING, EDITING, ACTIVE, DELETING, DELETED, ERROR, PENDING, UNKNOWN)
ttl
optional		존의 TTL.
Example : 3600
any of [integer, null]

2.7 - HostedZoneV1Dot3

NameDescriptionSchemaDefault
created_at
required		생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required		설명
Example : This is description
any of [string, null]
hosted_zone_type
optional		호스티드 존 유형
Example : public
enum (public, private)
id
required		호스티드 존 ID
Example : 3432012nfdksdf03ktrld9234lgfg
string
modified_at
required		수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		호스티드 존 이름
Example : my-zone.com
string
pool_id
required		풀 ID 지정
Example : 10fjksdpooliddfsi12389esfdslkdsr32
string
private_dns_id
optional		프라이빗 DNS ID
Example : 10fjkewefprivatedns3193rud543
any of [string, null]
private_dns_name
optional		프라이빗 DNS 이름
Example : private-dns01
any of [string, null]
status
required		상태
Example : CREATING
enum (CREATING, EDITING, ACTIVE, DELETING, DELETED, ERROR, PENDING, UNKNOWN)
ttl
optional		존의 TTL.
Example : 3600
any of [integer, null]

2.8 - PrivateDns

NameDescriptionSchemaDefault
auth_dns_name
required		권한 DNS 이름
Example :
any of [string, null]
connected_vpc_ids
optional		연결된 VPC ID
array[string]
created_at
required		생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required		설명
Example : This is description
any of [string, null]
id
required		프라이빗 DNS ID
Example : 10fjkewefprivatedns3193rud543
string
modified_at
required		수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		프라이빗 DNS 이름
Example : private-dns01
string
pool_id
required		풀 ID 지정
Example : 10fjksdpooliddfsi12389esfdslkdsr32
any of [string, null]
pool_name
required		풀 이름
Example :
any of [string, null]
registered_region
required		등록된 리전
Example : KR-WEST1
any of [string, null]
resolver_ip
required		프라이빗 DNS 리졸버 IP
Example : 198.19.0.101
any of [string, null]
resolver_name
required		프라이빗 DNS 리졸버 이름
Example :
any of [string, null]
state
required		상태
Example : CREATING
enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR, PENDING)

2.9 - PrivateDnsActivateRequest

NameDescriptionSchemaDefault
name
required		프라이빗 DNS 이름
Example : private-dns01
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string

2.10 - PrivateDnsCreateRequest

NameDescriptionSchemaDefault
connected_vpc_ids
optional		연결된 VPC ID
array[string]
description
optional		설명
Example : This is description
any of [string, null]
name
required		프라이빗 DNS 이름
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

NameDescriptionSchemaDefault
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

NameDescriptionSchemaDefault
connected_vpc_ids
optional		연결된 VPC ID
Example :
any of [array[string], null]
description
optional		설명
Example : This is description
any of [string, null]

2.13 - PrivateDnsShowResponse

NameDescriptionSchemaDefault
private_dns
required
PrivateDns

2.14 - PubblicDomainWhoisInfoUpdateRequest

NameDescriptionSchemaDefault
address_type
required		주소 유형
Example : DOMESTIC
string
domestic_first_address_en
required		국내 주소 1 (EN)
Example : 125 Olympic-ro 35-gil, Songpa-gu, Seoul
string
domestic_first_address_ko
required		국내 주소 1 (KO)
Example : 서울특별시 송파구 올림픽로35길 125 (신천동)
string
domestic_second_address_en
required		국내 주소 2 (EN)
Example : West Campus 1F
any of [string, null]
domestic_second_address_ko
required		국내 주소 2 (KO)
Example : 서관 1층
Maximum length : 16
string
overseas_first_address
required		해외 주소 - 주소
Example : 123 Main St
any of [string, null]
overseas_second_address
required		해외 주소 - 도시
Example : New York
any of [string, null]
overseas_third_address
required		해외 주소 - 주 및 국가
Example : NY 10001
any of [string, null]
postal_code
required		우편번호
Example : 12345
Maximum length : 6
string
register_email
required		등록 이메일
Example : admin@example.com
string
register_telno
required		등록 전화번호
Example : 010-1234-5678
string

2.15 - PublicDomainDetail

NameDescriptionSchemaDefault
address_type
required		주소 유형
Example : DOMESTIC
string
auto_extension
required		자동 연장 플래그
Example : True
boolean
created_at
required		생성 날짜
Example : 2025-09-08T03:43:57Z
string
created_by
required		생성자
Example : 504f24f8111e42e0578f367acd2a149f
string
description
optional		설명
Example : This is description
any of [string, null]
domestic_address_en
required		국내 주소 (EN)
Example : West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul
string
domestic_address_ko
required		국내 주소 (KO)
Example : 서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층
string
domestic_first_address_en
required		국내 주소 1 (EN)
Example : 125 Olympic-ro 35-gil, Songpa-gu, Seoul
string
domestic_first_address_ko
required		국내 주소 1 (KO)
Example : 서울특별시 송파구 올림픽로35길 125 (신천동)
string
domestic_second_address_en
required		국내 주소 2 (EN)
Example : West Campus 1F
string
domestic_second_address_ko
required		국내 주소 2 (KO)
Example : 서관 1층
string
expired_date
required		만료 날짜
Example : 2026-09-09T00:00:00Z
string
id
required		ID
Example : 10fjkeweffpublicdomain3193rud543
string
modified_at
required		수정 날짜
Example : 2026-02-09T08:00:40Z
string
modified_by
required		수정자
Example : 504f24f8111e42e0578f367acd2a149f
string
name
required		퍼블릭 도메인 이름
Example : example.com
string
overseas_address
optional		해외 주소
Example : 123 Main St, New York, NY 10001
string
overseas_first_address
required		해외 주소 - 주소
Example : 123 Main St
string
overseas_second_address
required		해외 주소 - 도시
Example : New York
string
overseas_third_address
required		해외 주소 - 주 및 국가
Example : NY 10001
string
postal_code
required		우편번호
Example : 12345
string
register_email
required		등록 이메일
Example : admin@example.com
string
register_name_en
required		해외 등록 이름
Example : Hong Gildong
string
register_name_ko
required		국내 등록 이름
Example : 홍길동
string
register_telno
required		등록 전화번호
Example : 010-1234-5678
string
start_date
required		시작 날짜
Example : 2025-09-09T00:00:00Z
string
status
required		상태
Example : REGISTERED
string

2.16 - PublicDomainDetailResponse

NameDescriptionSchemaDefault
public_domain_name
required
PublicDomainDetail

2.17 - PublicDomainListItem

NameDescriptionSchemaDefault
created_at
required		생성 날짜
Example : 2025-09-08T03:43:57Z
string
created_by
required		시작 날짜
Example : 504f24f8111e42e0578f367acd2a149f
string
expired_date
required		만료 날짜
Example : 2026-09-09T00:00:00Z
string
id
required		ID
Example : 10fjkeweffpublicdomain3193rud543
string
modified_at
required		수정 날짜
Example : 2026-02-09T08:00:40Z
string
modified_by
required		수정자
Example : 504f24f8111e42e0578f367acd2a149f
string
name
required		퍼블릭 도메인 이름
Example : example.com
string
register_email
required		등록 이메일
Example : admin@example.com
string
start_date
required		시작 날짜
Example : 2025-09-09T00:00:00Z
string
status
required		상태
Example : REGISTERED
string

2.18 - PublicDomainListResponse

NameDescriptionSchemaDefault
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

NameDescriptionSchemaDefault
auto_extension
optional		자동 연장 플래그
Example : True
any of [boolean, null]
description
optional		설명
Example : This is description
any of [string, null]

2.20 - PublicDomainPartialUpdateResponse

NameDescriptionSchemaDefault
auto_extension
optional		자동 연장 플래그
Example : True
any of [boolean, null]
description
optional		설명
Example : This is description
any of [string, null]
id
required		ID
Example : 10fjkeweffpublicdomain3193rud543
string

2.21 - PublicDomainTransferRequest

NameDescriptionSchemaDefault
target_account_id
optional		대상 프로젝트 ID (type=REQUEST일 때 필수)
Example : 003dffc50eb123a1cbf4f2e5c71d4f15
any of [string, null]
type
required		이전 작업 유형
Example : REQUEST
enum (REQUEST, CANCEL, APPROVE, REJECT)

2.22 - PublicDomainTransferResponse

NameDescriptionSchemaDefault
auto_extension
required		자동 연장 플래그
Example : True
boolean
created_at
required		생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required		설명
Example : This is description
any of [string, null]
expired_date
required		만료 날짜
Example : 2026-09-09T00:00:00Z
string (date-time)
id
required		ID
Example : 10fjkeweffpublicdomain3193rud543
string
modified_at
required		수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		퍼블릭 도메인 이름
Example : example.com
string
start_date
required		시작 날짜
Example : 2025-09-09T00:00:00Z
string (date-time)
state
required		상태
Example : TRANSFER_REQUESTED
enum (CREATING, REGISTERED, EXPIRED, DELETED, TRANSFER_REQUESTING, TRANSFER_REQUESTED, DELETING)

2.23 - PublicDomainWhoisInfoUpdateResponse

NameDescriptionSchemaDefault
address_type
required		주소 유형
Example : DOMESTIC
string
domestic_first_address_en
required		국내 주소 1 (EN)
Example : 125 Olympic-ro 35-gil, Songpa-gu, Seoul
string
domestic_first_address_ko
required		국내 주소 1 (KO)
Example : 서울특별시 송파구 올림픽로35길 125 (신천동)
string
domestic_second_address_en
required		국내 주소 2 (EN)
Example : West Campus 1F
any of [string, null]
domestic_second_address_ko
required		국내 주소 2 (KO)
Example : 서관 1층
Maximum length : 16
string
name
required		퍼블릭 도메인 이름
Example : example.com
string
overseas_first_address
required		해외 주소 - 주소
Example : 123 Main St
any of [string, null]
overseas_second_address
required		해외 주소 - 도시
Example : New York
any of [string, null]
overseas_third_address
required		해외 주소 - 주 및 국가
Example : NY 10001
any of [string, null]
postal_code
required		우편번호
Example : 12345
Maximum length : 6
string
register_email
required		등록 이메일
Example : admin@example.com
string
register_name_en
required		해외 등록 이름
Example : Hong Gildong
string
register_name_ko
required		국내 등록 이름
Example : 홍길동
string
register_telno
required		등록 전화번호
Example : 010-1234-5678
string

2.24 - Record

NameDescriptionSchemaDefault
action
optional		진행 중인 작업
Example : CREATE
any of [string, null]
created_at
optional		생성 날짜
Example : 2025-09-08T03:43:57Z
any of [string, null]
description
optional		설명
Example : This is description
any of [string, null]
id
optional		레코드 ID
Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
any of [string, null]
links
optional		리소스 링크
Example :
any of [object, null]
name
optional		이름
Example : test.app
any of [string, null]
project_id
optional		프로젝트 ID
Example : 003dffc50eb123a1cbf4f2e5c71d4f15
any of [string, null]
records
optional		이 레코드의 데이터 목록
Example : ['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']
any of [array[string], null]
status
optional		상태
Example : ACTIVE
any of [string, null]
ttl
optional		존의 TTL.
Example : 3600
any of [integer, null]
type
optional		레코드 유형
Example : A
any of [string, null]
updated_at
optional		수정 날짜
Example : 2026-02-09T08:00:40Z
any of [string, null]
version
optional		버전
Example : 1
any of [integer, null]
zone_id
optional		이 레코드를 포함하는 존의 ID
Example : 3432012nfdksdf03ktrld9234lgfg
any of [string, null]
zone_name
optional		이 레코드를 포함하는 존의 이름
Example : my-zone.com
any of [string, null]

2.25 - RecordCreateRequest

NameDescriptionSchemaDefault
description
optional		설명
Example : This is description
any of [string, null]
name
required		이름
Example : test.app
string
records
required		이 레코드의 데이터 목록
Example : ['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']
array[object]
ttl
optional		존의 TTL.
Example : 3600
any of [integer, null]
type
required		레코드 유형
Example : A
string

2.26 - RecordCreateResponse

NameDescriptionSchemaDefault
action
optional		진행 중인 작업
Example : CREATE
any of [string, null]
created_at
optional		생성 날짜
Example : 2025-09-08T03:43:57Z
any of [string, null]
description
optional		설명
Example : This is description
any of [string, null]
id
optional		레코드 ID
Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
any of [string, null]
links
optional		리소스 링크
Example :
any of [object, null]
name
optional		이름
Example : test.app
any of [string, null]
project_id
optional		프로젝트 ID
Example : 003dffc50eb123a1cbf4f2e5c71d4f15
any of [string, null]
records
optional		이 레코드의 데이터 목록
Example : ['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']
any of [array[string], null]
status
optional		상태
Example : ACTIVE
any of [string, null]
ttl
optional		존의 TTL.
Example : 3600
any of [integer, null]
type
optional		레코드 유형
Example : A
any of [string, null]
updated_at
optional		수정 날짜
Example : 2026-02-09T08:00:40Z
any of [string, null]
version
optional		버전
Example : 1
any of [integer, null]
zone_id
optional		이 레코드를 포함하는 존의 ID
Example : 3432012nfdksdf03ktrld9234lgfg
any of [string, null]
zone_name
optional		이 레코드를 포함하는 존의 이름
Example : my-zone.com
any of [string, null]

2.27 - RecordListResponse

NameDescriptionSchemaDefault
count
optional		전체 개수
Example : 20
any of [integer, null]
links
optional		리소스 링크
Example :
any of [object, null]
metadata
optional		전체 개수
Example :
any of [object, null]
records
required		레코드 목록
array[Record]

2.28 - RecordSetRequest

NameDescriptionSchemaDefault
records
optional		이 레코드의 데이터 목록
Example : ['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']
any of [array[object], null]
ttl
optional		존의 TTL.
Example : 3600
any of [integer, null]

2.29 - RecordSetResponse

NameDescriptionSchemaDefault
action
optional		진행 중인 작업
Example : CREATE
any of [string, null]
created_at
optional		생성 날짜
Example : 2025-09-08T03:43:57Z
any of [string, null]
description
optional		설명
Example : This is description
any of [string, null]
id
optional		레코드 ID
Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
any of [string, null]
links
optional		리소스 링크
Example :
any of [object, null]
name
optional		이름
Example : test.app
any of [string, null]
project_id
optional		프로젝트 ID
Example : 003dffc50eb123a1cbf4f2e5c71d4f15
any of [string, null]
records
optional		이 레코드의 데이터 목록
Example : ['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']
any of [array[string], null]
status
optional		상태
Example : ACTIVE
any of [string, null]
ttl
optional		존의 TTL.
Example : 3600
any of [integer, null]
type
optional		레코드 유형
Example : A
any of [string, null]
updated_at
optional		수정 날짜
Example : 2026-02-09T08:00:40Z
any of [string, null]
version
optional		버전
Example : 1
any of [integer, null]
zone_id
optional		이 레코드를 포함하는 존의 ID
Example : 3432012nfdksdf03ktrld9234lgfg
any of [string, null]
zone_name
optional		이 레코드를 포함하는 존의 이름
Example : my-zone.com
any of [string, null]

2.30 - RecordShowResponse

NameDescriptionSchemaDefault
action
optional		진행 중인 작업
Example : CREATE
any of [string, null]
created_at
optional		생성 날짜
Example : 2025-09-08T03:43:57Z
any of [string, null]
description
optional		설명
Example : This is description
any of [string, null]
id
optional		레코드 ID
Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
any of [string, null]
links
optional		리소스 링크
Example :
any of [object, null]
name
optional		이름
Example : test.app
any of [string, null]
project_id
optional		프로젝트 ID
Example : 003dffc50eb123a1cbf4f2e5c71d4f15
any of [string, null]
records
optional		이 레코드의 데이터 목록
Example : ['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']
any of [array[string], null]
status
optional		상태
Example : ACTIVE
any of [string, null]
ttl
optional		존의 TTL.
Example : 3600
any of [integer, null]
type
optional		레코드 유형
Example : A
any of [string, null]
updated_at
optional		수정 날짜
Example : 2026-02-09T08:00:40Z
any of [string, null]
version
optional		버전
Example : 1
any of [integer, null]
zone_id
optional		이 레코드를 포함하는 존의 ID
Example : 3432012nfdksdf03ktrld9234lgfg
any of [string, null]
zone_name
optional		이 레코드를 포함하는 존의 이름
Example : my-zone.com
any of [string, null]

2.31 - Tag

NameDescriptionSchemaDefault
key
required		tag key
Example :
string
value
required		tag value
Example :
string