What is APIKEY for?

TS.ChrisR · April 15, 2020, 9:44am

That one can be used to login as the serveradmin into the WebQuery.

Click here to see a mini tutorial about WebQuery .

How to use:

start ts3server with WebQuery enabled ./ts3server query_protocols=raw,ssh,http,https
create a universal API key. ( BAByFoiEXZfnSJyE6dbXFiW_nn_SdwkclpKNz9j in the example)

$ nc -q1 localhost 10011 <<EOF
login serveradmin password
apikeyadd scope=manage lifetime=0
EOF

TS3
Welcome to the TeamSpeak 3 ServerQuery interface, type "help" for a list of commands and "help <command>" for information on a specific command.
error id=0 msg=ok
apikey=BAByFoiEXZfnSJyE6dbXFiW_nn_SdwkclpKNz9j id=4 sid=0 cldbid=1 scope=manage time_left=unlimited created_at=1582102492 expires_at=1582102492
error id=0 msg=ok

testing the API key

$ curl -H 'x-api-key: BAByFoiEXZfnSJyE6dbXFiW_nn_SdwkclpKNz9j' 'http://127.0.0.1:10080/gm?msg=Hello+World'

{"status":{"code":0,"message":"ok"}}

$ curl -H 'x-api-key: BAByFoiEXZfnSJyE6dbXFiW_nn_SdwkclpKNz9j' 'http://127.0.0.1:10080/1/channellist?-topic&-icon'

{"body":[{"channel_icon_id":"0","channel_name":"Default Channel","channel_needed_subscribe_power":"0","channel_order":"0","channel_topic":"Default Channel has no topic","cid":"1","pid":"0","total_clients":"1"}],"status":{"code":0,"message":"ok"}}