Network settings 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.

Description

The Network settings API makes it possible to configure the network settings on the device.

info

This API includes operations on sensitive data. You must use a secured channel for the communication transmissions.

Authentication

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

Use cases

Manage system settings

The system settings contains a configuration for the hostname and resolver configuration. The hostname configuration is essential when assigning an identity to a device. It can either be assigned statically or assigned by DHCP. The resolver configuration is essential for allowing the device to resolve names into IP addresses. It can either be assigned statically or assigned by DHCP.

Get system settings

The hostname and resolver configuration are part of the system entity network-settings.v2.system. Fetching it will return all settings under system, including the current hostname and resolver settings:

hostname - Indicates which hostname the device is currently using.
staticHostname - Indicates the statically assigned hostname, used if useDhcpHostname is set to false, or if no hostname could be obtained from DHCP.
useDhcpHostname - Indicates whether any hostname assigned via DHCP should be automatically used.
nameServers - Indicates which nameservers the device is currently using to do lookups to resolve DNS queries.
staticNameServers - Indicates the statically assigned nameservers, which are used either if useDhcpResolver is set to false, or if no nameservers were obtained from DHCP.
searchDomains - Indicates which search domains the device is currently using to do lookups to resolve DNS queries. If the looked up name does not exist, the resolver will attempt to lookup the name with each suffixed search domain specified.
staticSearchDomains - Indicates the statically assigned search domains, which are used either if useDHCPResolver is set to false, or if no search domains were obtained from DHCP.
useDhcpResolver - Indicates if any resolver configuration assigned via DHCP should be automatically assigned.

curl
HTTP

curl --request GET \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-settings/v2beta/system

GET /config/rest/network-settings/v2beta/system HTTP/1.1
HOST: my-device
Content-Type: application/json

200 OK
Content-Type: application/json
{
    "status": "success",
    "data": {
        "hostname": "realhostname",
        "staticHostname": "testhostname",
        "useDhcpHostname": true,
        "nameServers": [
            "192.168.0.1",
            "192.168.1.2",
            "1234::77"
        ],
        "searchDomains": [
            "axis.com",
            "example.com"
        ],
        "staticSearchDomains": [
            "axis.com",
            "example.com"
        ],
        "useDhcpResolver": true
    }
}

Set hostname settings

To configure the hostname settings, use the following parameters:

staticHostname - Specifies the static hostname to use.
useDhcpHostname - Specifies whether any hostname assigned via DHCP should be applied.

{
    "request": {
        "operation": "SET",
        "path": "network-settings.v2.system",
        "data": {
            "staticHostname": "myhostname",
            "useDhcpHostname": false
        }
    },
    "response": {
        "status": "success"
    }
}

Set resolver settings

Use the staticNameServers parameter to configure the static nameservers.
Use the staticSearchDomains parameter to configure the static search domains.
Use the useDhcpResolver parameter to configure if DHCP assigned resolver configuration should be used.

Example:

curl
HTTP

curl --request PATCH \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-settings/v2beta/system \
  --data '{
    "data": {
        "staticNameServers": [
            "192.168.0.1",
            "192.168.1.2",
            "1234::77"
        ],
        "staticSearchDomains": [
            "axis.com",
            "example.com"
        ],
        "useDhcpResolver": false
    }
}'

PATCH /config/rest/network-settings/v2beta/system HTTP/1.1
HOST: my-device
Content-Type: application/json

{
    "data": {
        "staticNameServers": [
            "192.168.0.1",
            "192.168.1.2",
            "1234::77"
        ],
        "staticSearchDomains": [
            "axis.com",
            "example.com"
        ],
        "useDhcpResolver": false
    }
}

200 OK
Content-Type: application/json

{
    "status": "success"
}

Manage switch settings

Some devices have built-in switches that allow additional products to be connected for network connectivity. Switch support is dynamic and not always available. Use switch_supported to check switch support on the device.

Get switch configuration

The switch entity network-settings.v2.switch will return the current switch configuration if switch_supported is true, otherwise not available.

{
    "request": {
        "operation": "GET",
        "path": "network-settings.v2.switch"
    },
    "response": {
        "status": "success",
        "data": [
            {
               "port": [
                    {
                        "lowerState": "UP",
                        "portId": "1",
                        "remoteAddresses": [
                            "55:72:97:5a:c7:cf"
                        ],
                        "security_supported": false,
                        "enabled": true,
                        "security": {
                            "macSecState": "SECURED",
                            "authServerEnabled": true,
                            "authServerEnforced": "MACSEC_SECURED",
                            "authState": "AUTHENTICATED"
                        }
                    },
                    {
                        "lowerState": "DOWN",
                        "portId": "2",
                        "remoteAddresses": [],
                        "security_supported": true,
                        "enabled": true,
                        "security": {
                            "macSecState": "UNKNOWN",
                            "authServerEnabled": true,
                            "authServerEnforced": "AUTHENTICATED",
                            "authState": "UNKNOWN"
                        }
                    }
                ]
            }
        ]
    }
}

