1 - CreatePublicDomainRequest

NameDescriptionSchemaDefault
address_type
required
Address type
Example :
string
auto_extension
optional
Auto extension flag
Example : True
any of [boolean, null]True
description
optional
description
Example :
any of [string, null]
domestic_first_address_en
required
Domestic first address (EN)
Example :
any of [string, null]
domestic_first_address_ko
required
Domestic first address (KO)
Example :
any of [string, null]
domestic_second_address_en
required
Domestic second address (EN)
Example :
any of [string, null]
domestic_second_address_ko
required
Domestic second address (KO)
Example :
Maximum length : 16
string
name
required
name
Example :
string
overseas_first_address
required
Overseas address - Address
Example :
any of [string, null]
overseas_second_address
required
Overseas address - City
Example :
any of [string, null]
overseas_third_address
required
Overseas address - State & Country
Example :
any of [string, null]
postal_code
required
Postal code
Example :
Maximum length : 6
string
register_email
required
Register email
Example :
string
register_name_en
required
Register Name Overseas
Example :
Maximum length : 30
string
register_name_ko
required
Register Name Domestic
Example :
Maximum length : 30
string
register_telno
required
Register telephone number
Example :
string
tags
optional
Tag List
array[Tag]

2 - CreatePublicDomainResponse

NameDescriptionSchemaDefault
public_domain_name
required

PublicDomainDetail

3 - HostedZone

NameDescriptionSchemaDefault
action
required
current action in progress
Example :
string
attributes
optional
Key:Value pairs of information about this zone
Example :
any of [object, null]
created_at
optional
Created Date
Example :
any of [string, null]
description
optional
description
Example :
any of [string, null]
email
required
email
Example :
string
hosted_zone_type
optional
Hosted Zone type
Example :
any of [string, null]
id
required
Id
Example :
string
links
optional
Links to resource
Example :
any of [object, null]
masters
optional
The servers to slave from to get DNS information
Example :
any of [array[string], null]
name
required
name
Example :
string
pool_id
required
Designate Pool ID
Example :
string
project_id
required
ProjectID
Example :
string
serial
required
serial number
Example :
integer
shared
optional
True if the zone is shared with another account
Example :
any of [boolean, null]
status
required
The status
Example :
string
transferred_at
optional
The last time an update was retrieved from the master servers
Example :
any of [string, null]
ttl
optional
TTL for the zone.
Example :
any of [integer, null]
type
optional
Type of zone
Example :
any of [string, null]
updated_at
optional
Updated Date
Example :
any of [string, null]
version
optional
Version
Example :
any of [integer, null]

4 - HostedZoneCreateRequest

NameDescriptionSchemaDefault
description
optional
description
Example :
any of [string, null]
email
required
email
Example :
string
name
required
name
Example :
string
tags
optional
Tag List
array[Tag]
type
optional
Type of zone
Example :
Pattern : ^(public|private)$
any of [string, null]

5 - HostedZoneCreateRequestV1Dot2

NameDescriptionSchemaDefault
description
optional
description
Example :
any of [string, null]
email
required
email
Example :
string
name
required
name
Example :
string
private_dns_id
optional
Private DNS ID
Example :
any of [string, null]
tags
optional
Tag List
array[Tag]
type
optional
Type of zone
Example :
Pattern : ^(public|private)$
any of [string, null]

6 - HostedZoneCreateRequestV1Dot3

NameDescriptionSchemaDefault
description
optional
description
Example : This is description
any of [string, null]
name
required
name
Example : my-zone.com
string
private_dns_id
optional
Private DNS ID
Example :
any of [string, null]
tags
optional
Tag List
array[Tag]
type
required
Type of zone
Example : public
enum (public, private)

7 - HostedZoneCreateResponse

