Manage your domains
List domains
Retrieve the list of domains you own.
query Parameters
pagepage_sizeorder_byregistrarstatusproject_idorganization_idis_externaldomainList domains › Responses
total_countGet domain
Retrieve a specific domain and display the domain's information.
path Parameters
domainGet domain › Responses
domainorganization_idproject_idauto_renew_statusStatus of the automatic renewal of the domain.
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.
List of the domain's DNS zones.
Contact information of the domain's owner.
Contact information of the domain's technical 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.
linked_productsList of Scaleway resources linked to the domain.
pending_tradeIndicates if a trade is ongoing.
Update a domain's contacts
Update contacts for a specific domain or create a new contact.
If you add the same contact for multiple roles (owner, administrative, technical), only one ID will be created and used for all of the roles.
path Parameters
domainUpdate a domain's contacts › Request Body
technical_contact_idadministrative_contact_idowner_contact_idUpdate a domain's contacts › Responses
domainorganization_idproject_idauto_renew_statusStatus of the automatic renewal of the domain.
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.
List of the domain's DNS zones.
Contact information of the domain's owner.
Contact information of the domain's technical 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.
linked_productsList of Scaleway resources linked to the domain.
pending_tradeIndicates if a trade is ongoing.
Get a domain's authorization code
Retrieve the authorization code to transfer an unlocked domain. The output returns an error if the domain is locked. Some TLDs may have a different procedure to retrieve the authorization code. In that case, the information displays in the message field.
path Parameters
domainGet a domain's authorization code › Responses
auth_codeDisable auto renew
Disable the auto renew feature for a domain. This means the domain will not be renewed before its expiry date.
path Parameters
domainDisable auto renew › Responses
domainorganization_idproject_idauto_renew_statusStatus of the automatic renewal of the domain.
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.
List of the domain's DNS zones.
Contact information of the domain's owner.
Contact information of the domain's technical 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.
linked_productsList of Scaleway resources linked to the domain.
pending_tradeIndicates if a trade is ongoing.
Disable a domain's DNSSEC
Disable DNSSEC for a domain.
path Parameters
domainDisable a domain's DNSSEC › Responses
domainorganization_idproject_idauto_renew_statusStatus of the automatic renewal of the domain.
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.
List of the domain's DNS zones.
Contact information of the domain's owner.
Contact information of the domain's technical 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.
linked_productsList of Scaleway resources linked to the domain.
pending_tradeIndicates if a trade is ongoing.
Enable auto renew
Enable the auto renew feature for a domain. This means the domain will be automatically renewed before its expiry date.
path Parameters
domainEnable auto renew › Responses
domainorganization_idproject_idauto_renew_statusStatus of the automatic renewal of the domain.
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.
List of the domain's DNS zones.
Contact information of the domain's owner.
Contact information of the domain's technical 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.
linked_productsList of Scaleway resources linked to the domain.
pending_tradeIndicates if a trade is ongoing.
Update domain DNSSEC
If your domain uses another registrar and has the default Scaleway NS, you have to update the DS record at your registrar.
path Parameters
domainUpdate domain DNSSEC › Responses
domainorganization_idproject_idauto_renew_statusStatus of the automatic renewal of the domain.
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.
List of the domain's DNS zones.
Contact information of the domain's owner.
Contact information of the domain's technical 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.
linked_productsList of Scaleway resources linked to the domain.
pending_tradeIndicates if a trade is ongoing.
List a domain's hostnames
List a domain's hostnames using their glue IPs.
path Parameters
domainquery Parameters
pagepage_sizeList a domain's hostnames › Responses
total_countCreate a hostname for a domain
Create a hostname for a domain with glue IPs.
path Parameters
domainCreate a hostname for a domain › Responses
domainnameips(IP address)
statusDelete a domain's hostname
path Parameters
domainnameDelete a domain's hostname › Responses
domainnameips(IP address)
statusUpdate a domain's hostname
Update a domain's hostname with glue IPs.
path Parameters
domainnameUpdate a domain's hostname › Responses
domainnameips(IP address)
statusLock the transfer of a domain
Lock the transfer of a domain. This means that the domain cannot be transferred and the authorization code cannot be requested to your current registrar.
path Parameters
domainLock the transfer of a domain › Responses
domainorganization_idproject_idauto_renew_statusStatus of the automatic renewal of the domain.
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.
List of the domain's DNS zones.
Contact information of the domain's owner.
Contact information of the domain's technical 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.
linked_productsList of Scaleway resources linked to the domain.
pending_tradeIndicates if a trade is ongoing.
Unlock the transfer of a domain
Unlock the transfer of a domain. This means that the domain can be transferred and the authorization code can be requested to your current registrar.
path Parameters
domainUnlock the transfer of a domain › Responses
domainorganization_idproject_idauto_renew_statusStatus of the automatic renewal of the domain.
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.
List of the domain's DNS zones.
Contact information of the domain's owner.
Contact information of the domain's technical 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.
linked_productsList of Scaleway resources linked to the domain.
pending_tradeIndicates if a trade is ongoing.
List domains that can be renewed
Retrieve the list of domains you own that can be renewed. You can also see the maximum renewal duration in years for your domains that are renewable.
query Parameters
pagepage_sizeorder_byproject_idorganization_idList domains that can be renewed › Responses
total_countSearch available domains
Search a domain or a maximum of 10 domains that are available.
If the TLD list is empty or not set, the search returns the results from the most popular TLDs.
query Parameters
domainsA list of domain to search, TLD is optional.
strict_searchSearch exact match.
include_exact_matchIf an exact match is found, include it in response as a separate element.
tldsArray of tlds to search on.
Search available domains › Responses
Array of available domains.
If an exact match was asked and found, the result is in this field.
List TLD offers
Retrieve the list of TLDs and offers associated with them.
query Parameters
tldsArray of TLDs to return.
pagePage number for the returned Projects.
page_sizeMaximum number of Project per page.
order_bySort order of the returned TLDs.
List TLD offers › Responses
Array of TLDs.
total_countTotal count of TLDs returned.