Scaleway logo
Domain names - Registrar API
Domain names - Registrar API

Schemas

Download schema

google.protobuf.BoolValue

boolean | null

google.protobuf.Int32Value

integer | null · int32

google.protobuf.StringValue

string | null

google.type.Money

currency_code
​string
units
​integer · int64
nanos
​integer · int32

scaleway.domain.v2beta1.AvailableDomain

domain
​string
available
​boolean

scaleway.domain.v2beta1.CheckContactsCompatibilityResponse

compatible
​boolean

scaleway.domain.v2beta1.CheckContactsCompatibilityResponse.ContactCheckResult

compatible
​boolean
error_message
​google.protobuf.StringValue

scaleway.domain.v2beta1.Contact

id
​string
legal_form
​scaleway.domain.v2beta1.Contact.LegalForm · enum
Enum values:
legal_form_unknown
individual
corporate
association
other
Default: legal_form_unknown
firstname
​string
lastname
​string
company_name
​string
email
​string
email_alt
​string
phone_number
​string
fax_number
​string
address_line_1
​string
address_line_2
​string
zip
​string
city
​string
country
​string
vat_identification_code
​string
company_identification_code
​string
lang
​scaleway.std.LanguageCode · enum
Enum values:
unknown_language_code
en_US
fr_FR
de_DE
Default: unknown_language_code
resale
​boolean
whois_opt_in
​boolean
email_status
​scaleway.domain.v2beta1.Contact.EmailStatus · enum
Enum values:
email_status_unknown
validated
not_validated
invalid_email
Default: email_status_unknown
state
​string
status
​scaleway.domain.v2beta1.Contact.Status · enum
Enum values:
status_unknown
active
pending
Default: status_unknown

scaleway.domain.v2beta1.Contact.EmailStatus

string · enum
Enum values:
email_status_unknown
validated
not_validated
invalid_email
Default: email_status_unknown

scaleway.domain.v2beta1.Contact.ExtensionEU

european_citizenship
​string

scaleway.domain.v2beta1.Contact.ExtensionFR

Enum values:
mode_unknown
individual
company_identification_code
duns
local
association
trademark
code_auth_afnic
Default: mode_unknown
​
​
​
​
​

scaleway.domain.v2beta1.Contact.ExtensionFR.AssociationInfo

publication_jo
​string | null · date-time

(RFC 3339 format)

publication_jo_page
​integer · uint32

scaleway.domain.v2beta1.Contact.ExtensionFR.CodeAuthAfnicInfo

code_auth_afnic
​string

scaleway.domain.v2beta1.Contact.ExtensionFR.DunsInfo

duns_id
​string
local_id
​string

scaleway.domain.v2beta1.Contact.ExtensionFR.IndividualInfo

whois_opt_in
​boolean

scaleway.domain.v2beta1.Contact.ExtensionFR.Mode

string · enum
Enum values:
mode_unknown
individual
company_identification_code
duns
local
association
trademark
code_auth_afnic
Default: mode_unknown

scaleway.domain.v2beta1.Contact.ExtensionFR.TrademarkInfo

trademark_inpi
​string

scaleway.domain.v2beta1.Contact.ExtensionIT

pin
​string · required

Domain name registrant's Taxcode (mandatory / only optional when the trustee is used). Domain name registrant's Taxcode (mandatory / only optional when the trustee is used)

If the requester:

  • is an Italian natural person it contains his/her Codice Fiscale (16 characters format).
  • For others than residents of IT it can contain a document number. (ID Card).
  • In all other cases it must be equal to VAT number (in the 16 characters format if nationality is IT) or the numeric Codice Fiscale.

scaleway.domain.v2beta1.Contact.ExtensionNL

Enum values:
legal_form_unknown
other
non_dutch_eu_company
non_dutch_legal_form_enterprise_subsidiary
limited_company
limited_company_in_formation
cooperative
limited_partnership
Default: legal_form_unknown
legal_form_registration_number
​string

scaleway.domain.v2beta1.Contact.ExtensionNL.LegalForm

string · enum
Enum values:
legal_form_unknown
other
non_dutch_eu_company
non_dutch_legal_form_enterprise_subsidiary
limited_company
limited_company_in_formation
cooperative
limited_partnership
Default: legal_form_unknown

scaleway.domain.v2beta1.Contact.LegalForm

