Tunnel
Virtual Networks
Virtual Networks endpoint reference.
List
Lists and filters virtual networks in an account.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account identifier. | |
params | array | No | [] | Array containing the necessary params. |
php
$response = $client->tunnel()->virtualNetworks()->list('ACCOUNT_ID', []);
Create
Adds a new virtual network to an account.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account identifier. | |
name | string | Yes | A user-friendly name for the virtual network. | |
isDefault | bool | No | false | If `true`, this virtual network is the default for the account. |
comment | string|null | No | Optional remark describing the virtual network. |
php
$response = $client->tunnel()->virtualNetworks()->create('ACCOUNT_ID', 'NAME', true, 'COMMENT');
Get
Get a virtual network.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account identifier. | |
virtualNetworkId | string | Yes | UUID of the virtual network. |
php
$response = $client->tunnel()->virtualNetworks()->get('ACCOUNT_ID', 'VIRTUAL_NETWORK_ID');
Edit
Updates an existing virtual network.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account identifier. | |
virtualNetworkId | string | Yes | UUID of the virtual network. | |
values | array | No | [] | he fields that are meant to be updated |
php
$response = $client->tunnel()->virtualNetworks()->edit('ACCOUNT_ID', 'VIRTUAL_NETWORK_ID', []);
Delete
Deletes an existing virtual network.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account identifier. | |
virtualNetworkId | string | Yes | UUID of the virtual network. |
php
$response = $client->tunnel()->virtualNetworks()->delete('ACCOUNT_ID', 'VIRTUAL_NETWORK_ID');