Domains and DNS - Registrar API
​boolean​google.protobuf.StringValue​string​scaleway.domain.v2beta1.Contact.LegalForm · enum​string​string​string​string​string​string​string​string​string​string​string​string​string​string​scaleway.std.LanguageCode · enum​boolean​boolean​scaleway.domain.v2beta1.Contact.EmailStatus · enum​string​scaleway.domain.v2beta1.Contact.Status · enum​scaleway.domain.v2beta1.Contact.ExtensionFR.Mode · enum​string · required​string · deprecated​string · deprecated​scaleway.domain.v2beta1.Contact.ExtensionNL.LegalForm · enum​string​boolean​boolean​boolean​string​string​string[]​string[]​string[]​scaleway.domain.v2beta1.DNSZone.Status · enum​google.protobuf.StringValue​string · date-time​string​scaleway.domain.v2beta1.LinkedProduct[]​integer · uint32​scaleway.domain.v2beta1.DSRecord.Algorithm · enum​string​string​string​string · enum​string[]​string · date-time​string · date-time​string​boolean​string · enum​scaleway.domain.v2beta1.LinkedProduct[]​boolean​string​string​scaleway.domain.v2beta1.Domain.FeatureStatus · enum​scaleway.domain.v2beta1.Domain.FeatureStatus · enum​string[]​string · date-time​string · date-time​string​boolean​scaleway.domain.v2beta1.Domain.Status · enum​string​string · date-time​boolean​string​string​string[]​scaleway.domain.v2beta1.Host.Status · enum​string​string · date-time​string · date-time​string​string​string · enum​string​string​integer · uint64​string[]​string​string​string​string · date-time​string​string​string​string · date-time​string​string​string​string​scaleway.domain.v2beta1.RenewableDomain.Status · enum​google.protobuf.Int32Value · int32​string · date-time​string · date-time​string · date-time​string · date-time​string​string​string​string​string · enum​string · enum​string · date-time​string · date-time​string​string​string​boolean​integer · uint32​integer · uint32​boolean​google.protobuf.StringValue​google.protobuf.StringValue
scaleway.domain.v2beta1.CheckContactsCompatibilityResponse.ContactCheckResult
compatibleerror_messagescaleway.domain.v2beta1.Contact
idlegal_formEnum values:
legal_form_unknown
individual
corporate
association
other
Default: legal_form_unknown
firstnamelastnamecompany_nameemailemail_altphone_numberfax_numberaddress_line_1address_line_2zipcitycountryvat_identification_codecompany_identification_codelangEnum values:
unknown_language_code
en_US
fr_FR
de_DE
Default: unknown_language_code
resalewhois_opt_inemail_statusEnum values:
email_status_unknown
validated
not_validated
invalid_email
Default: email_status_unknown
statestatusEnum values:
status_unknown
active
pending
Default: status_unknown
​scaleway.domain.v2beta1.Contact.Question[] · deprecated
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.ExtensionFR
modeEnum values:
mode_unknown
individual
company_identification_code
duns
local
association
trademark
code_auth_afnic
Default: mode_unknown
​object
​object
​object
​object
​object
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.ExtensionIT
pinDomain 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.
european_citizenshipThis option is useless anymore.
tax_codeTax_code is renamed to pin.
scaleway.domain.v2beta1.Contact.ExtensionNL
legal_formEnum 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_numberscaleway.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.Status
string · enum
Enum values:
status_unknown
active
pending
Default: status_unknown
scaleway.domain.v2beta1.ContactRoles.Roles
is_owneris_administrativeis_technicalscaleway.domain.v2beta1.DNSZone
domainsubdomainnsns_defaultns_masterstatusEnum values:
unknown
active
pending
error
locked
Default: unknown
messageupdated_at(RFC 3339 format)
project_idlinked_productsEnum 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_idalgorithmEnum values:
rsamd5
dh
dsa
rsasha1
dsa_nsec3_sha1
rsasha1_nsec3_sha1
rsasha256
rsasha512
Default: rsamd5
​object
​object
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.Type
string · enum
Enum values:
sha_1
sha_256
gost_r_34_11_94
sha_384
Default: sha_1
scaleway.domain.v2beta1.Domain
domainorganization_idproject_idauto_renew_statusStatus of the automatic renewal of the domain.
Enum values:
feature_status_unknown
enabling
enabled
disabling
disabled
Default: feature_status_unknown
​object
Status of the DNSSEC configuration of the domain.
epp_codeList of the domain's EPP codes.
expired_atDate of expiration of the domain. (RFC 3339 format)
updated_atDomain's last modification date. (RFC 3339 format)
registraris_externalIndicates whether Scaleway is the domain's registrar.
statusStatus 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.
​object
Contact information of the domain's owner.
​object
Contact information of the domain's technical contact.
​object
Contact information of the domain's administrative contact.
​object
Registration status of an external domain, if available.
​object
Status of a domain, when available for transfer.
​object
Domain's TLD information.
linked_productsList of Scaleway resources linked to the domain.
Enum values:
unknown_product
vpc
pending_tradeIndicates if a trade is ongoing.
scaleway.domain.v2beta1.Domain.FeatureStatus
string · enum
Enum values:
feature_status_unknown
enabling
enabled
disabling
disabled
Default: feature_status_unknown
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
domainproject_idauto_renew_statusEnum values:
feature_status_unknown
enabling
enabled
disabling
disabled
Default: feature_status_unknown
dnssec_statusEnum values:
feature_status_unknown
enabling
enabled
disabling
disabled
Default: feature_status_unknown
epp_codeexpired_at(RFC 3339 format)
updated_at(RFC 3339 format)
registraris_externalstatusEnum values:
status_unknown
active
creating
create_error
renewing
renew_error
xfering
xfer_error
Default: status_unknown
​object
​object
organization_idcreated_at(RFC 3339 format)
pending_tradescaleway.domain.v2beta1.Host
domainnameips(IP address)
statusEnum 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
idThe unique identifier of the inbound transfer.
created_atThe creation date of the inbound transfer. (RFC 3339 format)
last_updated_atThe last modification date of the inbound transfer. (RFC 3339 format)
project_idThe project ID associated with the inbound transfer.
domainThe domain associated with the inbound transfer.
statusInbound transfer status.
Enum values:
unknown
in_progress
done
err_internal
err_domain_pending
err_already_transferring
err_transfer_prohibited
err_transfer_impossible
Default: unknown
messageHuman-friendly message to describe the current inbound transfer status.
task_idThe unique identifier of the associated task.
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.ListDomainsRequest.OrderBy
string · enum
Enum values:
domain_asc
domain_desc
Default: domain_asc
scaleway.domain.v2beta1.ListRenewableDomainsRequest.OrderBy
string · enum
Enum values:
domain_asc
domain_desc
Default: domain_asc
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.ListTldsResponse
Array of TLDs.
total_countTotal count of TLDs returned.
scaleway.domain.v2beta1.OrderResponse
domainsorganization_idproject_idtask_idcreated_at(RFC 3339 format)
scaleway.domain.v2beta1.RegisterExternalDomainResponse
domainorganization_idvalidation_tokencreated_at(RFC 3339 format)
project_idscaleway.domain.v2beta1.RenewableDomain
domainproject_idorganization_idstatusEnum values:
unknown
renewable
late_reneweable
not_renewable
Default: unknown
renewable_duration_in_yearsexpired_at(RFC 3339 format)
limit_renew_at(RFC 3339 format)
limit_redemption_at(RFC 3339 format)
estimated_delete_at(RFC 3339 format)
scaleway.domain.v2beta1.RenewableDomain.Status
string · enum
Enum values:
unknown
renewable
late_reneweable
not_renewable
Default: unknown
scaleway.domain.v2beta1.SearchAvailableDomainsResponse
Array of available domains.
​object
If an exact match was asked and found, the result is in this field.
scaleway.domain.v2beta1.Task
idThe unique identifier of the task.
project_idThe project ID associated to the task.
organization_idThe organization ID associated to the task.
domainThe domain name associated to the task.
typeThe 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
statusThe status of the task.
Enum values:
unavailable
new
waiting_payment
pending
success
error
Default: unavailable
started_atStart date of the task. (RFC 3339 format)
updated_atLast update of the task. (RFC 3339 format)
messageError message associated to the task.
contact_identifierHuman-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
namednssec_supportduration_in_years_minduration_in_years_maxidn_support​object
​object
scaleway.domain.v2beta1.UpdateContactRequest.Question
questionanswer