How to get the connection status

Introduction

You can obtain information about the connection status of the device:

  • VPN connection
  • Configuration connection
  • Data logging connection

Get the Connection Status

curl --request GET \
     --url 'http://192.168.140.1:80/api/v1/connection/status'
{
  "vpn": {
    "status": "inactive"
  },
  "configuration": {
    "status": "connected"
  },
  "data_logging": {
    "status": "unconfigured"
  }
}

Possible statuses per connection type:

  • VPN:
    • inactive
    • connecting
    • connected
  • Configuration:
    • disconnecting
    • disconnected
    • connecting
    • connected
  • Data logging:
    • unconfigured
    • disconnected
    • connected
🚧

Connection timeouts apply

If you unplug the ethernet cable, you may not immediately see connection status of each component go to disconnected or connecting, because each connection has a timeout. Only after that timeout expires, the connection will no longer be considered connected.



Did this page help you?