Set device name
1. API Description
This API is used to set the device name.
Request mode: POST [ip]/api/system/set-device-name
| Administrator Rights | Logged-in |
|---|---|
| Yes | Yes |
2. Input Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| name | Yes | String | The device name |
3. Output Parameters
| Name | Type | Description |
|---|---|---|
| status | Int | Status code |
| code | String | Status description |
| ext-need-reboot | Boolean | Whether a reboot is required. true: Yes; false: No |
4. Example
Setting the device name to Magewell-1.
Input Example
{
"name": "Magewell-1"
}
Output Example
{
"status": 0,
"code": "SUCCESS",
"ext-need-reboot": true
}
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 | The parameters are missing or incorrect |