Tunploy
APIReferenceDevices

Get a device's config

GET/devices/{id}/config

Needs the devices:read scope.

Authorization

apiKey
AuthorizationBearer <token>

An API key: tp_….

In: header

Path Parameters

id*integer

Device ID.

Range1 <= value

Query Parameters

format?string
Default"conf"

Value in

  • "conf"
  • "qr"
kill_switch?boolean

true adds wg-quick firewall rules that block all traffic outside the tunnel while it is up, for Linux. Only with format=conf: phone and Windows apps refuse the PostUp lines, and have their own kill switch setting.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/devices/1/config"
"string"