List networks

get

Authorizations

cookieapi_token

defguard_sessionstringRequired

Responses

200

All networks.

application/json

Stores the configuration required to set up a WireGuard network.

acl_default_allowbooleanRequired

acl_enabledbooleanRequired

addressstring[]Required

allow_all_groupsbooleanRequired

allowed_ipsstring[]Required

connected_atstring · nullableOptional

dnsstring · nullableOptional

endpointstringRequired

fwmarkinteger · int64Required

idinteger · int64Required

keepalive_intervalinteger · int32Required

location_mfa_modestring · enumRequiredPossible values:

mtuinteger · int32Required

namestringRequired

peer_disconnect_thresholdinteger · int32Required

portinteger · int32Required

pubkeystringRequired

service_location_modestring · enumRequiredPossible values:

allowed_groupsstring[]Required

has_devicesbooleanRequired

401

Session is missing or invalid.

application/json

403

Requires admin privileges.

application/json

500

Unable to list networks.

application/json

get/api/v1/network

HTTPcURLJavaScriptPython

GET /api/v1/network HTTP/1.1
Accept: */*

[
  {
    "acl_default_allow": true,
    "acl_enabled": true,
    "address": [
      "text"
    ],
    "allow_all_groups": true,
    "allowed_ips": [
      "text"
    ],
    "connected_at": null,
    "dns": null,
    "endpoint": "text",
    "fwmark": 1,
    "id": 1,
    "keepalive_interval": 1,
    "location_mfa_mode": "disabled",
    "mtu": 1,
    "name": "text",
    "peer_disconnect_threshold": 1,
    "port": 1,
    "pubkey": "text",
    "service_location_mode": "disabled",
    "allowed_groups": [
      "text"
    ],
    "gateways": [
      {
        "address": "text",
        "certificate_expiry": null,
        "certificate_serial": null,
        "connected": true,
        "connected_at": null,
        "disconnected_at": null,
        "enabled": true,
        "id": 1,
        "location_id": 1,
        "location_name": "text",
        "modified_at": "2026-08-07T22:10:51.428Z",
        "modified_by": "text",
        "name": "text",
        "port": 1,
        "version": null
      }
    ],
    "has_devices": true
  }
]