Release notes

New features, improvements, and changes to the DigiCert DNS APIs.

v2.0.0 release notes

The DigiCert® DNS APIs are now generally available. Version 2.0.0 brings DNS provisioning, record management, monitoring, and account administration into your scripts, deployment pipelines, and infrastructure tools.

Two REST APIs provide access to the service:

  • Zone and record management: Provision zones, manage records and regional responses, configure failover, inspect DNS health, and automate reporting and recovery.
  • Users and access: Manage account access for people and applications, assign roles, inspect effective permissions, and manage API credentials.

Both APIs use the base URL https://api.dns.digicert.com/v1 and authenticate with an API token in the X-API-Key header. Each request acts on the account associated with the token.

See the Overview to get started.

Zone and record management

Manage DNS resources throughout their lifecycle, from initial provisioning and configuration to monitoring, changes, and recovery.

See the API reference for endpoints, request parameters, and response schemas, or download the OpenAPI definition in JSON or YAML format.

Use this API to manage the following:

Audit, usage, and entitlements

Search and retrieve audit records, obtain available audit-filter values, and export audit activity as JSON or CSV.

Access monthly usage summaries, daily usage for a selected month, current month-to-date usage, and account entitlements. Request monthly query-volume reports for zones and retrieve the generated results for reporting and capacity planning.

Batches and tasks

Submit supported create, update, and delete operations in a batch, or retrieve several resources through a batch-read request. Synchronous write batches support up to 50 operations; asynchronous batches support up to 1,000.

List asynchronous tasks and retrieve their status, progress, results, and available resource links. Delete completed tasks from task history with the required administrator role.

DNS health and delegation

Retrieve overall zone health and the results of delegation, SOA serial number, and zone transfer checks. Inspect the SOA serial, refresh, retry, and expire values reported by delegated nameservers.

Review the most recent transfer with each recently active peer, including its address, IP set, serial number, transfer time, and outcome. Use these checks to investigate delegation mismatches, inconsistent zone copies, or transfer failures.

DNSSEC health is available separately and does not contribute to the overall zone health result.

DNS records

Create, retrieve, replace, partially update, and delete record sets. Manage record values and TTLs, list records by type, and search or filter records by name, content, and TTL.

Supported types include A, AAAA, ALIAS, CAA, CERT, CNAME, DS, HINFO, HTTPS, MX, NAPTR, NS, PTR, RP, SRV, SSHFP, SVCB, TLSA, and TXT.

Use record-set responses to distinguish values created by users from system-generated values where supported. Full replacement and partial-update operations provide separate ways to apply configuration changes.

DNS settings

Create, retrieve, update, and delete nameserver sets, inbound IP sets, outbound IP sets, and TSIG keys. Apply these resources to zone configuration to manage authoritative nameservers, upstream transfer sources, authorized downstream transfers, and notification destinations.

Retrieve and update account-default SOA settings. Manage an individual zone’s SOA values through its SOA record.

DNSSEC

Sign zones using the account’s default DNSSEC policy, retrieve signing status and active signing keys, and obtain the DS records needed for publication in the parent zone. Remove signing when DNSSEC is no longer required.

A separate DNSSEC health operation compares the expected DS records with those published in the parent zone. Publishing or removing parent-zone DS records remains a separate action, usually performed through the registrar.

Failover

Use SIMPLE_FAILOVER routing with A and AAAA record sets to configure prioritized IP endpoints and a shared health monitor. Supported monitoring protocols are HTTP, HTTPS, TCP, UDP, and ICMP.

Enable or disable individual endpoints, adjust their priorities, and inspect their reported health and serving state. The service selects the enabled endpoint with the lowest priority number that is not unhealthy. If all enabled endpoints are unhealthy, it uses the highest-priority enabled endpoint as a last resort.

Imports and exports

Import records into an existing zone from a BIND zone file, either as a file upload or as base64-encoded content in a JSON request. Imports can add records and replace existing entries.

Export up to 250 zones in one operation as BIND zone files packaged in a ZIP archive. Imports and exports run as asynchronous tasks so integrations can track completion and retrieve their results.

Integrations

Link integrations, retrieve their status, and unlink them from the account. Generate CertCentral activation credentials when linking the integration, or issue replacement credentials for an existing link.

Configure the returned credentials in CertCentral to complete activation. Valimail Monitor becomes active when linked and does not require activation credentials. Manage integration enablement for individual primary zones through zone configuration.

Regional views

