Giter VIP home page Giter VIP logo

librenmsapi's Introduction

LibreNMSAPI

A Python API client library for (https://www.librenms.org/ "LibreNMS").
LibreNMS is a fully featured network monitoring system that provides a wealth of features and device support.

Installation

Add the folder LibreNMSAPI to your project this way it can be used as module.

Quick start

To begin import the API and create an instance of the LibreNMSAPI class.

from LibrenmsAPI.LibreNMSAPI import LibreNMSAPI

# Do not use a trailing slasg for the URL
api = librenmsAPI(
  access_token = "token"
  base_url= "https://librenms.example.com/api/v0"
)

Queries

You can reach all endpoints inside the LibreNMS API by calling there routes as attribute of the LibreNMSAPI instance.
All queries return an Endpoint that can again be queried and in some cases contain the data from the queries endpoint (if any).
For example:

all_devices = api.devices.all()
for device in all_devices:
  print(device.device_id)

specific_device = api.devices.get("s01.example.com")
if specific_device:
  print(device.device_id)

specific_device.delete()

Contributing

If you want to contribute please fork this project, push your changes and send a pull request.

librenmsapi's People

Contributors

roberth1993 avatar cliffalbert avatar jpobeda avatar sprich96 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.