NameDescriptionSchemaDefault
action
required
current action in progress
Example :
string
attributes
optional
Key:Value pairs of information about this zone
Example :
any of [object, null]
created_at
optional
Created Date
Example :
any of [string, null]
description
optional
description
Example :
any of [string, null]
email
required
email
Example :
string
hosted_zone_type
optional
Hosted Zone type
Example :
any of [string, null]
id
required
Id
Example :
string
links
optional
Links to resource
Example :
any of [object, null]
masters
optional
The servers to slave from to get DNS information
Example :
any of [array[string], null]
name
required
name
Example :
string
pool_id
required
Designate Pool ID
Example :
string
project_id
required
ProjectID
Example :
string
serial
required
serial number
Example :
integer
shared
optional
True if the zone is shared with another account
Example :
any of [boolean, null]
status
required
The status
Example :
string
transferred_at
optional
The last time an update was retrieved from the master servers
Example :
any of [string, null]
ttl
optional
TTL for the zone.
Example :
any of [integer, null]
type
optional
Type of zone
Example :
any of [string, null]
updated_at
optional
Updated Date
Example :
any of [string, null]
version
optional
Version
Example :
any of [integer, null]

8 - HostedZoneDeleteResponse

NameDescriptionSchemaDefault
action
required
current action in progress
Example :
string
attributes
optional
Key:Value pairs of information about this zone
Example :
any of [object, null]
created_at
optional
Created Date
Example :
any of [string, null]
description
optional
description
Example :
any of [string, null]
email
required
email
Example :
string
hosted_zone_type
optional
Hosted Zone type
Example :
any of [string, null]
id
required
Id
Example :
string
links
optional
Links to resource
Example :
any of [object, null]
masters
optional
The servers to slave from to get DNS information
Example :
any of [array[string], null]
name
required
name
Example :
string
pool_id
required
Designate Pool ID
Example :
string
project_id
required
ProjectID
Example :
string
serial
required
serial number
Example :
integer
shared
optional
True if the zone is shared with another account
Example :
any of [boolean, null]
status
required
The status
Example :
string
transferred_at
optional
The last time an update was retrieved from the master servers
Example :
any of [string, null]
ttl
optional
TTL for the zone.
Example :
any of [integer, null]
type
optional
Type of zone
Example :
any of [string, null]
updated_at
optional
Updated Date
Example :
any of [string, null]
version
optional
Version
Example :
any of [integer, null]

9 - HostedZoneListResponse

NameDescriptionSchemaDefault
count
optional
total count
Example : 20
any of [integer, null]
links
optional
Links to resource
Example :
any of [object, null]
metadata
optional
Total Count
Example :
any of [object, null]
zones
required
Hosted Zone LIST
array[HostedZone]

10 - HostedZoneListResponseV1Dot1

NameDescriptionSchemaDefault
count
required
Count
Example :
integer
hosted_zones
required
Hosted Zone LIST
array[HostedZone]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
page
required
Page
Example :
integer
size
required
Size
Example :
integer
sort
required
Sort
Example :
string

11 - HostedZoneListResponseV1Dot2

NameDescriptionSchemaDefault
count
required
Count
Example :
integer
hosted_zones
required
Hosted Zone LIST
array[HostedZoneV1Dot2]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
page
required
Page
Example :
integer
size
required
Size
Example :
integer
sort
required
Sort
Example :
string

12 - HostedZoneListResponseV1Dot3

NameDescriptionSchemaDefault
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]

13 - HostedZoneSetRequest

NameDescriptionSchemaDefault
description
optional
description
Example :
any of [string, null]
email
optional
email
Example :
any of [string, null]

14 - HostedZoneSetRequestV1Dot3

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

15 - HostedZoneSetResponse

