AnyDesk REST-API: Features, Setup, Credentials, and Python Module Explained

License: Standard, Advanced, Ultimate-Cloud, On-Premises

The AnyDesk REST API lets you automate the retrieval and management of account data from the my.anydesk I management console.

You can use the API to integrate AnyDesk data with third-party systems, for example, to automate billing or collect session logs.

Features

As of version 1.1.1, the REST API supports the following commands:

• View license details
• View account details (license, number of AnyDesk clients, etc.)
• List all AnyDesk clients registered to the account
• Get details for a specific client (e.g., Alias, online status)
• Remove a client from the license
• Retrieve Session History for a selected time range
• View detailed session data
• Add or update session comments
• Close an active session
• Change a client Alias
• Remove a client Alias
• List the names and IDs of all Address Books associated with your license

Set up the API

The latest REST-API documentation can be found in the Files tab of the my.anydesk.com customer portal.

This documentation contains the setup process (domain, authentication header) to connect the REST-Interface to the AnyDesk Servers.

The latest API documentation is available in the Files tab of my.anydesk I account. It includes instructions for:

• API endpoint domains
• Authentication headers
• Connection setup steps

Credentials

To use the REST API, you’ll need:

• Your License ID
• Your API Password

💡 NOTE

To request API credentials, contact AnyDesk support and provide your customer number.
For On-Premises licenses, refer to the Installation Guide under Console Commands > Advanced Commands > REST-API.

Python module

You can also access an open-source Python module that includes scripts and templates to help you get started with the API. You can use these examples to build your own integrations or automate tasks.

Included example scripts:

• Export session data (to terminal or CSV)
• List all Address Books and their IDs
• List all clients added to your license, including Aliases
• Output system stats (active sessions, total session count, client count, online devices and more)

The module is open-source, so you’re free to adapt it to fit your automation needs.

To get started:

1. Download the Python module from GitHub.
2. Extract the files to your preferred location.
3. In the auth.cfg file (found in /doc/examples/), enter your API credentials.
4. Install the latest version of Python for your OS.

A record of all remote sessions conducted using AnyDesk, including details such as duration and participants.

A guide that provides step-by-step instructions on how to install and set up AnyDesk.