Skip to main content

A python module for RouterOS REST API

Project description

Contributors Forks Stars Commits Issues


REST RouterOS

A python module for the RouterOS REST API
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

There are many modules I found for the Mikrotik RouterOS. I didn't find any for the REST API and I have my router configured to support short lived certs with Hashicorp vault. Current implementations only allow for it to manage one certificate service.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

  • Python
  • HTTPX

(back to top)

Getting Started

Prerequisites

Python and HTTPX is required

  • HTTPX
    pip install httpx
    

Installation

Install the module using pip

  • RestRouterOS
    pip install Rest-RouterOS
    

(back to top)

Usage

import json
from RestRouterOS.api import RestRouterOS

router = RestRouterOS("hostname", "username", "password")
response = router.identity()
print(json.dumps(response, indent=4))

(back to top)

Roadmap

  • Build Complete Roadmap
  • Get Calls For DNS
  • Get Calls For DHCP
  • Build Documentation

(back to top)

Contributing

If you would like to help with development, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Top contributors:

contrib.rocks image

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Silvertoken - https://github.com/silvertoken

Project Link: https://github.com/silvertoken/rest-routeros

(back to top)

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

rest_routeros-0.1.1.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

Rest_RouterOS-0.1.1-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file rest_routeros-0.1.1.tar.gz.

File metadata

  • Download URL: rest_routeros-0.1.1.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for rest_routeros-0.1.1.tar.gz
Algorithm Hash digest
SHA256 4c96803d4fa4f23e785b8de518142a020706d2005c7e0bdcdb804bec98b99b5d
MD5 65de4f6bccbf09d75e6dea292cf89cf2
BLAKE2b-256 dac6981fe90a91a2c1160e42d0e8e199f522115ce0c5525f5fcc49fa6e924b18

See more details on using hashes here.

Provenance

The following attestation bundles were made for rest_routeros-0.1.1.tar.gz:

Publisher: pypi.yml on silvertoken/rest-routeros

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file Rest_RouterOS-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: Rest_RouterOS-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for Rest_RouterOS-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a5586dba0ddf7140c1a7a67e188e08893f89a0d758282428bb464ec9f67c2391
MD5 8fdbe593cb4a6d90b9ac7c236a0a0b7a
BLAKE2b-256 5114c4dce0772be14923bbd0bf101ecb320d1a3063106b0025c7895a44e868c9

See more details on using hashes here.

Provenance

The following attestation bundles were made for Rest_RouterOS-0.1.1-py3-none-any.whl:

Publisher: pypi.yml on silvertoken/rest-routeros

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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