Get switch port settings

Retrieve individual port settings from the collection of switch ports with portId.

The switch port security settings are dynamically supported. Check security_supported for availability. security will be excluded if it is not supported.

{
    "request": {
        "operation": "GET",
        "path": "network-settings.v2.switch.port['1']"
    },
    "response": {
        "status": "success",
        "data": {
                    "lowerState": "UP",
                    "portId": "1",
                    "remoteAddresses": [
                        "55:72:97:5a:c7:cf"
                    ],
                    "security_supported": true,
                    "enabled": true,
                    "security": {
                        "macSecState": "SECURED",
                        "authServerEnabled": true,
                        "authServerEnforced": "MACSEC_SECURED",
                        "authState": "AUTHENTICATED"
                    }
                }
    }
}

Set switch port settings

Set portId to configure individual port settings on the collection of switch ports.

To enable a port, set enabled to true, which is the default value.
To disable a port, set enabled to false.

The switch port security settings are dynamically supported. Check security_supported for availability. You can't set security if security settings are not supported.

{
    "request": {
        "operation": "SET",
        "path": "network-settings.v2.switch.port['1']",
        "data": {
            "enabled": true,
            "security": {
                "authServerEnabled": false,
                "authServerEnforced": "NONE"
            }
        }
    },
    "response": {
        "status": "success"
    }
}

Get modem, SIM and connection settings

The modem is the component in the device that enables communication with cellular network towers (base stations). Modem support varies by device. Check modem_supported to verify if your device supports cellular connectivity.

To connect to the cellular network, a SIM card must be installed in the device. The SIM card contains pre-configured credentials that identify and authenticate the device with the cellular network provider. SIM-specific information such as provider name and status can be read through the API.

Once authenticated, the device establishes a data connection through the wireless wide area network (WWAN) interface, which provides internet connectivity via the cellular network.

note

This API does not control when to power on or off the modem. Power behavior is product-specific and can vary between devices. By default, most products automatically start the modem when the device boots up.

Get modem configuration

Retrieve the modem configuration and all associated information, including SIM details, connection status and cellular network interface settings. See modem for additional information.

Example:

curl
HTTP

curl --request GET \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-settings/v2beta/modem

GET /config/rest/network-settings/v2beta/modem HTTP/1.1
HOST: my-device
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success",
    "data": {
        "imei": "359918921411872",
        "sim": [
            {
                "connection": {
                    "connectionStatus": "IP_ASSIGNED",
                    "networkInterface": [
                        {
                            "accessPointName": "",
                            "interfaceName": "wwan0",
                            "ipv4Info": {
                                "ipAddress": "172.26.248.70",
                                "origin": "CELLULAR",
                                "prefixLength": 30
                            }
                        }
                    ],
                    "operatorName": "999 40",
                    "radioInterface": "5GSA"
                },
                "iccid": "8900099200002070051",
                "pinRetries": 3,
                "provider": "NDAC",
                "pukRetries": 10,
                "slotId": "1",
                "status": "UNLOCKED"
            }
        ]
    }
}

Get modem configuration when modem is not ready

If the modem is still starting up or is turned off, the configuration will return empty values as shown in this example. See modem for additional information.

Example:

curl
HTTP

curl --request GET \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-settings/v2beta/modem

GET /config/rest/network-settings/v2beta/modem HTTP/1.1
HOST: my-device
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success",
    "data": {
        "imei": null,
        "sim": []
    }
}

Get SIM configuration

Retrieve settings for all SIM cards in the device. In this example, only one SIM card is present. See modem for additional information.

Example:

curl
HTTP

curl --request GET \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-settings/v2beta/modem/sim

GET /config/rest/network-settings/v2beta/modem/sim HTTP/1.1
HOST: my-device
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success",
    "data": [
        {
            "connection": {
                "connectionStatus": "IP_ASSIGNED",
                "networkInterface": [
                    {
                        "accessPointName": "",
                        "interfaceName": "wwan0",
                        "ipv4Info": {
                            "ipAddress": "172.26.248.70",
                            "origin": "CELLULAR",
                            "prefixLength": 30
                        }
                    }
                ],
                "operatorName": "999 40",
                "radioInterface": "5GSA"
            },
            "iccid": "8900099200002070051",
            "pinRetries": 3,
            "provider": "NDAC",
            "pukRetries": 10,
            "slotId": "1",
            "status": "UNLOCKED"
        }
    ]
}

Get connection configuration

Retrieve connection settings for a particular SIM card by using the SIM slot index as key. See network-settings.v2.modem.sim.connection for additional information.

Example:

curl
HTTP

curl --request GET \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-settings/v2beta/modem/sim//1/connection

