Skip to main content

Network diagnostics API

This API is based on the Device Configuration API framework. For guidance on how to use these APIs, please refer to Device Configuration APIs.

Overview​

The VAPIX® Network diagnostics API allows you to interact with various diagnostic tools for troubleshooting network issues.

Authentication​

For detailed information on how to authenticate requests to this API, please refer to Authentication.

Use Cases​

Get TCP retransmissions information​

Use the trigger network-diagnostics.v1.netstats.tcpRetransmissions to get the number of TCP retransmissions in the last number of specified hours. Specifying 0 returns the total amount of retransmissions recorded on the device. The device buffers a limited number of retransmissions samples and overwrites older data after a few days.

Example:

curl --request POST \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-diagnostics/v1/netstats/tcpRetransmissions
HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success",
    "data": 1515
}

Use the trigger network-diagnostics.v1.netstats.tcpRetransmissionSpikes to get the last number of specified spikes. Specifying 0 returns all buffered spikes. The device stores up to 1024 spikes. When the limit is reached, the oldest spikes are replaced by new ones.

Example:

curl --request POST \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-diagnostics/v1/netstats/tcpRetransmissionSpikes
HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success",
    "data": [
        {
            "retransmissions": 807,
            "timestamp": "2026-02-19T11:00:08Z"
        },
        {
            "retransmissions": 103,
            "timestamp": "2026-02-19T11:26:58Z"
        },
        {
            "retransmissions": 375,
            "timestamp": "2026-02-19T11:26:31Z"
        },
        {
            "retransmissions": 511,
            "timestamp": "2026-02-19T11:26:28Z"
        }
    ]
}

API definition​

Structure​

network-diagnostics.v1 (Root Entity)
    ├── netstats (Entity)
        ├── tcpRetransmissionSpikes (Action)
        ├── tcpRetransmissions (Action)

Entities​

network-diagnostics.v1​

  • Description: Tools used to diagnose network issues
  • Type: Singleton
  • Operations
    • Get
  • Attributes
    • Dynamic Support: No
Properties​

This entity has no properties.

Actions​

This entity has no actions.

network-diagnostics.v1.netstats​

  • Description: Interface that retrieves network statistics
  • Type: Singleton
  • Operations
    • Get
  • Attributes
    • Dynamic Support: No
Properties​

This entity has no properties.

Actions​
tcpRetransmissionSpikes​
  • Description: Get an array of the last N TCP retransmission spikes. Specifying 0 spikes gets all recorded spikes.
  • Request Datatype: PositiveInteger
  • Response Datatype: TcpRetransmissionSpikes
  • Trigger Permissions: admin
  • Attributes
    • Dynamic Support: No
tcpRetransmissions​
  • Description: Get number of TCP retransmissions in the last N hours. Specifying 0 hours gets all retransmissions recorded.
  • Request Datatype: PositiveInteger
  • Response Datatype: PositiveInteger
  • Trigger Permissions: admin
  • Attributes
    • Dynamic Support: No

Data types​

IsoTimestamp​

  • Description: Timestamp of the spike in ISO 8601 RFC3339 format
  • Type: string
  • Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$

PositiveInteger​

  • Description: An integer which is either zero or greater than zero
  • Type: integer
  • Minimum Value: 0

TcpRetransmissionSpike​

  • Description: Representation of a TCP retransmission spike
  • Type: complex
  • Fields
    • retransmissions
      • Description: Magnitude of the spike
      • Type: PositiveInteger
      • Nullable: No / Gettable: Yes
    • timestamp
      • Description: Timestamp of the spike
      • Type: IsoTimestamp
      • Nullable: No / Gettable: Yes

TcpRetransmissionSpikes​

  • Description: A list of retransmission spikes
  • Type: array
  • Element type: TcpRetransmissionSpike
  • Null Value: No