Pytonika

Pytonika is a typed Python client for the Teltonika Networks Web API. It wraps the API in device-aware classes, so you can automate routers, gateways, access points and switches without building raw HTTP requests yourself.

Features

• Device-aware — each of the 88 supported models exposes the endpoint groups documented for it, so your editor autocompletes only what that device actually supports.
• Full API coverage — 160+ endpoint groups and 2,500+ operations, from interfaces and firewall to VPNs, mobile, GPS, Modbus and more, including file uploads and downloads.
• Simple session handling — log in once and the Bearer token is attached to every subsequent request.
• Fully typed — ships with py.typed and type hints on every public method.
• Lightweight — synchronous client built on httpx, with no other runtime dependencies.

Installation

Pytonika requires Python 3.11 or later.

pip install pytonika

Quick start

from pytonika import RUTX50

with RUTX50("https://192.168.1.1/") as device:
    device.authentication.login("admin", "<password>")

    status = device.firmware.get_firmware_device_status()
    print(status["data"]["version"])

    device.authentication.logout()

Using the device as a context manager closes the underlying HTTP connection when the block exits. Outside a with block, call device.close() when you are done.

Connection options

Every device class accepts the same keyword arguments:

To keep verification enabled with your own certificate authority, pass an ssl.SSLContext:

import ssl

from pytonika import RUTX50

context = ssl.create_default_context(cafile="/path/to/ca.pem")

with RUTX50("https://192.168.1.1/", verify=context) as device:
    ...

Responses

Methods return the API's JSON response as a dict, without modification:

response = device.interfaces.get_interfaces_status()

if response["success"]:
    for interface in response["data"]:
        ...
else:
    print(response["errors"])

Pytonika does not raise exceptions for API-level errors, so check the success field before using data. Network failures (timeouts, connection errors) are raised by httpx as usual.

Query parameters, uploads and downloads

Optional query parameters are keyword arguments, and are only sent when you pass them:

device.wireguard.get_wireguard_config(all_options=True)

Methods that upload a file take a file argument: raw bytes, an open binary file, or a (filename, content) pair. Methods that download a file return its content as bytes, or the JSON error dict if the device refuses:

from pathlib import Path

with open("firmware.bin", "rb") as firmware:
    device.firmware.firmware_actions_upload_device_firmware(firmware)

device.backup.backup_actions_generate()
backup = device.backup.backup_actions_download()

if isinstance(backup, bytes):
    Path("backup.tar.gz").write_bytes(backup)

Generic device classes

If you don't need model-specific endpoints, use the generic class for the device family. It works with any model of that family and exposes the endpoint groups common to all of them:

from pytonika import Router

with Router("https://192.168.1.1/", timeout=30.0) as router:
    router.authentication.login("admin", "<password>")
    router.wireguard.get_wireguard_config()

Supported devices

Pytonika supports 88 models across four families. Each family has a generic class, and each model has its own class with the endpoints specific to it:

Endpoints are generated from the official API reference for the latest firmware documented for each model: RutOS 7.25.3 for most models. A few models are documented for older firmware lines (7.23.8 for RUTM31, 7.14.5 for RUT300, RUT360, TCR100, TRB245 and TRB255, 7.6.21 for RUT240, RUT950 and RUT955, and SwOS 1.10.2 for the switches), and their classes reflect that. Operations added in newer firmware return an error on devices running an older version.

Missing a device? Open a device request.

Endpoints

Each endpoint group from the official API reference is available as an attribute named after the group:

Method names follow the structure of the API:

The full list of groups is in pytonika/endpoints/. For request payloads and response schemas, see the Teltonika Web API reference.

Project status

Pytonika is in beta (pre-1.0). The public interface may change between minor releases; changes are documented in the release notes.

Contributing

Bug reports, device and endpoint requests and pull requests are welcome. See the Contributing guidelines to get started.

Security

Please do not report vulnerabilities through public issues. See the Security Policy for how to report them privately.

License

Distributed under the MIT License.