README.md in falconz-1.0.0 vs README.md in falconz-1.0.1

- old
+ new

@@ -3,26 +3,36 @@ <p align="center"> <img alt="i like birds" src="falcon.jpg"/> <p> -Falcon Sandbox has a powerful and simple API that can be used to submit files/URLs for analysis, pull report data, but also perform advanced search queries. The API is open and free to the entire IT-security community. +[Falcon Sandbox](https://www.hybrid-analysis.com/docs/api/v2) has a powerful and simple API that can be used to submit files/URLs for analysis, pull report data, but also perform advanced search queries. The API is open and free to the entire IT-security community. ## Installation $ gem install falconz ## Usage -Currently requires the `HYBRID_ANALYSIS_API_KEY` enviroment variable set to communicate with the API. +Currently requires the `HYBRID_ANALYSIS_API_KEY` environment variable set to communicate with the API. ```ruby require "falconz" client = Falconz.client.new ``` +Get the current file hashes that are being processed along with their environment IDs. +```ruby +client.in_progress +# => [{:hash=>"b8560ce1bacb5515fdaef7cb3615a8172663da749b038687ab4a439cbf64f23b", :environment=>"100"}, +# {:hash=>"4f456ae8d592a73be8e898384a6b78cf1406965bcb2cea38ffa976c1084acb74", :environment=>"120"}, +# {:hash=>"6e206c74d4b9796264e5e2cb351e563806320e8d6d794fba38d3be93aa4b1bb5", :environment=>"100"}, +# {:hash=>"8d5bd56a19d06d46c8e92552f0bf81fa38cbf3365ab022e97075810be18000d9", :environment=>"120"}, +# {:hash=>"497f631d332b6b242528409778ecb7a778b1b50d6964139b549fdd71410381bc", :environment=>"120"}] +``` + Upload a local file to the sandbox. ```ruby client.submit_file(file: "malware.exe", environment_id: 100) # => {"job_id"=>"5acc00b27ca3e138c14ab0e4", # "environment_id"=>"100", @@ -43,9 +53,15 @@ Check the number of environments available to use. ```ruby client.number_of_environments # => 5 +``` + +Get the available environments ID numbers. +```ruby +client.environment_ids +# => [100, 110, 120, 300, 200] ``` Get information about current API key being used. ```ruby client.current_key