Fetch Device(s)

This section of the Device API explains how to retrieve one or more devices.

Get Device

GET devices/{device_id}

Request

$ curl http://api.enapter.com/v3/devices/devicea0-45f2-4e9e-a6f0-69a310ab110b

Expand response with communication and connectivity:

$ curl http://api.enapter.com/v3/devices/devicea0-45f2-4e9e-a6f0-69a310ab110b?expand=communication,connectivity

Query Parameters

expandarray of strings#

Comma-separated list of additional device information to display. By default, no additional fields are included.

Supported values:

site — includes information about the site, to which the device is connected.
manifest — includes device blueprint manifest.
properties — includes the last received device properties.
connectivity — includes current device connection status.
communication — includes device communication info.

Response

Default response:

{
    "device": {
        "id": "devicea0-45f2-4e9e-a6f0-69a310ab110b",
        "blueprint_id": "bluepri1-50n3-4t9d-e6v0-69i310cb110e",
        "name": "Gas detector in living room",
        "site_id": "sitebba0-79f2-4e9e-a6f0-69a310ab110b",
        "updated_at": 1735689600,
        "slug": "gas-detector-in-living-room",
        "type": "LUA",
        "authorized_role": "INSTALLER"
    }
}

Expanded response:

{
    "device": {
        "id": "devicea0-45f2-4e9e-a6f0-69a310ab110b",
        "blueprint_id": "bluepri1-50n3-4t9d-e6v0-69i310cb110e",
        "name": "My Device",
        "site_id": "sitebba0-79f2-4e9e-a6f0-69a310ab110b",
        "updated_at": 1735689600,
        "slug": "my-device",
        "type": "LUA",
        "authorized_role": "INSTALLER",
        "communication": {
            "type": "UCM_LUA",
            "upstream_id": "ucmbbba0-79f2-4e9e-a6f0-69a310ab110b"
        },
        "connectivity": {"status": "ONLINE"}
    }
}

deviceobject#

Object containing device information.

device.idstring#: Device ID.

device.blueprint_idstring#: Blueprint ID.

device.site_idstring#: Site ID.

device.namestring#: Device name.

device.updated_atinteger#: The timestamp of the most recent update of the device’s information.

device.authorized_rolestring#: The user's authorized role for the device.

device.slugstring#: Device's slug.

device.typestring#

One of the following types:

STANDALONE – device that operates independently without needing to be connected to a Gateway or other Enapter hardware.
GATEWAY – device that connects Enapter energy systems to the Enapter Cloud for data communication, remote monitoring and control.
EMBEDDED_UCM – communication module, which embedded into Enapter devices UCM,
HARDWARE_UCM – Enapter Universal Communication Module (UCM),
VIRTUAL_UCM – Enapter virtual UCM,
LINK_MASTER_UCM, – Enapter LINK master device,
LINK_SLAVE_UCM – Enapter UCM, connected to Enapter LINK master device,
LUA – a third-party device, which connected to Enapter UCM and controlled by a Lua script,
NATIVE – Enapter device like Electrolyser or Dryer.

device.implemented_profilesarray of strings#: A list of profiles implemented by the device. You can also find them in the device's manifest.

Expanded fields

device.propertiesobject#: Device's properties.

device.manifestobject#: Device's manifest.

device.communicationobject#

Device's communication info.

`UCM_LUA` or `UCM_EMBBEDED`	Other communication types
`communication.upstream_id`string# Device ID of upstream device.	`communication.upstream_id`string# Device ID of upstream device.
`communication.type`string# A type of communication to the Enapter EMS: - `MQTT_V1_PLAINTEXT` – unencrypted MQTT connection, - `MQTT_V1_TLS` – encrypted MQTT connection (MQTTS), - `MQTT_V1_LOCALHOST` – connected to a local MQTT server, - `UCM_LUA` – connected to Enapter UCM, hardware or virtual, - `UCM_EMBEDDED` – via embedded UCM, - `LINK` – via Enapter LINK.	`communication.type`string# A type of communication to the Enapter EMS: - `MQTT_V1_PLAINTEXT` – unencrypted MQTT connection, - `MQTT_V1_TLS` – encrypted MQTT connection (MQTTS), - `MQTT_V1_LOCALHOST` – connected to a local MQTT server, - `UCM_LUA` – connected to Enapter UCM, hardware or virtual, - `UCM_EMBEDDED` – via embedded UCM, - `LINK` – via Enapter LINK.
	`communication.hardware_id`string# Device hardware ID.
	`communication.channel_id`string# Device channel ID.

