API setwgstatus: Difference between revisions
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: ''' | ''7Kas VoIP REST API function. Available to: '''Operator'''.'' | ||
== Description == | == Description == | ||
| Line 25: | Line 25: | ||
---- | ---- | ||
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: | Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile Operator]] | ||
[[Category:API Operator]][[Category:API function]] | |||
Latest revision as of 13:47, 5 November 2026
7Kas VoIP REST API function. Available to: Operator.
Description
Enables/disables a WireGuard peer. Operators/SuperRoot only (client ukeys rejected).
Call
GET …/7Kas?func=setwgstatus&ukey=YOUR_KEY&…
Requires the ukey parameter.
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
host |
string | Yes | — | Peer host id. |
root |
integer | Yes | — | Operator root the peer belongs to. |
status |
integer | Yes | — | New status (e.g. 0=disabled, 1=enabled). |
Example
https://api.7kas.com:9080/7Kas?func=setwgstatus&ukey=OPKEY&host=h1&root=5&status=1
Response
Object confirming the change.
Back to API VoIP · ▶ Try it live · Profiles: API profile Operator