Welcome to the Subdomain Management Guide for Superlink’s free subdomain service. This page outlines the steps and prerequisites required to create and delete subdomains for the parent domains which you have onboarded with us.

Prerequisites

Before proceeding, ensure that the Superlink SDK is correctly installed and configured within your environment. For detailed instructions, please refer to our SDK Setup Guide.

Subdomain Management

There are only two actions you can perform with a subdomain: creation or deletion. This policy ensures the integrity of subdomains by preventing updates or modifications after creation. Additionally, a cooldown period follows the revocation of a subdomain, preventing immediate recreation with new details.

Creating a Subdomain

To create a subdomain, utilize the following APIs:

  1. Subdomain Available API — confirms if the subdomain is available for creation.
  2. Subdomain Mint API — facilitates the creation of the subdomain.

Please note: All domain information must be provided at the time of creation, as updates are not permitted post-creation. This policy is designed to enhance trust among all parties involved. Also an eth address is required as it is used for reverse resolution

Revoking a Subdomain

To revoke a subdomain, use the Subdomain Revoke API, which will delete the subdomain and all associated information. A cooldown period ensues, during which the subdomain name cannot be reused. This measure is in place to prevent the potential misuse of changing information for a domain already in use by a customer.