Configuring UltraDNS Instance

  1. Go to Menu > WORKFLOW > Integration.
  2. On the Integrations page, from the Select Category dropdown, select only DDI and click Apply.
  3. Click the Add new vendor icon.
    The Select Vendor pop-up is displayed.
  4. Select UltraDNS.
    The Vendor Configuration pop-up is displayed.
  5. In the Information section, enter the following values:
    Table 1. Field descriptions for Information section
    Field Description
    *Category polling Default value as DDI
    *Vendor Default value as UltraDNS
    *Name Enter a suitable name.
    Version Enter a appropriate version.
    Description Enter a description for the vendor.
    Upload image Provision to upload vendor image/logo.
    Tags Select/Enter the tag.
    Data center Select data center value.
  6. In the Credentials section, based on the Type as REST and SSH, enter the following values:
    If the Type = REST, the Auth Type has the following values in the dropdown - Basic Auth, Credentials, Bearer Token, API, AWS Signature, Digest Auth, Akamai EdgeGrid, OAuth 2.0. The table below has the corresponding field descriptions for each of the Auth Types.
    Table 2. If Type = REST, and Auth Type = Basic Auth or Credentials
    Fields Description
    *Credential Type Select credential type as Manual or Credential List - XXX.
    Note: The credentials must be added in the respective Device Inventory.
    *Username This field is displayed if Credential Type = Manual

    Enter the username to authenticate and authorize communication with the vendor's system.
    *Password This field is displayed if Credential Type = Manual

    Enter the password to authenticate and authorize communication with the vendor's system.
    *Credential List This field is displayed if Credential Type = Credential List - XXX

    Select the configured device credentials.
    *URL Enter the valid URL/endpoint of the vendor’s API.

    To validate the URL Click Validate URL.
    *: Mandatory fields
    Table 3. If Type = REST, and Auth Type = Bearer Token
    Fields Description
    *Token Enter the authentication token required for API requests.
    *URL Enter the valid URL/endpoint of the vendor’s API.

    To validate the URL Click Validate URL.
    *: Mandatory fields
    Table 4. If Type = REST, and Auth Type = API Key
    Fields Description
    *Key Enter the name of the API key parameter.
    *Value Enter the actual API key used for authentication.
    *Add to Select where the API key should be included in the request - Header, or Query Parameter.
    Custom Header If the API key needs to be sent in a specific header, enable the toggle and enter the key and value for defining a custom header name for it.
    Custom Header Config This field is displayed if the Custom Header toggle is enabled.

    Enter the key and value for defining a custom header name for it.
    *URL Enter the valid URL/endpoint of the vendor’s API.

    To validate the URL Click Validate URL.
    *: Mandatory fields
    Table 5. If Type = REST, and Auth Type = AWS Signature
    Fields Description
    *Access Key Enter the AWS access key ID associated with the AWS account, used for authentication.
    *Secret Key Enter the secret key corresponding to the access key, used to sign API requests securely.
    Advanced Configs Enable the toggle button for additional configuration settings for customizing the authentication process.
    *AWS Region This field is displayed if the Advanced Configs toggle is enabled.

    Enter the AWS region (e.g., us-east-1),where the API request should be sent
    *Service Name This field is displayed if the Advanced Configs toggle is enabled.

    Enter the AWS service being accessed (e.g., s3, ec2), required for signing the request correctly.
    *Session Token This field is displayed if the Advanced Configs toggle is enabled.

    A temporary session token used when using AWS temporary security credentials (e.g., from AWS STS).
    *URL Enter the valid URL/endpoint of the vendor’s API.

    To validate the URL Click Validate URL.
    *: Mandatory fields
    Table 6. If Type = REST, and Auth Type = Digest Auth
    Fields Description
    *Username Enter the username used to authenticate with the vendor's API.
    *Password Enter the corresponding password for the username.
    Upload file If authentication requires a certificate or key file, this field allows uploading the necessary credentials.
    Advanced Configs Enable the toggle button for additional configurations for customizing the authentication request.
    Realm This field is displayed if the Advanced Configs toggle is enabled.

    A protection space defined by the server to indicate the scope of authentication (e.g., "example.com").
    *Nonce This field is displayed if the Advanced Configs toggle is enabled.

    A unique, one-time token generated by the server to prevent replay attacks.
    *Algorithm This field is displayed if the Advanced Configs toggle is enabled.

    The hashing algorithm used for authentication (e.g., MD5, SHA-256).
    qop This field is displayed if the Advanced Configs toggle is enabled.

    (Quality of Protection) Defines the security level of the authentication (e.g., auth for authentication only, auth-int for authentication with integrity protection).
    Nonce Count This field is displayed if the Advanced Configs toggle is enabled.

    A counter that tracks the number of requests made with the same nonce to prevent replay attacks.
    Client Nonce This field is displayed if the Advanced Configs toggle is enabled.

    A unique, random value generated by the client to add randomness to the authentication process.
    Opaque This field is displayed if the Advanced Configs toggle is enabled.

    A server-specified string that must be returned unchanged by the client in subsequent requests.
    *URL Enter the valid URL/endpoint of the vendor’s API.

    To validate the URL Click Validate URL.
    *: Mandatory fields
    Table 7. If Type = REST, and Auth Type = Akamai EdgeGrid
    Fields Description
    *Access Token Enter the token that uniquely identifies the client and grants access to Akamai’s APIs.
    *Client Secret Enter the secret key used to sign the request for secure authentication.
    *Client Token Enter the token that identifies the client making the request and is required for authentication.
    Advanced Configs Enable the toggle button for additional configurations for customizing the authentication request.
    *Nonce This field is displayed if the Advanced Configs toggle is enabled.

    A unique, one-time random string used to prevent replay attacks and enhance security.
    *Timestamp This field is displayed if the Advanced Configs toggle is enabled.

    The time when the request is made, ensuring freshness and preventing request reuse.
    *Base URL This field is displayed if the Advanced Configs toggle is enabled.

    The root URL of the Akamai API endpoint that requests will be sent to.
    *Headers to sign This field is displayed if the Advanced Configs toggle is enabled.

    Enter the specific HTTP headers that should be included in the request signature to ensure integrity and security.
    *URL Enter the valid URL/endpoint of the vendor’s API.

    To validate the URL Click Validate URL.
    *: Mandatory fields
    Table 8. If Type = REST, and Auth Type = OAuth 2.0
    Fields Description
    *Username Used in Grant Type = Password , enter the username for authentication.

    This field is mandatory only if the Grant Type = Password.
    *Password Used in Grant Type = Password , enter the password for the username.

    This field is mandatory only if the Grant Type = Password.
    *Access Token URL Enter the provider's authentication server, to exchange an authorization code for an access token.
    *Client ID Enter the ID for the client application registered with the API provider.

    This field is mandatory only if the Grant Type = Client Credentials.
    Client Secret Enter the client secret given by the API provider.

    This field is mandatory only if the Grant Type = Client Credentials.
    Grant Type Select the OAuth 2.0 flow to be used:
    • Password (for user authentication with username and password).
    • Client Credentials (for machine-to-machine authentication).
    Scope Defines the level of access requested (e.g., read, write, admin).
    *URL Enter the valid URL/endpoint of the vendor’s API.

    To validate the URL Click Validate URL.
    *: Mandatory fields
    If the Type = SSH, the Auth Type has the following values in the dropdown - Credentials, SSH Key, No Auth. The table below has the corresponding field descriptions for each of the Auth Types.
    Table 9. If Type = SSH, and Auth Type = Credentials
    Fields Description
    Communication type Select the communication type as IP or FQDN/Host name
    *IP or FQDN/Host name Enter the IP address or the FQDN/Host name of the vendor’s server that AppViewX will connect to over SSH.
    *Port Enter the SSH port on the vendor’s server.
    *Username Enter the login username used to authenticate the SSH session.
    *Password Enter the password for the corresponding username.
    *: Mandatory fields
    Table 10. If Type = SSH, and Auth Type = SSH Key
    Fields Description
    Communication type Select the communication type as IP or FQDN/Host name
    *IP Enter the IP address or the FQDN/Host name of the vendor’s server that AppViewX will connect to over SSH.
    *SSH Key Enter the private SSH key used for authentication instead of a password.
    *: Mandatory fields
    Table 11. If Type = SSH, and Auth Type = No Auth
    Fields Description
    Communication type Select the communication type as IP or FQDN/Host name
    *IP Enter the IP address or the FQDN/Host name of the vendor’s server that AppViewX will connect to over SSH.
    *Port Enter the SSH port on the vendor’s server.
    *Username The username used for the SSH session, though no authentication (password or key) is required.
    *: Mandatory fields
  7. In the Proxy settings section, the Use Proxy checkbox can be checked or unchecked.
    Note: Before enabling, add proxy details under Menu > Settings > General > Proxy.
  8. Under Configurations, turn on the Enable config to add additional vendor configurations/attributes in JSON format. Attributes can be referred as variables.
    Note: For a list of variables in workflow automation click the Variables button on the top right of the screen. A Field variable mapping pop-up is displayed with the label name and its corresponding variable name.
  9. To save the changes, click Add. (Use the Reset button to clear all entered data and restores the fields to their default values.)