Sign in

v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB
Networks

List networks

get/v1/network

Query parameters

client_idstring

ID of a client

Example:c_0123456789ab
offsetinteger

Starting index for pagination

limitinteger

Number of items to return for pagination

sort_by'id'

Sort by a specific field

sort_ascboolean

Sort in ascending order

created_afterstring date-time

Filter results to after a specific creation timestamp (RFC3339 format)

created_beforestring date-time

Filter results to before a specific creation timestamp (RFC3339 format)

Response

OK

Example response

{
  "data": [
    {
      "bridge_device_id": "d_0123456789ab",
      "client_id": "c_0123456789ab",
      "comments": "This is a test network",
      "connected_virt_ids": [
        "virt_0123456789ab"
      ],
      "dhcp": true,
      "dhcp_range_end": "10.0.0.200",
      "dhcp_range_start": "10.0.0.100",
      "internet": true,
      "ipsec_conns": [
        {
          "ipsec_id": "ipsec_0123456789ab",
          "local_addrs": [
            "1.2.3.4"
          ],
          "local_id": "ipsec_0123456789ab_slide",
          "local_networks": [
            "10.0.0.0/24"
          ],
          "name": "Dental Associates, Main Office",
          "psk": "buRAPDIX5SMlPlzLsLO8WVaWeFXam1Aa",
          "remote_addrs": [
            "1.2.3.4"
          ],
          "remote_id": "ipsec_0123456789ab_partner",
          "remote_networks": [
            "10.0.0.0/24"
          ]
        }
      ],
      "name": "Bridge to LAN Network",
      "nameservers": [
        "1.1.1.1",
        "1.0.0.1"
      ],
      "network_id": "net_012345",
      "port_forwards": [
        {
          "dest": "10.0.0.100:80",
          "endpoint": "use1-prod-gateway-1.slide.tech:25881",
          "port": 25881,
          "port_forward_id": "pfw_0123456789ab",
          "proto": "tcp"
        }
      ],
      "router_prefix": "10.0.0.1/24",
      "type": "standard",
      "vlan_tag": 100,
      "wg": true,
      "wg_peers": [
        {
          "peer_name": "My PC",
          "remote_networks": [
            "10.80.0.0/24"
          ],
          "wg_address": "10.0.0.100",
          "wg_endpoint": "use1-prod-gateway-1.slide.tech:51820",
          "wg_peer_id": "wgp_0123456789ab",
          "wg_private_key": "INRPOJHOzuMiRzim2tzzU2OU7Z3jNOIS4HRVA32NzUY",
          "wg_public_key": "buRAPDIX5SMlPlzLsLO8WVaWe+1+FXf+TKk26e4Vkm8="
        }
      ],
      "wg_prefix": "192.168.178.1/24",
      "wg_public_key": "IMKVRsReZWiyL9YorJjVQvQ8/cuFI/3tXBvoWeAxghw="
    }
  ],
  "pagination": {
    "next_offset": 10
  }
}