BackscatterIO - the Ruby gem for the Backscatter.io
This is the Backscatter.io API.
This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.RubyClientCodegen
To build the Ruby code into a gem:
gem build backscatterio.gemspec
Then either install the gem locally:
gem install ./backscatterio-1.0.0.gem
(for development, run gem install --dev ./backscatterio-1.0.0.gem
to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'backscatterio', '~> 1.0.0'
If the Ruby gem is hosted at a git repository: https://github.com/backscatterio/ruby, then add the following in the Gemfile:
gem 'backscatterio', :git => 'https://github.com/backscatterio/ruby.git'
Include the Ruby code directly using -I
as follows:
ruby -Ilib script.rb
Please follow the installation procedure and then run the following code:
# Load the gem
require 'backscatterio'
# Setup authorization
BackscatterIO.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-KEY'] = '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['X-API-KEY'] = 'Bearer'
end
api_instance = BackscatterIO::Api.new
query = 'query_example' # String |
begin
#enriches asn
result = api_instance.enrich_asn(query)
p result
rescue BackscatterIO::ApiError => e
puts "Exception when calling Api->enrich_asn: #{e}"
end
All URIs are relative to https://api.backscatter.io/v0
Class | Method | HTTP request | Description |
---|---|---|---|
BackscatterIO::Api | enrich_asn | GET /enrichment/asn | enriches asn |
BackscatterIO::Api | enrich_ip | GET /enrichment/ip | enriches ip |
BackscatterIO::Api | enrich_network | GET /enrichment/network | enriches network |
BackscatterIO::Api | hello | GET /hello | authenticate to the service |
BackscatterIO::Api | observations | GET /observations/{queryType} | fetches observations for a given ip address |
BackscatterIO::Api | trends | GET /trends/popular/{trendType} | Top N items |
- BackscatterIO::ASNEnrichment
- BackscatterIO::ASNEnrichmentResults
- BackscatterIO::Hello
- BackscatterIO::IPEnrichment
- BackscatterIO::IPEnrichmentResults
- BackscatterIO::NetworkEnrichment
- BackscatterIO::NetworkEnrichmentResults
- BackscatterIO::Observation
- BackscatterIO::Observations
- BackscatterIO::Query
- BackscatterIO::Results
- BackscatterIO::Summary
- BackscatterIO::Trends
- BackscatterIO::Unique
- Type: API key
- API key parameter name: X-API-KEY
- Location: HTTP header