Create and manage regional record sets that override matching global records. Retrieve the effective record view for a region, inspect only its overrides, and list the regions configured for a zone or record set.

Add region exclusions to suppress records for a particular name and type, including the global fallback. Remove an exclusion to restore normal regional or global resolution.

Snapshots and recovery

Create named snapshots of eligible primary zones, list saved snapshots, retrieve their captured record sets, and delete snapshots that are no longer needed. Restore a snapshot to replace a zone’s current records with the saved records.

Snapshot creation and restoration run asynchronously. Retrieved snapshot data includes the captured records and whether regional views were enabled when the snapshot was taken.

Zone management

Create primary zones whose records you manage in DigiCert® DNS, or secondary zones that receive records from an upstream DNS provider. Populate a primary zone during creation by copying an existing zone, importing a zone file, or requesting an AXFR transfer.

List, filter, sort, and retrieve zones, update their configuration and supported status values, and delete zones that are no longer required. Convert a secondary zone to primary while retaining its transferred records, or request a transfer to refresh a secondary zone.

Retrieve a zone’s assigned nameservers, their addresses, and detected delegation status to check whether delegation matches the intended configuration.

Users and access

Manage the identities that access your DNS account and the permissions and credentials they use.

See the API reference for endpoints, request parameters, and response schemas, or download the OpenAPI definition in JSON or YAML format.

Use this API to manage the following:

API tokens

Create and list tokens for the authenticated user, other users, and service users, subject to permissions. To generate a token, use:

  • POST /me/tokens for the authenticated user or service user
  • POST /users/{userId}/tokens for a specified user
  • POST /service-users/{serviceUserId}/tokens for a specified service user

These operations require an existing valid API token and the appropriate permissions.

Optionally specify an expiry date when generating a token. The full token value is returned only when the token is created; subsequent reads return only the token’s metadata and prefix. Store the value securely. The expiry date cannot be changed afterward.

Update a token’s name, description, or enabled state. Revoking a token stops it from authenticating immediately and sets its revocation timestamp (revokedAt). A revoked token can be re-enabled, which clears that timestamp. Permanently delete tokens that should no longer be retained.

Calling identity

Retrieve the account and identity associated with the current token through /me. Inspect the enabled state, role assignments, and token count of the authenticated user or service user, and retrieve its effective permissions without first looking up its ID.

Roles and permissions

List available roles and retrieve the permissions each role grants, including permissions inherited by resources beneath a parent resource.

For users and service users, list role assignments, add individual roles, replace the assigned role set, or revoke an assignment. Retrieve effective permissions to determine the combined access provided by all assigned roles.

Role changes take effect immediately. The API prevents callers from changing their own role assignments and protects the built-in self role from manual assignment.

Service users

Create dedicated identities for scripts, applications, and integrations, assigning their initial roles during creation. Retrieve and search service users, update their names and descriptions, and enable or disable their access.

Generate tokens separately after creating a service user. Delete a service user when it is no longer needed; deletion permanently removes its tokens and prevents further authentication with those credentials.

User access

List, filter, sort, and retrieve existing account users. Activate or deactivate a user’s account and review their assigned roles and token count.

While a user is deactivated, the API rejects their requests, including token requests. Activating the user restores account access. User identity details, such as name, email address, and phone number, remain managed outside this API.

Known limitations and considerations

  • Batch requests: In a write batch, if a sub-request fails, later sub-requests are not run and earlier changes are not retained. The onFailure parameter has no effect in this release. Zone actions such as :transfer cannot be batched.
  • Location header: In this release, some 201 Created responses omit the Location header when creating an immediately available zone, an inbound IP set, a TSIG key, or an integration link. Use the resource ID or name returned in the response body instead.
  • Protected service users: Protected service users restrict configuration, role, and token changes. See the endpoint reference for the applicable restrictions.
  • Snapshots: Snapshot creation requires a primary zone that is not DNSSEC-signed or suspended and contains no more than 50,000 records.
  • Tasks: Pending or running tasks cannot be cancelled. Only completed tasks can be deleted, and deletion requires the account-admin role. Filtering the task list by status is not supported in this release.
  • User administration: The Users and access API manages existing users’ account access and roles; it does not create user identities or update their personal profile details.
  • Zone exports: Zones that do not exist or that the authenticated user or service user does not have permission to read are skipped without failing the export task. Compare the archive contents with the requested zones to identify omissions.
  • Zone status: Primary zones support ACTIVE, DISABLED, and SUSPENDED updates; secondary zones only support ACTIVE and SUSPENDED.