Skip to content

DatabasesExpiringDroppedApi.md

Latest commit

 

History

History
385 lines (277 loc) · 9.74 KB

DatabasesExpiringDroppedApi.md

File metadata and controls

385 lines (277 loc) · 9.74 KB
Raw

WhoisFreaks::DatabasesExpiringDroppedApi

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

Method HTTP request Description
db_dropped GET /v3.1/download/domainer/dropped Dropped Domains
db_dropped_backlinks GET /v3.3/download/domainer/dropped/backlinks Dropped With Backlinks
db_dropped_json GET /v3.1/domains/dropped Dropped Domains (JSON)
db_expired GET /v3.1/download/domainer/expired Expiring Domains
db_expired_cleaned GET /v3.1/download/domainer/expired/cleaned Expiring Cleaned WHOIS

db_dropped

File db_dropped(whois, opts)

Dropped Domains

Dropped Domains. Returns the file/snapshot described by this operation.

Examples

require 'time'
require 'whoisfreaks'
# setup authorization
WhoisFreaks.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'
end

api_instance = WhoisFreaks::DatabasesExpiringDroppedApi.new
whois = true # Boolean | 
opts = {
  date: Date.parse('2013-10-20') # Date | yyyy-MM-dd; omit for latest
}

begin
  # Dropped Domains
  result = api_instance.db_dropped(whois, opts)
  p result
rescue WhoisFreaks::ApiError => e
  puts "Error when calling DatabasesExpiringDroppedApi->db_dropped: #{e}"
end

Using the db_dropped_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(File, Integer, Hash)> db_dropped_with_http_info(whois, opts)

begin
  # Dropped Domains
  data, status_code, headers = api_instance.db_dropped_with_http_info(whois, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => File
rescue WhoisFreaks::ApiError => e
  puts "Error when calling DatabasesExpiringDroppedApi->db_dropped_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
whois Boolean
date Date yyyy-MM-dd; omit for latest [optional]

Return type

File

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream, application/json

db_dropped_backlinks

File db_dropped_backlinks(opts)

Dropped With Backlinks

Dropped With Backlinks. Returns the file/snapshot described by this operation.

Examples

require 'time'
require 'whoisfreaks'
# setup authorization
WhoisFreaks.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'
end

api_instance = WhoisFreaks::DatabasesExpiringDroppedApi.new
opts = {
  whois: true, # Boolean | 
  date: Date.parse('2013-10-20') # Date | yyyy-MM-dd; omit for latest
}

begin
  # Dropped With Backlinks
  result = api_instance.db_dropped_backlinks(opts)
  p result
rescue WhoisFreaks::ApiError => e
  puts "Error when calling DatabasesExpiringDroppedApi->db_dropped_backlinks: #{e}"
end

Using the db_dropped_backlinks_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(File, Integer, Hash)> db_dropped_backlinks_with_http_info(opts)

begin
  # Dropped With Backlinks
  data, status_code, headers = api_instance.db_dropped_backlinks_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => File
rescue WhoisFreaks::ApiError => e
  puts "Error when calling DatabasesExpiringDroppedApi->db_dropped_backlinks_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
whois Boolean [optional]
date Date yyyy-MM-dd; omit for latest [optional]

Return type

File

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream, application/json

db_dropped_json

Array<String> db_dropped_json(opts)

Dropped Domains (JSON)

Dropped Domains (JSON). Returns the file/snapshot described by this operation.

Examples

require 'time'
require 'whoisfreaks'
# setup authorization
WhoisFreaks.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'
end

api_instance = WhoisFreaks::DatabasesExpiringDroppedApi.new
opts = {
  date: Date.parse('2013-10-20'), # Date | yyyy-MM-dd; omit for latest
  tlds: 'tlds_example' # String | 
}

begin
  # Dropped Domains (JSON)
  result = api_instance.db_dropped_json(opts)
  p result
rescue WhoisFreaks::ApiError => e
  puts "Error when calling DatabasesExpiringDroppedApi->db_dropped_json: #{e}"
end

Using the db_dropped_json_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(Array<String>, Integer, Hash)> db_dropped_json_with_http_info(opts)

begin
  # Dropped Domains (JSON)
  data, status_code, headers = api_instance.db_dropped_json_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Array&lt;String&gt;
rescue WhoisFreaks::ApiError => e
  puts "Error when calling DatabasesExpiringDroppedApi->db_dropped_json_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
date Date yyyy-MM-dd; omit for latest [optional]
tlds String [optional]

Return type

Array<String>

Authorization

ApiKeyAuth

HTTP request headers

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

db_expired

File db_expired(whois, opts)

Expiring Domains

Expiring Domains. Returns the file/snapshot described by this operation.

Examples

require 'time'
require 'whoisfreaks'
# setup authorization
WhoisFreaks.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'
end

api_instance = WhoisFreaks::DatabasesExpiringDroppedApi.new
whois = true # Boolean | 
opts = {
  date: Date.parse('2013-10-20') # Date | yyyy-MM-dd; omit for latest
}

begin
  # Expiring Domains
  result = api_instance.db_expired(whois, opts)
  p result
rescue WhoisFreaks::ApiError => e
  puts "Error when calling DatabasesExpiringDroppedApi->db_expired: #{e}"
end

Using the db_expired_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(File, Integer, Hash)> db_expired_with_http_info(whois, opts)

begin
  # Expiring Domains
  data, status_code, headers = api_instance.db_expired_with_http_info(whois, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => File
rescue WhoisFreaks::ApiError => e
  puts "Error when calling DatabasesExpiringDroppedApi->db_expired_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
whois Boolean
date Date yyyy-MM-dd; omit for latest [optional]

Return type

File

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream, application/json

db_expired_cleaned

File db_expired_cleaned(opts)

Expiring Cleaned WHOIS

Expiring Cleaned WHOIS. Returns the file/snapshot described by this operation.

Examples

require 'time'
require 'whoisfreaks'
# setup authorization
WhoisFreaks.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'
end

api_instance = WhoisFreaks::DatabasesExpiringDroppedApi.new
opts = {
  date: Date.parse('2013-10-20') # Date | yyyy-MM-dd; omit for latest
}

begin
  # Expiring Cleaned WHOIS
  result = api_instance.db_expired_cleaned(opts)
  p result
rescue WhoisFreaks::ApiError => e
  puts "Error when calling DatabasesExpiringDroppedApi->db_expired_cleaned: #{e}"
end

Using the db_expired_cleaned_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(File, Integer, Hash)> db_expired_cleaned_with_http_info(opts)

begin
  # Expiring Cleaned WHOIS
  data, status_code, headers = api_instance.db_expired_cleaned_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => File
rescue WhoisFreaks::ApiError => e
  puts "Error when calling DatabasesExpiringDroppedApi->db_expired_cleaned_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
date Date yyyy-MM-dd; omit for latest [optional]

Return type

File

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream, application/json