Jump to content

API setwgstatus

From Wiki 7Kas

7Kas VoIP REST API function. Available to: SuperRoot, 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 SuperRoot, API profile Operator