string · enum
Enum values:
legal_form_unknown
individual
corporate
association
other
Default: legal_form_unknown

scaleway.domain.v2beta1.Contact.Question

question
​string
answer
​string

scaleway.domain.v2beta1.Contact.Status

string · enum
Enum values:
status_unknown
active
pending
Default: status_unknown

scaleway.domain.v2beta1.ContactRoles

​object

scaleway.domain.v2beta1.ContactRoles.Roles

is_owner
​boolean
is_administrative
​boolean
is_technical
​boolean

scaleway.domain.v2beta1.DNSZone

domain
​string
subdomain
​string
ns
​string[]
ns_default
​string[]
ns_master
​string[]
status
​scaleway.domain.v2beta1.DNSZone.Status · enum
Enum values:
unknown
active
pending
error
locked
Default: unknown
updated_at
​string | null · date-time

(RFC 3339 format)

project_id
​string
Enum values:
unknown_product
vpc

scaleway.domain.v2beta1.DNSZone.Status

string · enum
Enum values:
unknown
active
pending
error
locked
Default: unknown

scaleway.domain.v2beta1.DSRecord

key_id
​integer · uint32
algorithm
​scaleway.domain.v2beta1.DSRecord.Algorithm · enum
Enum values:
rsamd5
dh
dsa
rsasha1
dsa_nsec3_sha1
rsasha1_nsec3_sha1
rsasha256
rsasha512
Default: rsamd5
​
​

scaleway.domain.v2beta1.DSRecord.Algorithm

string · enum
Enum values:
rsamd5
dh
dsa
rsasha1
dsa_nsec3_sha1
rsasha1_nsec3_sha1
rsasha256
rsasha512
Default: rsamd5

scaleway.domain.v2beta1.DSRecord.Digest

Enum values:
sha_1
sha_256
gost_r_34_11_94
sha_384
Default: sha_1
digest
​string

scaleway.domain.v2beta1.DSRecord.Digest.Type

string · enum
Enum values:
sha_1
sha_256
gost_r_34_11_94
sha_384
Default: sha_1

scaleway.domain.v2beta1.DSRecord.PublicKey

key
​string

scaleway.domain.v2beta1.DeleteExternalDomainResponse

scaleway.domain.v2beta1.Domain

domain
​string
organization_id
​string
project_id
​string
auto_renew_status
​scaleway.domain.v2beta1.Domain.FeatureStatus · enum

Status of the automatic renewal of the domain.

Enum values:
feature_status_unknown
enabling
enabled
disabling
disabled
Default: feature_status_unknown

Status of the DNSSEC configuration of the domain.

epp_code
​string[]

List of the domain's EPP codes.

expired_at
​string | null · date-time

Date of expiration of the domain. (RFC 3339 format)

updated_at
​string | null · date-time

Domain's last modification date. (RFC 3339 format)

registrar
​string
is_external
​boolean

Indicates whether Scaleway is the domain's registrar.

status
​scaleway.domain.v2beta1.Domain.Status · enum

Status of the domain.

Enum values:
status_unknown
active
creating
create_error
renewing
renew_error
xfering
xfer_error
Default: status_unknown

List of the domain's DNS zones.

​scaleway.domain.v2beta1.Contact

Contact information of the domain's owner.

​scaleway.domain.v2beta1.Contact

Contact information of the domain's technical contact.

​scaleway.domain.v2beta1.Contact

Contact information of the domain's administrative contact.

​

Registration status of an external domain, if available.

​

Status of a domain, when available for transfer.

Domain's TLD information.

List of Scaleway resources linked to the domain.

Enum values:
unknown_product
vpc
pending_trade
​boolean

Indicates if a trade is ongoing.

scaleway.domain.v2beta1.Domain.DNSSEC

status
​scaleway.domain.v2beta1.Domain.FeatureStatus · enum
Enum values:
feature_status_unknown
enabling
enabled
disabling
disabled
Default: feature_status_unknown

scaleway.domain.v2beta1.Domain.FeatureStatus

string · enum
Enum values:
feature_status_unknown
enabling
enabled
disabling
disabled
Default: feature_status_unknown

scaleway.domain.v2beta1.Domain.RegistrationStatusExternalDomain

validation_token
​string

scaleway.domain.v2beta1.Domain.RegistrationStatusTransfer

Enum values:
status_unknown
pending
waiting_vote
rejected
processing
done
Default: status_unknown
vote_current_owner
​boolean
vote_new_owner
​boolean

