Network configurations

This tutorial shows how to change the network configurations of your Nureva® devices over the local network.

Supported devices

• HDL310, HDL410, and HDX

What can be controlled with the API?

The networkConfiguration property consists of a list of network settings that can be applied to the audio device. A list is provided to configure network settings on multiple ports at once for the Nureva HDX system.

• port: The port of the network configuration. For HDX devices, there are two network ports: A and B. For HDL310 and HDL410 devices, there is only one network port, which is A. (required)
• isStatic: Whether the network configuration is static or dynamic. (required)
• ip: The IP address of the device for this network port. (required if isStatic is true)
• subnetMask: The subnet mask of the network associated with this device on the specified port. (required if isStatic is true)
• gateway: The address of the gateway router for this network port. (optional)
• dns: The list of DNS server addresses for this network port. (optional)

Minimum role required: general

The Get network configuration and Set network configuration endpoints accept the general role (recommended) or any higher role that already has access to the device on the local network. Follow the Authorization tutorial to authenticate with a general role and obtain YOUR_GENERAL_AUTHPARAMETERS which is required for the requests below.

Overview

1. Call Get network configuration to make a request to get the current network configuration settings on the audio device.
2. Call Set network configuration to make a request to update the network configuration on the audio device.
3. Call Get network configuration again to verify that the updated network configuration has been applied.

Instructions

Step 1 - Make a request to get the current network configuration

Use the Get network configuration endpoint:

1. Set the path with the IP address of the Nureva device followed by /api/v1/network/configuration.
2. Update the headers to include Authorization as key and the value being Nureva followed by the authParameters received from the login endpoint using the general account.
3. Update the headers to include Nureva-Client-Id as key and integration_app_name as the value.
4. Update the headers to include Nureva-Client-Version as key and 0.0.1 as the value.
5. Call Get network configuration to retrieve the current network configuration for all ports.

curl --request GET \
  --url https://10.0.0.12/api/v1/network/configuration \
  --header 'Authorization: Nureva <YOUR_GENERAL_AUTHPARAMETERS>' \
  --header 'Nureva-Client-Id: integration_app_name' \
  --header 'Nureva-Client-Version: 0.0.1'

6. If the call is successful, an HTTP status code of 200 OK will be returned.

{
  "networkConfiguration": [
    {
      "port": "A",
      "isStatic": false,
      "ip": "10.0.0.12",
      "subnetMask": "255.255.0.0",
      "gateway": "10.0.0.1",
      "dns": ["8.8.8.8", "8.8.4.4"],
      "mac": "EB:6A:FE:EF:9E:7D"
    }
  ]
}

Step 2 - Make a request to update the network configuration

Use the Set network configuration endpoint.

1. Set the path with the IP address of the Nureva device followed by /api/v1/network/configuration.
2. Update the headers to include Authorization as key and the value being Nureva followed by the authParameters received from the login endpoint using the general account.
3. Update the headers to include Nureva-Client-Id as key and integration_app_name as the value.
4. Update the headers to include Nureva-Client-Version as key and 0.0.1 as the value.
5. Add the networkConfiguration property to the body with a list of network configuration settings (one configuration for each port).
6. Send the PATCH request.

curl --request PATCH \
  --url https://10.0.0.12/api/v1/network/configuration \
  --header 'Authorization: NUREVA <YOUR_GENERAL_AUTHPARAMETERS>' \
  --header 'Nureva-Client-Id: integration_app_name' \
  --header 'Nureva-Client-Version: 0.0.1' \
  --header 'Content-type: application/json' \
  --data '{
          "networkConfiguration": [
            {
              "port": "A",
              "isStatic": true,
              "ipAddress": "10.0.0.82",
              "subnetMask": "255.255.0.0",
              "gateway": "10.0.0.1",
              "dns": [
                  "64.59.134.145",
                  "64.59.134.129"
              ]
            }
          ]
        }'

7. If the call is successful, an HTTP status code of 202 Accepted will be returned.

Step 3 - Check that the change has been applied successfully

Use the Get network configuration endpoint:

1. Set the path with the updated IP address of the Nureva device followed by /api/v1/network/configuration.
2. Update the headers to include Authorization as key and the value being Nureva followed by the authParameters received from the login endpoint using the general account.
3. Update the headers to include Nureva-Client-Id as key and integration_app_name as the value.
4. Update the headers to include Nureva-Client-Version as key and 0.0.1 as the value.
5. Call Get network configuration to retrieve the current network configuration for all ports.

curl --request GET \
  --url https://10.0.0.82/api/v1/network/configuration \
  --header 'Authorization:NUREVA <YOUR_GENERAL_AUTHPARAMETERS>' \
  --header 'Nureva-Client-Id: integration_app_name' \
  --header 'Nureva-Client-Version: 0.0.1'

6. If the call is successful, an HTTP status code of 200 OK will be returned.
7. Verify the network configuration at the port you modified in step 2 matches the body returned here.

{
  "networkConfiguration": [
    {
      "port": "A",
      "isStatic": true,
      "ip": "10.0.0.82",
      "subnetMask": "255.255.0.0",
      "gateway": "10.0.0.1",
      "dns": ["64.59.134.145", "64.59.134.129"],
      "mac": "EB:6A:FE:EF:9E:7D"
    }
  ]
}

✅

Tutorial complete!

You now know how to view and make changes to the network configuration.