DIdigicert
domains - primary

Lists all available primary domains.

This endpoint lists all available primary domains, enabling users to review and manage the domains they have configured.</br></br>Key features include:</br></br>- Clear success messaging: Returns a 200 success code with a confirmation message indicating the successful completion of the requested action.</br>- Comprehensive data retrieval: Returns a comprehensive list of all primary domains, providing a complete and accurate overview for seamless management and analysis.</br>- Comprehensive error handling: Returns a 404 error code with a clear description when requests fail.</br>- Controlled data limits: The pageSize parameter allows users to define the maximum number of domains to display per page, optimizing data retrieval for specific use cases.</br>- Customizable pagination: The pageNumber parameter allows users to specify the page of results they wish to retrieve, ensuring targeted access to data.</br>- Dynamic filtering: Uses the filterBy and name parameters to filter results, streamlining access to specific domains and enhancing data retrieval efficiency.</br>- Efficient sorting: The sortBy parameter enables users to organize responses by various attributes, offering flexibility in result management.

get/domains/primary

Request

Query parameters

namestring

Filters primary domains by the specified name.

sortBy'updatedAtDesc' | 'updatedAtAsc' | 'createdTsAsc' | 'createdTsDesc' | 'createdAtDesc' | 'createdAtAsc' | 'modifiedTsAsc' | 'modifiedTsDesc'

Specifies the sorting order of results.

pageSizeinteger

The maximum number of domains to return per page. Defaults to 25 if not specified.

pageNumberinteger

The page of results to return. Defaults to 0 if not specified.

filterBy'primary' | 'secondary'

Filters results based on the domain type.

Response

Primary domains listed successfully.

totalinteger
countinteger
perPageinteger
currentPageinteger
totalPagesinteger

Example response

{
  "data": [
    {
      "id": 1,
      "name": "example.com",
      "type": "primary",
      "dnssec": true,
      "noOfRecords": 30,
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "queries": {
        "total": 200,
        "refused": 50,
        "servfail": 5,
        "notimpl": 5,
        "responsecount": 60,
        "noerror": 50,
        "nxdomain": 20,
        "formerr": 10
      },
      "soa": {
        "id": 1,
        "name": "Default SOA"
      },
      "tsigKeyConfig": [
        {
          "ipset": {
            "ipSetId": 1
          },
          "tsigKey": {
            "id": 1
          }
        }
      ],
      "status": "active"
    }
  ],
  "total": 25,
  "count": 10,
  "perPage": 10,
  "totalPages": 3
}

Changes

No recorded changes to this operation across all 1 revision of this API.