wildfire-client

Node.JS wildfire api client library.

Usage no npm install needed!

<script type="module">
  import wildfireClient from 'https://cdn.skypack.dev/wildfire-client';
</script>

README

wildfire-client Build Status

Node.JS wildfire api client library.

Getting Started

npm install --save wildfire-client

const createWildfireClient = require("wildfire-client").create

const wildfireClient = createWildfireClient({
    apikey: process.env.API_KEY,    // get your own :)
    baseUrl: process.env.BASE_URL,  // https://wildfire.paloaltonetworks.com/publicapi/
    json: true                      // api is xml only, client library converts the xml to json using xml2js
})

// Promise based client
wildfireClient.submitFile({file: "<read_stream>"});   // /submit/file
wildfireClient.submitUrl({url: "<url>"});             // /submit/url
wildfireClient.getReport({hash: "<sha256>"});         // /get/report
wildfireClient.getVerdict({hash: "<sha256>"});        // /get/verdict

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the ISC License - see the LICENSE file for details