Class: PassiveTotal::Client::Enrichment

Inherits:
Base
  • Object
show all
Defined in:
lib/passivetotal/clients/enrichment.rb

Constant Summary

Constants inherited from Base

Base::BASE_URL, Base::HOST, Base::VERSION

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from PassiveTotal::Client::Base

Instance Method Details

#bulk_data(*query) ⇒ Hash

Get bulk enrichment data for many queries api.passivetotal.org/api/docs/#api-Bulk_Enrichment-GetV2EnrichmentBulk

Parameters:

  • query (Array<String>) —

    the domains and IPs being queried

Returns:

  • (Hash) 


78
79
80
81
82
83
84
 
# File 'lib/passivetotal/clients/enrichment.rb', line 78

def bulk_data(*query)
  params = {
    query: query,
  }.compact

  _get("/enrichment/bulk", params) { |json| json }
end

#bulk_malware(*query) ⇒ Hash

Get bulk malware data for many queries api.passivetotal.org/api/docs/#api-Bulk_Enrichment-GetV2EnrichmentBulkMalware

Parameters:

  • query (Array<String>) —

    the domains and IPs being queried

Returns:

  • (Hash) 


94
95
96
97
98
99
100
 
# File 'lib/passivetotal/clients/enrichment.rb', line 94

def bulk_malware(*query)
  params = {
    query: query,
  }.compact

  _get("/enrichment/bulk/malware", params) { |json| json }
end

#bulk_osint(*query) ⇒ Hash

Get bulk osint data for many queries api.passivetotal.org/api/docs/#api-Bulk_Enrichment-GetV2EnrichmentBulkOsint

Parameters:

  • query (Array<String>) —

    the domains and IPs being queried

Returns:

  • (Hash) 


110
111
112
113
114
115
116
 
# File 'lib/passivetotal/clients/enrichment.rb', line 110

def bulk_osint(*query)
  params = {
    query: query,
  }.compact

  _get("/enrichment/bulk/osint", params) { |json| json }
end

#get(query) ⇒ Hash

Get enrichment data for a query api.passivetotal.org/api/docs/#api-Enrichment-GetV2Enrichment

Parameters:

  • query (String) —

    the domain or IP being queried

Returns:

  • (Hash) 


14
15
16
17
18
19
20
 
# File 'lib/passivetotal/clients/enrichment.rb', line 14

def get(query)
  params = {
    query: query,
  }.compact

  _get("/enrichment", params) { |json| json }
end

#malware(query) ⇒ Hash

Get malware data for a query api.passivetotal.org/api/docs/#api-Enrichment-GetV2EnrichmentMalware

Parameters:

  • query (String) —

    the domain or IP being queried

Returns:

  • (Hash) 


30
31
32
33
34
35
36
 
# File 'lib/passivetotal/clients/enrichment.rb', line 30

def malware(query)
  params = {
    query: query,
  }.compact

  _get("/enrichment/malware", params) { |json| json }
end

#osint(query) ⇒ Hash

Get osint data for a query api.passivetotal.org/api/docs/#api-Enrichment-GetV2EnrichmentOsint

Parameters:

  • query (String) —

    the domain or IP being queried

Returns:

  • (Hash) 


46
47
48
49
50
51
52
 
# File 'lib/passivetotal/clients/enrichment.rb', line 46

def osint(query)
  params = {
    query: query,
  }.compact

  _get("/enrichment/osint", params) { |json| json }
end

#subdomains(query) ⇒ Hash

Get subdomains data for a query api.passivetotal.org/api/docs/#api-Enrichment-GetV2EnrichmentSubdomains

Parameters:

  • query (String) —

    the domain being queried

Returns:

  • (Hash) 


62
63
64
65
66
67
68
 
# File 'lib/passivetotal/clients/enrichment.rb', line 62

def subdomains(query)
  params = {
    query: query,
  }.compact

  _get("/enrichment/subdomains", params) { |json| json }
end