pfsense-api
v1.0.1
Published
Wrapper for pfsense REST api, no association with pfsense
Downloads
105
Maintainers
Readme
Pfsense-api
This npm package is designed to interact with the Pfsense API, inspired by the work done in jaredhendrickson13/pfsense-api.
Installation
To install the package, run:
npm install pfsense-api
Usage
Here is a basic example of how to use the package:
import Pfsense from "pfsense";
const pf = new Pfsense("https://hosturl", "api_key");
const version = await pf.system.getVersion();
Implements all endpoints from pfrest
Features
- Easy interaction with Pfsense API
- Supports multiple endpoints
- Handles authentication
Contributing
Contributions are welcome! Please fork the repository and submit a pull request.
Disclaimers
Caution
Just like the RESTAPI, This package is not affiliated or supported by Netgate or the pfSense team. This package is developed and maintained by the community.
License
This project is licensed under the Apache-2.0 License.