curl --request GET \
--url https://api.beta.ontoto.com/devices/{sn} \
--header 'x-api-key: <api-key>'{
"items": [
{
"deviceKind": "physical",
"serialNumber": "2CF44434E908",
"alias": "North mine piezometer",
"description": "Vibrating wire settlement gauge",
"name": "NW-PZ-01",
"orgUuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"legacyDeviceId": 10042,
"site": {
"uuid": "31d09506-82da-4f9d-960f-a871bae63258",
"name": "River Dam"
},
"location": {
"lat": -42.8814,
"lon": 147.3258
},
"samplingPeriodSeconds": 300,
"txPeriodSeconds": 3600,
"state": "active",
"health": {
"battery": {
"voltage": 3.72,
"percentage": 87,
"remaining": "~14 days at current sampling rate",
"isCharging": false
},
"connection": {
"lastSeen": "2024-06-15T08:42:11.000Z",
"status": "online",
"signalStrength": {
"rssi": -71,
"rsrp": -95,
"rsrq": -12,
"signalQuality": "good"
},
"error": null,
"txSuccessRate": 98.5,
"txProtocol": "coap",
"nextTxTimestamp": "2024-06-15T09:42:11.000Z"
},
"sensors": {
"status": "ok",
"metadataError": null,
"errors": null,
"lastDataTimestamp": "2024-06-15T08:41:03.000Z"
},
"powerSource": "battery"
},
"lastTxTimestamp": "2024-06-15T08:42:11.000Z",
"product": "Greyhound",
"hardware": {
"model": "GH5",
"revision": "1.2"
},
"modems": [
{
"type": "lte",
"model": "EG800Q",
"imei": "861234056789012",
"iccid": "89014103211118510720",
"uuid": "a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6"
}
],
"firmware": {
"string": "GH5_REV1.2_VW_1_ff",
"version": "2.4.1"
},
"tags": [
{
"id": 12,
"name": "Dam monitoring",
"colour": "#1E88E5"
}
],
"queuedCommand": null,
"gnss": null,
"_internal": {
"peripheralId": 18,
"metadata": null,
"config": null,
"boardId": 401
},
"sharedBy": null,
"sensors": [
{
"uuid": "b2c3d4e5-f6a7-48b9-c0d1-e2f3a4b5c6d7",
"model": "VW-GENERIC",
"type": "vibrating_wire",
"physicalSensor": null,
"connectionType": "integrated",
"name": "VibratingWire_CH1",
"alias": "VW channel 1",
"deviceSerialNumber": "2CF44434E908",
"parameters": [
{
"sourceType": "raw",
"deviceSerialNumber": "2CF44434E908",
"sensorUuid": "b2c3d4e5-f6a7-48b9-c0d1-e2f3a4b5c6d7",
"alias": "Frequency",
"name": "Frequency_CH1",
"parameterType": "frequency",
"baseUnit": "Hz",
"displayUnit": "Hz",
"displayPrecision": 2,
"suppressFaults": false,
"configErrorMessage": null,
"readIndex": 0,
"deviceAlarmSupported": true,
"uuid": "c3d4e5f6-a7b8-49c0-d1e2-f3a4b5c6d7e8",
"createdAt": "2024-01-10T00:00:00.000Z",
"updatedAt": "2024-06-01T12:00:00.000Z",
"parameterPath": {
"deviceSerialNumber": "2CF44434E908",
"sensorName": "VibratingWire_CH1",
"parameterName": "Frequency_CH1"
},
"status": "ok",
"lastFaultSummary": null,
"lastFaultTimestamp": null
}
],
"attributes": null,
"channelIndex": 0,
"isActive": true,
"lastActivatedAt": "2024-01-01T00:00:00.000Z",
"lastDeactivatedAt": null,
"enabled": true
}
]
}
]
}Returns full detail for a single device, including sensors and current configuration.
curl --request GET \
--url https://api.beta.ontoto.com/devices/{sn} \
--header 'x-api-key: <api-key>'{
"items": [
{
"deviceKind": "physical",
"serialNumber": "2CF44434E908",
"alias": "North mine piezometer",
"description": "Vibrating wire settlement gauge",
"name": "NW-PZ-01",
"orgUuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"legacyDeviceId": 10042,
"site": {
"uuid": "31d09506-82da-4f9d-960f-a871bae63258",
"name": "River Dam"
},
"location": {
"lat": -42.8814,
"lon": 147.3258
},
"samplingPeriodSeconds": 300,
"txPeriodSeconds": 3600,
"state": "active",
"health": {
"battery": {
"voltage": 3.72,
"percentage": 87,
"remaining": "~14 days at current sampling rate",
"isCharging": false
},
"connection": {
"lastSeen": "2024-06-15T08:42:11.000Z",
"status": "online",
"signalStrength": {
"rssi": -71,
"rsrp": -95,
"rsrq": -12,
"signalQuality": "good"
},
"error": null,
"txSuccessRate": 98.5,
"txProtocol": "coap",
"nextTxTimestamp": "2024-06-15T09:42:11.000Z"
},
"sensors": {
"status": "ok",
"metadataError": null,
"errors": null,
"lastDataTimestamp": "2024-06-15T08:41:03.000Z"
},
"powerSource": "battery"
},
"lastTxTimestamp": "2024-06-15T08:42:11.000Z",
"product": "Greyhound",
"hardware": {
"model": "GH5",
"revision": "1.2"
},
"modems": [
{
"type": "lte",
"model": "EG800Q",
"imei": "861234056789012",
"iccid": "89014103211118510720",
"uuid": "a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6"
}
],
"firmware": {
"string": "GH5_REV1.2_VW_1_ff",
"version": "2.4.1"
},
"tags": [
{
"id": 12,
"name": "Dam monitoring",
"colour": "#1E88E5"
}
],
"queuedCommand": null,
"gnss": null,
"_internal": {
"peripheralId": 18,
"metadata": null,
"config": null,
"boardId": 401
},
"sharedBy": null,
"sensors": [
{
"uuid": "b2c3d4e5-f6a7-48b9-c0d1-e2f3a4b5c6d7",
"model": "VW-GENERIC",
"type": "vibrating_wire",
"physicalSensor": null,
"connectionType": "integrated",
"name": "VibratingWire_CH1",
"alias": "VW channel 1",
"deviceSerialNumber": "2CF44434E908",
"parameters": [
{
"sourceType": "raw",
"deviceSerialNumber": "2CF44434E908",
"sensorUuid": "b2c3d4e5-f6a7-48b9-c0d1-e2f3a4b5c6d7",
"alias": "Frequency",
"name": "Frequency_CH1",
"parameterType": "frequency",
"baseUnit": "Hz",
"displayUnit": "Hz",
"displayPrecision": 2,
"suppressFaults": false,
"configErrorMessage": null,
"readIndex": 0,
"deviceAlarmSupported": true,
"uuid": "c3d4e5f6-a7b8-49c0-d1e2-f3a4b5c6d7e8",
"createdAt": "2024-01-10T00:00:00.000Z",
"updatedAt": "2024-06-01T12:00:00.000Z",
"parameterPath": {
"deviceSerialNumber": "2CF44434E908",
"sensorName": "VibratingWire_CH1",
"parameterName": "Frequency_CH1"
},
"status": "ok",
"lastFaultSummary": null,
"lastFaultTimestamp": null
}
],
"attributes": null,
"channelIndex": 0,
"isActive": true,
"lastActivatedAt": "2024-01-01T00:00:00.000Z",
"lastDeactivatedAt": null,
"enabled": true
}
]
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.beta.ontoto.com/llms.txt
Use this file to discover all available pages before exploring further.
Successful response
Response body for querying devices. Schema-level example reflects list defaults (no sensors); GET /devices/:sn documents a fuller example which includes sensors.
List of devices. Each element is a DeviceItem (see components.schemas.DeviceItem in the OpenAPI document).
Show child attributes