Class RegistrarAPI

Purchase domains. Request the registration of domain names. You can provide a domain's already existing contact or a new contact.

Check if contacts are compatible with a domain or a TLD. Check whether contacts are compatible with a domain or a TLD. If contacts are not compatible with either the domain or the TLD, the information that needs to be corrected is returned.

Create a hostname for a domain. Create a hostname for a domain with glue IPs.

Delete a domain's hostname.

Delete an external domain. Delete an external domain name.

Disable auto renew. Disable the auto renew feature for a domain. This means the domain will not be renewed before its expiry date.

Disable a domain's DNSSEC. Disable DNSSEC for a domain.

Enable auto renew. Enable the auto renew feature for a domain. This means the domain will be automatically renewed before its expiry date.

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.

Get a contact. Retrieve a contact's details from the registrar using the given contact's ID.

Get domain. Retrieve a specific domain and display the domain's information.

Get a domain's authorization code. Retrieve the authorization code to tranfer 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.

List contacts. Retrieve the list of contacts and their associated domains and roles. You can filter the list by domain name.

List a domain's hostnames. List a domain's hostnames using their glue IPs.

List domains. Retrieve the list of domains you own.

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.

List tasks. List all operations performed on the account. You can filter the list of tasks by domain name.

List TLD offers. Retrieve the list of TLDs and offers associated with them.

Lock 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.

Register an external domain. Request the registration of an external domain name.

Renew domains. Request the renewal of one or more domain names.

Search 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.

Trade a domain's contact. Request to change a domain's contact owner.
If you specify the organization_id of the domain's new owner, the contact will change from the current owner's Scaleway account to the new owner's Scaleway account.
If the new owner's current contact information is not available, the first ever contact they have created for previous domains is taken into account to operate the change.
If the new owner has never created a contact to register domains before, an error message displays.

Transfer a domain. Request the transfer of a domain from another registrar to Scaleway Domains and DNS.

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.

Update contact. Edit the contact's information.

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.

Update a domain's hostname. Update a domain's hostname with glue IPs.

Waits for Domain to be in a final state.