Forget Wi-Fi
1. API Description
This API is used to forget a Wi-Fi, that is, removing the existing Wi-Fi configuration.
Request mode: POST [ip]/api/network/wifi-forget
| Administrator Rights | Logged-in |
|---|---|
| Yes | Yes |
2. Input Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| iface | Yes | String | The network card name, wlan0 |
| ssid | Yes | String | The Wi-Fi name |
3. Output Parameters
| Name | Type | Description |
|---|---|---|
| status | Int | Status code |
4. Example
Forgetting the Wi-Fi named "magewell".
Input Example
{
"iface": "wlan0",
"ssid": "magewell"
}
Output Example
{
"status": 0
}
5. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Status | Definition | Description |
|---|---|---|
| 7 | MW_STATUS_INVALID_ARG | Missing required parameters |
| 11 | MW_STATUS_DEVICE_BUSY | The wireless network card does not exist |
| 16 | MW_STATUS_NOT_EXIST | The record does not exist |