Skip to content

GET /api/service/identity/get/

Return device service information.

Auth: Bearer (powerUser).


The request body is not used.

ParameterValueDescription
includePassword1If specified, the devicePassword field is added to the response. Otherwise, the password is not returned.

Example: GET /api/service/identity/get/?includePassword=1


{
"available": true,
"donglePresent": true,
"hasDevicePrivateKey": true,
"hasDevicePassword": true,
"uuid": "002B003A-3234510F-38383235",
"devicePublicKey": "base64...",
"macAddress": "00:11:22:33:44:55",
"isUnique": true,
"urlAutoConfig": "https://example.invalid",
"manufacturer": "Novatek",
"pinCode": "123456",
"devicePassword": "Ab12Cd34"
}
FieldTypeDescription
availablebooleanDevice service data is available
donglePresentbooleanThe hardware service dongle is present
hasDevicePrivateKeybooleanThe device private key is set
hasDevicePasswordbooleanThe device password is set; the password value is not disclosed
uuidstring | nullFull MCU unique ID in XXXXXXXX-XXXXXXXX-XXXXXXXX format
devicePublicKeystring | nullDevice public key in WireGuard base64 format
macAddressstringEffective MAC address in XX:XX:XX:XX:XX:XX format, including the fallback value
isUniquebooleantrue if the MAC address was read from the EUI-48 chip; false if the fallback derived from the MCU UUID is used
urlAutoConfigstring | nullAuto-configuration URL
manufacturerstring | nullManufacturer string
pinCodestring | nullPIN code
devicePasswordstring | nullDevice password. Present only when requested with ?includePassword=1

If the device service data is not ready yet, the API returns 503 ERROR_NOT_READY.