scaleway.domain.v2beta1.Domain.RegistrationStatusTransfer.Status

string · enum
Enum values:
status_unknown
pending
waiting_vote
rejected
processing
done
Default: status_unknown

scaleway.domain.v2beta1.Domain.Status

string · enum
Enum values:
status_unknown
active
creating
create_error
renewing
renew_error
xfering
xfer_error
Default: status_unknown

scaleway.domain.v2beta1.DomainSummary

domain
​string
project_id
​string
auto_renew_status
​scaleway.domain.v2beta1.Domain.FeatureStatus · enum
Enum values:
feature_status_unknown
enabling
enabled
disabling
disabled
Default: feature_status_unknown
dnssec_status
​scaleway.domain.v2beta1.Domain.FeatureStatus · enum
Enum values:
feature_status_unknown
enabling
enabled
disabling
disabled
Default: feature_status_unknown
epp_code
​string[]
expired_at
​string | null · date-time

(RFC 3339 format)

updated_at
​string | null · date-time

(RFC 3339 format)

registrar
​string
is_external
​boolean
status
​scaleway.domain.v2beta1.Domain.Status · enum
Enum values:
status_unknown
active
creating
create_error
renewing
renew_error
xfering
xfer_error
Default: status_unknown
​
​
organization_id
​string
created_at
​string | null · date-time

(RFC 3339 format)

pending_trade
​boolean

scaleway.domain.v2beta1.GetDomainAuthCodeResponse

auth_code
​string

scaleway.domain.v2beta1.Host

domain
​string
name
​string
ips
​string[]

(IP address)

status
​scaleway.domain.v2beta1.Host.Status · enum
Enum values:
unknown_status
active
updating
deleting
Default: unknown_status

scaleway.domain.v2beta1.Host.Status

string · enum
Enum values:
unknown_status
active
updating
deleting
Default: unknown_status

scaleway.domain.v2beta1.InboundTransfer

id
​string

The unique identifier of the inbound transfer.

created_at
​string | null · date-time

The creation date of the inbound transfer. (RFC 3339 format)

last_updated_at
​string | null · date-time

The last modification date of the inbound transfer. (RFC 3339 format)

project_id
​string

The project ID associated with the inbound transfer.

domain
​string

The domain associated with the inbound transfer.

Inbound transfer status.

Enum values:
unknown
in_progress
done
err_internal
err_domain_pending
err_already_transferring
err_transfer_prohibited
err_transfer_impossible
Default: unknown
message
​string

Human-friendly message to describe the current inbound transfer status.

task_id
​string

The unique identifier of the associated task.

scaleway.domain.v2beta1.InboundTransfer.Status

string · enum
Enum values:
unknown
in_progress
done
err_internal
err_domain_pending
err_already_transferring
err_transfer_prohibited
err_transfer_impossible
Default: unknown

scaleway.domain.v2beta1.LinkedProduct

string · enum
Enum values:
unknown_product
vpc
Default: unknown_product

scaleway.domain.v2beta1.ListContactsRequest.Role

string · enum
Enum values:
unknown_role
owner
administrative
technical
Default: unknown_role

scaleway.domain.v2beta1.ListContactsResponse

total_count
​integer · uint32

scaleway.domain.v2beta1.ListDomainHostsResponse

total_count
​integer · uint32

scaleway.domain.v2beta1.ListDomainsRequest.OrderBy

string · enum
Enum values:
domain_asc
domain_desc
Default: domain_asc

scaleway.domain.v2beta1.ListDomainsResponse

total_count
​integer · uint32

scaleway.domain.v2beta1.ListInboundTransfersResponse

total_count
​integer · uint32

scaleway.domain.v2beta1.ListRenewableDomainsRequest.OrderBy

string · enum
Enum values:
domain_asc
domain_desc
Default: domain_asc

scaleway.domain.v2beta1.ListRenewableDomainsResponse

total_count
​integer · uint32

scaleway.domain.v2beta1.ListTasksRequest.OrderBy

string · enum
Enum values:
domain_desc
domain_asc
type_asc
type_desc
status_asc
status_desc
updated_at_asc
updated_at_desc
Default: domain_desc

scaleway.domain.v2beta1.ListTasksResponse

total_count
​integer · uint32

scaleway.domain.v2beta1.ListTldsRequest.OrderBy

