List DCV Domains

Before you Begin

Ensure the following before calling this API:

You have valid AppViewX credentials or an active session ID.
The Certificate Lifecycle Management module is enabled and accessible.
You have the DCV CA Mgmt View permission assigned to your user account.

Request Structure


Endpoint:	`/certificate/dcv/domain/list`
Type:	`POST`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/certificate/dcv/domain/list?gwsource=external` To understand the elements of the sample URL, see References.
Headers
Content-Type:	application/json

Table 1. Input Parameters
Name	Description
sessionId `Header`	(Mandatory) Session ID received after login. Type: String Constraint: Required if `username` and `password` are not provided.
username `Header`	(Mandatory) AppViewX login username. Type: String Constraint: Required if `sessionId` is not provided.
password `Header`	(Mandatory) AppViewX login password. Type: String Constraint: Required if `sessionId` is not provided.
Content-Type `Header`	(Mandatory) Format of the request body. Type: String Constraint: Value must be `application/json`.
gwsource `Query`	(Mandatory) Source from which the request is triggered. Type: String Example: `external`
Payload `Body`	Contains all the parameters to include in the request body. Type: Payload

Payload Parameters


Parameter	Description
`skip`	Number of records to skip before returning results. Use this with `limit` to paginate through large result sets. Type: Integer. Default: `0`.
`limit`	Maximum number of domain records to return in a single response. Type: Integer. Default: `100`. Maximum value supported is 1000.
`search`	Text to filter domain results. The API returns only domains whose name or details match the search term. Type: String. Maximum 1000 characters.
`status`	Filter results by the domain validation status. Type: String. Allowed values: `active`, `expired`, `failed`, `pending`.
`sortColumn`	Column name to sort the results by. Type: String. Allowed values: `domainName`, `caName`, `settingName`, `organizationName`, `dcvExpirationDateTime`.
`sortOrder`	Direction to sort the results. Type: String. Allowed values: `asc`, `desc`.

Response Structure

The API returns a response of type application/json with the following parameters:


Parameter	Description
`response`	Contains the list response data. Type: Object.
`response.search`	The search term used in the query. Type: String.
`response.totalRecords`	Total number of domain records that match the query filters. Type: Integer.
`response.retrievedRecords`	Number of domain records returned in this response. Type: Integer.
`response.executionTime`	Timestamp of when the query was executed, in epoch seconds. Type: Long.
`response.data`	List of DCV domain records. See data (array object) below. Type: Array of Object.
`tags`	Additional information returned in case of a failure response.

response.data (array object)


Parameter	Description
`domainId`	Unique identifier for the domain in AppViewX. Type: String.
`domainIdFromCa`	Domain identifier assigned by the certificate authority. Type: String.
`domainName`	Fully qualified domain name. Type: String.
`certificateAuthority`	Name of the certificate authority that manages the domain. Type: String.
`settingName`	Name of the CA integration setting used for this domain. Type: String.
`dcvValidationMethod`	DCV validation method currently applied to the domain. Type: String.
`dcvApprovalDateTime`	Timestamp of domain validation approval, in epoch milliseconds. Type: Long.
`dcvExpirationDateTime`	Timestamp when the current domain validation expires, in epoch milliseconds. Type: Long.
`validationStatus`	Current validation status of the domain. Type: String. Example: `active`, `expired`.
`dnsValidationType`	Type of DNS validation used for this domain. Type: String. Allowed values: `automated`, `manual`.
`autoRevalidation`	Whether auto-revalidation is enabled for this domain. Type: String. Allowed values: `enabled`, `disabled`.
`daysBeforeAutoRevalidation`	Number of days before expiry when auto-revalidation triggers. Type: Integer.
`organizationName`	Organization associated with the domain. Type: String.
`certCount`	Number of certificates associated with this domain. Type: Integer.
`tokenInfo`	Token details for DCV validation. See tokenInfo below. Type: Object.
`dnsServerDetails`	DNS server configuration used for this domain. See dnsServerDetails below. Type: Object.
`revalidationPreferences`	Stored auto-revalidation preferences for this domain. See revalidationPreferences below. Type: Object.
`domainValidationResponse`	History of validation attempts for this domain. See domainValidationResponse (array object) below. Type: Array of Object.
`revalidationDetails`	Details of the most recent revalidation attempt. See revalidationDetails below. Type: Object.
`dcvWorkflowInfo`	Workflow details associated with DCV token management. See dcvWorkflowInfo below. Type: Object.

tokenInfo


Parameter	Description
`token`	Validation token value to place in the DNS record. Type: String.
`status`	Current status of the token. Type: String. Example: `pending`.
`host`	Hostname where the token must be placed for validation. Type: String.
`expirationDate`	Timestamp when the token expires, in epoch milliseconds. Type: Long.

dnsServerDetails


Parameter	Description
`dnsServer`	DNS server configured in DDI. Type: String.
`dnsVendor`	Name of the DNS vendor. Type: String.

revalidationPreferences


Parameter	Description
`dcvValidationMethod`	Preferred validation method for auto-revalidation. Type: String.
`dnsValidationType`	DNS validation type used during auto-revalidation. Type: String.
`dNSServerDetails.dnsServer`	DNS server used during auto-revalidation. Type: String.
`dNSServerDetails.dnsVendor`	DNS vendor used during auto-revalidation. Type: String.

domainValidationResponse (array object)


Parameter	Description
`validationStatus`	Result of this validation attempt. Type: String. Example: `success`, `failed`.
`lastValidatedOn`	Timestamp of this validation attempt, in epoch milliseconds. Type: Long.
`validationDescription`	Description of what happened during the validation attempt. Type: String.
`message`	Short message summarizing the validation result. Type: String.
`expiryDate`	Expiry timestamp for this validation record, in epoch milliseconds. Type: Long.
`validationMethod`	Validation method used in this attempt. Type: String.

revalidationDetails


Parameter	Description
`revalidationStatus`	Status of the most recent revalidation. Type: String. Example: `Failed`, `Success`.
`revalidationMessage`	Message from the most recent revalidation. Type: String.
`triggeredOn`	Timestamp when the last revalidation was triggered, in epoch milliseconds. Type: Long.
`retryCount`	Number of revalidation retry attempts made. Type: Integer.
`user`	Username of the person or process that triggered the revalidation. Type: String.

dcvWorkflowInfo


Parameter	Description
`vwfRequestId`	Workflow request ID associated with DCV token management. Type: String.
`workOrderAction`	Action performed by the workflow. Type: String.
`workorderId`	Work order identifier. Type: String.

Status Codes


HTTP Status	appStatusCode	Description
`200 OK`	null	Domain list retrieved successfully.
`400 Bad Request`	`CERT-GEN-0042`	Invalid `limit` value. Supported range: 0 to 1000. Remediation: Enter a `limit` value between 0 and 1000.
`400 Bad Request`	`CERT-GEN-0042`	Invalid `status` value. Remediation: Use one of the allowed values: `active`, `expired`, `failed`, `pending`.
`400 Bad Request`	`CERT-GEN-0042`	Invalid `sortColumn` value. Remediation: Use one of the allowed values: `domainName`, `caName`, `settingName`, `organizationName`, `dcvExpirationDateTime`.
`400 Bad Request`	`CERT-GEN-0042`	Invalid `sortOrder` value. Remediation: Use `asc` or `desc`.
`401 Unauthorized`	`AVX_GW_003`	Authentication failed — invalid credentials. Remediation: Provide a valid `username` and `password` or a valid `sessionId`.
`500 Internal Server Error`	—	An unexpected error occurred. Remediation: Contact your AppViewX administrator.

Sample Request/Response

Sample Request

{
  "skip": 0,
  "limit": 25,
  "search": "example",
  "status": "active",
  "sortColumn": "domainName",
  "sortOrder": "desc"
}

Sample Response

{
  "response": {
    "search": "",
    "totalRecords": 1,
    "data": [
      {
        "domainId": "domain-id",
        "domainIdFromCa": "1234567",
        "domainName": "example.com",
        "certificateAuthority": "DigiCert",
        "settingName": "test-digi",
        "dcvValidationMethod": "dns-cname-token",
        "dcvApprovalDateTime": 0,
        "dcvExpirationDateTime": 0,
        "validationStatus": "active",
        "dnsValidationType": "automated",
        "tokenInfo": {
          "token": "<token>",
          "status": "pending",
          "host": "<host>",
          "expirationDate": 1787985302000
        },
        "domainValidationResponse": [
          {
            "validationStatus": "success",
            "lastValidatedOn": 1785393403625,
            "validationDescription": "Domain has been successfully validated",
            "message": "Validation Successful",
            "expiryDate": 0,
            "validationMethod": "dns-cname-token"
          }
        ],
        "dnsServerDetails": {
          "dnsServer": "dns-server-hostname",
          "dnsVendor": "dns-vendor-name"
        },
        "autoRevalidation": "disabled",
        "revalidationPreferences": {
          "dcvValidationMethod": "dns-cname-token",
          "dnsValidationType": "automated",
          "dNSServerDetails": {
            "dnsServer": "dns-server-hostname",
            "dnsVendor": "dns-vendor-name"
          }
        },
        "daysBeforeAutoRevalidation": 0,
        "organizationName": "Example Organization",
        "certCount": 0
      }
    ],
    "executionTime": 1785394076,
    "retrievedRecords": 1
  },
  "tags": {}
}

References

Understanding the sample URL

IP/HostName/TenantName: Replace with the actual IP address, hostname, or tenant name based on the specific configuration in AppViewX.
- IP: A unique identifier assigned to each device connected to a network that uses the Internet Protocol for communication. The IP address is used in the endpoint URL for an on-premises deployment.
- HostName: A human-readable label assigned to a device on a network. The hostname is used in the endpoint URL for an on-premises deployment.
- TenantName: An identifier for a tenant indicating which tenant's data the API request accesses or modifies. The tenant name is used in the endpoint URL for a SaaS deployment.
GWPORT: AppViewX gateway port. A gateway port is the network port through which data is sent and received to communicate with a gateway in an on-premises deployment. Example: 31443
avxapi: Static path parameter that is part of the endpoint URL.
gwsource: Source or origin of the gateway request. Example: external.