patch
https://hub.xyte.io/core/v1/organization/devices/
Update configurations on a device.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Authorization
This endpoint requires Authorization.
Request Body
| Key | Type | Description |
|---|---|---|
| configuration | object | An object containing the configuration of elements of a device. |
| name | string | The display name of the device. |
| device_host_address | string | The host address of the device (e.g. IP address or hostname). |
| sub_model | string | The sub-model identifier of the device. |
| sn | string | The serial number of the device. |
| mac | string | The MAC address of the device (format aa:bb:cc:dd:ee:ff). Requires the device model's allow_mac_edit flag to be enabled. |
| custom_model_name | string | A custom model name override for the device. |
| custom_parameters | object | Edge devices only. Sets the values of the custom parameters declared on the device's device model. Keys are the human-readable parameter labels shown on the device model (for example Port, not {$PORT}). Unknown labels are rejected. This replaces the complete set — any parameter omitted from the request is reset to an empty value (see the note below). Values are propagated to the edge target. |
{
"configuration": {
"a": 0
},
"name": "My Device",
"device_host_address": "192.168.1.100",
"sub_model": "model-v2",
"sn": "SN-12345",
"mac": "00:11:22:33:44:55",
"custom_model_name": "My Custom Model",
"custom_parameters": {
"SNMP community": "public",
"Port": "161"
}
}Custom parameters are replaced as a complete set
Each Update Device request that includescustom_parametersrewrites the device's entire set of custom parameters. Any parameter declared on the device model but not included in the request is reset to an empty value. Always send every custom parameter you want to keep — not just the ones you are changing. To read the current values first, use Get Device.