- DigiCert product docs
- DigiCert DNS
- Get started
- Set up team and API access
- Set up Postman for the DNS API
Set up Postman for the DNS API
Import the DNS API definition into Postman, configure your API token, and send a request to verify access.
Before you begin
Open Postman and select the workspace you will use for DNS requests.
Confirm that you have an active API token and that its user or service user has permission to access the required DNS resources.
If you need a token, follow Create a service user and API token.
Open the DC: DigiCert® DNS API documentation.
Import the API definition
Open the relevant API.
Select Download beside Download OpenAPI specification.
Save the specification file.
In Postman, open Import.
Select the downloaded file.
Choose Postman Collection.
Select Import.
Under Collections, confirm that the DigiCert® DNS API appears.
Configure the collection variables
Select the DigiCert® DNS API collection.
Open Variables.
Check that baseUrl's value matches that provided in the DC: DigiCert® DNS API documentation (
https://api.dns.digicert.com/v1).Add a variable named
apiKey.Enter your API token as its value. Keep the token private and do not include it in shared collection exports.
Save your changes.
Confirm authorization
With the collection selected, open Authorization.
Confirm that Auth type displays API Key.
Confirm that Key displays
X-API-Key.Confirm that the
{{apiKey}}variable contains the API token generated in DigiCert® DNS.Confirm that Add to displays Header.
Send a test request
Expand the collection’s Zones folder.
Open
GETList zones.Review Authorization and ensure the request uses the collection’s authentication. Select Inherit auth from parent if needed.
Open Params to clear any optional query parameters you do not need. Replace any enabled example or placeholder values with valid values.
Confirm that {{baseUrl}} reflects
https://api.dns.digicert.com/v1.Select Send.
Confirm that the response returns 200 OK.
Review the response body for the zones available to your identity. If no zones match the request, the list may be empty.
Resolve setup problems
If Postman cannot resolve a variable, check its name and value in the collection’s Variables tab.
If authentication fails, verify that
apiKeycontains the complete token and that the request uses the collection’s authentication.Confirm that the token has not expired or been revoked and that its user or service user remains active.
If access is denied, review the identity’s assigned roles.
If the request fails validation, check enabled query parameters for placeholder or invalid values.
If the response contains no expected zones, review the filters and confirm that the token belongs to the intended account.
For response definitions and error details, see the DC: DigiCert® DNS API documentation.
Next steps
To create zones and manage records through the API, see the DC: DigiCert® DNS API documentation. Before sending a request that changes or deletes resources, review its parameters and body and replace example values with your intended configuration.