This repository serves as the source of truth for the UltraDNS API collections and environments in the public Postman workspace located at:
https://www.postman.com/digicertultradns/ultradns-public-workspace/overview
src/: Contains the Postman collection and environment JSON filesscripts/: Contains scripts used by workflows for validating and transforming collection JSONspec/: Contains the OpenAPI YAML specification, which is automatically generated from the Postman collection during releases
To use these collections:
- Visit our public workspace
- Fork the collection to your own workspace
- Create an environment and set up your credentials
Alternatively, you can import the files directly from this repository:
- Go to File in Postman
- Select Import
- Drag the files from
src/to the application
The collection-level pre-request script manages authentication and provides helper functions.
Since utils is defined globally by not using a declaration keyword, it is accessible to request-level scripts. This allows for the definition of reusable functions for our requests. Utility functions can be invoked like so:
utils.functionName()For the pre-request script to run, you must set username and password variables containing your UDNS credentials in an environment. UDNS uses OAuth2 to generate an access token. The access token and refresh token will also be stored in your environment along with a timestamp, so the script knows when to refresh.
The collection is organized into folders, each representing a base resource (ex: zones) or a specific functionality (ex: push notifications).
-
Zones: Contains the DNS configuration. Some resources are not available in the latest "version" of the API, hence why "snapshot/restore" use the "v1" endpoint.
-
Tasks: Operations that produce background tasks will return a
202status code and have anx-task-idheader. This ID is stored under thecurrentTaskvariable in the environment. -
Reports: After you request a report, retrieve it from the
resultsendpoint using the report ID. This ID is stored in the post-request script, similar to tasks. -
Webhook: A set of 3 requests related to UDNS's push notification feature.
-
Subaccounts: APIs exclusive to accounts that contain child accounts. If you don't have access to this feature, they'll produce an error.
-
Records: APIs for adding/updating/deleting RRsets for a zone. These APIs use RRset DTO definitions and pre-request/post-request scripts for managing environment variables and POST body content.
To manually provide your Bearer token, go to the "Authorization" tab of the collection and modify the value. This would be necessary, as an example, to use a token produced by the subaccount authorization endpoint. Remember to revert it to the {{accessToken}} variable after you're done.
We welcome contributions to expand the collection and implement more endpoints. Please see our CONTRIBUTING.md for detailed guidelines on how to contribute to this project.
This repo is distributed under the MIT license.