Postman

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

Repository Structure

• src/: Contains the Postman collection and environment JSON files
• scripts/: Contains scripts used by workflows for validating and transforming collection JSON
• spec/: Contains the OpenAPI YAML specification, which is automatically generated from the Postman collection during releases
• docs/: Hosts a live Swagger UI instance via GitHub Pages that loads the latest OpenAPI spec from the repository

Getting Started

To use these collections:

1. Visit our public workspace
2. Fork the collection to your own workspace
3. Create an environment and set up your credentials

Alternatively, you can import the files directly from this repository:

1. Go to File in Postman
2. Select Import
3. Drag the files from src/ to the application

Authentication

1. Set your credentials

   • Define the following environment variables:

     • username – your UDNS username
     • password – your UDNS password

2. Manually obtain your token (first time)

   • In Postman:

     • Open the Authorization tab at the collection level
     • Click "Get New Access Token", then "Use Token"

3. Token refresh

   • After the initial token is retrieved, Postman will automatically refresh it when needed—provided the refresh token remains valid.

Utilities

The collection-level pre-request script 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()

Resources

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.

• 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.

• Tasks: Operations that produce background tasks will return a 202 status code and have an x-task-id header. This ID is stored under the currentTask variable in the environment.

• Reports: After you request a report, retrieve it from the results endpoint 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.\

• DNSSEC Multi-Signer

• Traffic Management

Contributing

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.

License

This repo is distributed under the MIT license.