We use cookies. You can opt out and disable them in our Cookie Settings. See our Privacy Policy for more information.

REST-API

The AnyDesk REST-API is an interface to automate the retrieval and storage of database information from your AnyDesk account available for Professional, Power and Enterprise users. A general use case is to integrate AnyDesk into 3rd party applications such as automated billing applications or to collect session data.

Features

The REST-API supports the following commands in the current version 1.1.1:

  • Display the license info
  • Show system information (license, number of clients, etc.)
  • Show the client list
  • Show client details (such as online status, alias etc.)
  • Remove a client from your license
  • Show a session list within a given time frame
  • Show details of a particular session
  • Change session comment
  • Close an active session
  • Change an alias
  • Remove an alias
  • List name and ID of every address books in your license

Setup

To use the AnyDesk REST-API, login to my.anydesk.com and get the latest REST-API Documentation.
This document reveals the setup process (domain, authentication header) to connect to the AnyDesk Server.

Credentials

In order to access the REST-interface you need:

  • LicenseID
  • API-Password
Note: For the REST-API credentials contact us by providing your customer number. For OnPremises, refer to the Manual.

Python module

AnyDesk provides a Python module and example scripts to access the REST API. You can use it as a reference for implementing your own programs or to quickly create scripts to automate tasks.

The example scripts include:

  • Output of session data of every connection made within your license i.e. license name, max sessions, namespaces, etc.
Either as text response in the terminal or file export to .csv
  • Listing of all address book names and their IDs.
  • Listing of all IDs that have been added to your license including the alias, if applied.
  • System information like active sessions, total session count, client count, online clients and more.
  • The Python API is open source. Write scripts yourself to optimize your workflow.

Configure Python-Module

  • Download and install the latest Python for your operating system: Download Python
  • Configure environment variables (optional).
  • Download the Python-Module files.
  • Copy files to a preferred location and enter your API credentials in the "auth.cfg" which is located in "doc/examples/".