Class: SecurityTrails::Clients::IPs

Inherits:
SecurityTrails::Client show all
Defined in:
lib/securitytrails/clients/ips.rb

Constant Summary

Constants inherited from SecurityTrails::Client

SecurityTrails::Client::API_KEY_HEADER, SecurityTrails::Client::HOST, SecurityTrails::Client::URL, SecurityTrails::Client::VERSION

Instance Attribute Summary

Attributes inherited from SecurityTrails::Client

#api_key

Instance Method Summary collapse

Methods inherited from SecurityTrails::Client

#initialize

Constructor Details

This class inherits a constructor from SecurityTrails::Client

Instance Method Details

#explore(ipaddress) ⇒ Hash

Returns the neighbors in any given IP level range and essentially allows you to explore closeby IP addresses.

Parameters:

  • ipaddress (String) —

    Starting IP address (optionally with CIDR subnet mask)

Returns:

  • (Hash)

See Also:



15
16
17
 
# File 'lib/securitytrails/clients/ips.rb', line 15

def explore(ipaddress)
  get("/ips/nearby/#{ipaddress}") { |json| json }
end

#search(query) ⇒ Hash

Search IPs (DSL)

Parameters:

  • query (String) —

    The DSL query you want to run against the IPs database.

Returns:

  • (Hash)

See Also:



28
29
30
 
# File 'lib/securitytrails/clients/ips.rb', line 28

def search(query)
  post("/ips/list", query: query) { |json| json }
end

#stats(query) ⇒ Hash

IP Search statistics

Parameters:

  • query (String)

Returns:

  • (Hash)

See Also:



41
42
43
 
# File 'lib/securitytrails/clients/ips.rb', line 41

def stats(query)
  post("/ips/stats", query: query) { |json| json }
end