records - primary - NS

Lists the NS records of a specific primary domain.

This endpoint lists the NS records of a specific primary domain, helping users manage and review the domain's IP address mappings.</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 error handling: Returns 400, 401, and 404 error codes with clear descriptions when requests fail.</br>- Controlled data limits: The pageSize parameter allows users to define the maximum number of records 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>- Efficient sorting: The sortBy parameter enables users to organize responses by various attributes, offering flexibility in result management.</br>- Geographical filtering: Uses the gtdLocation parameter to filter results, allowing users to focus on region-specific data.</br>- Targeted data retrieval: Employs the domainId parameter to return the specified domain's NS records, ensuring accuracy and relevance in the response.

get/domains/primary/{domainId}/records/NS

Request

Path parameters

domainIdinteger required

Filters data by the domain's unique identifier.

Query parameters

pageSizeinteger

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

pageNumberinteger

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

sortBy'gtdLocationAsc' | 'gtdLocationDesc' | 'nameDesc' | 'typeAsc' | 'typeDesc' | 'modifiedTsAsc' | 'modifiedTsDesc' | 'createdTsAsc' | 'createdTsDesc'

Specifies the sorting order of results.

gtdLocation'DEFAULT' | 'NA_WEST' | 'NA_EAST' | 'SOUTH_AMERICA' | 'EUROPE' | 'AFRICA' | 'ASIA_PAC' | 'OCEANIA'

Filters records by the specified GTD location.

Response

NS records returned successfully.

totalinteger
countinteger
perPageinteger
currentPageinteger
totalPagesinteger

Example response

{
  "data": [
    {
      "id": 1,
      "type": "NS",
      "name": "testns",
      "ttl": 1800,
      "createdTs": "2026-01-01T01:00:00.123456Z",
      "modifiedTs": "2026-01-01T01:00:00.123456Z",
      "region\"": {
        "gtdLocationId": 1,
        "regionName": "NA_WEST",
        "regionLabel": "NA West"
      },
      "values": [
        {
          "id": 1,
          "hostname": "ns200.digicertdns.com.",
          "enabled": true,
          "sortOrder": 1
        }
      ]
    }
  ],
  "total": 25,
  "count": 10,
  "perPage": 10,
  "totalPages": 3
}

Changes

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