GET /config/rest/network-settings/v2beta/modem/sim//1/connection HTTP/1.1
HOST: my-device
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success",
    "data": {
        "connectionStatus": "IP_ASSIGNED",
        "networkInterface": [
            {
                "accessPointName": "",
                "interfaceName": "wwan0",
                "ipv4Info": {
                    "ipAddress": "172.26.248.70",
                    "origin": "CELLULAR",
                    "prefixLength": 30
                }
            }
        ],
        "operatorName": "999 40",
        "radioInterface": "5GSA"
    }
}

Get network interface configuration

Retrieve settings for all network interface associated with SIM card slot index 1. In this example, only the network interface modem.sim.connection.networkInterface is present.

Example:

curl
HTTP

curl --request GET \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-settings/v2beta/modem/sim//1/connection/networkInterface

GET /config/rest/network-settings/v2beta/modem/sim//1/connection/networkInterface HTTP/1.1
HOST: my-device
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success",
    "data": [
        {
            "accessPointName": "",
            "interfaceName": "wwan0",
            "ipv4Info": {
                "ipAddress": "172.26.248.70",
                "origin": "CELLULAR",
                "prefixLength": 30
            }
        }
    ]
}

Get detailed radio settings from the cellular network

The modem can retrieve radio parameters from the cellular network, including radio generation, radio band, cell connection information, and signal strength metrics. This information is valuable for network integrators when they want to determine optimal placement for fixed device installation(such as the Axis Cellular Back Box). It is also useful when troubleshooting to determine whether performance degradation is caused by network conditions or other factors.

Get radio parameters

Retrieve radio parameters for the 5G network connection associated with SIM slot 1 by using getRadioParameters.

Example:

curl
HTTP

curl --request POST \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-settings/v2beta/modem/sim/1/connection/getRadioParameters \
  --data '{
    "data": "5G"
}'

POST /config/rest/network-settings/v2beta/modem/sim/1/connection/getRadioParameters HTTP/1.1
HOST: my-device
Content-Type: application/json

{
    "data": "5G"
}

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success",
    "data": {
        "band": 78,
        "bandwidth": 80,
        "downlinkModulationCodingScheme": 0,
        "physicalCellId": 50,
        "signalStrength": {
            "rsrp": -109,
            "rsrq": -11,
            "rssi": -98,
            "snr": -67,
            "ssi": 0
        },
        "txPower": 23,
        "uplinkModulationCodingScheme": 13
    }
}

The API provides several security and management operations for SIM cards, including verifying the SIM PIN, enabling or disabling PIN protection, unblocking a blocked SIM, and changing the PIN code.

note

This API does not control SIM PIN storage behavior. Whether the device securely stores the PIN is product-specific. By default, most products automatically save the SIM PIN after successful entry and reuse it to unlock the SIM on subsequent boot ups. Performing a hard factory reset will clear the stored PIN.

Enable SIM protection

The setSimProtection action configures the SIM card to require a PIN code entry before the device can connect to the cellular network. Enabled PIN protection helps secure the SIM card if it is lost or stolen, in which case it cannot be used to access the network without the correct PIN code.

Example:

curl
HTTP

curl --request POST \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-settings/v2beta/modem/sim/1/setSimProtection \
  --data '{
    "data": {
        "enable": true,
        "pin": "1234"
    }
}'

POST /config/rest/network-settings/v2beta/modem/sim/1/setSimProtection HTTP/1.1
HOST: my-device
Content-Type: application/json

{
    "data": {
        "enable": true,
        "pin": "1234"
    }
}

HTTP/1.1 200 OK
Content-Type: application/json

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

Unlock SIM

The verifySimPin action unlocks the SIM card by verifying the PIN code. Once the correct PIN is entered, the device will connect to the cellular network.

Example:

curl
HTTP

curl --request POST \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-settings/v2beta/modem/sim/1/verifySimPin \
  --data '{
    "data": "1234"
}'

POST /config/rest/network-settings/v2beta/modem/sim/1/verifySimPin HTTP/1.1
HOST: my-device
Content-Type: application/json

{
    "data": "1234"
}

HTTP/1.1 200 OK
Content-Type: application/json

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

Change SIM PIN

The changeSimPin action changes the PIN code for the SIM card. Both the old and a new PIN must be provided.

Example:

curl
HTTP

curl --request POST \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-settings/v2beta/modem/sim/1/changeSimPin \
  --data '{
    "data": {
        "oldpin": "1234",
        "newpin": "5678"
    }
}'

POST /config/rest/network-settings/v2beta/modem/sim/1/changeSimPin HTTP/1.1
HOST: my-device
Content-Type: application/json

{
    "data": {
        "oldpin": "1234",
        "newpin": "5678"
    }
}

HTTP/1.1 200 OK
Content-Type: application/json

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

Unblock a blocked SIM

The SIM card will be blocked after three incorrect PIN attempts and cannot be used until it is unblocked. To unblock the SIM card, the PUK (Personal Unblocking Key) code provided by the cellular network provider must be entered, followed by a new PIN code and the following action: unblockSim