device.siteobject#: Device's site info.

device.connectivityobject#

Device's connectivity information.

connectivity.statusstring#: Connectivity status. Can be ONLINE or OFFLINE.

List Devices

GET devices

Get a list of devices.

Request

$ curl http://api.enapter.com/v3/devices

To enrich response with an additional information:

$ curl http://api.enapter.com/v3/devices?expand=communication,connectivity

Query Parameters

limitnumber#: The maximum number of devices to return.

offsetnumber#: The number of devices to skip. Devices are ordered by ID.

profiles.hasstring#: Filter devices by profiles.

expandarray of strings#

Comma-separated list of additional device information to display. By default, no additional fields are included.

Supported values:

site — includes information about the site, to which the device is connected.
manifest — includes device blueprint manifest.
properties — includes the last received device properties.
connectivity — includes current device connection status.
communication — includes device communication info.

Response

Default response:

{
    "devices": [
        {
            "id": "ucmbbba0-79f2-4e9e-a6f0-69a310ab110b",
            "blueprint_id": "bluepri0-79n2-4t9e-u6c0-69m310ab110b",
            "name": "My UCM",
            "site_id": "sitebba0-79f2-4e9e-a6f0-69a310ab110b",
            "updated_at": 1735689600,
            "slug": "my-ucm",
            "type": "HARDWARE_UCM",
            "authorized_role": "INSTALLER"
        },
        {
            "id": "devicea0-45f2-4e9e-a6f0-69a310ab110b",
            "blueprint_id": "bluepri1-50n3-4t9d-e6v0-69i310cb110e",
            "name": "My Device",
            "site_id": "sitebba0-79f2-4e9e-a6f0-69a310ab110b",
            "updated_at": 1735689600,
            "slug": "my-device",
            "type": "LUA",
            "authorized_role": "INSTALLER"
        }
    ],
    "total_count": 2
}

Expanded response:

{
    "devices": [
        {
            "id": "ucmbbba0-79f2-4e9e-a6f0-69a310ab110b",
            "blueprint_id": "bluepri0-79n2-4t9e-u6c0-69m310ab110b",
            "name": "My UCM",
            "site_id": "sitebba0-79f2-4e9e-a6f0-69a310ab110b",
            "updated_at": 1735689600,
            "slug": "my-ucm",
            "type": "HARDWARE_UCM",
            "authorized_role": "INSTALLER",
            "communication": {
                "type": "MQTT_V1_TLS",
                "hardware_id": "C8795CBA5375484E829105E959663C8B",
                "channel_id": "ucm"
            },
            "connectivity": {"status": "ONLINE"}
        },
        {
            "id": "devicea0-45f2-4e9e-a6f0-69a310ab110b",
            "blueprint_id": "bluepri1-50n3-4t9d-e6v0-69i310cb110e",
            "name": "My Device",
            "site_id": "sitebba0-79f2-4e9e-a6f0-69a310ab110b",
            "updated_at": 1735689600,
            "slug": "my-device",
            "type": "LUA",
            "authorized_role": "INSTALLER",
            "communication": {
                "type": "UCM_LUA",
                "upstream_id": "ucmbbba0-79f2-4e9e-a6f0-69a310ab110b"
            },
            "connectivity": {"status": "ONLINE"}
        }
    ],
    "total_count": 2
}

devicesarray of objects#

A list of Device objects.

deviceobject#

Object containing device information.

device.idstring#: Device ID.

device.blueprint_idstring#: Blueprint ID.

device.site_idstring#: Site ID.

device.namestring#: Device name.

device.updated_atinteger#: The timestamp of the most recent update of the device’s information.

device.authorized_rolestring#: The user's authorized role for the device.

device.slugstring#: Device's slug.

device.typestring#

One of the following types:

STANDALONE – device that operates independently without needing to be connected to a Gateway or other Enapter hardware.
GATEWAY – device that connects Enapter energy systems to the Enapter Cloud for data communication, remote monitoring and control.
EMBEDDED_UCM – communication module, which embedded into Enapter devices UCM,
HARDWARE_UCM – Enapter Universal Communication Module (UCM),
VIRTUAL_UCM – Enapter virtual UCM,
LINK_MASTER_UCM, – Enapter LINK master device,
LINK_SLAVE_UCM – Enapter UCM, connected to Enapter LINK master device,
LUA – a third-party device, which connected to Enapter UCM and controlled by a Lua script,
NATIVE – Enapter device like Electrolyser or Dryer.

