Title: Search DNS Records Using the API
PrimaryCategory: DNS
Type: Reference/Tabular
Tags: dns, api, dns_records, search, pagination, record_types
Source UI Terms: auth-userid, api-key, domain-name, type, no-of-records, page-no, host, value
Source Reference: Search DNS Records Using the API

Key Info:
This article explains how to search DNS records via an API. It outlines supported DNS record types, available search filters, pagination parameters, HTTP method, example request, and response details.

Reference Data:

| Name          | Data Type | Required / Optional | Description                                                       |
|---------------|-----------|---------------------|-------------------------------------------------------------------|
| auth-userid   | Integer   | Required            | Authentication Parameter                                         |
| api-key       | String    | Required            | Authentication Parameter                                         |
| domain-name   | String    | Required            | The Domain name whose DNS record(s) you want to search          |
| type          | String    | Required            | Type of record. Values may be: A, MX, CNAME, TXT, NS, SRV, AAAA  |
| no-of-records | Integer   | Required            | Number of Resource Records to be fetched                         |
| page-no       | Integer   | Required            | Page number for which details are to be fetched                  |
| host          | String    | Optional            | Hostname of the record                                           |
| value         | String    | Optional            | Value of the record                                              |

HTTP Method: GET

Example Test URL Request:  
`https://test.httpapi.com/api/dns/manage/search-records.json?auth-userid=0&amp;api-key=key&amp;domain-name=domain.asia&amp;type=A&amp;no-of-records=10&amp;page-no=1`

Response:  
Returns details of DNS records matching the specified criteria.

Key Definitions:
- auth-userid: Integer ID used for authenticating the user.
- api-key: String key for API authentication.
- domain-name: The DNS domain to search records within.
- type: DNS record type such as A, MX, CNAME, TXT, NS, SRV, or AAAA.
- no-of-records: Limits the number of records returned.
- page-no: Specifies the pagination page number.
- host: Filter by hostname within DNS records.
- value: Filter by the value field within DNS records.

Summary:  
You can search DNS records using the API by specifying authentication details, domain name, record type, pagination, and optional filters for host or value. The API responds with matching DNS record details.

Evaluation Pairs:  
Q: What record types can I search for using the DNS records API?  
A: You can search for A, MX, CNAME, TXT, NS, SRV, and AAAA record types.

Q: How do I paginate results when searching DNS records via the API?  
A: Use the parameters no-of-records to set how many records per page, and page-no to specify which page number to fetch.

Q: What authentication parameters are required for the DNS records search API?  
A: You need to provide auth-userid (an integer) and api-key (a string) as authentication parameters.

<p>When you want to search DNS records using the API. This article explains supported DNS record types, available search filters, pagination parameters, and response details for matching DNS records.</p>
<div class="region region-content">
<div class="hidden"> </div>
<div class="block block-core block-page-title-block" id="block-twostates-page-title">
<div class="content">
<h1 class="title page-title"><span class="field field--name-title field--type-string field--label-hidden">Searching DNS Records</span></h1>
<div id="toc" style="display: block;">
<div id="toc_content"></div>
</div>
</div>
</div>
<div class="node__content clearfix">
<div class="layout layout--onecol">
<div class="layout__region layout__region--content">
<div class="clearfix text-formatted field field--name-body field--type-text-with-summary field--label-hidden field__item">
<h2>Description</h2>
<p>Searches records based on the specified criteria.</p>
<h2>Parameters</h2>
<table class="codetable"><tbody><tr><th colspan="1" rowspan="1">Name</th><th colspan="1" rowspan="1">Data Type</th><th colspan="1" rowspan="1">Required / Optional</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">auth-userid</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Authentication Parameter</td></tr><tr><td colspan="1" rowspan="1">api-key</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Authentication Parameter</td></tr><tr><td colspan="1" rowspan="1">domain-name</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">The Domain name whose DNS record(s) you want to search</td></tr><tr><td colspan="1" rowspan="1">type</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">
<p>Type of record. Values may be:</p>
<ul><li>
<p><em>A</em></p>
</li><li>
<p><em>MX</em></p>
</li><li>
<p><em>CNAME</em></p>
</li><li>
<p><em>TXT</em></p>
</li><li>
<p><em>NS</em></p>
</li><li>
<p><em>SRV</em></p>
</li><li>
<p><em>AAAA</em></p>
</li></ul>
</td></tr><tr><td colspan="1" rowspan="1">no-of-records</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Number of Resource Records to be fetched</td></tr><tr><td colspan="1" rowspan="1">page-no</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Page number for which details are to be fetched</td></tr><tr><td colspan="1" rowspan="1">host</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Optional</td><td colspan="1" rowspan="1">Hostname of the record</td></tr><tr><td colspan="1" rowspan="1">value</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Optional</td><td colspan="1" rowspan="1">Value of the record</td></tr></tbody></table>
<h2>HTTP Method</h2>
<p>GET</p>
<h2>Example Test URL Request</h2>
<p><code>https://test.httpapi.com/api/dns/manage/search-records.json?auth-userid=0&amp;api-key=key&amp;domain-name=domain.asia&amp;type=A&amp;no-of-records=10&amp;page-no=1 </code></p>
<h2>Response</h2>
<p>Returns the details of the DNS records, which match the specified criteria.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to search DNS records using the API. This article explains supported DNS record types, available search filters, pagination parameters, and response details for matching DNS records.

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Authentication Parameter
api-key	String	Required	Authentication Parameter
domain-name	String	Required	The Domain name whose DNS record(s) you want to search
type	String	Required	Type of record. Values may be: A MX CNAME TXT NS SRV AAAA
no-of-records	Integer	Required	Number of Resource Records to be fetched
page-no	Integer	Required	Page number for which details are to be fetched
host	String	Optional	Hostname of the record
value	String	Optional	Value of the record