Skip to content

DNSApi.md

Latest commit

 

History

History
244 lines (168 loc) · 6.43 KB

DNSApi.md

File metadata and controls

244 lines (168 loc) · 6.43 KB
Raw

WhoisFreaks.DNSApi

All URIs are relative to https://api.whoisfreaks.com

Method HTTP request Description
dnsBulk POST /v2.0/dns/bulk/live Bulk DNS Lookup
dnsHistorical GET /v2.0/dns/historical Historical DNS Lookup
dnsLive GET /v2.0/dns/live Live DNS Lookup
dnsReverse GET /v2.1/dns/reverse Reverse DNS Lookup

dnsBulk

BulkDnsResponse dnsBulk(type, dnsBulkRequest, opts)

Bulk DNS Lookup

Up to 100 domains + 100 IPs in one request.

Example

import WhoisFreaks from 'whoisfreaks';
let defaultClient = WhoisFreaks.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

let apiInstance = new WhoisFreaks.DNSApi();
let type = "'all'"; // String | 
let dnsBulkRequest = new WhoisFreaks.DnsBulkRequest(); // DnsBulkRequest | 
let opts = {
  'format': "'json'" // String | 
};
apiInstance.dnsBulk(type, dnsBulkRequest, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
type String [default to 'all']
dnsBulkRequest DnsBulkRequest
format String [optional] [default to 'json']

Return type

BulkDnsResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

dnsHistorical

HistoricalDnsResponse dnsHistorical(domainName, type, opts)

Historical DNS Lookup

All historical DNS records. 2 credits per page (100 records/page).

Example

import WhoisFreaks from 'whoisfreaks';
let defaultClient = WhoisFreaks.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

let apiInstance = new WhoisFreaks.DNSApi();
let domainName = "domainName_example"; // String | 
let type = "'all'"; // String | 
let opts = {
  'page': 1, // Number | 
  'format': "'json'" // String | 
};
apiInstance.dnsHistorical(domainName, type, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
domainName String
type String [default to 'all']
page Number [optional] [default to 1]
format String [optional] [default to 'json']

Return type

HistoricalDnsResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

dnsLive

DnsResponse dnsLive(type, opts)

Live DNS Lookup

Real-time DNS record lookup. 1 credit per query.

Example

import WhoisFreaks from 'whoisfreaks';
let defaultClient = WhoisFreaks.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

let apiInstance = new WhoisFreaks.DNSApi();
let type = "'all'"; // String | all or comma-separated: A,MX,NS,TXT,SOA,SPF,AAAA,CNAME
let opts = {
  'domainName': "domainName_example", // String | 
  'ipAddress': "ipAddress_example", // String | Use for PTR lookups
  'format': "'json'" // String | 
};
apiInstance.dnsLive(type, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
type String all or comma-separated: A,MX,NS,TXT,SOA,SPF,AAAA,CNAME [default to 'all']
domainName String [optional]
ipAddress String Use for PTR lookups [optional]
format String [optional] [default to 'json']

Return type

DnsResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

dnsReverse

ReverseDnsResponse dnsReverse(value, type, opts)

Reverse DNS Lookup

Search domains by IP or DNS value. 5 credits per page.

Example

import WhoisFreaks from 'whoisfreaks';
let defaultClient = WhoisFreaks.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

let apiInstance = new WhoisFreaks.DNSApi();
let value = "value_example"; // String | IP, CIDR, or record value
let type = "type_example"; // String | 
let opts = {
  'exact': true, // Boolean | 
  'page': 1, // Number | 
  'format': "'json'" // String | 
};
apiInstance.dnsReverse(value, type, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
value String IP, CIDR, or record value
type String
exact Boolean [optional] [default to true]
page Number [optional] [default to 1]
format String [optional] [default to 'json']

Return type

ReverseDnsResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json