๐Ÿ“˜ Epiphan Knowledge
All pages ยท pearl family ยท Firmware

Pearl REST API check firmware version and device identity

Firmware and identity endpoints identify which Pearl model you are talking to and which firmware it is running. They are the safest first call in any automation script, because they confirm both reachability and model before anything is changed.

Applies to: Pearl-2, Pearl Mini, Pearl Nexus, Pearl Nano.

Method and path Returns
GET /system/firmware All firmware details in one object
GET /system/firmware/version Firmware version alone, such as 4.24.5
GET /system/firmware/revision Firmware revision string
GET /system/firmware/product_id Numeric product identifier
GET /system/firmware/product_name Product name, such as Pearl Mini
GET /system/ident Device name, location, and description

The combined firmware call returns everything at once:

{
  "status": "ok",
  "result": {
    "version": "4.24.1",
    "revision": "250107_1e4514f",
    "product_id": 44,
    "product_name": "Pearl Mini"
  }
}

version follows a three-part number. product_name matches the product name shown on the Info page of the Pearl Admin panel.

Device identity fields returned by /system/ident:

Field Limit
name Up to 50 characters. Letters, digits, hyphen, space, apostrophe, parentheses, square brackets, and underscore
location Up to 50 characters
description Up to 50 characters

Use product_name or product_id to branch automation logic by model, since input IDs and several input settings differ between Pearl-2, Pearl Mini, Pearl Nexus, and Pearl Nano.

Was this helpful?
Source: pearl-rest-api.md ยท id pearl-family/pearl-rest-api-check-firmware-version-and-device-identity ยท Updated Oct 7, 2026 ยท view as markdown