Where can I find ServerQuery documentation?

TeamSpeak 6 Server
1

Hi,

i need to search for current server query documentation
with paths and parameters.

Best, Sebastian

2

You can visit YaTQA – Resources - a very helpful tool in the TeamSpeak Server Admin community.

3

thx for reply. I will try it, but TS6 has changed to a RESTful API and the documentation will been generated automatic today.

4

You can still use the classic query through ssh. Also, knowing TeamSpeak, I highly doubt the webquery is documented automatically.

3 Likes
5

Hi, I didn’t mean by itself. Thanks to the standardized structure of the Rest API definition (paths and parameters), documentation can now be created fully automatically without anyone having to type it in.

I know there is also the SSH variant, but I don’t need it and didn’t want to use it.

Best, Sebastian

6

That’s fair. Personally, I avoid the webquery since there are still some features that are only supported by the ssh query, specifically events.

1 Like
7

I understand, but in my case, internal communication on my NAS is working. If I find out anything or get information from other sources, I will provide feedback here.

8

Hi,

first thing I found out is that the API key for using the REST API can only be generated via SSH access.

$ ssh serveradmin@domain/ip -p 10022
$ apikeyadd scope=manage lifetime=0

A request to the REST API then works like this:
curl --location ‘http://domain/ip:10080/whoami’ --header ‘x-api-key: XXX’

Currently known and functioning $_GET routes:

  • /whoiam
  • /serverlist
  • /1/clientlist
  • /version

Best, Sebastian

9

The web query essentially supports the exact same commands as the legacy query. You can find a list in the discussion thread about the web query.

2 Likes