firewalla / msp-api-examples

Sample code on using Firewalla MSP API

Home Page:https://firewalla.net

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Firewalla Managed Security Portal (MSP) API Examples

This repository contains code examples that demonstrate how to use Firewalla MSP API to interact with Firewalla MSP. You can read, play with, or adapt from these examples to create your own applications.

Prerequisites

  • A Firewalla MSP account and a valid plan
  • Access token from your MSP account, check the document for details

Quick Start

You can use either file or environment variable to setup your MSP domain and credential, check each example for details

git clone https://github.com/firewalla/msp-api-examples.git
cd msp-api-examples/flow-pagination
npm install
domain="<YOUR-MSP-DOMAIN>" token="<YOUR-MSP-TOKEN>" node ./flow-pagination/index.js

Examples

Example Firewalla MSP API Document Contributors
Flow Pagination Flow
Get Active Alarms By Specific Box Alarm
Send alarms to Discord Alarm
Get Offline Devices Device
Get Top Bandwidth Usage Devices TBD
Target list with CloudFlare Target List @CozMedic
Target list with CrowdSec Target List @CozMedic

Disclaimer

As Firewalla MSP API will operate directly on your data, please be careful about what you are writing.

Contributing

Pull requests are welcome. The latest development happens on main branch

You might also want to check our user community on firewalla.com and reddit

About

Sample code on using Firewalla MSP API

https://firewalla.net

License:MIT License


Languages

Language:JavaScript 75.8%Language:Shell 24.2%