device.implemented_profilesarray of strings#: A list of profiles implemented by the device. You can also find them in the device's manifest.

Expanded fields

device.propertiesobject#: Device's properties.

device.manifestobject#: Device's manifest.

device.communicationobject#

Device's communication info.

`UCM_LUA` or `UCM_EMBBEDED`	Other communication types
`communication.upstream_id`string# Device ID of upstream device.	`communication.upstream_id`string# Device ID of upstream device.
`communication.type`string# A type of communication to the Enapter EMS: - `MQTT_V1_PLAINTEXT` – unencrypted MQTT connection, - `MQTT_V1_TLS` – encrypted MQTT connection (MQTTS), - `MQTT_V1_LOCALHOST` – connected to a local MQTT server, - `UCM_LUA` – connected to Enapter UCM, hardware or virtual, - `UCM_EMBEDDED` – via embedded UCM, - `LINK` – via Enapter LINK.	`communication.type`string# A type of communication to the Enapter EMS: - `MQTT_V1_PLAINTEXT` – unencrypted MQTT connection, - `MQTT_V1_TLS` – encrypted MQTT connection (MQTTS), - `MQTT_V1_LOCALHOST` – connected to a local MQTT server, - `UCM_LUA` – connected to Enapter UCM, hardware or virtual, - `UCM_EMBEDDED` – via embedded UCM, - `LINK` – via Enapter LINK.
	`communication.hardware_id`string# Device hardware ID.
	`communication.channel_id`string# Device channel ID.

device.siteobject#: Device's site info.

device.connectivityobject#

Device's connectivity information.

connectivity.statusstring#: Connectivity status. Can be ONLINE or OFFLINE.

total_countinteger#: The total number of user's devices.

Get Device​

Request​

Query Parameters​

expandarray of strings#

Response​

deviceobject#

device.idstring#

device.blueprint_idstring#

device.site_idstring#

device.namestring#

device.updated_atinteger#

device.authorized_rolestring#

device.slugstring#

device.typestring#

device.implemented_profilesarray of strings#

Expanded fields

device.propertiesobject#

device.manifestobject#

device.communicationobject#

communication.upstream_idstring#

communication.upstream_idstring#

communication.typestring#

communication.typestring#

communication.hardware_idstring#

communication.channel_idstring#

device.siteobject#

device.connectivityobject#

connectivity.statusstring#

List Devices​

Request​

Query Parameters​

limitnumber#

offsetnumber#

profiles.hasstring#

expandarray of strings#

Response​

devicesarray of objects#

deviceobject#

device.idstring#

device.blueprint_idstring#

device.site_idstring#

device.namestring#

device.updated_atinteger#

device.authorized_rolestring#

device.slugstring#

device.typestring#

device.implemented_profilesarray of strings#

Expanded fields

device.propertiesobject#

device.manifestobject#

device.communicationobject#

communication.upstream_idstring#

communication.upstream_idstring#

communication.typestring#

communication.typestring#

communication.hardware_idstring#

communication.channel_idstring#

device.siteobject#

device.connectivityobject#

connectivity.statusstring#

total_countinteger#

Get Device

Request

Query Parameters

`expand`array of strings#

Response

`device`object#

`device.id`string#

`device.blueprint_id`string#

`device.site_id`string#

`device.name`string#

`device.updated_at`integer#

`device.authorized_role`string#

`device.slug`string#

`device.type`string#

`device.implemented_profiles`array of strings#

`device.properties`object#

`device.manifest`object#

`device.communication`object#

`communication.upstream_id`string#

`communication.upstream_id`string#

`communication.type`string#

`communication.type`string#

`communication.hardware_id`string#

`communication.channel_id`string#

`device.site`object#

`device.connectivity`object#

`connectivity.status`string#

List Devices

Request

Query Parameters

`limit`number#

`offset`number#

`profiles.has`string#

`expand`array of strings#

Response

`devices`array of objects#

`device`object#

`device.id`string#

`device.blueprint_id`string#

`device.site_id`string#

`device.name`string#

`device.updated_at`integer#

`device.authorized_role`string#

`device.slug`string#

`device.type`string#

`device.implemented_profiles`array of strings#

`device.properties`object#

`device.manifest`object#

`device.communication`object#

`communication.upstream_id`string#

`communication.upstream_id`string#

`communication.type`string#

`communication.type`string#

`communication.hardware_id`string#

`communication.channel_id`string#

`device.site`object#

`device.connectivity`object#

`connectivity.status`string#

`total_count`integer#