Create Realtime Register API Key

To maintain security, we configure the API using the principle of least privilege. Follow the steps below to create a dedicated user role, assign it to a new user, and ensure access is limited to only what is necessary.

Written By Corné van ctrlDNS

Last updated 5 months ago

Create a user role

  1. Open your browser and go to Account → Users, then click on the User roles tab or visit https://dm.realtimeregister.com/app/user-roles (for production) or https://dm.yoursrs-ote.com/app/user-roles (for OT&E environment).

  2. Click New user role.

  3. In the Name field, enter: ctrlDNS.

  4. In the Description field, enter: ctrlDNS.

  5. Under Permissions, select only the following options:

    • Update DNS zone (UPDATE_DNS_ZONE)

    • Create DNS zone (CREATE_DNS_ZONE)

    • Delete DNS zone (DELETE_DNS_ZONE)

    • View DNS zone (VIEW_DNS_ZONE)

    • View DNS zone statistics (VIEW_DNS_ZONE_STATS)

  6. Click Create to create the new user role.

Create a user

We will now create a new user and assign the previously created role.

  1. Go to Account → Users or visit https://dm.realtimeregister.com/app/users/create (for production) or https://dm.yoursrs-ote.com/app/users/create (for OT&E environment).

  2. Click New user.

  3. In the User login name field, enter: ctrlDNS.

  4. Fill in the required fields for Password, Email, and Full name.

  5. Under Roles, select the role you created earlier: ctrlDNS.

  6. Disable Multi-Factor Authentication because it cannot be used together with API access.

  7. Under Access, select only API access and disable Web access, as web access is not required for this user.

  8. In the IP whitelist, add the IP address of our servers. You can find these here: https://help.ctrldns.com/en/help/articles/6808350-ip-addresses-for-whitelisting.

  9. Click Create to create the new user.

Create an API Key for the New User

  1. Click on the newly created user ctrlDNS.

  2. On the right-hand side of the window, click the button API Keys.

  3. On the right side of the page in the Description field, enter: ctrlDNS.

  4. Check only the box for API access.

  5. Copy the generated API Key and securely store it—this is the key you will use in ctrlDNS.