DELETE: Delete network or device from configuration

The DELETE command lets you delete a network or a device from the configuration.

Deleting a network

Note that for practical reasons, this operation makes sense only for remote networks. You cannot delete an active network with a local interface. Any auto-generated sub-networks (such as those generated by Ethernet/IP route browsing) can be deleted, but will re-appear during probing.

For example, to reference the network you want to delete, use the network's GUID after the /networks endpoint.

Request:

DELETE https://192.168.0.1/networks/BDDEE0CA-E615-49BB-9E13-356D308207BB

will delete the remote network with the GUID BDDEE0CA-E615-49BB-9E13-356D308207BB.

Deleting a device, or blacklisting an IP address

You can delete individual devices from a network using the sub-addressing "/device/", follewed by the device's IP address, host name, or MAC address.

Example:

DELETE https://192.168.0.1/networks/BDDEE0CA-E615-49BB-9E13-356D308207BB/devices/192.168.10.34

For this request, the following options can be used:

exclude=True
Exclude IP address of the device from the network IP range (OTbase Discovery will no longer try to detect the device)

ignore=device_not_found
In combination with exclude=True: will exclude the IP address even if the device is not currently present (you have to provide the device IP Address in the URI)

Example:

DELETE https://127.0.0.1:44462/networks/87E4D1C5-F637-4EC7-94EF-FA5C1C280C6D/devices/192.168.78.86?exclude=True&ignore=device_not_found

In this example we delete a device with IP address 192.168.78.86 from the network 87E4D1C5-F637-4EC7-94EF-FA5C1C280C6D, and exclude the IP address from further discovery even if the device is currently not present. This way, the IP address is effectively blacklisted for further probing.