List or terminate active Wireguard ZTNA client sessions

Request

Returns active Wireguard client (ZTNA) sessions on the node's virtual networks, optionally filtered by network, application ID, or session ID. Setting action to kill terminates matching sessions instead.

Requires nodes::service:wg-clients or nodes::remote-execute permission.

Security

JWTAuthorizer

Path

nodeIDstringrequired

Node ID

Query

waitinteger

Pass 1 to block until the node responds and return its output.

Value:1

Bodyapplication/json

actionstring

list — return active Wireguard client sessions
kill — terminate matching sessions

Default:"list"

Enum:"list""kill"

networkstring

Virtual network name filter. Use all or omit for all networks.

appstring

Application ID filter. Use all or omit for all apps.

sessionstring

ZTNA session ID filter. Use all or omit for all sessions.

curl -i -X POST \
  'https://apidocs.trustgrid.io/_mock/node/{nodeID}/trigger/wg-clients?wait=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "action": "list",
    "network": "string",
    "app": "string",
    "session": "string"
  }'

Responses

OK

Bodyapplication/json

outputobject

One of:

Client list (action=list)

Response

{
  "output": {
    "network": "string",
    "clients": [ … ]
  }
}