Dyn’s Managed DNS API enables you to programmatically maintain your Managed DNS account.
The standard API activity follows the workflow shown here where the process begins with Login and ends with Logout.
Session Login
- Before any interaction can take place within Managed DNS a session must be established.
- Logging in with either REST or SOAP will establish this session and yield a Token.
- The Token will be used with every api call to validate the authenticity of a request.
- For more information on logging into an API session see Session Log-in
WARNING: Operating on the same resource (e.g. the same hostname or instance of a service) from more than one session at the same time may cause unexpected behavior, such as unintentional service changes or the inability to propagate new zone changes.
Change Settings
- Managed DNS can set parameters for Users, Zones, Records, and Services.
- The Managed DNS API can manage all of these features. Additionally, the API can gather statistics to create Reports.
- For instructions on changing settings and adding or removing items within your installation, select one of the following to find the correct commands: REST Resources or SOAP Commands.
Review Changes
- Each request made in the API returns a Job ID; zone change requests are queued within a Changeset.
- Changesets allow for a zone configuration to be finalized before it goes live and can be reviewed or removed at anytime.
- To view the current Changeset, use the instructions Get Zone Changesets.
- Job IDs allow a user to check on the status of a request or fetch the response of a previously completed request.
- To view the current job ID, use the instructions Get Job.
- Both Changesets and Job IDs are only valid for the duration of a session.
Publish Changes
- When you are ready to make your Changesets live, call the publish command.
- All pending Changesets for a zone go live when the publish request is made.
- To publish the Changeset items, use the instructions Publish Zone
Session Logout
- While an unused session can and will timeout eventually, it is always recommended to log out from your session when your scripts are complete.
- To log out from your session, use the instructions Session Log Out