Skip to content

Network

Total endpoints: 3 Example base URL: https://<ROBOT_IP>/rest Required access for this section: ADMIN

Configure Wifi

  • Endpoint: /api/v2/network/configure/
  • Function: Configure a Wi-Fi network and activate it on the robot.
  • Method: POST
  • Parameters:
  • config (body, WiFiConfig)
  • Shell Command:
curl -X POST "https://<ROBOT_IP>/rest/api/v2/network/configure/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"ssid": "example", "password": "example", "is_hidden": true, "eap_method": "PEAP", "phase2": "MSCHAPV2", "identity": "example", "anonymous_identity": "example", "ca_cert": "example", "client_cert": "example", "private_key": "example", "private_key_password": "example", "subject_match": "example", "domain_suffix_match": "example", "security": "example"}'
  • Python Command:

```python import requests

url = "https:///rest/api/v2/network/configure/" headers = {"Authorization": "Bearer "} json_payload = {'ssid': 'example', 'password': 'example', 'is_hidden': True, 'eap_method': 'PEAP', 'phase2': 'MSCHAPV2', 'identity': 'example', 'anonymous_identity': 'example', 'ca_cert': 'example', 'client_cert': 'example', 'private_key': 'example', 'private_key_password': 'example', 'subject_match': 'example', 'domain_suffix_match': 'example', 'security': 'example'} response = requests.post(url, headers=headers, json=json_payload, timeout=10)

print(response.status_code) print(response.json()) ```

  • Response Example (200):
{
  "message": "Wi-Fi configuration applied successfully."
}

Get Available Wifi

  • Endpoint: /api/v2/network/get_wifi_list/
  • Function: Scan available Wi-Fi networks and return scan + connection state.
  • Method: GET
  • Parameters: none
  • Shell Command:
curl -L "https://<ROBOT_IP>/rest/api/v2/network/get_wifi_list/" \
  -H "Authorization: Bearer <token>"
  • Python Command:
import requests

url = "https://<ROBOT_IP>/rest/api/v2/network/get_wifi_list/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers, timeout=10)

print(response.status_code)
print(response.json())
  • Response Example (200):
{
  "available_networks": [
    {
      "ssid": "ExampleWiFi",
      "security": "WPA2",
      "signal_level": -45,
      "configured": true
    }
  ],
  "connected_network": {
    "ssid": "ExampleWiFi",
    "ip_address": "192.168.1.42"
  }
}

Remove Wifi Network

  • Endpoint: /api/v2/network/remove/
  • Function: Remove all configured network entries matching an SSID.
  • Method: DELETE
  • Parameters:
  • ssid (query, str)
  • Shell Command:
curl -X DELETE "https://<ROBOT_IP>/rest/api/v2/network/remove/?ssid=example" \
  -H "Authorization: Bearer <token>"
  • Python Command:
import requests

url = "https://<ROBOT_IP>/rest/api/v2/network/remove/"
headers = {"Authorization": "Bearer <token>"}
params = {'ssid': 'example'}
response = requests.delete(url, headers=headers, params=params, timeout=10)

print(response.status_code)
print(response.json())
  • Response Example (200):
{
  "message": "Successfully removed Wi-Fi network 'ExampleWiFi'"
}