tailscale 0.7.0

Asynchronous Python client for the Tailscale API.

Python: Asynchronous client for the Tailscale API

Asynchronous Python client for the Tailscale API.

About

This package allows you to control and monitor Tailscale clients programmatically. It is mainly created to allow third-party programs to integrate with Tailscale.

An excellent example of this might be Home Assistant, which allows you to write automations based on the status of your Tailscale network devices.

Installation

pip install tailscale

Usage

The client is an async context manager; every API call is a coroutine. A quick example that lists all devices in your tailnet:

import asyncio

from tailscale import Tailscale


async def main() -> None:
    """Show example of using the Tailscale API client."""
    async with Tailscale(
        tailnet="frenck",
        api_key="tskey-somethingsomething",
    ) as tailscale:
        devices = await tailscale.devices()

        for device_id, device in devices.items():
            print(f"{device.hostname} ({device.os})")
            print(f"  Addresses: {', '.join(device.addresses)}")
            print(f"  Last seen: {device.last_seen}")
            print(f"  Update available: {device.update_available}")


if __name__ == "__main__":
    asyncio.run(main())

Each device returned is a Device dataclass with properties like hostname, os, addresses, authorized, client_version, last_seen, tags, advertised_routes, enabled_routes, and more. Devices are returned as a dictionary keyed by device ID.

Connection options

All constructor arguments except tailnet and api_key are optional:

Tailscale(
    tailnet="your-tailnet",
    api_key="tskey-...",
    request_timeout=10,  # per-request timeout in seconds (default: 8)
)

You may also pass your own aiohttp.ClientSession via session=... to share a connection pool across multiple clients.

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

• MAJOR: Incompatible or major changes.
• MINOR: Backwards-compatible new features and enhancements.
• PATCH: Backwards-compatible bugfixes and package updates.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! :heart_eyes:

Setting up development environment

This Python project is fully managed using the Poetry dependency manager. But also relies on the use of NodeJS for certain checks during development.

You need at least:

• Python 3.11+
• Poetry
• NodeJS 24+ (including NPM)

To install all packages, including all development requirements:

npm install
poetry install

As this repository uses the prek framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:

poetry run prek run --all-files

To run just the Python tests:

poetry run pytest

Authors & contributors

The original setup of this repository is by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

Disclaimer

This project is an independent, community-driven effort and is not affiliated with, endorsed by, or supported by Tailscale Inc. All product names, trademarks, and registered trademarks are property of their respective owners.

This library interacts with the Tailscale API, which is a publicly documented interface. A valid API key, issued by Tailscale, is required to use this library.

Use this software at your own risk. The authors are not responsible for any consequences resulting from the use of this library, including but not limited to unintended changes to your Tailscale network configuration.

License

MIT License

Copyright (c) 2021-2026 Franck Nijhof

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.