Root Zone Management API
Root zone change requests can be submitted and transacted upon via an application programming interface (API) by credentialed customers. A non-production environment is also available for testing integrations.
Getting started
Credentialed users of our Root Zone Management System (RZMS) can enable API access from within the website by:
- Completing Identity Verification
- Enabling multi-factor authentication
- Navigate to Settings > Password & Authentication
- Click Enable 2FA and follow the prompts
- Save the recovery codes that are generated
- Generating an API Token
- Navigate to Settings > Password & Authentication
- Click Add API Token
- Record the token
Using the API
The RZMS API allows users to conduct actions they can otherwise perform via our web interface. This means that users with limited permissions can only take actions they are authorized to perform.
Formal technical documentation of the API, including the formatting of actions and access methods, is published in our API Documentation.
Testing environment
IANA operates an Operational Test and Evaluation (OTE) Environment for TLD Managers to develop and test API integrations, such as the bulk creation of change requests, before making the changes in production. The OTE environment differs from the production service in the following key ways:
- It is operated on a different host. Users must obtain separate API credentials by logging into the OTE website at https://rzm-ote.iana.org and following the same process as would be used in the production service.
- No emails will be sent from the OTE environment. This is to avoid potentially confusing situations where authorizers receive unexpected notifications. Use the OTE RZMS website or API to determine status and perform actions instead of relying upon emails.
- Change requests will not be monitored by staff and as a result, any request that proceeds to staff review will remain in that status.
- No copy of the root zone is made available from the data in the OTE environment.
- The data in the OTE environment is a copy of RZMS production data. It will be re-synced with production data each quarter, or upon request; changes made in the OTE environment will eventually be replaced with current production data.
Please be aware that changes made in the OTE environment will never be applied to production. RZMS OTE exists only for testing purposes.
Details on using the API are supplied in the API Documentation.
More information
Please contact root-mgmt@iana.org for assistance with credential recovery, progressing change requests, requesting a reset of data, or general questions regarding the API and OTE environment.