Example:

curl
HTTP

curl --request POST \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-settings/v2beta/modem/sim/1/unblockSim \
  --data '{
    "data": {
        "pin": "1122",
        "puk": "12345678"
    }
}'

POST /config/rest/network-settings/v2beta/modem/sim/1/unblockSim HTTP/1.1
HOST: my-device
Content-Type: application/json

{
    "data": {
        "pin": "1122",
        "puk": "12345678"
    }
}

HTTP/1.1 200 OK
Content-Type: application/json

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

Manage wired settings

Some devices have wired uplinks. The wired uplink can be configured to either negotiate the network speed and duplex mode automatically, or to be statically configured. Wired uplink support is dynamic and not always available. Check wired_supported for wired uplink support on the device.

Get wired configuration

The wired entity returns the current wired configuration if wired_supported is true, otherwise it's not available. To get the maximum number of supported VLANs, check the maxNumberOfVlans parameter.

Example:

curl
HTTP

curl --request GET \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-settings/v2beta/wired

GET /config/rest/network-settings/v2beta/wired HTTP/1.1
HOST: my-device
Content-Type: application/json

200 OK
Content-Type: application/json

{
    "status": "success",
    "data": [
        {
            "linkMode": "1000FD",
            "staticLinkMode": "AUTO",
            "supportedLinkModes": [
                "AUTO",
                "10HD",
                "10FD",
                "100HD",
                "100FD",
                "1000HD",
                "1000FD"
            ],
            "maxNumberOfVlans": 5
        }
    ]
}

Set wired settings

Set wired to configure the link mode on the wired uplink.

To configure the link mode on the wired uplink, set staticLinkMode to the desired value. To let the link automatically negotiate the link mode, set the property to AUTO. Using an unsupported link mode can result in a connection loss.

Example:

curl
HTTP

curl --request PATCH \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-settings/v2beta/wired/staticLinkMode \
  --data '{
    "data": "100FD"
}'

PATCH /config/rest/network-settings/v2beta/wired/staticLinkMode HTTP/1.1
HOST: my-device
Content-Type: application/json

{
    "data": "100FD"
}

200 OK
Content-Type: application/json

{
    "status": "success"
}

Manage VLANs

The VLAN management is used to tag IEEE 802.1Q traffic going out on the network. The network determines where the tagged packets are directed. It is possible to add, remove and list VLANs with specific VLAN tags.

Add a VLAN

To add a VLAN, call the vlans entity and specify the desired VLAN ID with a number between 1 and 4094.

curl
HTTP

curl --request GET \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-settings/v2beta/wired/vlans

GET /config/rest/network-settings/v2beta/wired/vlans HTTP/1.1
HOST: my-device
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success"
}

List VLANs

To list the currently configured VLANs, use the vlans entity.

curl
HTTP

curl --request GET \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-settings/v2beta/wired/vlans

GET /config/rest/network-settings/v2beta/wired/vlans HTTP/1.1
HOST: my-device
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success",
    "data": [
        {
            "id": "1"
        },
        {
            "id": "2"
        }
    ]
}

Remove a VLAN

To remove a previously configured VLAN, use the vlans entity.

curl
HTTP

curl --request GET \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/network-settings/v2beta/wired/vlans

GET /config/rest/network-settings/v2beta/wired/vlans HTTP/1.1
HOST: my-device
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success"
}

API definition

Structure

network-settings.v2 (Root Entity)
    ├── modem_supported (Property)
    ├── switch_supported (Property)
    ├── wired_supported (Property)
    ├── system (Entity)
        ├── hostname (Property)
        ├── nameServers (Property)
        ├── searchDomains (Property)
        ├── staticHostname (Property)
        ├── staticNameServers (Property)
        ├── staticSearchDomains (Property)
        ├── useDhcpHostname (Property)
    ├── wired (Entity)
        ├── linkMode (Property)
        ├── maxNumberOfVlans (Property)
        ├── staticLinkMode (Property)
        ├── supportedLinkModes (Property)
        ├── useDhcpResolver (Property)
        ├── vlans (Entity Collection)
            ├── id (Property)
    ├── modem (Entity)
        ├── imei (Property)
        ├── sim (Entity Collection)
            ├── iccid (Property)
            ├── pinRetries (Property)
            ├── provider (Property)
            ├── pukRetries (Property)
            ├── slotId (Property)
            ├── status (Property)
            ├── changeSimPin (Action)
            ├── setSimProtection (Action)
            ├── unblockSim (Action)
            ├── verifySimPin (Action)
            ├── connection (Entity)
                ├── connectionStatus (Property)
                ├── operatorName (Property)
                ├── radioInterface (Property)
                ├── getRadioParameters (Action)
                ├── networkInterface (Entity Collection)
                    ├── accessPointName (Property)
                    ├── interfaceName (Property)
                    ├── ipv4Info (Property)
                    ├── setAccessPointName (Action)
    ├── switch (Entity)
        ├── port (Entity Collection)
            ├── enabled (Property)
            ├── lowerState (Property)
            ├── portId (Property)
            ├── remoteAddresses (Property)
            ├── security_supported (Property)
            ├── security (Entity)
                ├── authServerEnabled (Property)
                ├── authServerEnforced (Property)
                ├── authState (Property)
                ├── macSecState (Property)

