Ethernet Endpoint

IP configuration. MAC info. BrainD port.

See the Ethernet Entity for generic information.

PUT /api/v1/brainstem/(serial_num)/ethernet/(index)/enabled

Sets the Ethernet’s interface to enabled/disabled.

See JSON Schema for Request Object and Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Request JSON Object:

  • value (boolean) –

    Boolean value to set.

    May be specified as a boolean, integer, or a string (formatted as “True”, “FALSE”, “1”, etc.)

Response JSON Object:

  • response.value (boolean) – Value formatted as a boolean

  • response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/ethernet/(index)/enabled

Gets the current enable value of the Ethernet interface.

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Response JSON Object:

  • response.value (boolean) – Value formatted as a boolean

  • response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/ethernet/(index)/networkconfiguration

Get the method in which IP Address is assigned to this device

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/ethernet/(index)/networkconfiguration

Get the method in which IP Address is assigned to this device

See JSON Schema for Request Object and Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Request JSON Object:

  • value (integer) –

    8-bit Integer value to set.

    May be specified as an integer or a string (formatted as “123”, “0x12”, etc.)

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/ethernet/(index)/staticipv4address

Get the expected IPv4 address of this device, when networkConfiguration == STATIC

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Response JSON Object:

  • response.value (string) – Value formatted as a string

  • response.rawValue (list(integer)) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/ethernet/(index)/staticipv4address

Set the desired IPv4 address of this device, if NetworkConfiguration == STATIC.

See JSON Schema for Request Object and Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Request JSON Object:

  • value (list) –

    List of 8-bit values to set.

    May be specified as: * String (formatted as “Hello”, “x40x41”, etc.) * List of integers * List of strings (formatted as “0x40”, “40”, etc.)

Response JSON Object:

  • response.value (string) – Value formatted as a string

  • response.rawValue (list(integer)) – Unformatted value

GET /api/v1/brainstem/(serial_num)/ethernet/(index)/staticipv4netmask

Get the expected IPv4 netmask of this device, when networkConfiguration == STATIC

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Response JSON Object:

  • response.value (string) – Value formatted as a string

  • response.rawValue (list(integer)) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/ethernet/(index)/staticipv4netmask

Set the desired IPv4 address of this device, if NetworkConfiguration == STATIC

See JSON Schema for Request Object and Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Request JSON Object:

  • value (list) –

    List of 8-bit values to set.

    May be specified as: * String (formatted as “Hello”, “x40x41”, etc.) * List of integers * List of strings (formatted as “0x40”, “40”, etc.)

Response JSON Object:

  • response.value (string) – Value formatted as a string

  • response.rawValue (list(integer)) – Unformatted value

GET /api/v1/brainstem/(serial_num)/ethernet/(index)/staticipv4gateway

Get the expected IPv4 gateway of this device, when networkConfiguration == STATIC

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Response JSON Object:

  • response.value (string) – Value formatted as a string

  • response.rawValue (list(integer)) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/ethernet/(index)/staticipv4gateway

Set the desired IPv4 gateway of this device, if NetworkConfiguration == STATIC

See JSON Schema for Request Object and Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Request JSON Object:

  • value (list) –

    List of 8-bit values to set.

    May be specified as: * String (formatted as “Hello”, “x40x41”, etc.) * List of integers * List of strings (formatted as “0x40”, “40”, etc.)

Response JSON Object:

  • response.value (string) – Value formatted as a string

  • response.rawValue (list(integer)) – Unformatted value

GET /api/v1/brainstem/(serial_num)/ethernet/(index)/ipv4address

Get the effective IP address of this device.

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Response JSON Object:

  • response.value (string) – Value formatted as a string

  • response.rawValue (list(integer)) – Unformatted value

GET /api/v1/brainstem/(serial_num)/ethernet/(index)/ipv4netmask

Get the effective IP netmask of this device.

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Response JSON Object:

  • response.value (string) – Value formatted as a string

  • response.rawValue (list(integer)) – Unformatted value

GET /api/v1/brainstem/(serial_num)/ethernet/(index)/ipv4gateway

Get the effective IP gateway of this device.

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Response JSON Object:

  • response.value (string) – Value formatted as a string

  • response.rawValue (list(integer)) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/ethernet/(index)/staticipv4dnsaddress

Set IPv4 DNS Addresses (plural), if NetworkConfiguration == STATIC

See JSON Schema for Request Object and Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Request JSON Object:

  • value (list) –

    List of 8-bit values to set.

    May be specified as: * String (formatted as “Hello”, “x40x41”, etc.) * List of integers * List of strings (formatted as “0x40”, “40”, etc.)

Response JSON Object:

  • response.value (string) – Value formatted as a string

  • response.rawValue (list(integer)) – Unformatted value

GET /api/v1/brainstem/(serial_num)/ethernet/(index)/staticipv4dnsaddress

Get IPv4 DNS addresses (plural), when NetworkConfiguration == STATIC

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Response JSON Object:

  • response.value (string) – Value formatted as a string

  • response.rawValue (list(integer)) – Unformatted value

GET /api/v1/brainstem/(serial_num)/ethernet/(index)/ipv4dnsaddress

Get effective IPv4 DNS addresses, for the current NetworkConfiguration

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Response JSON Object:

  • response.value (string) – Value formatted as a string

  • response.rawValue (list(integer)) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/ethernet/(index)/hostname

Set hostname that’s requested when this device sends a DHCP request.

See JSON Schema for Request Object and Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Request JSON Object:

  • value (list) –

    List of 8-bit values to set.

    May be specified as: * String (formatted as “Hello”, “x40x41”, etc.) * List of integers * List of strings (formatted as “0x40”, “40”, etc.)

Response JSON Object:

  • response.value (string) – Value formatted as a string

  • response.rawValue (list(integer)) – Unformatted value

GET /api/v1/brainstem/(serial_num)/ethernet/(index)/hostname

Get hostname that’s requested when this device sends a DHCP request.

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Response JSON Object:

  • response.value (string) – Value formatted as a string

  • response.rawValue (list(integer)) – Unformatted value

GET /api/v1/brainstem/(serial_num)/ethernet/(index)/macaddress

Get the MAC address of the Ethernet interface.

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Response JSON Object:

  • response.value (string) – Value formatted as a string

  • response.rawValue (list(integer)) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/ethernet/(index)/interfaceport/(service)

Set the port of a TCPIP service on the device.

See JSON Schema for Request Object and Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

  • service – The index of the service to set the port for.

Request JSON Object:

  • value (integer) –

    16-bit Integer value to set.

    May be specified as an integer or a string (formatted as “123”, “0x12”, etc.)

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/ethernet/(index)/interfaceport/(service)

Get the port of a TCPIP service on the device.

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

  • service – The index of the service to get the port for.

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value