NameDescriptionSchemaDefault
action
required
current action in progress
Example :
string
attributes
optional
Key:Value pairs of information about this zone
Example :
any of [object, null]
created_at
optional
Created Date
Example :
any of [string, null]
description
optional
description
Example :
any of [string, null]
email
required
email
Example :
string
hosted_zone_type
optional
Hosted Zone type
Example :
any of [string, null]
id
required
Id
Example :
string
links
optional
Links to resource
Example :
any of [object, null]
masters
optional
The servers to slave from to get DNS information
Example :
any of [array[string], null]
name
required
name
Example :
string
pool_id
required
Designate Pool ID
Example :
string
project_id
required
ProjectID
Example :
string
serial
required
serial number
Example :
integer
shared
optional
True if the zone is shared with another account
Example :
any of [boolean, null]
status
required
The status
Example :
string
transferred_at
optional
The last time an update was retrieved from the master servers
Example :
any of [string, null]
ttl
optional
TTL for the zone.
Example :
any of [integer, null]
type
optional
Type of zone
Example :
any of [string, null]
updated_at
optional
Updated Date
Example :
any of [string, null]
version
optional
Version
Example :
any of [integer, null]

16 - HostedZoneShowResponse

NameDescriptionSchemaDefault
action
required
current action in progress
Example :
string
attributes
optional
Key:Value pairs of information about this zone
Example :
any of [object, null]
created_at
optional
Created Date
Example :
any of [string, null]
description
optional
description
Example :
any of [string, null]
email
required
email
Example :
string
hosted_zone_type
optional
Hosted Zone type
Example :
any of [string, null]
id
required
Id
Example :
string
links
optional
Links to resource
Example :
any of [object, null]
masters
optional
The servers to slave from to get DNS information
Example :
any of [array[string], null]
name
required
name
Example :
string
pool_id
required
Designate Pool ID
Example :
string
project_id
required
ProjectID
Example :
string
serial
required
serial number
Example :
integer
shared
optional
True if the zone is shared with another account
Example :
any of [boolean, null]
status
required
The status
Example :
string
transferred_at
optional
The last time an update was retrieved from the master servers
Example :
any of [string, null]
ttl
optional
TTL for the zone.
Example :
any of [integer, null]
type
optional
Type of zone
Example :
any of [string, null]
updated_at
optional
Updated Date
Example :
any of [string, null]
version
optional
Version
Example :
any of [integer, null]

17 - HostedZoneShowResponseV1Dot2

NameDescriptionSchemaDefault
action
required
current action in progress
Example :
string
attributes
optional
Key:Value pairs of information about this zone
Example :
any of [object, null]
created_at
optional
Created Date
Example :
any of [string, null]
description
optional
description
Example :
any of [string, null]
email
required
email
Example :
string
hosted_zone_type
optional
Hosted Zone type
Example :
any of [string, null]
id
required
Id
Example :
string
links
optional
Links to resource
Example :
any of [object, null]
masters
optional
The servers to slave from to get DNS information
Example :
any of [array[string], null]
name
required
name
Example :
string
pool_id
required
Designate Pool ID
Example :
string
private_dns_id
optional
Private DNS ID
Example :
any of [string, null]
private_dns_name
optional
Private DNS Name
Example :
any of [string, null]
project_id
required
ProjectID
Example :
string
serial
required
serial number
Example :
integer
shared
optional
True if the zone is shared with another account
Example :
any of [boolean, null]
status
required
The status
Example :
string
transferred_at
optional
The last time an update was retrieved from the master servers
Example :
any of [string, null]
ttl
optional
TTL for the zone.
Example :
any of [integer, null]
type
optional
Type of zone
Example :
any of [string, null]
updated_at
optional
Updated Date
Example :
any of [string, null]
version
optional
Version
Example :
any of [integer, null]

18 - HostedZoneShowResponseV1Dot3

NameDescriptionSchemaDefault
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]

19 - HostedZoneV1Dot2

