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

Return to the regular view of this page.

Models

1: CreatePublicDomainRequest
2: CreatePublicDomainResponse
3: HostedZoneCreateRequestV1Dot3
4: HostedZoneListResponseV1Dot3
5: HostedZoneSetRequestV1Dot3
6: HostedZoneShowResponseV1Dot3
7: HostedZoneV1Dot3
8: PrivateDns
9: PrivateDnsActivateRequest
10: PrivateDnsCreateRequest
11: PrivateDnsListResponse
12: PrivateDnsSetRequest
13: PrivateDnsShowResponse
14: PubblicDomainWhoisInfoUpdateRequest
15: PublicDomainDetail
16: PublicDomainDetailResponse
17: PublicDomainListItem
18: PublicDomainListResponse
19: PublicDomainPartialUpdateRequest
20: PublicDomainPartialUpdateResponse
21: PublicDomainTransferRequest
22: PublicDomainTransferResponse
23: PublicDomainWhoisInfoUpdateResponse
24: Record
25: RecordCreateRequest
26: RecordCreateResponse
27: RecordListResponse
28: RecordSetRequest
29: RecordSetResponse
30: RecordShowResponse
31: Tag

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

Name	Description	Schema	Default
public_domain_name required		PublicDomainDetail

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)

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]

5 - HostedZoneSetRequestV1Dot3

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

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]

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]

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)

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

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]

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]

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]

13 - PrivateDnsShowResponse

Name	Description	Schema	Default
private_dns required		PrivateDns

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

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

16 - PublicDomainDetailResponse

Name	Description	Schema	Default
public_domain_name required		PublicDomainDetail

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

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]

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]

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

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)

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)

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

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]

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

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]

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]

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]

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]

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]

31 - Tag

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