Entities

network-settings.v2

Description: System wide network configurations
Type: Singleton
Operations
- GET
Attributes
- Dynamic Support: No

Properties

modem_supported

Description:
Datatype: boolean
Operations
- Get
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

switch_supported

Description: Indicates if switch is supported.
Datatype: boolean
Operations
- GET
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

wired_supported

Description:
Datatype: boolean
Operations
- Get
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

network-settings.v2.system

Description: The global network configuration
Type: Singleton
Operations
- GET
- SET
Attributes
- Dynamic Support: No

Properties

hostname

Description: The currently used hostname
Datatype: Hostname
Operations
- GET
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

nameServers

Description: The name servers currently in use.
Datatype: NameServers
Operations
- GET (Permissions: admin)
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

searchDomains

Description: The search domains currently in use.
Datatype: SearchDomains
Operations
- GET (Permissions: admin)
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

staticHostname

Description: The statically configured hostname. It is used if useDhcpHostname is set to false, or if no hostname was obtained by DHCP.
Datatype: Hostname
Operations
- GET
- SET (Permissions: admin)
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

staticNameServers

Description: The statically configured name servers. It is used if useDhcpResolver is set to false, or if no name servers were obtained by DHCP.
Datatype: NameServers
Operations
- GET (Permissions: admin)
- SET
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

staticSearchDomains

Description: The statically configured search domains. It is used if useDhcpResolver is set to false, or if no search domains were obtained by DHCP.
Datatype: SearchDomains
Operations
- GET (Permissions: admin)
- SET
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

useDhcpHostname

Description: Checks which DHCP-assigned hostname should be used. If set to false, the staticHostname will be used.
Datatype: boolean
Operations
- GET
- SET (Permissions: admin)
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

network-settings.v2.wired

Description: The wired uplink configuration.
Type: Singleton
Operations
- Get
Attributes
- Dynamic Support: Yes

Properties

linkMode

Description: The current link mode.
Datatype: LinkMode
Operations
- Get (Permissions: admin)

maxNumberOfVlans

Description: The maximum number of supported VLANs.
Datatype: integer
Operations
- Get (Permissions: admin)
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

useDhcpResolver

Description: Checks if any DHCP-assigned resolver information should be used. If set to false, the static resolver values will be used.
Datatype: boolean
Operations
- GET (Permissions: admin)
- SET
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

staticLinkMode

Description: The statically configured link mode.
Datatype: LinkMode
Operations
- Get (Permissions: admin)
- Set
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

supportedLinkModes

Description: The supported link modes.
Datatype: LinkModes
Operations
- Get (Permissions: admin)
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

Actions

This entity has no actions.

network-settings.v2.modem

Description: The modem configuration and SIM management.
Type: Singleton
Operations
- Get
Attributes
- Dynamic Support: Yes

Properties

imei

Description: The IMEI of the modem, null if the modem is not ready.
Datatype: Imei
Operations
- Get (Permissions: admin)
Attributes
- Nullable: Yes
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

Actions

This entity has no actions.

network-settings.v2.modem.sim

Description: The collection of SIM slots.
Type: Collection (Key Property: slotId)
Operations
- Get
Attributes
- Dynamic Support: No

Properties

iccid

Description: The Integrated Circuit Card Identifier of the SIM, null if the SIM is absent.
Datatype: Iccid
Operations
- Get (Permissions: admin)
Attributes
- Nullable: Yes
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

pinRetries

Description: The number of attempts remaining for entering the SIM PIN, null if the SIM is absent.
Datatype: integer
Operations
- Get (Permissions: admin)
Attributes
- Nullable: Yes
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

provider

Description: The name of the SIM provider, null if the SIM is absent.
Datatype: string
Operations
- Get (Permissions: admin)
Attributes
- Nullable: Yes
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

pukRetries

Description: The number of attempts remaining for entering the SIM PUK, null if the SIM is absent.
Datatype: integer
Operations
- Get (Permissions: admin)
Attributes
- Nullable: Yes
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

slotId

Description: The slot ID of the SIM.
Datatype: SimSlotId
Operations
- Get (Permissions: admin)
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

status

Description: The status of the SIM.
Datatype: SimStatus
Operations
- Get (Permissions: admin)
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

Actions

changeSimPin

Description: Change the SIM PIN.
Request Datatype: SimPinOldAndNew
Response Datatype: EmptyJson
Trigger Permissions: admin
Attributes
- Dynamic Support: No

setSimProtection

