Subscribe to the 'network connection state change' event.

GET 
/network/events/on-connection-change

This endpoint allows clients to subscribe to server-sent events (SSE) that notify them when the internet connection or servers connection state have been changed.

Request

Responses

200

application/json

Schema

Schema

errMsg stringnullable

An optional error message if there was an issue with the connections.

internetConnection booleanrequired

Indicates whether the agent has an active internet connection.

serverAddress stringrequired

The address of the server the agent is trying to connect to.

serverConnection booleanrequired

Indicates whether the agent can successfully connect to the server.

Example (from schema)

{
  "errMsg": "string",
  "internetConnection": true,
  "serverAddress": "string",
  "serverConnection": true
}

Loading...