NameDescriptionSchemaDefault
action
required
current action in progress
Example :
string
attributes
optional
Key:Value pairs of information about this zone
Example :
any of [object, null]
created_at
optional
Created Date
Example :
any of [string, null]
description
optional
description
Example :
any of [string, null]
email
required
email
Example :
string
hosted_zone_type
optional
Hosted Zone type
Example :
any of [string, null]
id
required
Id
Example :
string
links
optional
Links to resource
Example :
any of [object, null]
masters
optional
The servers to slave from to get DNS information
Example :
any of [array[string], null]
name
required
name
Example :
string
pool_id
required
Designate Pool ID
Example :
string
private_dns_id
optional
Private DNS ID
Example :
any of [string, null]
private_dns_name
optional
Private DNS Name
Example :
any of [string, null]
project_id
required
ProjectID
Example :
string
serial
required
serial number
Example :
integer
shared
optional
True if the zone is shared with another account
Example :
any of [boolean, null]
status
required
The status
Example :
string
transferred_at
optional
The last time an update was retrieved from the master servers
Example :
any of [string, null]
ttl
optional
TTL for the zone.
Example :
any of [integer, null]
type
optional
Type of zone
Example :
any of [string, null]
updated_at
optional
Updated Date
Example :
any of [string, null]
version
optional
Version
Example :
any of [integer, null]

20 - HostedZoneV1Dot3

NameDescriptionSchemaDefault
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]

21 - PrivateDns

NameDescriptionSchemaDefault
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)

22 - PrivateDnsActivateRequest

NameDescriptionSchemaDefault
name
required
Private DNS Name
Example : private-dns01
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string

23 - PrivateDnsCreateRequest

NameDescriptionSchemaDefault
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]

24 - 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]

25 - PrivateDnsSetRequest

NameDescriptionSchemaDefault
connected_vpc_ids
optional
Connected VPC ID
Example :
any of [array[string], null]
description
optional
description
Example : This is description
any of [string, null]

26 - PrivateDnsShowResponse

NameDescriptionSchemaDefault
private_dns
required

PrivateDns

27 - PubblicDomainWhoisInfoUpdateRequest

NameDescriptionSchemaDefault
address_type
required
Address type
Example :
string
domestic_first_address_en
required
Domestic first address (EN)
Example :
string
domestic_first_address_ko
required
Domestic first address (KO)
Example :
string
domestic_second_address_en
required
Domestic second address (EN)
Example :
any of [string, null]
domestic_second_address_ko
required
Domestic second address (KO)
Example :
Maximum length : 16
string
overseas_first_address
required
Overseas address - Address
Example :
any of [string, null]
overseas_second_address
required
Overseas address - City
Example :
any of [string, null]
overseas_third_address
required
Overseas address - State & Country
Example :
any of [string, null]
postal_code
required
Postal code
Example :
Maximum length : 6
string
register_email
required
Register email
Example :
string
register_telno
required
Register telephone number
Example :
string

28 - PublicDomainDetail

NameDescriptionSchemaDefault
address_type
required
Address type
Example :
string
auto_extension
required
Auto extension flag
Example :
boolean
created_at
required
Created Date
Example :
string
created_by
required
Created By_
Example :
string
description
optional
description
Example :
any of [string, null]
domestic_address_en
required
Domestic Address (EN)
Example :
string
domestic_address_ko
required
Domestic Address (KO)
Example :
string
domestic_first_address_en
required
Domestic first address (EN)
Example :
string
domestic_first_address_ko
required
Domestic first address (KO)
Example :
string
domestic_second_address_en
required
Domestic second address (EN)
Example :
string
domestic_second_address_ko
required
Domestic second address (KO)
Example :
string
expired_date
required
Expired date
Example :
string
id
required
ID
Example :
string
modified_at
required
Modified Date
Example :
string
modified_by
required
Modified By_
Example :
string
name
required
Public Domain Name
Example :
string
overseas_address
optional
Overseas Address
Example :
string
overseas_first_address
required
Overseas address - Address
Example :
string
overseas_second_address
required
Overseas address - City
Example :
string
overseas_third_address
required
Overseas address - State & Country
Example :
string
postal_code
required
Postal code
Example :
string
register_email
required
Register email
Example :
string
register_name_en
required
Register Name Overseas
Example :
string
register_name_ko
required
Register Name Domestic
Example :
string
register_telno
required
Register telephone number
Example :
string
start_date
required
Start date
Example :
string
status
required
The status
Example :
string