Description: Set SIM PIN protection on or off.
Request Datatype: SimPinAndEnable
Response Datatype: EmptyJson
Trigger Permissions: admin
Attributes
- Dynamic Support: No

unblockSim

Description: Unblock the SIM card.
Request Datatype: SimPinAndPuk
Response Datatype: EmptyJson
Trigger Permissions: admin
Attributes
- Dynamic Support: No

verifySimPin

Description: Unlock the SIM using the PIN or just verify the PIN.
Request Datatype: SimPin
Response Datatype: EmptyJson
Trigger Permissions: admin
Attributes
- Dynamic Support: No

network-settings.v2.modem.sim.connection

Description: The cellular network connection.
Type: Singleton
Operations
- Get
Attributes
- Dynamic Support: No

Properties

connectionStatus

Description: The connection status.
Datatype: CellularConnectionStatus
Operations
- Get (Permissions: admin)
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

operatorName

Description: The operator name, null if not connected to a cellular network.
Datatype: string
Operations
- Get (Permissions: admin)
Attributes
- Nullable: Yes
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

radioInterface

Description: The connected radio interface.
Datatype: RadioInterface
Operations
- Get (Permissions: admin)
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

Actions

getRadioParameters

Description: Get the current radio parameters.
Request Datatype: RadioGeneration
Response Datatype: RadioParameters
Trigger Permissions: admin
Attributes
- Dynamic Support: No

network-settings.v2.modem.sim.connection.networkInterface

Description: The collection of network interfaces for this SIM.
Type: Collection (Key Property: interfaceName)
Operations
- Get
Attributes
- Dynamic Support: No

Properties

accessPointName

Description: The Access Point Name for this interface.
Datatype: string
Operations
- Get (Permissions: admin)
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

interfaceName

Description: The interface name.
Datatype: string
Operations
- Get (Permissions: admin)
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

ipv4Info

Description: The IPv4 information provided by the cellular network, null if an IPv4 connection is not established.
Datatype: Ipv4AddressStruct
Operations
- Get (Permissions: admin)
Attributes
- Nullable: Yes
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

Actions

setAccessPointName

Description: Set the Access Point Name for a given interface.
Request Datatype: AccessPointName
Response Datatype: EmptyJson
Trigger Permissions: admin
Attributes
- Dynamic Support: No

network-settings.v2.switch

Description: Global switch configurations
Type: Singleton
Operations
- GET
Attributes
- Dynamic Support: Yes

network-settings.v2.switch.port

Description: Switch port configurations
Type: Collection (Key Property: portId)
Operations
- GET
- SET
Attributes
- Dynamic Support: No

Properties

enabled

Description: Specifies if a network interface device is enabled.
Datatype: boolean
Operations
- GET
- SET (Permissions: admin)
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

lowerState

Description: Indicates if the network interface device status is UP or DOWN.
Datatype: State
Operations
- GET
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

portId

Description: Switch port ID.
Datatype: string
Operations
- GET
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

remoteAddresses

Description: List all stored remote MAC addresses observed on the switch port.
Datatype: RemoteAddresses
Operations
- GET
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

security_supported

Description: Indicates if security is supported.
Datatype: boolean
Operations
- GET
  - SET (Permissions: admin)
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

network-settings.v2.switch.port.security

Description: Switch port security configurations.
Type: Singleton
Operations
- GET
- SET
Attributes
- Dynamic Support: Yes

Properties

authServerEnabled

Description: Indicates if the authentication server is enabled.
Datatype: boolean
Operations
- GET
- SET (Permissions: admin)
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

authServerEnforced

Description: Indicates if the authentication server is enforced.
Datatype: AuthServerEnforced
Operations
- GET
- SET (Permissions: admin)
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

authState

Description: Indicates the authentication state of the port.
Datatype: AuthState
Operations
- GET
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

macSecState

Description: Indicates the MACSec state of the port
Datatype: MacSecState
Operations
- GET
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

network-settings.v2.wired.vlans

Description: VLAN configurations.
Type: Collection (Key Property: id)
Operations
- Get
- Add
  - Required properties: id
- Remove
Attributes
- Dynamic Support: No

Properties

id

Description: The ID of the VLAN. Needs to be between 1 and 4094.
Datatype: VlanId
Operations
- Get (Permissions: admin)
Attributes
- Nullable: No
- Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

Actions

This entity has no actions.

Data types

AccessPointName

Description: The Access Point Name (APN).
Type: string
Minimum Length: 0
Maximum Length: 100
Pattern: ^[a-zA-Z0-9.-]*$

CellularConnectionStatus

Description: The initial state is no network registration, followed by registered without data connection, then data connection without IP and finally IP assigned.
Type: string
Enum Values: "NOT_REGISTERED", "REGISTERED", "DATA_ENABLED", "IP_ASSIGNED"

DomainName

Description: Domain name type.
Type: string

EmptyJson

Description: Empty response object.
Type: complex
Fields

