Device Logs

This part of Device API describes how to get device logs.

Get Logs CloudGateway

GET /v3/devices/{device_id}/logs

Returns last 50 device logs. It is posible filter and paginate logs via query parameters.

Request

$ curl http://api.enapter.com/v3/devices/fecbbba0-79f2-4e9e-a6f0-69a310ab110b/logs

$ curl http://api.enapter.com/v3/devices/fecbbba0-79f2-4e9e-a6f0-69a310ab110b/logs?retention=PERSISTENT&limit=10

Query Parameters

retentionstringdefault: ALL

Type of logs to retrieve:

• ALL — all logs
• PERSISTENT — logs were sent from Lua script with persist=true
• EPHEMERAL — logs were sent from Lua script with persist=false

orderstringdefault: RECEIVED_AT_ASC

Logs ordering:

• RECEIVED_AT_ASC — ascending (from oldest to most recent)
• RECEIVED_AT_DESC — descending (from most recent to oldest)

Logs ordered by received_at time. It's not time on device, which send logs. It's a time whe logs was received by MQTT-broker.

limitstringdefault: 50

Maximum number of logs to retrieve. Cannot be more than 50.

offsetstringdefault: 0

Number of logs to skip on retrieve.

received_at.gtestring

Don't retrieve logs older than provided date. Date should be in RFC 3339 format 2006-01-02T15:04:05Z07:00.

received_at.ltstring

Don't retrieve logs newer than provided date. Date should be in RFC 3339 format 2006-01-02T15:04:05Z07:00.

severitystring

Retrieve logs with provided severity only.

Stream Logs CloudGateway

WebSocket /devices/{device_id}/logs

Subscribe to device logs.

Request

All type of logs

$ websocat wss://api.enapter.com/v3/devices/fecbbba0-79f2-4e9e-a6f0-69a310ab110b/logs

Persisted only logs

$ websocat wss://api.enapter.com/v3/devices/fecbbba0-79f2-4e9e-a6f0-69a310ab110b/logs?retention=PERSISTENT

Query Parameters

retentionstringdefault: ALL

Type of logs to retrieve:

• ALL — all logs
• PERSISTENT — logs were sent from Lua script with persist=true
• EPHEMERAL — logs were sent from Lua script with persist=false

severitystring

Retrieve logs with provided severity only.