29 - PublicDomainDetailResponse

NameDescriptionSchemaDefault
public_domain_name
required

PublicDomainDetail

30 - PublicDomainListItem

NameDescriptionSchemaDefault
created_at
required
Start date
Example :
string
created_by
required
Start date
Example :
string
expired_date
required
Expired date
Example :
string
id
required
Id
Example :
string
modified_at
required
Start date
Example :
string
modified_by
required
Start date
Example :
string
name
required
name
Example :
string
register_email
required
Register email
Example :
string
start_date
required
Start date
Example :
string
status
required
The status
Example :
string

31 - 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]

32 - PublicDomainPartialUpdateRequest

NameDescriptionSchemaDefault
auto_extension
optional
Auto extension flag
Example :
any of [boolean, null]
description
optional
description
Example :
any of [string, null]

33 - PublicDomainPartialUpdateResponse

NameDescriptionSchemaDefault
auto_extension
optional
Auto extension flag
Example :
any of [boolean, null]
description
optional
description
Example :
any of [string, null]
id
required
Id
Example :
string

34 - PublicDomainTransferRequest

NameDescriptionSchemaDefault
target_account_id
optional
Target account id (required when type=REQUEST)
Example :
any of [string, null]
type
required
Transfer operation type
Example : REQUEST
enum (REQUEST, CANCEL, APPROVE, REJECT)

35 - PublicDomainTransferResponse

NameDescriptionSchemaDefault
auto_extension
required
Auto extension flag
Example :
boolean
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required
description
Example :
any of [string, null]
expired_date
required
Expired date
Example :
string (date-time)
id
required
ID
Example :
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Public Domain Name
Example :
string
start_date
required
Start date
Example :
string (date-time)
state
required
State
Example : ACTIVE
enum (ACTIVE, CREATING, REGISTERED, EXPIRED, DELETED, TRANSFER_REQUESTING, TRANSFER_REQUESTED, DELETING)

36 - PublicDomainWhoisInfoUpdateResponse

NameDescriptionSchemaDefault
address_type
required
Address type
Example :
string
domestic_first_address_en
required
Domestic first address (EN)
Example :
string
domestic_first_address_ko
required
Domestic first address (KO)
Example :
string
domestic_second_address_en
required
Domestic second address (EN)
Example :
any of [string, null]
domestic_second_address_ko
required
Domestic second address (KO)
Example :
Maximum length : 16
string
name
required
name
Example :
string
overseas_first_address
required
Overseas address - Address
Example :
any of [string, null]
overseas_second_address
required
Overseas address - City
Example :
any of [string, null]
overseas_third_address
required
Overseas address - State & Country
Example :
any of [string, null]
postal_code
required
Postal code
Example :
Maximum length : 6
string
register_email
required
Register email
Example :
string
register_name_en
required
Register Name Overseas
Example :
string
register_name_ko
required
Register Name Domestic
Example :
string
register_telno
required
Register telephone number
Example :
string

37 - Record

NameDescriptionSchemaDefault
action
optional
current action in progress
Example :
any of [string, null]
created_at
optional
Created Date
Example :
any of [string, null]
description
optional
description
Example :
any of [string, null]
id
optional
Id
Example :
any of [string, null]
links
optional
Links to resource
Example :
any of [object, null]
name
optional
name
Example :
any of [string, null]
project_id
optional
ProjectID
Example :
any of [string, null]
records
optional
A list of data for this record
Example :
any of [array[string], null]
status
optional
The status
Example :
any of [string, null]
ttl
optional
TTL for the zone.
Example :
any of [integer, null]
type
optional
Type of the record
Example :
any of [string, null]
updated_at
optional
Updated Date
Example :
any of [string, null]
version
optional
Version
Example :
any of [integer, null]
zone_id
optional
ID for the zone that contains this record
Example :
any of [string, null]
zone_name
optional
The name of the zone that contains this record
Example :
any of [string, null]

38 - RecordCreateRequest