Hostname

Description: Hostname type
Type: string
MinLength: 1
MaxLength: 63
- Pattern: ^\[a-zA-Z\]$|^\[a-zA-Z0-9\]\[a-zA-Z0-9.-\]*\[a-zA-Z0-9\]$

Iccid

Description: The Integrated Circuit Card Identification number.
Type: string

Imei

Description: The IMEI type.
Type: string
Minimum Length: 15
Maximum Length: 15

IpAddress

Description: The IPv4 or IPv6 address type.
Type: string

Ipv4Address

Description: The IPv4 address type.
Type: string
Pattern: ^(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)$

AuthServerEnforced

Description: The authentication server enforcement level.
Type: string
Enum Values: NONE, AUTHENTICATED, MACSEC_SECURED

AuthState

Description: The authentication state type.
Type: string
Enum Values: UNKNOWN, AUTHENTICATED, AUTHENTICATING, STOPPED, FAILED

LinkMode

Description: The link speed and duplex mode of the wired connection.
Type: string
Enum Values: "UNKNOWN", "AUTO", "10HD", "10FD", "100HD", "100FD", "1000HD", "1000FD"

LinkModes

Description: A list of link modes.
Type: array
Element type: LinkMode
Null Value: No

MacAddress

Description: The MAC address type.
Type: string
Pattern: ^(\[0-9A-Fa-f\]{2}\[:\]){5}(\[0-9A-Fa-f\]{2})$

MacSecState

Description: The MACsec state type.
Type: string
Enum Values: UNKNOWN, SECURED, CONNECTING, STOPPED, FAILED

NameServers

Description: The name servers type.
Type: array
Element type: IpAddress
Null Value: No
Minimum item number: 0
Maximum item number: 3

RadioGeneration

Description: The radio generation type.
Type: string
Enum Values: "4G", "5G"

RadioInterface

Description: The connected radio interface type.
Type: string
Enum Values: "4G", "5GSA", "5GNSA", "UNKNOWN"

RadioParameters

Description: The radio parameter object.
Type: complex
Fields
- band
  - Description: The radio band class.
  - Type: integer
  - Nullable: No / Gettable: Yes
- bandwidth
  - Description: The bandwidth (in MHz).
  - Type: integer
  - Nullable: No / Gettable: Yes
- downlinkModulationCodingScheme
  - Description: Typically 0-31 for 5G and 0-28 for 4G. Higher value means better signal quality and higher potential data rates.
  - Type: integer
  - Nullable: No / Gettable: Yes
- physicalCellId
  - Description: The physical cell ID.
  - Type: integer
  - Nullable: No / Gettable: Yes
- signalStrength
  - Description: The signal strength parameters.
  - Type: SignalStrength
  - Nullable: No / Gettable: Yes
- txPower
  - Description: The transmit power (in dBm/10).
  - Type: integer
  - Nullable: No / Gettable: Yes
- uplinkModulationCodingScheme
  - Description: Typically 0-31 for 5G and 0-28 for 4G. Higher value means better signal quality and higher potential data rates.
  - Type: integer
  - Nullable: No / Gettable: Yes

RemoteAddresses

Description: The remote addresses type.
Type: array
Element type: MacAddress
Null Value: No

SearchDomains

Description: The search domains type.
Type: array
Element type: DomainName
Null Value: No
Minimum item number: 0
Maximum item number: 6

SignalStrength

Description: The signal strength object.
Type: complex
Fields
- rsrp
  - Description: The Reference Signal Received Power (in dBm).
  - Type: integer
  - Nullable: No / Gettable: Yes
- rsrq
  - Description: The Reference Signal Received Quality (in dB).
  - Type: integer
  - Nullable: No / Gettable: Yes
- rssi
  - Description: The Received Signal Strength Indicator (in dBm).
  - Type: integer
  - Nullable: No / Gettable: Yes
- snr
  - Description: The Signal to noise ratio (in dB).
  - Type: integer
  - Nullable: No / Gettable: Yes
- ssi
  - Description: The Signal Strength Index.
  - Type: SignalStrengthIndex
  - Nullable: No / Gettable: Yes

SignalStrengthIndex

Description: The signal strength index ranging from 0 (weakest) to 4 (strongest), -1 if no signal.
Type: integer
Minimum Value: -1
Maximum Value: 4

SimPin

Description: The SIM PIN type.
Type: string
Minimum Length: 4
Maximum Length: 8
Pattern: ^[0-9]+$

SimPinAndEnable

Description: The PIN and PIN enabled object.
Type: complex
Fields
- enable
  - Description: true if SIM PIN protection should be enabled, otherwise false.
  - Type: boolean
  - Nullable: No / Gettable: Yes
- pin
  - Description: The SIM PIN.
  - Type: SimPin
  - Nullable: No / Gettable: Yes

SimPinAndPuk

