Onboarding UltraDNS

Prerequisites

Before configuring the UltraDNS integration in AppViewX, ensure that the required role-based permissions are configured in UltraDNS. These permissions allow AppViewX to perform DNS-based Domain Control Validation (DCV) or ACME DNS-01 challenge validation.

To enable DNS discovery through UltraDNS in AppViewX, ensure that the configured UltraDNS user account has the following permissions assigned.

Required Permissions

The following table lists the minimum permissions that must be assigned to the UltraDNS user account used by AppViewX:
Resource Permissions Required
Domain Read, Write, Create, Delete
CNAME Record Read, Write, Create, Delete
TXT Record Read, Write, Create, Delete
Note: During DNS automation, AppViewX retrieves the hosted zones list and validates the existence of zones as a prerequisite before creating DNS records.

Recommendation

  • Assign the above permissions to a dedicated service account in UltraDNS to be used exclusively for AppViewX integration.
  • Ensure the service account has access to all zones (domains) that AppViewX is expected to discover for DCV or ACME DNS-01 validation.

Configuring UltraDNS

To configure UltraDNS:
  1. Go to (Menu > CERT+ > ADMINISTRATION > DCV Management > Manage DDI services > Add new vendor.
    The Select vendor page is displayed.
  2. On the Select Vendor page, click UltraDNS.
  3. On the Vendor Configuration page, under the General section, enter or select the required field information.
    The following table describes the various fields in this section:
    Field Description
    *Name Enter a unique name to identify the configured vendor account.
    Description Enter a description for the purpose of configuring this vendor, if required.
    Data center Select a data center from the options available in the dropdown list.
    *: Mandatory fields
  4. On the Vendor Configuration page, under the Credentials section, enter or select the required field information.
    The following table describes the various fields in this section:
    Field Description
    *Auth Type Displays the OAuth 2.0 method of authentication selected by default.
    *URL Enter the API URL for the vendor using the HTTPS or HTTP protocol.
    Note: The API URL is the same as the Hostname URL.
    Example: https://api.ultradns.com/
    *Username Enter the username of the UltraDNS account configured for AppViewX integration.
    Note: This field is displayed when Grant Type is set to Password.
    *Password Enter the password of the UltraDNS account configured for AppViewX integration.
    Note: This field is displayed when Grant Type is set to Password.
    *Access Token URL Enter the URL used to obtain an OAuth 2.0 access token for UltraDNS API authentication.
    *Grant Type Select the grant type from the dropdown list. The available options are Password and Client Credentials.
    *Client ID Enter the unique client ID provided by UltraDNS.
    Note: This field is displayed when Grant Type is set to Client Credentials.
    *Client Secret Enter the client secret provided by UltraDNS.
    Note: This field is displayed when Grant Type is set to Client Credentials.
    Scope Enter a scope for the purpose of configuring this vendor, if required.
    *Account Name Enter the UltraDNS account name for API integration.
    *: Mandatory fields
  5. Enable Config Sync to allow AppViewX to parse the vendor configuration.
  6. On the Vendor Configuration page, under the Configurations section, turn Off the Enable Config toggle.
  7. Click Finish.
    A "Vendor configuration saved successfully" confirmation message is displayed.

Validating the Vendor Configuration

  1. On the Integration Hub page, locate the configured vendor tile.
  2. Confirm that a green check mark (✔) appears on the tile this indicates the vendor is active and reachable.
  3. Click the View status icon on the tile to open the Vendor Status Log: (Vendor Name) dialog.
  4. Verify that the Authentication entry displays a Success status with a recent timestamp.