REST RouterOS
A python module for the RouterOS REST API
Report Bug
·
Request Feature
Table of Contents
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.
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.
Getting Started
Prerequisites
Python and HTTPX is required
- HTTPX
pip install httpx
Installation
Install the module using pip
- RestRouterOS
pip install Rest-RouterOS
Usage
import json
from RestRouterOS.api import RestRouterOS
router = RestRouterOS("hostname", "username", "password")
response = router.identity()
print(json.dumps(response, indent=4))
Roadmap
- Build Complete Roadmap
- Get Calls For DNS
- Get Calls For DHCP
- Build Documentation
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".
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Top contributors:
License
Distributed under the MIT License. See LICENSE.txt for more information.
Contact
Silvertoken - https://github.com/silvertoken
Project Link: https://github.com/silvertoken/rest-routeros
Metadata
Release files for Rest-RouterOS 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| rest_routeros-0.1.1.tar.gz | 5.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| Rest_RouterOS-0.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 10.9 kB
Release files / rest_routeros-0.1.1.tar.gz
| Download URL | rest_routeros-0.1.1.tar.gz |
|---|---|
| Size | 5.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4c96803d4fa4f23e785b8de518142a020706d2005c7e0bdcdb804bec98b99b5d
|
|
BLAKE2b-256 checksum How to use checksums |
dac6981fe90a91a2c1160e42d0e8e199f522115ce0c5525f5fcc49fa6e924b18
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 8, 2025.
Transparency logRelease files / Rest_RouterOS-0.1.1-py3-none-any.whl
| Download URL | Rest_RouterOS-0.1.1-py3-none-any.whl |
|---|---|
| Size | 5.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a5586dba0ddf7140c1a7a67e188e08893f89a0d758282428bb464ec9f67c2391
|
|
BLAKE2b-256 checksum How to use checksums |
5114c4dce0772be14923bbd0bf101ecb320d1a3063106b0025c7895a44e868c9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 8, 2025.
Transparency log