v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB

Networks

Update network

patch/v1/network/{network_id}

Path parameters

network_idstring required

ID of an network

Example:net_012345

Request body

client_idstring

ID of a client or an empty string

commentsstring

Comments about the network

dhcpboolean

Whether the disaster network should have DHCP

dhcp_range_endstring

DHCP range end for the network

dhcp_range_startstring

DHCP range start for the network

internetboolean

Whether the network should have Internet access

namestring

Name of the network

nameserversstring[]

List of DNS servers

router_prefixstring

Router IP and netmask for the network

vlan_taginteger

VLAN tag for bridge-LAN networks (0 = no tagging, 1-4094 = tagged)

wgboolean

Whether the network should have WireGuard enabled

wg_prefixstring

WireGuard IP address and netmask for the WireGuard network

Example request

{
  "client_id": "c_0123456789ab",
  "comments": "This is a network for a client's disaster",
  "dhcp": true,
  "dhcp_range_end": "10.0.0.200",
  "dhcp_range_start": "10.0.0.100",
  "internet": true,
  "name": "Bridge to LAN Network",
  "nameservers": [
    "1.1.1.1",
    "1.0.0.1"
  ],
  "router_prefix": "10.0.0.1/24",
  "vlan_tag": 100,
  "wg": true,
  "wg_prefix": "192.168.178.1/24"
}

Response

Updated

bridge_device_idstring

ID of a device

client_idstring

ID of a client

commentsstring required

Comments about the network

connected_virt_idsVirtID[] required

List of the virtual machines connected to the network.

dhcpboolean

Whether the disaster network should have DHCP

dhcp_range_endstring

DHCP range end for the network

dhcp_range_startstring

DHCP range start for the network

internetboolean

Whether the network should have Internet access

namestring required

Name of the network

nameserversstring[]

List of DNS servers

network_idstring required

ID of an network

router_prefixstring

Router IP and netmask for the network

type'standard' | 'bridge-lan' required

Network type of the disaster network

vlan_taginteger

VLAN tag for bridge-LAN networks (0 = no tagging, 1-4094 = tagged)

wgboolean

Whether the network should have WireGuard enabled

wg_prefixstring

WireGuard IP address and netmask for the WireGuard network

wg_public_keystring

WireGuard server's public key

Example response

{
  "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="
}