Skip to content
DNSmigrator
betaDNS betaRegistrar betaRegistrarSetup guide checked 2026-09-27

Realtime Register

Realtime Register API key setup: create a dedicated Realtime Register user role, assign it to an API user, and generate a one-time API key.

On this page

Realtime Register API key permissions

Credential type
API key
Preview access
VIEW_PROCESS, VIEW_DNS_ZONE, and VIEW_DOMAIN
Apply access
CREATE_DNS_ZONE, UPDATE_DNS_ZONE, and UPDATE_DOMAIN, plus the preview permissions
API endpoint
DNSMigrator uses the provider's fixed API endpoint.

Additional access

Check access lists a DNS zone only; it does not test create/update or registrar rights. Realtime Register says VIEW_PROCESS is essential because changes can run as processes.

DNSControl id

creds.json TYPE
{
  "TYPE": "REALTIMEREGISTER"
}

Create credentials

Create a dedicated Realtime Register user role, assign it to an API user, and generate a one-time API key.

Access you'll grant

Preview

VIEW_PROCESS, VIEW_DNS_ZONE, and VIEW_DOMAIN

Apply

CREATE_DNS_ZONE, UPDATE_DNS_ZONE, and UPDATE_DOMAIN, plus the preview permissions

Check access lists a DNS zone only; it does not test create/update or registrar rights. Realtime Register says VIEW_PROCESS is essential because changes can run as processes.

Before you start

  • A Realtime Register administrator who can create user roles, users, and API keys.
  • A separate OT&E account if you want to use the test environment.
  • The DNS service used by the zones: Basic or Premium.

Setup steps

0 of 7 done

  1. Create a user role

    Open Account details → User Roles, select + New user role, and give the role a name such as DNSMigrator.

    Open Realtime Register user roles

  2. Select the role permissions

    Add the preview permissions below. Add DNS-zone create/update and domain update only for apply and automated cutover, then select Create user role.

    PreviewVIEW_PROCESS, VIEW_DNS_ZONE, VIEW_DOMAIN
    ApplyCREATE_DNS_ZONE, UPDATE_DNS_ZONE, UPDATE_DOMAIN

  3. Create a dedicated user

    Open Account details → Users, select New user, enter the required identity fields, and assign the role. Keep API as an allowed access point, then select Create user.

    Open Realtime Register users

  4. Restrict the user by IP (optional)

    If you enable the user's optional IP whitelists, add the DNSMigrator egress address before creating the user.

    Allowed IP addressour egress IP

  5. Generate the API key

    Open the dedicated user's profile and generate an API key. Administrators can also reach the user through Account details → Users. Copy the key now; Realtime Register shows it only when it is created.

    Realtime Register API authentication

  6. Choose DNS service and environment

    Turn on Premium DNS only for Premium zones; otherwise DNSMigrator queries Basic zones. Turn on Use the OTE (test) environment only with a key generated in the separate OT&E portal.

  7. Paste the API key

    Paste the one-time value into API key, set the two switches, and check access.

Troubleshooting

Realtime Register rejects the API key

Make sure the key was copied in full and belongs to the selected production or OT&E environment. Generate a new key if the original was not saved.

No zones appear

Switch Premium DNS to match the zone service and confirm the role includes VIEW_DNS_ZONE.

A domain update is forbidden

Add VIEW_DOMAIN, UPDATE_DOMAIN, and VIEW_PROCESS to the user's role, then have the user sign out and back in so role changes take effect.

A process cannot be read after an accepted change

Add VIEW_PROCESS. Realtime Register documents it as essential for operations that run through Domain Manager processes.

Official documentation

Guide checked against the official documentation on .

Credential fields

FieldRequirementWhere to find it
API keyapiKeyRequiredThe key generated on the dedicated user's profile. It is shown only at creation; generate a replacement if it was not saved.
Premium DNSpremiumOptionalOff selects Basic DNS zones; on selects Premium DNS zones. One connection can address one service at a time.
Use the OTE (test) environmentsandboxOptionalOff uses api.yoursrs.com. On uses the separate OT&E environment at api.yoursrs-ote.com.

Capabilities

Create zones
Yes
List zones
Yes
DNSSEC
Managed through the API
Minimum TTL
60 seconds
Apex CNAME
No
Read only
No

Record types

  • A
  • AAAA
  • CNAME
  • MX
  • TXT
  • NS
  • SRV
  • CAA
  • ALIAS
  • DS
  • LOC
  • NAPTR
  • SSHFP
  • TLSA
  • URI
  • CERT

Realtime Register-only types

  • URL

These records need translation or review when you move to another provider.

Caveats

  • Every change rewrites the zone's full custom record list in one request; records we don't manage (such as MBOXFW and HINFO) are sent back unchanged.
  • Basic and Premium DNS are separate services with separate zones; the connection works with one of them at a time.
  • Zones linked to a DNS template also receive the template's records, which are managed on the template, not per zone.

Troubleshooting

Realtime Register rejects the API key
Make sure the key was copied in full and belongs to the selected production or OT&E environment. Generate a new key if the original was not saved.
No zones appear
Switch Premium DNS to match the zone service and confirm the role includes VIEW_DNS_ZONE.
A domain update is forbidden
Add VIEW_DOMAIN, UPDATE_DOMAIN, and VIEW_PROCESS to the user's role, then have the user sign out and back in so role changes take effect.
A process cannot be read after an accepted change
Add VIEW_PROCESS. Realtime Register documents it as essential for operations that run through Domain Manager processes.

Related links

Realtime Register migration overviewMarketing overview and provider differences.Connect a providerHow connection checks and permissions work.Cloudflare → Realtime RegisterRoute 53 → Realtime RegisterAzure DNS → Realtime RegisterCloud DNS → Realtime Register