version

The version command returns version information for the DisplayNet server and API.

Command Type	DisplayNet
Minimum Version	3.5.0

Usage

version

This command takes no arguments.

Understanding version numbers

DisplayNet reports multiple version numbers from different sources:

Version	Source	Description
SDVoE API	version command, result.version	Control Server API version
DisplayNet API	API_INITIALIZED handshake, version field	DisplayNet API version
Application	API_INITIALIZED handshake, app_version field	DisplayNet application version

Return value

version
{
  "status": "SUCCESS",
  "request_id": null,
  "result": {
    "server": "Control Server",
    "vendor": "Semtech",
    "version": "3.9.0.1",
    "build": "494",
    "interfaces": [
      "192.168.190.64",
      "192.168.2.243",
      "10.241.52.63"
    ],
    "modules": [
      { "name": "api", "version": "3.9.0.1" },
      { "name": "multiview", "version": "1.1.0" }
    ]
  },
  "error": null
}

Field	Type	Description
server	String	Server identification string
vendor	String	Control Server vendor
version	String	SDVoE API version, matching the api module
build	String	Control Server build number
interfaces	Array of String	Network interfaces the server is listening on
modules	Array of objects	The loaded API modules. Each entry has a name and a version; these are the names require accepts

API_INITIALIZED response

The initial handshake when connecting to DisplayNet also carries version information:

API_INITIALIZED handshake
{
  "status": "API_INITIALIZED",
  "request_id": null,
  "result": null,
  "error": null,
  "version": "4.7.0.2600",
  "app_version": "4.7.0.2564",
  "setupComplete": "1",
  "AuthenticationRequired": false
}

Field	Description
version	DisplayNet API version
app_version	DisplayNet Manager application version
setupComplete	"1" if initial setup is complete
AuthenticationRequired	Whether authentication is required for this connection

REST API

No REST equivalent

This command has not been migrated to the command registry that publishes DisplayNet API operations, and it is not an SDVoE API command either, so there is no way to call it over REST today.

The OpenAPI document at GET /api/openapi.json identifies the REST contract, not the server build, so it is not a substitute. Read the version over the telnet or WebSocket interface.

See also

• Connecting to the API: where the API_INITIALIZED handshake occurs