Skip to main content

A python API client for OPNsense

Project description

You can see the full rendered docs at: http://pyopnsense.readthedocs.io/en/latest/

A python API client for the OPNsense API. This provides a python interface for interacting with the OPNsense API.

Installation

pyopnsense is available via pypi so all you need to do is run:

pip install -U pyopnsense

to get the latest pyopnsense release on your system. If you need to use a development version of pyopnsense you can clone the repo and install it locally with:

git clone https://github.com/mtreinish/pyopnsense && pip install -e pyopnsense

which will install pyopnsense in your python environment in editable mode for development.

Usage

To use pyopnsense you need a couple pieces of information, the API key and the API secret. Both can be created/found from the OPNsense web UI by navigating to: System->Access->Users under API keys.

More information on this can be found in the OPNsense documentation: https://docs.opnsense.org/development/how-tos/api.html

Once you have the API key and API secret you can use pyopnsense to interact with your OPNsense installation. You can do this by passing your credentials to a client class. For example:

from pyopnsense import diagnostics

api_key = 'XXXXXX'
api_secret = 'XXXXXXXXXXXXXXX'
opnsense_url = 'http://192.168.1.1/api'
timeout = 5

netinsight_client = diagnostics.NetworkInsightClient(
    api_key, api_secret, opnsense_url, timeout)

print(netinsight_client.get_interfaces())

which will print a dictionary mapping physical devices to their interface label.

This same formula can be used to access each individual API endpoint you need to access. The basic structure of the library is setup to roughly mirror the endpoint tree of the OPNsense API. Each client module maps to the base endpoint and then there is a client class in those modules for the next level up off that.

You can find more detail on how to use the clients in the API reference documentation found here:

http://pyopnsense.readthedocs.io/en/latest/api.html

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyopnsense-0.4.0.tar.gz (22.5 kB view details)

Uploaded Source

Built Distribution

pyopnsense-0.4.0-py3-none-any.whl (23.8 kB view details)

Uploaded Python 3

File details

Details for the file pyopnsense-0.4.0.tar.gz.

File metadata

  • Download URL: pyopnsense-0.4.0.tar.gz
  • Upload date:
  • Size: 22.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for pyopnsense-0.4.0.tar.gz
Algorithm Hash digest
SHA256 dc32a556b3ad31ae79813bb9e7ba60a23469760acee69119dcbfbd80aa16f728
MD5 17a8a7ec8b53006feec45cd8373575d6
BLAKE2b-256 d3081dc0e7948764c59635a560dfd14a15266a5efdb4e628ec737bcfb6a1d59e

See more details on using hashes here.

Provenance

File details

Details for the file pyopnsense-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: pyopnsense-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 23.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for pyopnsense-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0d5ef9de0383a37f7c17e5b7011e345fccd965d0d4188faa155a884f689b0eb1
MD5 3968015b81bfdf67703a8d028931c49a
BLAKE2b-256 822a2d444c937ca5d5e69cf56cbc4577f91f95027d48a5a80892bb1c096e1f49

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page