LDWS API Diagnostics Endpoints

GET /v1/diagnostics/ 

Runs network diagnostics on the player and returns the result in JSON format.

Request Example

Response Body

For each of ethernet, wifi, modem, and internet:

• diagnosis string: Indicates if this type of interface is present

• log object[ ]: This contains the diagnostic results for the interface:

  • name string:  The name of the diagnostic test

  • pass bool: Indicates whether the test passed or not

  • result string: The actual value for the diagnostic tests like checking type and ping.

• ok bool: If diagnostics were run on the interface or not.

Response Example

GET /v1/diagnostics/dns-lookup/:address/ 

Runs a DNS lookup for an address, which can be a hostname or IP address.

Segment

• :address: The hostname (for example, http://google.com) or IP address

Request Example

Response Body

The player queries each DNS field separately, then collects returned data into the records object, the tcp and udp connection information is in the server_test object, and returned errors into the errorList object.

• records object:

  • ipv4 string[ ]: IPv4 addresses

  • ipv6 string[ ]: IPv6 addresses

  • text string[ ]: Text records

  • mx object[ ]: Mail exchange records

    • exchange string

    • priority int

• server_test object:

  • tcp object:

    • made int:  The total number of DNS requests made

    • pass int: The total number of requests that passed

    • fail int: The total number of requests that failed.

    • timeout int: The total number of requests that timed out

    • mismatch int: The total number of mismatched requests between the host and pointer records

  • udp object:

    • made int:  The total number of DNS requests made

    • pass int: The total number of requests that passed

    • fail int: The total number of requests that failed.

    • timeout int: The total number of requests that timed out.

    • mismatch int: The total number of mismatched requests between the host and pointer records

• errorList object[ ]

  • field string: The field ('ipv4', 'ipv6', 'cname', 'mx',  'service', or 'text') the error came from

  • err object:

    • errno string: Error number (usually the same value as code)

    • code string: Error code number (see https://nodejs.org/docs/latest-v14.x/api/dns.html#dns_error_codes)

    • syscall string: Information about the system call stack

    • hostname string: The value passed in the URL

Response Example

GET /v1/diagnostics/ping/:ipAddress/ 

Pings the address passed in the request. This does not work for hostnames, only for IP addresses.

Segment

• :ipAddress: The specified IP address

Request Example

Response Body

• success bool: A flag that indicates if the operation succeeded or not

• response object:

  • hostname string: The value that you passed in the URL

  • results object:

    • ipv4 object[ ]

      • address string: The IPv4 address that is pinged

      • results object:

        • received int: The number of packets received

        • stats object:

          • average int: The average time for the packet to return

          • quickest int: The quickest time for packet to return

          • slowest int: The slowest time for the packet to return

          • units int: The time units (usually microseconds)

        • transmitted int: The number of packets transmitted

    • ipv6 object[ ]: This will only be returned if IPv6 is present.

      • interface string:

      • source string:

      • address string: The IPv6 address that is pinged

      • results object:

        • received int: The number of packets received

        • transmitted int: The number of packets transmitted

Response Example

GET /v1/diagnostics/trace-route/:address/ 

Runs trace-route on the player. You can optionally pass the boolean query parameter ?resolveAddress to resolve IP addresses in the result.

Segment

• :address: The specified IP or hostname address

Query String Parameter

• resolveAddress bool optional: Specifies whether the IP or hostname address should be resolved or not in the result

Request Example

Response Body

• address string: The IP address on which you are running the trace route

• results object:

  • output string[ ]: Returns the trace route output information in text format

  • protocol string: The IP protocol (for example, "ipv4")

  • route object[ ]:

    • hop int: How many times the data moves from one router to the next 

    • servers object:

      • address string: The address to which the trace route request is made

      • hostname string: The server hostname

      • stats object[ ]

        • reachable string:

        • time string: The time required for the trace route request to return

        • units string: The time units (usually in milliseconds)

Response Example

GET /v1/diagnostics/network-neighborhood/ 

Retrieves information about the player’s current network neighborhood (the other players on the same network).

Request Example

Response Body

• success bool: A flag that indicates if the operation succeeded

• response object[ ]: An array of information about players in your network neighborhood

  • chassis-descr string: The model version, OS version, serial number, etc.

  • chassis-id string: A unique identifier for the player

  • chassis-name string: The name of the player

  • mgmt-ip string:

  • port-descr string: Which interface the player is using

  • port-id string:

  • vlan-pvid string:

If the diagnostic could not be performed, the response body may instead be an error message.

Response Example

GET /v1/diagnostics/network-configuration/:interfaceName/ 

Gets the network configuration on the player. See https://brightsign.atlassian.net/wiki/spaces/DOC/pages/1172734089 for more information about digest authentication.

Segment

• :interfaceName: The network interface. Possible names include eth0, wlan0, and modem.

Request Example

Response Body

• text string: The network configuration information in plain-text form

• output Output: The network configuration information as a JSON object:

  • interfaces Interface[ ]: An array of Interface objects representing network interfaces:

    • name string: The interface name (for example, "eth0")

    • errors  Error[ ]: An array of error messages associated with the interface

    • params Param[ ]: An array of Param objects representing parameters associated with the network interface. Each Param interface has the following entries:

      • name string: The property name (e.g. "MAC")

      • value string: The property value (e.g. "90:ac:3f:0b:d2:88")

  • host Info[ ]: An array of Info objects providing network host information. Each object can have the following entries:

    • errors Error[ ]: An array of error messages associated with the network host

    • params Param[ ]: An array of Param objects representing parameters associated with the network host 

  • bsn Info[ ]: An array of Info objects providing information about BSN communication. 

  • other Info[ ]: An array of Info objects providing information miscellaneous network information.

• caCertificate string optional: The contents of a CA certificate file in text form (i.e. a "pem" file).

• clientCertificate bool optional: A flag indicating whether the player is using a client certificate

• clientIdentifier string optional: The DHCP client identifier for the network interface

• dnsServerList string[ ] optional:  An IP address list of the DNS servers

• domain string optional: The domain name for the network interface

• eapTlsOptions string optional: A string containing EAP-specific options

• enabledProtocolList string[ ] optional: An array of enabled IP protocols. Currently supported values are "IPv4" and "IPv6".

• identity string optional: The RADIUS identity

• ipAddressList string[ ] optional: The IP addresses assigned to the player

• inboundShaperRate int optional: The bandwidth limit for inbound traffic in bits per second. A value of -1 specifies the default bandwidth limit, and a value of 0 specifies no bandwidth limit (these two settings are functionally the same).

• metric int optional:  The routing metric for the default gateway on the interface. Routes with lower metrics are preferred over routes with higher metrics.

• mtu int optional: The maximum transmission unit (MTU) for the network interface in bytes

• privateKey string optional: The private key for authentication

• vlanIdList int[ ] optional: An array of VLAN IDs that are supported on the parent network interface

• securityMode string optional: Security mode for authentication

Response Example

PUT /v1/diagnostics/network-configuration/:interfaceName/ 

Applies a test network configuration on the player. You should use GET to get the configuration parameters before setting it using this API. The text and output parameters are NOT needed in PUT.

Segment

• :interfaceName: The network interface. Possible names include eth0, wlan0, and modem.

Request Body

• caCertificate string optional: The contents of a CA certificate file in text form (i.e. a "pem" file).

• clientCertificate bool optional: A flag indicating whether the player is using a client certificate

• clientIdentifier string optional: The DHCP client identifier for the network interface

• dnsServerList string[ ] optional:  An IP address list of the DNS servers

• domain string optional: The domain name for the network interface

• eapTlsOptions string optional: A string containing EAP-specific options

• enabledProtocolList string[ ] optional: An array of enabled IP protocols. Currently supported values are "IPv4" and "IPv6".

• identity string optional: The RADIUS identity

• ipAddressList string[ ] optional: The IP addresses assigned to the player

• inboundShaperRate int optional: The bandwidth limit for inbound traffic in bits per second. A value of -1 specifies the default bandwidth limit, and a value of 0 specifies no bandwidth limit (these two settings are functionally the same).

• metric int optional:  The routing metric for the default gateway on the interface. Routes with lower metrics are preferred over routes with higher metrics.

• mtu int optional: The maximum transmission unit (MTU) for the network interface in bytes

• privateKey string optional: The private key for authentication

• vlanIdList int[ ] optional: An array of VLAN IDs that are supported on the parent network interface

• securityMode string optional: Security mode for authentication

Request Example

The example request parameters and headers are set as follows:

This is the example request body:

Response Example

GET /v1/diagnostics/interfaces/ 

Returns list of applied network interfaces on the player.

Request Body

Response Body

GET /v1/diagnostics/packet-capture/ 

Returns the current status of packet capture operation. 

Request Example

Response Body

• statusCode int: The success or error code (200 is success)

• is_running bool: Flag indicating if the packet capture operation is running

Response Example

POST /v1/diagnostics/packet-capture/ 

Starts a packet capture operation

Request Body

• filename string: The name of the packet capture file. If you don't pass this string, 'capture.pcap' is the default.

• net_interface string: The name of the network interface for which we are performing packet capture. 'eth0' is the default.

• duration int: The duration for which the packet capture runs in seconds. The default is 300 seconds (5 minutes).

• maxpackets int: The maximum number of packets to capture before concluding the process. 0 is the default value.

• snaplen int: The maximum size of each packet. Specifying 0 will instruct the function to capture the entire packet no matter the size.

• filter string:  A field for conditional filtering of packets. This operation uses standard pcap syntax. This string is empty by default

Request Example

This is the example request body:

Response Example

DELETE /v1/diagnostics/packet-capture/ 

Stops a packet capture operation

Request Example

Response Example

GET /v1/diagnostics/telnet/

Returns information about whether or not Telnet is enabled on the player, and the port number on which it is enabled if it is. This is only available in BOS 9.0.110 or 8.5.46 and above.

Request Example

Response Example

A successful response is a 200 and this response body:

PUT /v1/diagnostics/telnet/

This is only available in BOS 9.0.110 or 8.5.46 and above.

Request Body

• enabled boolean: Enable or disable Telnet on the player

• portNumber integer: The port number on which to enable Telnet

• reboot boolean: This optional parameter reboots the player immediately after executing this operation. It is true by default.

Request Example

The example request parameters and headers are set as follows:

This is the example request body:

Response Example

GET /v1/diagnostics/ssh/

Returns information about whether or not SSH is enabled on the player, and the port number on which it is enabled if it is. This is only available in BOS 9.0.110 or 8.5.46 and above.

Request Example

The example request parameters and headers are set as follows:

Response Example

A successful response is a 200 and this response body:

PUT /v1/diagnostics/ssh/

This is only available in BOS 9.0.110 or 8.5.46 and above.

Request Body

• enabled boolean: Enable or disable SSH on the player

• portNumber integer: The port number on which to enable SSH

• password string: Sets the plain-text login password for the SSH connection

• reboot boolean: This optional parameter reboots the player immediately after executing this operation. It is true by default.

• obfuscatedPassword string: This optional parameter sets the login password for the SSH connection. The password should previously have been obfuscated using a shared secret. Contact support@brightsign.biz to learn more about generating a key for obfuscation and storing it on the player.

Request Example

The example request parameters and headers are set as follows:

This is the example request body:

Response Example