Description: The PIN and PUK object.
Type: complex
Fields
- pin
  - Description: The SIM PIN.
  - Type: SimPin
  - Nullable: No / Gettable: Yes
- puk
  - Description: The PUK code of the SIM.
  - Type: SimPuk
  - Nullable: No / Gettable: Yes

SimPinOldAndNew

Description: The old and new PIN object.
Type: complex
Fields
- newpin
  - Description: The new SIM PIN.
  - Type: SimPin
  - Nullable: No / Gettable: Yes
- oldpin
  - Description: The existing SIM PIN.
  - Type: SimPin
  - Nullable: No / Gettable: Yes

SimPuk

Description: The SIM PUK type.
Type: string
Minimum Length: 8
Maximum Length: 8
Pattern: ^[0-9]+$

SimSlotId

Description: A string index from 0 to 99.
Type: string
Minimum Length: 1
Maximum Length: 2
Pattern: ^[0-9]+$

SimStatus

Description: The PIN can be disabled, which means the SIM PIN is not required. Enter the SIM PIN to unlock the SIM card and change its status from LOCKED to UNLOCKED. Three incorrect SIM PIN attempts will make the SIM card BLOCKED. Ten incorrect SIM PUK attempts will make the SIM card PERMANENTLY_BLOCKED. A broken SIM card will be presented as UNKNOWN. The UNKNOWN status will also appear when fetching the SimStatus while the modem is not ready.
Type: string
Enum Values: "PIN_DISABLED", "UNLOCKED", "LOCKED", "BLOCKED", "PERMANENTLY_BLOCKED", "NO_SIM", "UNKNOWN"

State

Description: The link state type.
Type: string
Enum Values: UP, DOWN

VlanId

Description: The ID of the VLAN. Needs to be between 1 and 4094.
Type: string
Pattern: ^([1-9][0-9]{0,2}|[1-3][0-9]{3}|40[0-8][0-9]|409[0-4])$

Description​

Authentication​

Use cases​

Manage system settings​

Get system settings​

Set hostname settings​

Set resolver settings​

Manage switch settings​

Get switch configuration​

Get switch port settings​

Set switch port settings​

Get modem, SIM and connection settings​

Get modem configuration​

Get modem configuration when modem is not ready​

Get SIM configuration​

Get connection configuration​

Get network interface configuration​

Get detailed radio settings from the cellular network​

Get radio parameters​

SIM related actions​

Enable SIM protection​

Unlock SIM​

Change SIM PIN​

Unblock a blocked SIM​

Manage wired settings​

Get wired configuration​

Set wired settings​

Manage VLANs​

Add a VLAN​

List VLANs​

Remove a VLAN​

API definition​

Structure​

Entities​

network-settings.v2​

Properties​

modem_supported​

switch_supported​

wired_supported​

network-settings.v2.system​

Properties​

hostname​

nameServers​

searchDomains​

staticHostname​

staticNameServers​

staticSearchDomains​

useDhcpHostname​

network-settings.v2.wired​

Properties​

linkMode​

maxNumberOfVlans​

useDhcpResolver​

staticLinkMode​

supportedLinkModes​

Actions​

network-settings.v2.modem​

Properties​

imei​

Actions​

network-settings.v2.modem.sim​

Properties​

iccid​

pinRetries​

provider​

pukRetries​

slotId​

status​

Actions​

changeSimPin​

setSimProtection​

unblockSim​

verifySimPin​

network-settings.v2.modem.sim.connection​

Properties​

connectionStatus​

operatorName​

radioInterface​

Actions​

getRadioParameters​

Description

Authentication

Use cases

Manage system settings

Get system settings

Set hostname settings

Set resolver settings

Manage switch settings

Get switch configuration

Get switch port settings

Set switch port settings

Get modem, SIM and connection settings

Get modem configuration

Get modem configuration when modem is not ready

Get SIM configuration

Get connection configuration

Get network interface configuration

Get detailed radio settings from the cellular network

Get radio parameters

SIM related actions

Enable SIM protection

Unlock SIM

Change SIM PIN

Unblock a blocked SIM

Manage wired settings

Get wired configuration

Set wired settings

Manage VLANs

Add a VLAN

List VLANs

Remove a VLAN

API definition

Structure

Entities

network-settings.v2

Properties

modem_supported

switch_supported

wired_supported

network-settings.v2.system

Properties

hostname

nameServers

searchDomains

staticHostname

staticNameServers

staticSearchDomains

useDhcpHostname

network-settings.v2.wired

Properties

linkMode

maxNumberOfVlans

useDhcpResolver

staticLinkMode

supportedLinkModes

Actions

network-settings.v2.modem

Properties

imei

Actions

network-settings.v2.modem.sim

Properties

iccid

pinRetries

provider

pukRetries

slotId

status

Actions

changeSimPin

setSimProtection

unblockSim

verifySimPin

network-settings.v2.modem.sim.connection

Properties

connectionStatus

operatorName

radioInterface

Actions

getRadioParameters