Skip to main content

Device

Create Standalone Device CloudGateway​

Create a new standalone device.

enapter3 device create standalone --site-id="" --device-name="" [--api-allow-insecure] [--api-url=""] [--verbose]
--site-id=stringrequired#

Site ID.

--device-name, -nstring#

Name for the new device.

--api-allow-insecure#

Allows insecure connections to the Enapter API.

--api-url=string#

Overrides API base URL (default: "https://api.enapter.com").

--verbose#

Logs extra details about the operation.

Create Lua Device CloudGateway​

Create a new Lua device.

enapter3 device create lua-device --blueprint-id="" --runtime-id="" --device-name="" [--device-slug=""] [--api-allow-insecure] [--api-url=""] [--verbose]
--blueprint-id, -bstringconflicts: --blueprint-path#

Blueprint ID to use for the new Lua device.

--blueprint-path=stringconflicts: --blueprint-id#

Blueprint path (zip file or directory) to use for the new Lua device.

--runtime-id, -r=string#

UCM device ID where the new Lua device will run.

--device-name, -n=string#

Name for the new device.

--device-slugstring#

Slug for the new Lua device.

--api-allow-insecure#

Allows insecure connections to the Enapter API.

--api-url=string#

Overrides API base URL (default: "https://api.enapter.com").

--verbose#

Logs extra details about the operation.

List Devices CloudGateway​

List user devices ordered by device ID.

enapter3 device list --site-id="" [--expand=""] [--limit=""] [--api-allow-insecure] [--api-url=""] [--verbose]
--site-id=stringrequired#

List devices from this site.

--expand=array#

Comma-separated list of expanded device information

Supported values:

  • connectivity
  • manifest
  • properties
  • communication
  • site
--limit=string#

Maximum number of devices to retrieve (default: 0).

--api-allow-insecure#

Allows insecure connections to the Enapter API.

--api-url=string#

Overrides API base URL (default: "https://api.enapter.com").

--verbose#

Logs extra details about the operation.

Get Device CloudGateway​

Retrieve device information.

enapter3 device get --device-id="" [--expand=""] [--api-allow-insecure] [--api-url=""] [--verbose]
--device-id, -dstringrequired#

Device ID.

--expand=array#

Comma-separated list of expanded device information

Supported values:

  • connectivity
  • manifest
  • properties
  • communication
  • site
--api-allow-insecure#

Allows insecure connections to the Enapter API.

--api-url=string#

Overrides API base URL (default: "https://api.enapter.com").

--verbose#

Logs extra details about the operation.

Change Blueprint CloudGateway​

Change blueprint to device

enapter3 device change-blueprint --device-id="" --blueprint-id="" [--api-allow-insecure] [--api-url=""] [--verbose]
--device-id, -dstringrequired#

Device ID.

--blueprint-id, -bstringconflicts: --blueprint-path#

Blueprint ID to use as new device blueprint.

--blueprint-path=stringconflicts: --blueprint-id#

Blueprint path (zip file or directory) to use as new device blueprint.

--api-allow-insecure#

Allows insecure connections to the Enapter API.

--api-url=string#

Overrides API base URL (default: "https://api.enapter.com").

--verbose#

Logs extra details about the operation.

Show Logs CloudGateway​

Show device logs.

enapter3 device logs --device-id="" [--follow] [--from=""] [--to=""] [--limit=""] [--offset=""] [--order=""] [--severity=""] [--show=""] [--api-allow-insecure] [--api-url=""] [--verbose]
--device-id, -dstringrequired#

Device ID.

--follow, -f#

Follow the log output.

--from=string#

from timestamp in RFC 3339 format (e.g. 2006-01-02T15:04:05Z)

--to=string#

to timestamp in RFC 3339 format (e.g. 2006-01-02T15:04:05Z)

--limit, -l=string#

Maximum number of logs to retrieve (default: 0).

--offset, -o=string#

Number of logs to skip when retrieving (default: 0)

--order=string#

Order logs by criteria:

  • RECEIVED_AT_ASC (default)
  • RECEIVED_AT_DESC
--severity, -s=string#

Filter logs by severity (default: disabled):

  • info
  • warning
  • error
--show=string#

Filter logs by criteria :

  • ALL (default)
  • PERSISTED_ONLY
  • TEMPORARY_ONLY
--api-allow-insecure#

Allows insecure connections to the Enapter API.

--api-url=string#

Overrides API base URL (default: "https://api.enapter.com").

--verbose#

Logs extra details about the operation.

Delete Device CloudGateway​

Delete a device.

enapter3 device delete --device-id="" [--api-allow-insecure] [--api-url=""] [--verbose]
--device-id, -dstringrequired#

Device ID.

--api-allow-insecure#

Allows insecure connections to the Enapter API.

--api-url=string#

Overrides API base URL (default: "https://api.enapter.com").

--verbose#

Logs extra details about the operation.

Execute Command CloudGateway​

Execute a device command

enapter3 device command execute --device-id="" --name="" [--arguments=""] [--api-allow-insecure] [--api-url=""] [--verbose]
--device-id, -dstringrequired#

Device ID.

--namestringrequired#

Command name.

--argumentsstring#

Command arguments (should be a JSON string).

--api-allow-insecure#

Allows insecure connections to the Enapter API.

--api-url=string#

Overrides API base URL (default: "https://api.enapter.com").

--verbose#

Logs extra details about the operation.

List Command Executions CloudGateway​

List device command executions.

enapter3 device command list --device-id="" [--api-allow-insecure] [--api-url=""] [--verbose]
--device-id, -dstringrequired#

Device ID.

--api-allow-insecure#

Allows insecure connections to the Enapter API.

--api-url=string#

Overrides API base URL (default: "https://api.enapter.com").

--verbose#

Logs extra details about the operation.

Get Command Execution CloudGateway​

Retrieve a device command execution.

enapter3 device command list --device-id="" --execution-id="" [--expand=""] [--api-allow-insecure] [--api-url=""] [--verbose]
--device-id, -dstringrequired#

Device ID.

--execution-id=stringrequired#

Execution ID.

--expand=string#

Comma-separated list of expanded options. Supported values: log.

--api-allow-insecure#

Allows insecure connections to the Enapter API.

--api-url=string#

Overrides API base URL (default: "https://api.enapter.com").

--verbose#

Logs extra details about the operation.

Telemetry CloudGateway​

Show device telemetry.

enapter3 device telemetry --device-id="" [--follow] [--api-allow-insecure] [--api-url=""] [--verbose]
--device-id, -dstringrequired#

Device ID.

--follow, -f#

Follow the telemetry output.

--api-allow-insecure#

Allows insecure connections to the Enapter API.

--api-url=string#

Overrides API base URL (default: "https://api.enapter.com").

--verbose#

Logs extra details about the operation.

Generate Communication Configuration CloudGateway​

Generate a new communication config for device.

enapter3 device communication-config generate --device-id="" --protocol="" [--api-allow-insecure] [--api-url=""] [--verbose]
--device-id, -dstringrequired#

Device ID.

--protocolrequired#

Connection protocol. Supported values:

  • MQTT
  • MQTTS
--api-allow-insecure#

Allows insecure connections to the Enapter API.

--api-url=string#

Overrides API base URL (default: "https://api.enapter.com").

--verbose#

Logs extra details about the operation.

All Rights Reserved © 2026 Enapter AG.

Privacy Policy|Cookies Policy