string · enum
Enum values:
name_asc
name_desc
Default: name_asc

scaleway.domain.v2beta1.ListTldsResponse

Array of TLDs.

total_count
​integer · uint64

Total count of TLDs returned.

scaleway.domain.v2beta1.NewContact

legal_form
​scaleway.domain.v2beta1.Contact.LegalForm · enum
Enum values:
legal_form_unknown
individual
corporate
association
other
Default: legal_form_unknown
firstname
​string
lastname
​string
company_name
​google.protobuf.StringValue
email
​string
phone_number
​string
fax_number
​google.protobuf.StringValue
address_line_1
​string
address_line_2
​google.protobuf.StringValue
zip
​string
city
​string
country
​string
vat_identification_code
​google.protobuf.StringValue
company_identification_code
​google.protobuf.StringValue
lang
​scaleway.std.LanguageCode · enum
Enum values:
unknown_language_code
en_US
fr_FR
de_DE
Default: unknown_language_code
resale
​boolean
whois_opt_in
​boolean

scaleway.domain.v2beta1.OrderResponse

domains
​string[]
organization_id
​string
project_id
​string
task_id
​string
created_at
​string | null · date-time

(RFC 3339 format)

scaleway.domain.v2beta1.RegisterExternalDomainResponse

domain
​string
organization_id
​string
validation_token
​string
created_at
​string | null · date-time

(RFC 3339 format)

project_id
​string

scaleway.domain.v2beta1.RenewableDomain

domain
​string
project_id
​string
organization_id
​string
Enum values:
unknown
renewable
late_reneweable
not_renewable
Default: unknown
renewable_duration_in_years
​google.protobuf.Int32Value · int32
expired_at
​string | null · date-time

(RFC 3339 format)

limit_renew_at
​string | null · date-time

(RFC 3339 format)

limit_redemption_at
​string | null · date-time

(RFC 3339 format)

estimated_delete_at
​string | null · date-time

(RFC 3339 format)

scaleway.domain.v2beta1.RenewableDomain.Status

string · enum
Enum values:
unknown
renewable
late_reneweable
not_renewable
Default: unknown

scaleway.domain.v2beta1.RetryInboundTransferResponse

scaleway.domain.v2beta1.SearchAvailableDomainsResponse

Array of available domains.

​scaleway.domain.v2beta1.AvailableDomain

If an exact match was asked and found, the result is in this field.

scaleway.domain.v2beta1.Task

id
​string

The unique identifier of the task.

project_id
​string

The project ID associated to the task.

organization_id
​string

The organization ID associated to the task.

domain
​string | null

The domain name associated to the task.

type
​scaleway.domain.v2beta1.Task.Type · enum

The type of the task.

Enum values:
unknown
create_domain
create_external_domain
renew_domain
transfer_domain
trade_domain
lock_domain_transfer
unlock_domain_transfer
Default: unknown
status
​scaleway.domain.v2beta1.Task.Status · enum

The status of the task.

Enum values:
unavailable
new
waiting_payment
pending
success
error
Default: unavailable
started_at
​string | null · date-time

Start date of the task. (RFC 3339 format)

updated_at
​string | null · date-time

Last update of the task. (RFC 3339 format)

message
​string | null

Error message associated to the task.

contact_identifier
​string | null

Human-friendly contact identifier used when the task concerns a contact.

scaleway.domain.v2beta1.Task.Status

string · enum
Enum values:
unavailable
new
waiting_payment
pending
success
error
Default: unavailable

scaleway.domain.v2beta1.Task.Type

string · enum
Enum values:
unknown
create_domain
create_external_domain
renew_domain
transfer_domain
trade_domain
lock_domain_transfer
unlock_domain_transfer
Default: unknown

scaleway.domain.v2beta1.Tld

name
​string
dnssec_support
​boolean
duration_in_years_min
​integer · uint32
duration_in_years_max
​integer · uint32
idn_support
​boolean
​object
​object

scaleway.domain.v2beta1.Tld.Offer

action
​string
operation_path
​string
​google.type.Money

scaleway.domain.v2beta1.TransferInDomainRequest.TransferRequest

domain
​string
auth_code
​string

scaleway.domain.v2beta1.UpdateContactRequest.Question

scaleway.std.LanguageCode

string · enum
Enum values:
unknown_language_code
en_US
fr_FR
de_DE
Default: unknown_language_code

scaleway.std.StringsValue