DNS
Overview
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of DNS service and how to call CLI. The output is formatted as a JSON string
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 | - |
CLI Version History
1.3
- DNS CLI has been updated to version 1.3.
- DNS CLI versions 1.0 to 1.2 have been deprecated.
Changes
- [Changed]
dns hosted-zone create - Command has been changed.- The
--email option has been removed.
- [Changed]
dns hosted-zone show - Command has been changed.- The
email field has been removed from the output.
- [Changed]
dns hosted-zone update → dns hosted-zone set - Command has been changed.- The
--email option has been removed.
- [Changed]
dns hosted-zone-record list - Command has been changed.- Zone apex record name is displayed as-is (without
@. notation).
- [Changed]
dns record create → dns hosted-zone-record create - Command has been changed. - [Changed]
dns record delete → dns hosted-zone-record delete - Command has been changed. - [Changed]
dns record list → dns hosted-zone-record list - Command has been changed. - [Changed]
dns record show → dns hosted-zone-record show - Command has been changed. - [Changed]
dns record update → dns hosted-zone-record set - Command has been changed. - [New]
dns public-domain-name-transfer update - Command has been added.
1.2
DNS CLI has been updated to version 1.2.
Changes
- [Changed]
dns hosted-zone list - Command has been changed.- The following field has been added to the output:
private_dns_name (Private DNS name lookup)
- [Changed]
dns hosted-zone show - Command has been changed.- The following field has been added to the output:
private_dns_name (Private DNS name lookup)
1.1
DNS CLI has been updated to version 1.1.
Changes
- [Changed]
dns hosted_zone create → dns hosted-zone create - Command has been changed. - [Changed]
dns hosted_zone delete → dns hosted-zone delete - Command has been changed. - [Changed]
dns hosted_zone list → dns hosted-zone list - Command has been changed. - [Changed]
dns hosted_zone show → dns hosted-zone show - Command has been changed. - [Changed]
dns hosted_zone update → dns hosted-zone update - Command has been changed. - [Changed]
dns private_dns create → dns private-dns create - Command has been changed.- The following options have been added:
--registered-region--private-dns-cr-id
- [Changed]
dns private_dns delete → dns private-dns delete - Command has been changed. - [Changed]
dns private_dns list → dns private-dns list - Command has been changed. - [Changed]
dns private_dns set → dns private-dns set - Command has been changed. - [Changed]
dns private_dns show → dns private-dns show - Command has been changed. - [Changed]
dns recordset create → dns record create - Command has been changed. - [Changed]
dns recordset delete → dns record delete - Command has been changed. - [Changed]
dns recordset list → dns record list - Command has been changed.- Zone apex record name is displayed using
@. notation.
- [Changed]
dns recordset show → dns record show - Command has been changed. - [Changed]
dns recordset update → dns record update - Command has been changed. - [New]
dns private-dns activate - Command has been added. - [New]
dns public-domain-name create - Command has been added. - [New]
dns public-domain-name list - Command has been added. - [New]
dns public-domain-name show - Command has been added. - [New]
dns public-domain-name update - Command has been added. - [New]
dns public-domain-name-info update - Command has been added.
1.0
DNS CLI has been released.
Changes
- [New]
dns hosted_zone create - Command has been added. - [New]
dns hosted_zone delete - Command has been added. - [New]
dns hosted_zone list - Command has been added. - [New]
dns hosted_zone show - Command has been added. - [New]
dns hosted_zone update - Command has been added. - [New]
dns private_dns create - Command has been added. - [New]
dns private_dns delete - Command has been added. - [New]
dns private_dns list - Command has been added. - [New]
dns private_dns set - Command has been added. - [New]
dns private_dns show - Command has been added. - [New]
dns recordset create - Command has been added. - [New]
dns recordset delete - Command has been added. - [New]
dns recordset list - Command has been added. - [New]
dns recordset show - Command has been added. - [New]
dns recordset update - Command has been added.
1 - CLIs
1.1 - Activate Private DNS
1.1.1 - 1.3
scp-cli dns private-dns activate
--name <value>
Description
Activate Private DNS
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
name
required | string | The name of the private DNS. | private-dns01 |
Responses
| Name | Description | Example |
|---|
| id | The unique identifier of the private DNS. | fedcba9876543210fedcba9876543210 |
| auth_dns_name | The authoritative DNS name of the private DNS. | authdns-a1b2c3d4e5f6789012345678abcdef90 |
| connected_vpc_ids | The list of VPC identifiers connected to this private DNS.Only VPCs that are connected to the DNS can query the domain information registered in it. | [‘1234567890abcdef1234567890abcdef’, ‘fedcba0987654321fedcba0987654321’] |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | This is description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the private DNS. | private-dns01 |
| pool_id | The resource pool identifier associated with the private DNS. | 12345678-90ab-cdef-1234-567890abcdef |
| pool_name | The name of the resource pool. | private01-a1b2c3d4e5f6789012345678abcdef90 |
| registered_region | The region where the private DNS is registered. | KR-WEST1 |
| resolver_ip | The IP address of the DNS resolver. | 198.19.0.101 |
| resolver_name | The name of the DNS resolver. | resolver-a1b2c3d4e5f6789012345678abcdef90 |
| state | State | ACTIVE |
1.2 - Create Hosted Zone
1.2.1 - 1.3
scp-cli dns hosted-zone create
--type <value>
--name <value>
[--description <value>]
[--private_dns_id <value>]
[--tags <value>]
Description
Create a hosted zone that contains DNS records for managing domain name resolution.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
type
required | string | The type of the hosted zone (e.g., public or private). | private |
name
required | string | The domain name that a DNS service manages. all DNS records for that domain and its sub‑domains are stored and served within this hosted zone. | my-zone.com |
description
optional | string | Description | This is description |
private_dns_id
optional | string | The DNS server ID for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value. | fedcba9876543210fedcba9876543210 |
tags
optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|
| id | The unique identifier of the hosted zone. | 3432012nfdksdf03ktrld9234lgfg |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | This is description |
| hosted_zone_type | The type of the hosted zone (e.g., public or private). | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The domain name that a DNS service manages. all DNS records for that domain and its sub‑domains are stored and served within this hosted zone. | my-zone.com |
| pool_id | The resource pool identifier associated with the hosted zone. | 12345678-90ab-cdef-1234-567890abcdef |
| private_dns_id | The DNS server ID for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value. | fedcba9876543210fedcba9876543210 |
| private_dns_name | The DNS server name for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value. | private-dns01 |
| status | State | |
| ttl | The Time-To-Live (TTL) value in seconds for DNS records in this zone. | 3600 |
1.3 - Create Hosted Zone Record
1.3.1 - 1.3
scp-cli dns hosted-zone-record create
--hosted_zone_id <value>
--type <value>
--records <value>
--name <value>
[--description <value>]
[--ttl <value>]
Description
Create a DNS record resource for managing domain name resolution.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
hosted_zone_id
required | string | The unique identifier of the hosted zone. | 3432012nfdksdf03ktrld9234lgfg |
type
required | string | The type of the DNS record (e.g., A, AAAA, CNAME, MX, TXT, SPF). | - |
records
required | array | A list of data for this record | 12345.ns.private.kr-west1.dev2.samsungsdscloud.com |
name
required | string | The name of the DNS record. | test.app |
description
optional | string | Description | This is description |
ttl
optional | integer | The Time-To-Live (TTL) value in seconds for the DNS record. | 3600 |
Responses
| Name | Description | Example |
|---|
| id | The unique identifier of the DNS record. | 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 |
| action | The action performed on the DNS record. | CREATE |
| created_at | The timestamp when the resource was created, in ISO 8601 format. | 2025-09-08T03:43:57Z |
| description | Description | This is description |
| links | The links related to the DNS record. | |
| name | The name of the DNS record. | test.app |
| project_id | The project identifier associated with the DNS record. | 003dffc50eb123a1cbf4f2e5c71d4f15 |
| records | A list of data for this record | [‘12345.ns.private.kr-west1.dev2.samsungsdscloud.com’] |
| status | The current status of the DNS record. | ACTIVE |
| ttl | The Time-To-Live (TTL) value in seconds for the DNS record. | 3600 |
| type | The type of the DNS record (e.g., A, AAAA, CNAME, MX, TXT, SPF). | A |
| updated_at | The timestamp when the resource was last updated, in ISO 8601 format. | 2026-02-09T08:00:40Z |
| version | The version of the DNS record. | 1 |
| zone_id | ID for the zone that contains this record | 3432012nfdksdf03ktrld9234lgfg |
| zone_name | The name of the zone that contains this record | my-zone.com |
1.4 - Create Private DNS
1.4.1 - 1.3
scp-cli dns private-dns create
--name <value>
[--connected_vpc_ids <value>]
[--description <value>]
[--tags <value>]
Description
Create a private DNS instance for managing internal DNS resolution.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
name
required | string | The name of the private DNS. | private-dns01 |
connected_vpc_ids
optional | array | The list of VPC identifiers connected to this private DNS.Only VPCs that are connected to the DNS can query the domain information registered in it. | 1234567890abcdef1234567890abcdef |
description
optional | string | Description | This is description |
tags
optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|
| id | The unique identifier of the private DNS. | fedcba9876543210fedcba9876543210 |
| auth_dns_name | The authoritative DNS name of the private DNS. | authdns-a1b2c3d4e5f6789012345678abcdef90 |
| connected_vpc_ids | The list of VPC identifiers connected to this private DNS.Only VPCs that are connected to the DNS can query the domain information registered in it. | [‘1234567890abcdef1234567890abcdef’, ‘fedcba0987654321fedcba0987654321’] |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | This is description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the private DNS. | private-dns01 |
| pool_id | The resource pool identifier associated with the private DNS. | 12345678-90ab-cdef-1234-567890abcdef |
| pool_name | The name of the resource pool. | private01-a1b2c3d4e5f6789012345678abcdef90 |
| registered_region | The region where the private DNS is registered. | KR-WEST1 |
| resolver_ip | The IP address of the DNS resolver. | 198.19.0.101 |
| resolver_name | The name of the DNS resolver. | resolver-a1b2c3d4e5f6789012345678abcdef90 |
| state | State | ACTIVE |
1.5 - Create Public Domain Name
1.5.1 - 1.3
scp-cli dns public-domain-name create
--register_telno <value>
--register_name_ko <value>
--register_name_en <value>
--register_email <value>
--postal_code <value>
--overseas_third_address <value>
--overseas_second_address <value>
--overseas_first_address <value>
--name <value>
--domestic_second_address_ko <value>
--domestic_second_address_en <value>
--domestic_first_address_ko <value>
--domestic_first_address_en <value>
--address_type <value>
[--auto_extension <value>]
[--description <value>]
[--tags <value>]
Description
Create a public domain name registration resource.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
register_telno
required | string | The telephone number of the domain registrant. | - |
register_name_ko
required | string | The name of the domain registrant in Korean. | 홍길동 |
register_name_en
required | string | The name of the domain registrant in English. | Hong Gildong |
register_email
required | string | The email address of the domain registrant. | admin@example.com |
postal_code
required | string | The postal code for the domain registration. | 12345 |
overseas_third_address
required | string | The third line of overseas address. | NY 10001 |
overseas_second_address
required | string | The second line of overseas address. | New York |
overseas_first_address
required | string | The first line of overseas address. | 123 Main St |
name
required | string | The name of the public domain name. | example.com |
domestic_second_address_ko
required | string | The second line of domestic address in Korean. | 서관 1층 |
domestic_second_address_en
required | string | The second line of domestic address in English. | West Campus 1F |
domestic_first_address_ko
required | string | The first line of domestic address in Korean. | 서울특별시 송파구 올림픽로35길 125 (신천동) |
domestic_first_address_en
required | string | The first line of domestic address in English. | 125 Olympic-ro 35-gil, Songpa-gu, Seoul |
address_type
required | string | The type of address for the domain registration. | - |
auto_extension
optional | boolean | Indicates whether automatic extension is enabled for the domain. | True |
description
optional | string | Description | This is description |
tags
optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|
| id | The unique identifier of the public domain name. | 10fjkeweffpublicdomain3193rud543 |
| address_type | The type of address for the domain registration. | DOMESTIC |
| auto_extension | Indicates whether automatic extension is enabled for the domain. | True |
| created_at | The timestamp when the resource was created, in ISO 8601 format. | 2025-09-08T03:43:57Z |
| created_by | The user id that created the resource. | 504f24f8111e42e0578f367acd2a149f |
| description | Description | This is description |
| domestic_address_en | The domestic address in English for the domain registration. | West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul |
| domestic_address_ko | The domestic address in Korean for the domain registration. | 서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층 |
| domestic_first_address_en | The first line of domestic address in English. | 125 Olympic-ro 35-gil, Songpa-gu, Seoul |
| domestic_first_address_ko | The first line of domestic address in Korean. | 서울특별시 송파구 올림픽로35길 125 (신천동) |
| domestic_second_address_en | The second line of domestic address in English. | West Campus 1F |
| domestic_second_address_ko | The second line of domestic address in Korean. | 서관 1층 |
| expired_date | The expiration date of the domain registration. | 2026-09-09T00:00:00Z |
| modified_at | The timestamp when the resource was last modified, in ISO 8601 format. | 2026-02-09T08:00:40Z |
| modified_by | The user id that last modified the resource. | 504f24f8111e42e0578f367acd2a149f |
| name | The name of the public domain name. | example.com |
| overseas_address | The overseas address for the domain registration. | 123 Main St, New York, NY 10001 |
| overseas_first_address | The first line of overseas address. | 123 Main St |
| overseas_second_address | The second line of overseas address. | New York |
| overseas_third_address | The third line of overseas address. | NY 10001 |
| postal_code | The postal code for the domain registration. | 12345 |
| register_email | The email address of the domain registrant. | admin@example.com |
| register_name_en | The name of the domain registrant in English. | Hong Gildong |
| register_name_ko | The name of the domain registrant in Korean. | 홍길동 |
| register_telno | The telephone number of the domain registrant. | |
| start_date | The start date of the domain registration. | 2025-09-09T00:00:00Z |
| status | The current status of the public domain name. | REGISTERED |
1.6 - Delete Hosted Zone
1.6.1 - 1.3
scp-cli dns hosted-zone delete
--hosted_zone_id <value>
Description
Delete the hosted zone.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
hosted_zone_id
required | string | The unique identifier of the hosted zone. | 3432012nfdksdf03ktrld9234lgfg |
1.7 - Delete Hosted Zone Record
1.7.1 - 1.3
scp-cli dns hosted-zone-record delete
--record_id <value>
--hosted_zone_id <value>
Description
Delete the DNS record resource.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
record_id
required | string | The unique identifier of the DNS record. | 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 |
hosted_zone_id
required | string | The identifier of the hosted zone that contains this DNS record. | 3432012nfdksdf03ktrld9234lgfg |
1.8 - Delete Private DNS
1.8.1 - 1.3
scp-cli dns private-dns delete
--private_dns_id <value>
Description
Delete the private DNS instance.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
private_dns_id
required | string | The unique identifier of the private DNS. | fedcba9876543210fedcba9876543210 |
1.9 - List Hosted Zone Records
1.9.1 - 1.3
scp-cli dns hosted-zone-record list
--hosted_zone_id <value>
[--limit <value>]
[--marker <value>]
[--sort_dir <value>]
[--sort_key <value>]
[--name <value>]
[--exact_name <value>]
[--type <value>]
[--data <value>]
[--status <value>]
[--description <value>]
[--ttl <value>]
Description
Provides a list of DNS records.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
hosted_zone_id
required | string | The unique identifier of the hosted zone. | 3432012nfdksdf03ktrld9234lgfg |
limit
optional | integer | The maximum number of items to return. | - |
marker
optional | string | The last record ID of the previous page. | - |
sort_dir
optional | string | The sort direction for the list (ASC or DESC). | - |
sort_key
optional | string | The field to sort by. | - |
name
optional | string | The name of the DNS record. | test.app |
exact_name
optional | string | The name of the DNS record. | test.app |
type
optional | string | The type of the DNS record (e.g., A, AAAA, CNAME, MX, TXT, SPF). | A |
data
optional | string | The data to filter DNS records by. | 12345.ns.private.kr-west1.dev2.samsungsdscloud.com |
status
optional | string | The current status of the DNS record. | ACTIVE |
description
optional | string | Description | This is description |
ttl
optional | integer | The Time-To-Live (TTL) value in seconds for the DNS record. | 3600 |
Responses
| Name | Description | Example |
|---|
| id | The unique identifier of the DNS record. | 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 |
| action | The action performed on the DNS record. | CREATE |
| created_at | The timestamp when the resource was created, in ISO 8601 format. | 2025-09-08T03:43:57Z |
| description | Description | This is description |
| links | The links related to the DNS record. | |
| name | The name of the DNS record. | test.app |
| project_id | The project identifier associated with the DNS record. | 003dffc50eb123a1cbf4f2e5c71d4f15 |
| records | A list of data for this record | [‘12345.ns.private.kr-west1.dev2.samsungsdscloud.com’] |
| status | The current status of the DNS record. | ACTIVE |
| ttl | The Time-To-Live (TTL) value in seconds for the DNS record. | 3600 |
| type | The type of the DNS record (e.g., A, AAAA, CNAME, MX, TXT, SPF). | A |
| updated_at | The timestamp when the resource was last updated, in ISO 8601 format. | 2026-02-09T08:00:40Z |
| version | The version of the DNS record. | 1 |
| zone_id | ID for the zone that contains this record | 3432012nfdksdf03ktrld9234lgfg |
| zone_name | The name of the zone that contains this record | my-zone.com |
1.10 - List Hosted Zones
1.10.1 - 1.3
scp-cli dns hosted-zone list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--type <value>]
[--status <value>]
Description
Provides a list of hosted zones.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
size
optional | integer | size | 20 |
page
optional | integer | page | 0 |
sort
optional | string | sort | created_at:desc |
name
optional | string | The domain name that a DNS service manages. all DNS records for that domain and its sub‑domains are stored and served within this hosted zone. | my-zone.com |
type
optional | **** | The type of the hosted zone (e.g., public or private). | - |
status
optional | **** | The current status of the hosted zone (e.g., ACTIVE, CREATING, DELETING). | - |
Responses
| Name | Description | Example |
|---|
| id | The unique identifier of the hosted zone. | 3432012nfdksdf03ktrld9234lgfg |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | This is description |
| hosted_zone_type | The type of the hosted zone (e.g., public or private). | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The domain name that a DNS service manages. all DNS records for that domain and its sub‑domains are stored and served within this hosted zone. | my-zone.com |
| pool_id | The resource pool identifier associated with the hosted zone. | 12345678-90ab-cdef-1234-567890abcdef |
| private_dns_id | The DNS server ID for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value. | fedcba9876543210fedcba9876543210 |
| private_dns_name | The DNS server name for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value. | private-dns01 |
| status | State | |
| ttl | The Time-To-Live (TTL) value in seconds for DNS records in this zone. | 3600 |
1.11 - List Private DNS
1.11.1 - 1.3
scp-cli dns private-dns list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--state <value>]
Description
Provides a list of private DNS instances.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
size
optional | integer | size | 20 |
page
optional | integer | page | 0 |
sort
optional | string | sort | created_at:desc |
id
optional | string | The unique identifier of the private DNS. | fedcba9876543210fedcba9876543210 |
name
optional | string | The name of the private DNS. | private-dns01 |
vpc_id
optional | string | The list of VPC identifiers connected to this private DNS.Only VPCs that are connected to the DNS can query the domain information registered in it. | 7df8abb4912e4709b1cb237daccca7a8 |
state
optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|
| id | The unique identifier of the private DNS. | fedcba9876543210fedcba9876543210 |
| auth_dns_name | The authoritative DNS name of the private DNS. | authdns-a1b2c3d4e5f6789012345678abcdef90 |
| connected_vpc_ids | The list of VPC identifiers connected to this private DNS.Only VPCs that are connected to the DNS can query the domain information registered in it. | [‘1234567890abcdef1234567890abcdef’, ‘fedcba0987654321fedcba0987654321’] |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | This is description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the private DNS. | private-dns01 |
| pool_id | The resource pool identifier associated with the private DNS. | 12345678-90ab-cdef-1234-567890abcdef |
| pool_name | The name of the resource pool. | private01-a1b2c3d4e5f6789012345678abcdef90 |
| registered_region | The region where the private DNS is registered. | KR-WEST1 |
| resolver_ip | The IP address of the DNS resolver. | 198.19.0.101 |
| resolver_name | The name of the DNS resolver. | resolver-a1b2c3d4e5f6789012345678abcdef90 |
| state | State | ACTIVE |
1.12 - List Public Domain Names
1.12.1 - 1.3
scp-cli dns public-domain-name list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--created_by <value>]
Description
Provides a list of public domain names.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
size
optional | integer | size | 20 |
page
optional | integer | page | 0 |
sort
optional | string | sort | created_at:desc |
name
optional | string | The name of the public domain name. | example.com |
created_by
optional | string | The user id that created the resource. | 504f24f8111e42e0578f367acd2a149f |
Responses
| Name | Description | Example |
|---|
| id | The unique identifier of the public domain name. | 10fjkeweffpublicdomain3193rud543 |
| created_at | The timestamp when the resource was created, in ISO 8601 format. | 2025-09-08T03:43:57Z |
| created_by | The user id that created the resource. | 504f24f8111e42e0578f367acd2a149f |
| expired_date | The expiration date of the domain registration. | 2026-09-09T00:00:00Z |
| modified_at | The timestamp when the resource was last modified, in ISO 8601 format. | 2026-02-09T08:00:40Z |
| modified_by | The user id that last modified the resource. | 504f24f8111e42e0578f367acd2a149f |
| name | The name of the public domain name. | example.com |
| register_email | The email address of the domain registrant. | admin@example.com |
| start_date | The start date of the domain registration. | 2025-09-09T00:00:00Z |
| status | The current status of the public domain name. | REGISTERED |
1.13 - Set Hosted Zone
1.13.1 - 1.3
scp-cli dns hosted-zone set
--hosted_zone_id <value>
[--description <value>]
Description
Update the hosted zone.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
hosted_zone_id
required | string | The unique identifier of the hosted zone. | 3432012nfdksdf03ktrld9234lgfg |
description
optional | string | Description | This is description |
1.14 - Set Hosted Zone Record
1.14.1 - 1.3
scp-cli dns hosted-zone-record set
--record_id <value>
--hosted_zone_id <value>
[--records <value>]
[--ttl <value>]
Description
Update the DNS record values.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
record_id
required | string | The unique identifier of the DNS record. | 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 |
hosted_zone_id
required | string | The identifier of the hosted zone that contains this DNS record. | 3432012nfdksdf03ktrld9234lgfg |
records
optional | array | A list of data for this record | 12345.ns.private.kr-west1.dev2.samsungsdscloud.com |
ttl
optional | integer | The Time-To-Live (TTL) value in seconds for the DNS record. | 3600 |
1.15 - Set Private DNS
1.15.1 - 1.3
scp-cli dns private-dns set
--private_dns_id <value>
[--connected_vpc_ids <value>]
[--description <value>]
Description
Update the private DNS connected VPC List.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
private_dns_id
required | string | The unique identifier of the private DNS. | fedcba9876543210fedcba9876543210 |
connected_vpc_ids
optional | array | The list of VPC identifiers connected to this private DNS.Only VPCs that are connected to the DNS can query the domain information registered in it. | 1234567890abcdef1234567890abcdef |
description
optional | string | Description | This is description |
1.16 - Set Public Domain Name
1.16.1 - 1.3
scp-cli dns public-domain-name update
--public_domain_id <value>
[--auto_extension <value>]
[--description <value>]
Description
Update the public domain name.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
public_domain_id
required | string | The unique identifier of the public domain name. | 10fjkeweffpublicdomain3193rud543 |
auto_extension
optional | boolean | Indicates whether automatic extension is enabled for the domain. | True |
description
optional | string | Description | This is description |
1.17 - Set Public Domain Name Whois Info
1.17.1 - 1.3
scp-cli dns public-domain-name-info update
--public_domain_id <value>
--register_telno <value>
--register_email <value>
--postal_code <value>
--overseas_third_address <value>
--overseas_second_address <value>
--overseas_first_address <value>
--domestic_second_address_ko <value>
--domestic_second_address_en <value>
--domestic_first_address_ko <value>
--domestic_first_address_en <value>
--address_type <value>
Description
Update Public Domain Name Whois Info
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
public_domain_id
required | string | The unique identifier of the public domain name. | 10fjkeweffpublicdomain3193rud543 |
register_telno
required | string | The telephone number of the domain registrant. | - |
register_email
required | string | The email address of the domain registrant. | admin@example.com |
postal_code
required | string | The postal code for the domain registration. | 12345 |
overseas_third_address
required | string | The third line of overseas address. | NY 10001 |
overseas_second_address
required | string | The second line of overseas address. | New York |
overseas_first_address
required | string | The first line of overseas address. | 123 Main St |
domestic_second_address_ko
required | string | The second line of domestic address in Korean. | 서관 1층 |
domestic_second_address_en
required | string | The second line of domestic address in English. | West Campus 1F |
domestic_first_address_ko
required | string | The first line of domestic address in Korean. | 서울특별시 송파구 올림픽로35길 125 (신천동) |
domestic_first_address_en
required | string | The first line of domestic address in English. | 125 Olympic-ro 35-gil, Songpa-gu, Seoul |
address_type
required | string | The type of address for the domain registration. | - |
1.18 - Show Hosted Zone
1.18.1 - 1.3
scp-cli dns hosted-zone show
--hosted_zone_id <value>
Description
Provides details about a specific hosted zone.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
hosted_zone_id
required | string | The unique identifier of the hosted zone. | 3432012nfdksdf03ktrld9234lgfg |
Responses
| Name | Description | Example |
|---|
| id | The unique identifier of the hosted zone. | 3432012nfdksdf03ktrld9234lgfg |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | This is description |
| hosted_zone_type | The type of the hosted zone (e.g., public or private). | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The domain name that a DNS service manages. all DNS records for that domain and its sub‑domains are stored and served within this hosted zone. | my-zone.com |
| pool_id | The resource pool identifier associated with the hosted zone. | 12345678-90ab-cdef-1234-567890abcdef |
| private_dns_id | The DNS server ID for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value. | fedcba9876543210fedcba9876543210 |
| private_dns_name | The DNS server name for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value. | private-dns01 |
| status | State | |
| ttl | The Time-To-Live (TTL) value in seconds for DNS records in this zone. | 3600 |
1.19 - Show Hosted Zone Record
1.19.1 - 1.3
scp-cli dns hosted-zone-record show
--record_id <value>
--hosted_zone_id <value>
Description
Provides details about a specific DNS record.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
record_id
required | string | The unique identifier of the DNS record. | 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 |
hosted_zone_id
required | string | The identifier of the hosted zone that contains this DNS record. | 3432012nfdksdf03ktrld9234lgfg |
Responses
| Name | Description | Example |
|---|
| id | The unique identifier of the DNS record. | 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 |
| action | The action performed on the DNS record. | CREATE |
| created_at | The timestamp when the resource was created, in ISO 8601 format. | 2025-09-08T03:43:57Z |
| description | Description | This is description |
| links | The links related to the DNS record. | |
| name | The name of the DNS record. | test.app |
| project_id | The project identifier associated with the DNS record. | 003dffc50eb123a1cbf4f2e5c71d4f15 |
| records | A list of data for this record | [‘12345.ns.private.kr-west1.dev2.samsungsdscloud.com’] |
| status | The current status of the DNS record. | ACTIVE |
| ttl | The Time-To-Live (TTL) value in seconds for the DNS record. | 3600 |
| type | The type of the DNS record (e.g., A, AAAA, CNAME, MX, TXT, SPF). | A |
| updated_at | The timestamp when the resource was last updated, in ISO 8601 format. | 2026-02-09T08:00:40Z |
| version | The version of the DNS record. | 1 |
| zone_id | ID for the zone that contains this record | 3432012nfdksdf03ktrld9234lgfg |
| zone_name | The name of the zone that contains this record | my-zone.com |
1.20 - Show Private DNS
1.20.1 - 1.3
scp-cli dns private-dns show
--private_dns_id <value>
Description
Provides details about a specific private DNS.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
private_dns_id
required | string | The unique identifier of the private DNS. | fedcba9876543210fedcba9876543210 |
Responses
| Name | Description | Example |
|---|
| id | The unique identifier of the private DNS. | fedcba9876543210fedcba9876543210 |
| auth_dns_name | The authoritative DNS name of the private DNS. | authdns-a1b2c3d4e5f6789012345678abcdef90 |
| connected_vpc_ids | The list of VPC identifiers connected to this private DNS.Only VPCs that are connected to the DNS can query the domain information registered in it. | [‘1234567890abcdef1234567890abcdef’, ‘fedcba0987654321fedcba0987654321’] |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | This is description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the private DNS. | private-dns01 |
| pool_id | The resource pool identifier associated with the private DNS. | 12345678-90ab-cdef-1234-567890abcdef |
| pool_name | The name of the resource pool. | private01-a1b2c3d4e5f6789012345678abcdef90 |
| registered_region | The region where the private DNS is registered. | KR-WEST1 |
| resolver_ip | The IP address of the DNS resolver. | 198.19.0.101 |
| resolver_name | The name of the DNS resolver. | resolver-a1b2c3d4e5f6789012345678abcdef90 |
| state | State | ACTIVE |
1.21 - Show Public Domain Name
1.21.1 - 1.3
scp-cli dns public-domain-name show
--public_domain_id <value>
Description
Provides details about a specific public domain name.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
public_domain_id
required | string | The unique identifier of the public domain name. | 10fjkeweffpublicdomain3193rud543 |
Responses
| Name | Description | Example |
|---|
| id | The unique identifier of the public domain name. | 10fjkeweffpublicdomain3193rud543 |
| address_type | The type of address for the domain registration. | DOMESTIC |
| auto_extension | Indicates whether automatic extension is enabled for the domain. | True |
| created_at | The timestamp when the resource was created, in ISO 8601 format. | 2025-09-08T03:43:57Z |
| created_by | The user id that created the resource. | 504f24f8111e42e0578f367acd2a149f |
| description | Description | This is description |
| domestic_address_en | The domestic address in English for the domain registration. | West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul |
| domestic_address_ko | The domestic address in Korean for the domain registration. | 서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층 |
| domestic_first_address_en | The first line of domestic address in English. | 125 Olympic-ro 35-gil, Songpa-gu, Seoul |
| domestic_first_address_ko | The first line of domestic address in Korean. | 서울특별시 송파구 올림픽로35길 125 (신천동) |
| domestic_second_address_en | The second line of domestic address in English. | West Campus 1F |
| domestic_second_address_ko | The second line of domestic address in Korean. | 서관 1층 |
| expired_date | The expiration date of the domain registration. | 2026-09-09T00:00:00Z |
| modified_at | The timestamp when the resource was last modified, in ISO 8601 format. | 2026-02-09T08:00:40Z |
| modified_by | The user id that last modified the resource. | 504f24f8111e42e0578f367acd2a149f |
| name | The name of the public domain name. | example.com |
| overseas_address | The overseas address for the domain registration. | 123 Main St, New York, NY 10001 |
| overseas_first_address | The first line of overseas address. | 123 Main St |
| overseas_second_address | The second line of overseas address. | New York |
| overseas_third_address | The third line of overseas address. | NY 10001 |
| postal_code | The postal code for the domain registration. | 12345 |
| register_email | The email address of the domain registrant. | admin@example.com |
| register_name_en | The name of the domain registrant in English. | Hong Gildong |
| register_name_ko | The name of the domain registrant in Korean. | 홍길동 |
| register_telno | The telephone number of the domain registrant. | |
| start_date | The start date of the domain registration. | 2025-09-09T00:00:00Z |
| status | The current status of the public domain name. | REGISTERED |
1.22 - Transfer Public Domain Name
1.22.1 - 1.3
scp-cli dns public-domain-name-transfer update
--public_domain_id <value>
--type <value>
[--target_account_id <value>]
Description
Transfer The Public Domain Name to other Account
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
public_domain_id
required | string | The unique identifier of the public domain name. | 10fjkeweffpublicdomain3193rud543 |
type
required | string | Transfer operation type | REQUEST |
target_account_id
optional | string | Target account id (required when type=REQUEST) | 003dffc50eb123a1cbf4f2e5c71d4f15 |
Responses
| Name | Description | Example |
|---|
| id | The unique identifier of the public domain name. | 10fjkeweffpublicdomain3193rud543 |
| auto_extension | Indicates whether automatic extension is enabled for the domain. | True |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | This is description |
| expired_date | The expiration date of the domain registration. | 2026-09-09T00:00:00Z |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the public domain name. | example.com |
| start_date | The start date of the domain registration. | 2025-09-09T00:00:00Z |
| state | State | TRANSFER_REQUESTED |