Jump to content

API getwgconfig: Difference between revisions

From Wiki 7Kas
API docs (generated from func=help)
 
API docs regenerated from func=help (operator catalogue)
 
Line 1: Line 1:
''7Kas VoIP REST API function. Available to: '''SuperRoot, Operator, Client'''.''
''7Kas VoIP REST API function. Available to: '''Operator, Client'''.''


== Description ==
== Description ==
Line 21: Line 21:


----
----
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile SuperRoot]], [[API profile Operator]], [[API profile Client (of operator)]], [[API profile Client (direct)]]
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile Operator]], [[API profile Client (of operator)]], [[API profile Client (direct)]]
[[Category:API SuperRoot]][[Category:API Operator]][[Category:API Client]][[Category:API function]]
[[Category:API Operator]][[Category:API Client]][[Category:API function]]

Latest revision as of 13:47, 5 November 2026

7Kas VoIP REST API function. Available to: Operator, Client.

Description

Returns the WireGuard config for an SSIP device, authenticated by the device's vpnpassword (no role gate — any valid ukey with the correct password).

Call

GET  …/7Kas?func=getwgconfig&ukey=YOUR_KEY&…

Requires the ukey parameter.

Parameters

Parameter Type Required Default Meaning
password string Yes — The device vpnpassword (max 128).

Example

https://api.7kas.com:9080/7Kas?func=getwgconfig&ukey=KEY&password=DEVICEPASS

Response

Object/records with the WireGuard configuration.


Back to API VoIP · ▶ Try it live · Profiles: API profile Operator, API profile Client (of operator), API profile Client (direct)