KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #ai-agents #dsh-plugin #codex #developer-tools #claude-code #windows #desktop-app #typescript #rust #ai-agent #cli

msp-api-examples

★ 28 Open GitHub ↗

Sample code on using Firewalla MSP API

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Firewalla Managed Security Portal (MSP) API Examples

This repository contains code examples that demonstrate how to use [Firewalla MSP API](https://docs.firewalla.net/) to interact with [Firewalla MSP](https://firewalla.net/). You can read, play with, or adapt from these examples to create your own applications.

## Prerequisites

- A Firewalla MSP account and a valid [plan](https://firewalla.net/plans)
- Access token from your MSP account, check the [document](https://docs.firewalla.net/#create-your-personal-access-token) for details

## Quick Start

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

```bash
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-pagination/index.js) | [Flow](https://docs.firewalla.net/api-reference/flow/) | |
| [Get Active Alarms By Specific Box](./get-active-alarms-by-specific-box/index.js) | [Alarm](https://docs.firewalla.net/api-reference/alarm/) | |
| [Send alarms to Discord](./send-alarms-to-discord/README.md) | [Alarm](https://docs.firewalla.net/api-reference/alarm/) | |
| [Get Offline Devices](./get-offline-devices/README.md) | [Device](https://docs.firewalla.net/api-reference/device/) | |
| [Get Top Bandwidth Usage Devices](./get-top-bandwidth-usage-devices/README.md) | TBD | |
| [Target List from Gaming Alarm IPs](./target-list-from-gaming-alarm-ips/README.md) | [Alarm](https://docs.firewalla.net/api-reference/alarm/), [Target List](https://docs.firewalla.net/api-reference/target-lists/) | |
| [Target list with CloudFlare](./target-list-with-cloudflare/README.md) | [Target List](https://docs.firewalla.net/api-reference/target-lists/) | [@CozMedic](https://github.com/CozMedic) |
| [Target list with CrowdSec](./target-list-with-crowdsec/README.md) | [Target List](https://docs.firewalla.net/api-reference/target-lists/) | [@CozMedic](https://github.com/CozMedic) |
| [Get Rules With Conditions](./get-rules-with-conditions/README.md) _2.7.0 or later_ | [Rule](https://docs.firewalla.net/api-reference/rule/#get-rules) | |
| [Pause An Existing Rule](./pause-an-existing-rule/README.md) | [Rule](https://docs.firewalla.net/api-reference/rule/#pause-a-rule) | |

## 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](https://help.firewalla.com/hc/en-us/community/topics) and [reddit](https://www.reddit.com/r/firewalla/)

msp-api-examples

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README