NameDescriptionSchemaDefault
description
optional
description
Example :
any of [string, null]
name
required
name
Example :
string
records
required
A list of data for this record
array[object]
ttl
optional
TTL for the zone.
Example :
any of [integer, null]
type
required
Type of the record
Example :
string

39 - RecordCreateRequestV1Dot0To1Dot2

NameDescriptionSchemaDefault
description
optional
description
Example :
any of [string, null]
name
required
name
Example :
string
records
required
A list of data for this record
array[object]
ttl
optional
TTL for the zone.
Example :
any of [integer, null]
type
required
Type of the record
Example :
string

40 - RecordCreateResponse

NameDescriptionSchemaDefault
action
optional
current action in progress
Example :
any of [string, null]
created_at
optional
Created Date
Example :
any of [string, null]
description
optional
description
Example :
any of [string, null]
id
optional
Id
Example :
any of [string, null]
links
optional
Links to resource
Example :
any of [object, null]
name
optional
name
Example :
any of [string, null]
project_id
optional
ProjectID
Example :
any of [string, null]
records
optional
records for the record
Example :
any of [array[string], null]
status
optional
The status
Example :
any of [string, null]
ttl
optional
TTL for the zone.
Example :
any of [integer, null]
type
optional
Type of the record
Example :
any of [string, null]
updated_at
optional
Updated Date
Example :
any of [string, null]
version
optional
Version
Example :
any of [integer, null]
zone_id
optional
ID for the zone that contains this record
Example :
any of [string, null]
zone_name
optional
The name of the zone that contains this record
Example :
any of [string, null]

41 - RecordListResponse

NameDescriptionSchemaDefault
count
optional
total count
Example : 20
any of [integer, null]
links
optional
Links to resource
Example :
any of [object, null]
metadata
optional
the total count
Example :
any of [object, null]
records
required
record list
array[Record]

42 - RecordSetRequest

NameDescriptionSchemaDefault
records
optional
A list of data for this record
Example :
any of [array[object], null]
ttl
optional
TTL for the record
Example :
any of [integer, null]

43 - RecordSetResponse

NameDescriptionSchemaDefault
action
optional
current action in progress
Example :
any of [string, null]
created_at
optional
Created Date
Example :
any of [string, null]
description
optional
description
Example :
any of [string, null]
id
optional
Id
Example :
any of [string, null]
links
optional
Links to resource
Example :
any of [object, null]
name
optional
name
Example :
any of [string, null]
project_id
optional
ProjectID
Example :
any of [string, null]
records
optional
records for the record
Example :
any of [array[string], null]
status
optional
The status
Example :
any of [string, null]
ttl
optional
TTL for the zone.
Example :
any of [integer, null]
type
optional
Type of the record
Example :
any of [string, null]
updated_at
optional
Updated Date
Example :
any of [string, null]
version
optional
Version
Example :
any of [integer, null]
zone_id
optional
ID for the zone that contains this record
Example :
any of [string, null]
zone_name
optional
The name of the zone that contains this record
Example :
any of [string, null]

44 - RecordShowResponse

NameDescriptionSchemaDefault
action
optional
current action in progress
Example :
any of [string, null]
created_at
optional
Created Date
Example :
any of [string, null]
description
optional
description
Example :
any of [string, null]
id
optional
Id
Example :
any of [string, null]
links
optional
Links to resource
Example :
any of [object, null]
name
optional
name
Example :
any of [string, null]
project_id
optional
ProjectID
Example :
any of [string, null]
records
optional
records for the record.
Example :
any of [array[string], null]
status
optional
The status
Example :
any of [string, null]
ttl
optional
TTL for the zone.
Example :
any of [integer, null]
type
optional
Type of the record
Example :
any of [string, null]
updated_at
optional
Updated Date
Example :
any of [string, null]
version
optional
Version
Example :
any of [integer, null]
zone_id
optional
ID for the zone that contains this record
Example :
any of [string, null]
zone_name
optional
The name of the zone that contains this record
Example :
any of [string, null]

45 - Tag

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