{"info":{"_postman_id":"45924e2f-b898-4f77-8f3b-9895fdd31fd8","name":"Senquip Cloud API Documentation","description":"

Welcome to the Senquip Cloud API Docs!

The Senquip Cloud API allows you to seamlessly integrate with the Senquip platform, providing real-time access to asset data and to streamline the management of multiple devices from a central platform. Whether you need to track performance, manage diagnostics, or leverage advanced analytics, this RESTful API offers a straightforward way to interact with our cloud services.

Key features include:

Real-Time Data: Get up-to-date information on asset status and location.
\n
Device Management: Modify device settings, network configurations, and other parameters directly via the API.
\n
Provisioning: Add new devices to your account or perform bulk updates.
\n

For our other documentation see the Senquip Docs page.

To contact support, please use our contact form.

Authentication

To generate API credentials you must first sign up for an account on the Senquip Portal.
\n
Under Account settings, navigate to the API Access tab. Credentials can be generated using the Generate API Credentials button.
\n
Copy the API Key value. This is your access token, keep it safe!
\n
The Senquip Cloud API uses the API Key authorization type for authentication. The header X-API-Key must contain your unqiue access token for every request.
\n
API limits apply - see the Rates and Usage Limits section below.
\n

Important Notes

To start using the Senquip Cloud API, keep in mind:

Every request must contain a valid API Key header (see Authentication above).
\n
The API has rate and usage limits (see Rate and usage limits below).
\n
The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.
\n
The API responds in JSON format. When an API request returns an error, it is sent in the JSON response under the message key.
\n
API authorisation requests are cached by the server for 60 seconds (per API key).
\n

Most endpoints that deal with a specific device require that the Device ID is provided. This is a unique identifier for the device and consists of 9 letters and numbers. For example: JDA54E19F

The Device ID can be found printed under the lid or on the outside of the packaging box.

Getting Started

The easiest way to start using the Senquip Cloud APIs is by clicking the Run in Postman button above. Postman is a free tool that helps developers run and debug API requests.

From Postman, find the Variables tab and change the current value of the token variable with your actual API Key.

Go to an API function (for example General List All Devices) and press Send!

Errors and Response codes

Here are our standard response and error codes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

RESPONSE CODE	DESCRIPTION
`200` - OK	Everything worked as expected!
`202` - Accepted	Your request is accepted and is now queued.
`400` - Bad Request	The request was invalid or cannot be otherwise served.
`401` - Unauthorized	There is some error during validation. You need to check your token or credentials. The API key could be missing or malformed from the request.
`403` - Forbidden	The API key is incorrect, or you do not have access to make this request.
`404` - Not Found	The URI requested is invalid or the resource requested does not exist.
`405` - Method Not Allowed	The API was accessed using the wrong method. Check your HTTP method.
`422` - Unprocessable Entity	It means the request contains incorrect syntax or cannot be fulfilled. Try checking your code for errors.
`429` - Too Many Requests	You have exceeded the API call rate limit.
`500`, `502`, `504` - Server Errors	Some server error has occurred. Some APIs may show this due to syntax or parameter errors. Try contacting support if this persists.
`503` - Service Unavailable	Unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists contact support.

Rate and Usage Limits

Overall API rate limits are based on how many devices in your account are on a Hosted plan.

Account Limits per Hosted device:

Rate limit: 1 request per second
\n
Daily quota: 1000 requests per day
\n

These limits scale with the number of Hosted devices in your account. See example below.

If you have no Hosted devices, a minimum default limit applies to your account:

1 request per second
\n
1000 requests per day
\n

Your rate and quota limits are automatically recalculated every 12 hours based on the current number of Hosted devices.

If you exceed your limit, the API will return HTTP 429 - Too Many Requests

API Access for Devices Without a Hosted Plan

Devices without a Hosted plan can still be accessed via API, but there is an addtional limit:

50 requests per non-Hosted device per calendar month

When this monthly limit applies, responses will include an apiRequestsRemaining value.

This limit is intended to allow occasional configuration changes. If you need higher usage, you should upgrade the device to a Hosted plan.

The only exception to the 50 request/month limit is for requesting measurement data from a device using the Get Device Data endpoint. For this endpoint the device must either have a Trial or Hosted Plan.

Hosted plans can be purchased from the Subscriptions button on the home page of the Senquip Portal.

API Limit Example

If your account has 15 devices and 9 of them are on a Hosted plan, your total API limit is:

9 requests per second
\n
9000 requests per day
\n
The 6 devices without a Hosted plan will accept 50 requests per month each.
\n

To contact support or report a bug, please use our contact form.

Example: Add / Register a new device

Adding or registering a new device to the Senquip Portal for the first time is the same as the 'Add a User to a Device' process:

For a new device, no passwords are required to add the unit. Only the 9 digit Device ID is required.
\n
Use the 'Add a User to a Device' endpoint. No body parameters are required, however it is recommended to specify the groupid or groupName as a minimum.
\n
If successful the device will be added/registered to your Portal account and you can now use other API endpoints or the Senquip Portal to interact with it. If you receive the response 'Password Required', then the device has already been added to an account and you will need to provide the setupPassword body parameter in your request.
\n

Example: Client certificates for MQTT

To load unique client certificates on to a device:

Load each required certificate file using the 'Load File onto Device' endpoint. This step may require up to three seperate calls to load the files: 'mqtt_client.key', 'mqtt_client.crt' and 'mqtt_ca.pem'.
\n
Update the config on the device to use the certificates using the 'Update Device Config' endpoint. An example request body:
\n

{\n  \"config\": {\n    \"endpoint\": {\n      \"mqtt\": {\n        \"enable\": true,\n        \"server\": \"mqtt.broker.address:8883\",\n        \"client_id\": \"SETYOURID\",\n        \"ssl_cert\": \"mqtt_client.crt\",\n        \"ssl_key\": \"mqtt_client.key\",\n        \"ssl_ca_cert\": \"ca.pem\"\n      }\n    }\n  }\n}\n\n

In this example config the Internal Trust Store is used for the CA certificate instead of mqtt_ca.pem. The Internal Trust Store on the device contains a small set of AWS and Azure certificates and always has the filename 'ca.pem'.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Important Notes","slug":"important-notes"},{"content":"Getting Started","slug":"getting-started"},{"content":"Errors and Response codes","slug":"errors-and-response-codes"},{"content":"Rate and Usage Limits","slug":"rate-and-usage-limits"},{"content":"Example: Add / Register a new device","slug":"example-add-register-a-new-device"},{"content":"Example: Client certificates for MQTT","slug":"example-client-certificates-for-mqtt"}],"owner":"33042968","collectionId":"45924e2f-b898-4f77-8f3b-9895fdd31fd8","publishedId":"2sAXxWYoWa","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00afc9"},"publishDate":"2024-10-18T08:53:04.000Z"},"item":[{"name":"General","item":[{"name":"List All Devices","event":[{"listen":"test","script":{"id":"43d76cf0-0c41-41de-85ea-4cf7dedbf0d3","exec":[""],"type":"text/javascript","packages":{}}}],"id":"a73a5861-1163-4a71-b857-e5d6e76f1985","protocolProfileBehavior":{"followRedirects":true,"disabledSystemHeaders":{"connection":true}},"request":{"method":"GET","header":[],"url":"https://api.senquip.com/cloud-api-v2/devices","description":"

Gets a list of the devices associated with your account.

Note: the response may be cached by the server for up to 60 seconds.

This endpoint allows you to add a new user to a device. The device is identified by the deviceid in the path.

This endpoint is available for all devices, regardless of the device's Hosted plan status.

The request body contains all request parameters as valid JSON. If no parameters are required then the body can be left empty.

Body Parameters

setupPassword (string): Optional. The Setup Password for the device.
\n
targetPermission (string): Optional. Desired permission, must be: ADMIN, USER, OPERATOR or VIEW. If omitted defaults to ADMIN.
\n
targetEmail (string): Optional. Add a user with this email address to the device.
\n
groupid (string): Optional. Add the device to this group
\n
groupName (string): Optional. Add the device to this group.
\n

Note: If provided groupId takes precedence over groupName. If both are omitted, the device is added to the \"Ungrouped\" group by default.

There are two use cases:

Add the device to your account. The targetEmail parameter should be omitted.
\n
1. If this device allows adding users without a password, the setupPassword can be omitted.
  \n
2. If a password is required, a correct password should be provided in the setupPassword parameter.
  \n
\n
Add another user with a given email address to the device. The targetEmail parameter should be provided and the setupPassword parameter is not used.
\n

WARNING: You have limited attempts to add a device using the setup password. After 3 incorrect attempts, you must wait 10 minutes before trying again. Ongoing incorrect attempts will result in an automatic account suspension.

Response

result (string): A short code indicating the outcome of the request.
\n
message (string): Informational status message.
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"API_KEY"}]},"isInherited":true,"source":{"_postman_id":"45924e2f-b898-4f77-8f3b-9895fdd31fd8","id":"45924e2f-b898-4f77-8f3b-9895fdd31fd8","name":"Senquip Cloud API Documentation","type":"collection"}},"urlObject":{"path":["device","DEVICEID","user"],"host":["https://api.senquip.com/cloud-api-v2"],"query":[],"variable":[]}},"response":[{"id":"3b4da25b-8358-4590-adc2-e2558de119e5","name":"Device added successfully","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"setupPassword\": \"TESTPASSWORD\"}","options":{"raw":{"language":"json"}}},"url":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/user"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"68"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 29 Oct 2024 23:04:32 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-672169fe-6e372306188e0eff68692e84;Parent=09c09c08172d2d01;Sampled=0;Lineage=2:a8d42495:0"},{"key":"x-amzn-RequestId","value":"d25d2deb-a389-4c5d-9630-7976ee49219e"},{"key":"x-amz-apigw-id","value":"Ab1_0Gi6SwMEexQ="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 13ad48adfe7f5ca5b82509779525e518.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD1-C1"},{"key":"X-Amz-Cf-Id","value":"0EoiGKoSCDVNsWY1DktnDVVlBupy6khkteYqz8S0oMSCx9TMz48j2g=="}],"cookie":[],"responseTime":null,"body":"{\n \"resultCode\": \"DEVICE_ADDED\",\n \"message\": \"Device successfully added.\"\n}"},{"id":"a550d023-dffa-412b-8876-3f164e8e996a","name":"Device already added","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"setupPassword\": \"TESTPASSWORD\"}","options":{"raw":{"language":"json"}}},"url":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/user"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"71"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 30 Oct 2024 02:00:47 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6721934d-512484d77162a8e369af599a;Parent=22d43cd9f5dbfee6;Sampled=0;Lineage=2:a8d42495:0"},{"key":"x-amzn-RequestId","value":"8bf2e110-3dcb-44cd-980d-81d08ffcf17c"},{"key":"x-amz-apigw-id","value":"AcP0OEKZSwMELsw="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 2d39749f0342007f9798eeb0800f8a0e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD1-C1"},{"key":"X-Amz-Cf-Id","value":"J09qdfzL-WAOKM4v-gOWs_nTXoR2sGEj5zN7tGb_gOxjAH2iiEAyQQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"resultCode\": \"DEVICE_ALREADY_ADDED\",\n \"message\": \"Device already added.\"\n}"},{"id":"d5729ba3-7898-459f-9f18-b6965c4a56bd","name":"Password is incorrect","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"setupPassword\": \"WRONGPASS\"}","options":{"raw":{"language":"json"}}},"url":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/user"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"70"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 30 Oct 2024 02:09:24 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-67219552-43413b8e540ac615399551fb;Parent=6840590aaa09a4e0;Sampled=0;Lineage=2:a8d42495:0"},{"key":"x-amzn-RequestId","value":"328a31e8-b80e-4e4c-b233-633197bad026"},{"key":"x-amz-apigw-id","value":"AcRE5FpGSwMEK-Q="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 53c1b15bee05a74bbf23a945358028ec.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD1-C1"},{"key":"X-Amz-Cf-Id","value":"DGuRO3oZIdeKXXz7UHu11Af5A8D5MDWUSHncewQYUe7k8XzrLT8p2A=="}],"cookie":[],"responseTime":null,"body":"{\n \"resultCode\": \"INCORRECT_PASSWORD\",\n \"message\": \"Password is incorrect.\"\n}"},{"id":"7300c1b3-c16f-41a7-8e6c-71fec0c80513","name":"Password required","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/user"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 30 Oct 2024 02:23:14 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-67219890-551d234e75ae672c31171c05;Parent=2c54e63429b03ef3;Sampled=0;Lineage=2:a8d42495:0"},{"key":"x-amzn-RequestId","value":"635bf26d-d119-455d-92dc-97f6a81733a1"},{"key":"x-amz-apigw-id","value":"AcTGqHdOywMEAkw="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 9910b161083ec8200ad24e6d6beec168.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD1-C1"},{"key":"X-Amz-Cf-Id","value":"eXtHlbXvqmhZ7Kh5_5fOdJbEbOanYLUr76fqwcqWS8kIIfAgIdsbeA=="}],"cookie":[],"responseTime":null,"body":"{\n \"resultCode\": \"PASSWORD_REQUIRED\",\n \"message\": \"Password required.\"\n}"},{"id":"dd7a604e-aa02-4b2f-ad76-1a35759de6da","name":"Password attempts exceeded","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"setupPassword\": \"WRONGPASS\"}","options":{"raw":{"language":"json"}}},"url":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/user"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"89"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 30 Oct 2024 02:30:56 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-67219a5e-7b4024477629463030f0e6bf;Parent=41940ce3467733d9;Sampled=0;Lineage=1:a8d42495:0"},{"key":"x-amzn-RequestId","value":"1b3aff3d-407c-4cff-8f1c-00320dd9c351"},{"key":"x-amz-apigw-id","value":"AcUOzEe1SwMETsQ="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 d0c0855de58a470001e3701ff4871f82.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD1-C1"},{"key":"X-Amz-Cf-Id","value":"xD7RdueUs8N9fdu0EkqXigfEu3Wk-kCVnPN9EGoLfFx7RDmKy9oOuA=="}],"cookie":[],"responseTime":null,"body":"{\n \"resultCode\": \"ATTEMPTS_EXCEEDED\",\n \"message\": \"Attempts exceeded. Please wait 10 minutes.\"\n}"}],"_postman_id":"f0391572-e135-4da3-bb73-b72692a0efff"}],"id":"50c82030-e837-470c-8505-a3be4ff695f3","description":"

These are general endpoints to manage and access parts of your account.

\n","_postman_id":"50c82030-e837-470c-8505-a3be4ff695f3","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"API_KEY"}]},"isInherited":true,"source":{"_postman_id":"45924e2f-b898-4f77-8f3b-9895fdd31fd8","id":"45924e2f-b898-4f77-8f3b-9895fdd31fd8","name":"Senquip Cloud API Documentation","type":"collection"}}},{"name":"Data","item":[{"name":"Get Device Data","event":[{"listen":"test","script":{"id":"43d76cf0-0c41-41de-85ea-4cf7dedbf0d3","exec":[""],"type":"text/javascript","packages":{}}}],"id":"8dae6997-e88d-471e-b1aa-45e76c938a5e","protocolProfileBehavior":{"disabledSystemHeaders":{"connection":true}},"request":{"method":"GET","header":[],"url":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/data","description":"

Retrieves data for a given device. The time range of the data can be customised as required.

If no query parameters are provided, it returns the latest data point.

Specific data keys can be requested using the dataKeys parameter and repeating it for each new data key (see Specific data keys example).

There is an (soft) internal limit of how much data can be returned per request. If a non-null value for lastEvaluatedTime is returned, then there is more data available for the given parameters. The lastEvaluatedTime can be passed into a new query as the pageStartTime to continue the paginated request (keep other params the same).

This request can take up to 20 seconds when retrieving data over a large time range. Set your request timeout accordingly!

Response

data (array): An array of data points collected from the device.
\n
lastEvaluatedTime (number | null): A timestamp (Unix timestamps in seconds) used for pagination. If present, it should be provided in the next request to retrieve the next page of results. If null, there is no more data to paginate.
\n
deviceid (string): The id of the device the data belongs to.
\n
dataCount (integer): The number of data points returned.
\n
message (string): Informational status message.
\n

(string, optional) Relative time period from now. Possible options:\n1m = One minute,\n3d = Three days,\n5w = Five weeks,\n2M = Two months.\nNote: relative cannot be used with fromTime or toTime.

\n","type":"text/plain"},"key":"relative","value":""},{"disabled":true,"description":{"content":"

(integer, optional, default: 1) Maximum number of data points to return.

\n","type":"text/plain"},"key":"dataPoints","value":""},{"disabled":true,"description":{"content":"

(number, optional) Timestamp to start from (Unix timestamps in seconds).

\n","type":"text/plain"},"key":"fromTime","value":""},{"disabled":true,"description":{"content":"

(number, optional) Timestamp to end at (Unix timestamps in seconds).

\n","type":"text/plain"},"key":"toTime","value":""},{"disabled":true,"description":{"content":"

(number, optional) Starting timestamp for paginated queries.

\n","type":"text/plain"},"key":"pageStartTime","value":""},{"disabled":true,"description":{"content":"

(string, optional) A data key to return. This param can be repeated for each key.

\n","type":"text/plain"},"key":"dataKeys","value":""}],"variable":[]}},"response":[{"id":"1ff8cf87-2dd7-4ec1-b40a-10e2ce28e275","name":"Get the latest data point","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/data","host":["https://api.senquip.com/cloud-api-v2"],"path":["device","DEVICEID","data"],"query":[{"key":"relative","value":"1M","description":"Relative time period from now. Possible options:\n1m = One minute\n3d = Three days\n5w = Five weeks\n2M = Two months","disabled":true},{"key":"dataPoints","value":"6","description":"Maximum number of data points to return.","disabled":true},{"key":"fromTime","value":"1728857423","description":"Timestamp to start from (Unix timestamps in seconds).","disabled":true},{"key":"toTime","value":"1728857303","description":"Timestamp to end at (Unix timestamps in seconds).","disabled":true},{"key":"pageStartTime","value":"1726613627.5","description":"Starting timestamp for paginated queries.","type":"text","disabled":true},{"key":"dataKeys","value":"vin","description":"A data key to return. This param can be repeated for each key.","disabled":true},{"key":"dataKeys","value":"ambient","description":"A data key to return. This param can be repeated for each key.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"402"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 18 Oct 2024 01:49:28 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6711bea8-711a95234bf7069524fd6244;Parent=0a94e0087761dfea;Sampled=0;Lineage=2:1b85cbe5:0"},{"key":"x-amzn-RequestId","value":"bc0b9d6a-e4bb-427a-9db7-f32c5fa7de31"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"f0q6WHixywMEBfw="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 212ddd6c8eb82cf3007eedad5f05dca8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD62-P1"},{"key":"X-Amz-Cf-Id","value":"pjcOeikwnGYfJg1avvXlu8hxnhK5IzaDsQ1VNTl-fLHbi1F78Jjqkg=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"ts\": 1729462721.7,\n \"ambient\": 24.65,\n \"cp3\": \"MCswKzAuMDAwKzArMCswLjEzKzE3Ny40KzAuMTYrMTkuNisxLjU5KzEwMS45MiswLjcwNCsyMC4wLTU3LjAtODUuMCswLTAuMTMrMC4wMQ0K\",\n \"cp5\": 0,\n \"cp7\": 0,\n \"cp6\": 0,\n \"ttl\": 1792534721,\n \"cp9\": 0.13,\n \"cp8\": 0,\n \"current4\": 0.15,\n \"state\": 0,\n \"cp20\": 0.01,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.06,\n \"vsys\": 4.16,\n \"cycle\": 3591,\n \"cp17\": -57,\n \"cp18\": -85,\n \"cp19\": -0.13,\n \"aws_ts\": 1729462721,\n \"cp13\": 1.59,\n \"wifi_rssi\": -40,\n \"light\": 1,\n \"cp14\": 101.92,\n \"cp15\": 70.4,\n \"cp16\": 20,\n \"cp10\": 177.4,\n \"cp11\": 0.16,\n \"cp12\": 19.6,\n \"vin\": 12.09,\n \"analog4\": 5.159\n }\n ],\n \"lastEvaluatedTime\": null,\n \"deviceid\": \"ZSBDH91FF\",\n \"dataCount\": 1,\n \"message\": \"OK\"\n}"},{"id":"7b220925-8950-49be-b47a-d1a06b2f33a2","name":"Last 10 data points","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/data?dataPoints=10","host":["https://api.senquip.com/cloud-api-v2"],"path":["device","DEVICEID","data"],"query":[{"key":"relative","value":"10m","description":"Relative time period from now. Possible options:\n1m = One minute,\n3d = Three days,\n5w = Five weeks,\n2M = Two months.\nIf this parameter is present, it overrides the fromTime and toTime.","disabled":true},{"key":"dataPoints","value":"10","description":"Maximum number of data points to return."},{"key":"fromTime","value":"0","description":"Timestamp to start from (Unix timestamps in seconds).","disabled":true},{"key":"toTime","value":"1725336340","description":"Timestamp to end at (Unix timestamps in seconds).","disabled":true},{"key":"pageStartTime","value":"","description":"Starting timestamp for paginated queries.","type":"text","disabled":true},{"key":"dataKeys","value":"vin","description":"A data key to return. This param can be repeated for each key.","disabled":true},{"key":"dataKeys","value":"ambient","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1114"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 20 Oct 2024 22:18:30 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-671581b5-2879b46f4bf013386be4957a;Parent=47f1db988a1b1301;Sampled=0;Lineage=1:1b85cbe5:0"},{"key":"x-amzn-RequestId","value":"e0c474c7-4a5e-46f6-b737-96049fff78bf"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"f-E0eGOOSwMEGiA="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 fd8b250e4ee7cd8e5de453d78708baee.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD3-P1"},{"key":"X-Amz-Cf-Id","value":"BAwUcE-aZi4B8l07sSEHPrBU9F1SOeZ5wc1k6wD8DIZGIZ6Y5mF0Vw=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"ts\": 1729462661.7,\n \"ambient\": 24.62,\n \"cp3\": \"MCswKzAuMDAwKzArMCswLjExKzE4My4xKzAuMTgrMTkuNysxLjU5KzEwMS45MiswLjY5MisyMC4wLTYwLjEtODUuNSswLTAuMTEtMC4wMQ0K\",\n \"cp5\": 0,\n \"cp7\": 0,\n \"cp6\": 0,\n \"ttl\": 1792534661,\n \"cp9\": 0.11,\n \"cp8\": 0,\n \"current4\": 0.188,\n \"state\": 0,\n \"cp20\": -0.01,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.08,\n \"vsys\": 4.17,\n \"cycle\": 3590,\n \"cp17\": -60.1,\n \"cp18\": -85.5,\n \"cp19\": -0.11,\n \"aws_ts\": 1729462661,\n \"cp13\": 1.59,\n \"wifi_rssi\": -40,\n \"light\": 1,\n \"cp14\": 101.92,\n \"cp15\": 69.2,\n \"cp16\": 20,\n \"cp10\": 183.1,\n \"cp11\": 0.18,\n \"cp12\": 19.7,\n \"vin\": 12.09,\n \"analog4\": 5.156\n },\n {\n \"ts\": 1729462601.7,\n \"ambient\": 24.6,\n \"cp3\": \"MCswKzAuMDAwKzArMCswLjEzKzE4MC40KzAuMTUrMTkuNysxLjU5KzEwMS45MiswLjY4NSsyMC4wLTU4LjQtODUuMiswLTAuMTMtMC4wMA0K\",\n \"cp5\": 0,\n \"cp7\": 0,\n \"cp6\": 0,\n \"ttl\": 1792534601,\n \"cp9\": 0.13,\n \"cp8\": 0,\n \"current4\": 0.15,\n \"state\": 0,\n \"cp20\": 0,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.14,\n \"vsys\": 4.16,\n \"cycle\": 3589,\n \"cp17\": -58.4,\n \"cp18\": -85.2,\n \"cp19\": -0.13,\n \"aws_ts\": 1729462601,\n \"cp13\": 1.59,\n \"wifi_rssi\": -40,\n \"light\": 1,\n \"cp14\": 101.92,\n \"cp15\": 68.5,\n \"cp16\": 20,\n \"cp10\": 180.4,\n \"cp11\": 0.15,\n \"cp12\": 19.7,\n \"vin\": 12.09,\n \"analog4\": 5.159\n },\n {\n \"ts\": 1729462541.7,\n \"ambient\": 24.6,\n \"cp3\": \"MCswKzAuMDAwKzArMCswLjEzKzE4MC4xKzAuMTcrMTkuNysxLjU3KzEwMS45MiswLjY4NisxOS45LTU3LjQtODQuOSswLTAuMTMtMC4wMA0K\",\n \"cp5\": 0,\n \"cp7\": 0,\n \"cp6\": 0,\n \"ttl\": 1792534541,\n \"cp9\": 0.13,\n \"cp8\": 0,\n \"current4\": 0.148,\n \"state\": 0,\n \"cp20\": 0,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.1,\n \"vsys\": 4.14,\n \"cycle\": 3588,\n \"cp17\": -57.4,\n \"cp18\": -84.9,\n \"cp19\": -0.13,\n \"aws_ts\": 1729462541,\n \"cp13\": 1.57,\n \"wifi_rssi\": -43,\n \"light\": 1,\n \"cp14\": 101.92,\n \"cp15\": 68.6,\n \"cp16\": 19.9,\n \"cp10\": 180.1,\n \"cp11\": 0.17,\n \"cp12\": 19.7,\n \"vin\": 12.09,\n \"analog4\": 5.159\n },\n {\n \"ts\": 1729462481.7,\n \"ambient\": 24.6,\n \"cp3\": \"MCswKzAuMDAwKzArMCswLjE0KzE3OS4zKzAuMTgrMTkuNysxLjU4KzEwMS45MSswLjY4NCsyMC4wLTU3LjItODUuMCswLTAuMTQrMC4wMA0K\",\n \"cp5\": 0,\n \"cp7\": 0,\n \"cp6\": 0,\n \"ttl\": 1792534481,\n \"cp9\": 0.14,\n \"cp8\": 0,\n \"current4\": 0.261,\n \"state\": 0,\n \"cp20\": 0,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.08,\n \"vsys\": 4.15,\n \"cycle\": 3587,\n \"cp17\": -57.2,\n \"cp18\": -85,\n \"cp19\": -0.14,\n \"aws_ts\": 1729462481,\n \"cp13\": 1.58,\n \"wifi_rssi\": -41,\n \"light\": 1,\n \"cp14\": 101.91,\n \"cp15\": 68.4,\n \"cp16\": 20,\n \"cp10\": 179.3,\n \"cp11\": 0.18,\n \"cp12\": 19.7,\n \"vin\": 12.12,\n \"analog4\": 5.172\n },\n {\n \"ts\": 1729462421.7,\n \"ambient\": 24.55,\n \"cp3\": \"MCswKzAuMDAwKzArMCswLjE0KzE3OC4wKzAuMTgrMTkuNysxLjU3KzEwMS45MSswLjY4MisxOS45LTU3LjEtODQuOSswLTAuMTQrMC4wMA0K\",\n \"cp5\": 0,\n \"cp7\": 0,\n \"cp6\": 0,\n \"ttl\": 1792534421,\n \"cp9\": 0.14,\n \"cp8\": 0,\n \"current4\": 0.18,\n \"state\": 0,\n \"cp20\": 0,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.14,\n \"vsys\": 4.16,\n \"cycle\": 3586,\n \"cp17\": -57.1,\n \"cp18\": -84.9,\n \"cp19\": -0.14,\n \"aws_ts\": 1729462421,\n \"cp13\": 1.57,\n \"wifi_rssi\": -44,\n \"light\": 1,\n \"cp14\": 101.91,\n \"cp15\": 68.2,\n \"cp16\": 19.9,\n \"cp10\": 178,\n \"cp11\": 0.18,\n \"cp12\": 19.7,\n \"vin\": 12.15,\n \"analog4\": 5.162\n },\n {\n \"ts\": 1729462361.7,\n \"ambient\": 24.55,\n \"cp3\": \"MCswKzAuMDAwKzArMCswLjEyKzE3My4yKzAuMTcrMTkuNisxLjU4KzEwMS45MSswLjY4OSsyMC4wLTU2LjktODQuOSswLTAuMTIrMC4wMQ0K\",\n \"cp5\": 0,\n \"cp7\": 0,\n \"cp6\": 0,\n \"ttl\": 1792534361,\n \"cp9\": 0.12,\n \"cp8\": 0,\n \"current4\": 0.228,\n \"state\": 0,\n \"cp20\": 0.01,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.1,\n \"vsys\": 4.16,\n \"cycle\": 3585,\n \"cp17\": -56.9,\n \"cp18\": -84.9,\n \"cp19\": -0.12,\n \"aws_ts\": 1729462361,\n \"cp13\": 1.58,\n \"wifi_rssi\": -44,\n \"light\": 1,\n \"cp14\": 101.91,\n \"cp15\": 68.9,\n \"cp16\": 20,\n \"cp10\": 173.2,\n \"cp11\": 0.17,\n \"cp12\": 19.6,\n \"vin\": 12.18,\n \"analog4\": 5.175\n },\n {\n \"ts\": 1729462301.7,\n \"ambient\": 24.55,\n \"cp3\": \"MCswKzAuMDAwKzArMCswLjE0KzE4Mi4wKzAuMTYrMTkuNysxLjU3KzEwMS45MSswLjY4OCsyMC4wLTU0LjItODQuNyswLTAuMTQtMC4wMA0K\",\n \"cp5\": 0,\n \"cp7\": 0,\n \"cp6\": 0,\n \"ttl\": 1792534301,\n \"cp9\": 0.14,\n \"cp8\": 0,\n \"current4\": 0.148,\n \"state\": 0,\n \"cp20\": 0,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.08,\n \"vsys\": 4.15,\n \"cycle\": 3584,\n \"cp17\": -54.2,\n \"cp18\": -84.7,\n \"cp19\": -0.14,\n \"aws_ts\": 1729462301,\n \"cp13\": 1.57,\n \"wifi_rssi\": -45,\n \"light\": 1,\n \"cp14\": 101.91,\n \"cp15\": 68.8,\n \"cp16\": 20,\n \"cp10\": 182,\n \"cp11\": 0.16,\n \"cp12\": 19.7,\n \"vin\": 12.18,\n \"analog4\": 5.153\n },\n {\n \"ts\": 1729462241.7,\n \"ambient\": 24.57,\n \"cp3\": \"MCswKzAuMDAwKzArMCswLjE0KzE4MS4yKzAuMTYrMTkuNisxLjU3KzEwMS45MSswLjY4MysxOS45LTU2LjktODUuMCswLTAuMTQtMC4wMA0K\",\n \"cp5\": 0,\n \"cp7\": 0,\n \"cp6\": 0,\n \"ttl\": 1792534241,\n \"cp9\": 0.14,\n \"cp8\": 0,\n \"current4\": 0.15,\n \"state\": 0,\n \"cp20\": 0,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.06,\n \"vsys\": 4.15,\n \"cycle\": 3583,\n \"cp17\": -56.9,\n \"cp18\": -85,\n \"cp19\": -0.14,\n \"aws_ts\": 1729462241,\n \"cp13\": 1.57,\n \"wifi_rssi\": -43,\n \"light\": 1,\n \"cp14\": 101.91,\n \"cp15\": 68.3,\n \"cp16\": 19.9,\n \"cp10\": 181.2,\n \"cp11\": 0.16,\n \"cp12\": 19.6,\n \"vin\": 12.12,\n \"analog4\": 5.172\n },\n {\n \"ts\": 1729462181.7,\n \"ambient\": 24.55,\n \"cp3\": \"MCswKzAuMDAwKzArMCswLjEzKzE3OS4wKzAuMTYrMTkuNisxLjU2KzEwMS45MSswLjY4OSsxOS45LTU4LjEtODUuMiswLTAuMTMrMC4wMA0K\",\n \"cp5\": 0,\n \"cp7\": 0,\n \"cp6\": 0,\n \"ttl\": 1792534181,\n \"cp9\": 0.13,\n \"cp8\": 0,\n \"current4\": 0.193,\n \"state\": 0,\n \"cp20\": 0,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.07,\n \"vsys\": 4.14,\n \"cycle\": 3582,\n \"cp17\": -58.1,\n \"cp18\": -85.2,\n \"cp19\": -0.13,\n \"aws_ts\": 1729462181,\n \"cp13\": 1.56,\n \"wifi_rssi\": -43,\n \"light\": 1,\n \"cp14\": 101.91,\n \"cp15\": 68.9,\n \"cp16\": 19.9,\n \"cp10\": 179,\n \"cp11\": 0.16,\n \"cp12\": 19.6,\n \"vin\": 12.12,\n \"analog4\": 5.169\n },\n {\n \"ts\": 1729462121.7,\n \"ambient\": 24.52,\n \"cp3\": \"MCswKzAuMDAwKzArMCswLjE1KzE4NC41KzAuMTkrMTkuNisxLjU3KzEwMS45MCswLjY5NCsxOS45LTU3LjYtODUuMCswLTAuMTUtMC4wMQ0K\",\n \"cp5\": 0,\n \"cp7\": 0,\n \"cp6\": 0,\n \"ttl\": 1792534121,\n \"cp9\": 0.15,\n \"cp8\": 0,\n \"current4\": 0.15,\n \"state\": 0,\n \"cp20\": -0.01,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.11,\n \"vsys\": 4.15,\n \"cycle\": 3581,\n \"cp17\": -57.6,\n \"cp18\": -85,\n \"cp19\": -0.15,\n \"aws_ts\": 1729462121,\n \"cp13\": 1.57,\n \"wifi_rssi\": -40,\n \"light\": 1,\n \"cp14\": 101.9,\n \"cp15\": 69.4,\n \"cp16\": 19.9,\n \"cp10\": 184.5,\n \"cp11\": 0.19,\n \"cp12\": 19.6,\n \"vin\": 12.09,\n \"analog4\": 5.144\n }\n ],\n \"lastEvaluatedTime\": null,\n \"deviceid\": \"ZSBDH91FF\",\n \"dataCount\": 10,\n \"message\": \"OK\"\n}"},{"id":"42f67388-b93d-4035-89f3-2ea60bb17508","name":"Specify a time range","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/data?fromTime=1724901311.8&toTime=1724901551.8","host":["https://api.senquip.com/cloud-api-v2"],"path":["device","DEVICEID","data"],"query":[{"key":"relative","value":"","description":"Relative time period from now. Possible options:\n1m = One minute,\n3d = Three days,\n5w = Five weeks,\n2M = Two months.\nIf this parameter is present, it overrides the fromTime and toTime.","disabled":true},{"key":"dataPoints","value":"","description":"Maximum number of data points to return.","disabled":true},{"key":"fromTime","value":"1724901311.8","description":"Timestamp to start from (Unix timestamps in seconds)."},{"key":"toTime","value":"1724901551.8","description":"Timestamp to end at (Unix timestamps in seconds)."},{"key":"pageStartTime","value":"","description":"Starting timestamp for paginated queries.","type":"text","disabled":true},{"key":"dataKeys","value":"","description":"A data key to return. This param can be repeated for each key.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1087"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 21 Oct 2024 01:03:40 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6715a86b-59f62b3a7b494dc46af7cfb8;Parent=6e7f252f2cb128c0;Sampled=0;Lineage=2:1b85cbe5:0"},{"key":"x-amzn-RequestId","value":"b7d3893a-8bdd-45a5-97fa-25c2d9809178"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"f-dA1GsLSwMEOOw="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 3e61a2014e7d26249915c64513c0b4f2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD3-P1"},{"key":"X-Amz-Cf-Id","value":"O-Hn29RFPMu7G0O4X9JiynfFDEAIdn0VBhfVazjH3-UJWhvwXwv6hg=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"ts\": 1724901311.8,\n \"cp1\": 1400.8,\n \"ambient\": 27.85,\n \"cp2\": 8166.4,\n \"cp7\": 215,\n \"ttl\": 1787973311,\n \"cp9\": 30,\n \"cp8\": 142,\n \"state\": 0,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.04,\n \"vsys\": 4.16,\n \"can1\": [\n {\n \"data\": \"019B9BC62B000E9B\",\n \"id\": 217056256\n },\n {\n \"data\": \"CD2E33FFF4E02BFF\",\n \"id\": 217055747\n },\n {\n \"data\": \"FF4347FFFFFFFFFF\",\n \"id\": 419362304\n },\n {\n \"data\": \"D07F1EFFFF0FCB7D\",\n \"id\": 217056000\n },\n {\n \"data\": \"D07E1EFFFF0FC77D\",\n \"id\": 418383107\n }\n ],\n \"cycle\": 96,\n \"cp17\": 19,\n \"cp18\": 21,\n \"aws_ts\": 1724901311,\n \"cp13\": 90.7,\n \"wifi_rssi\": -36,\n \"light\": 1,\n \"cp14\": 200,\n \"cp15\": 14,\n \"cp16\": 32.9,\n \"cp10\": 130,\n \"cp11\": 119.8,\n \"cp12\": 31.9,\n \"vin\": 12.31\n },\n {\n \"ts\": 1724901341.8,\n \"cp1\": 1289.4,\n \"ambient\": 27.88,\n \"cp2\": 1625.8,\n \"cp7\": 69,\n \"ttl\": 1787973341,\n \"cp9\": 98,\n \"cp8\": 510,\n \"state\": 0,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.11,\n \"vsys\": 4.16,\n \"can1\": [\n {\n \"data\": \"0EDFDC4B28000EDC\",\n \"id\": 217056256\n },\n {\n \"data\": \"7ECDCE32FC7DFF67\",\n \"id\": 217055747\n },\n {\n \"data\": \"FFFFFF6D28FCCCFF\",\n \"id\": 419362304\n },\n {\n \"data\": \"D4FA62FFFF4FEF7D\",\n \"id\": 217056000\n },\n {\n \"data\": \"8E5803E37DDF7E81\",\n \"id\": 418383107\n }\n ],\n \"cycle\": 97,\n \"cp17\": 19,\n \"cp18\": 21,\n \"aws_ts\": 1724901341,\n \"cp13\": 90.7,\n \"wifi_rssi\": -35,\n \"light\": 1,\n \"cp14\": 200,\n \"cp15\": 14,\n \"cp16\": 32.9,\n \"cp10\": 102,\n \"cp11\": 119.8,\n \"cp12\": 31.9,\n \"vin\": 12.28\n },\n {\n \"ts\": 1724901371.8,\n \"cp1\": 599.6,\n \"ambient\": 27.85,\n \"cp2\": 8160,\n \"cp7\": 215,\n \"ttl\": 1787973371,\n \"cp9\": 12,\n \"cp8\": 140,\n \"state\": 0,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.09,\n \"vsys\": 4.14,\n \"can1\": [\n {\n \"data\": \"507D82BD12030E83\",\n \"id\": 217056256\n },\n {\n \"data\": \"DC0000FFF40000FF\",\n \"id\": 217055747\n },\n {\n \"data\": \"FF0146FFFFFFFFFF\",\n \"id\": 419362304\n },\n {\n \"data\": \"D1000CFFFF4F6F7D\",\n \"id\": 217056000\n },\n {\n \"data\": \"7F9F287F20442032\",\n \"id\": 418383107\n }\n ],\n \"cycle\": 98,\n \"cp17\": 19,\n \"cp18\": 21,\n \"aws_ts\": 1724901371,\n \"cp13\": 90.7,\n \"wifi_rssi\": -36,\n \"light\": 1,\n \"cp14\": 200,\n \"cp15\": 14,\n \"cp16\": 32.9,\n \"cp10\": 2,\n \"cp11\": 119.8,\n \"cp12\": 31.9,\n \"vin\": 12.31\n },\n {\n \"ts\": 1724901401.8,\n \"cp1\": 7839.9,\n \"ambient\": 27.85,\n \"cp2\": 8167.4,\n \"cp7\": 215,\n \"ttl\": 1787973401,\n \"cp9\": 0,\n \"cp8\": 138,\n \"state\": 0,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.09,\n \"vsys\": 4.16,\n \"can1\": [\n {\n \"data\": \"CD9A3BFFF40733FF\",\n \"id\": 217056256\n },\n {\n \"data\": \"CD983BFFF40C33FF\",\n \"id\": 217055747\n },\n {\n \"data\": \"FF1945FFFFFFFFFF\",\n \"id\": 419362304\n },\n {\n \"data\": \"C10000FFFF0FC47D\",\n \"id\": 217056000\n },\n {\n \"data\": \"8E58038E200FC37D\",\n \"id\": 418383107\n }\n ],\n \"cycle\": 99,\n \"cp17\": 19,\n \"cp18\": 21,\n \"aws_ts\": 1724901401,\n \"cp13\": 90.7,\n \"wifi_rssi\": -38,\n \"light\": 1,\n \"cp14\": 200,\n \"cp15\": 14,\n \"cp16\": 32.9,\n \"cp10\": 17,\n \"cp11\": 119.8,\n \"cp12\": 31.9,\n \"vin\": 12.28\n },\n {\n \"ts\": 1724901431.8,\n \"cp1\": 1709.8,\n \"ambient\": 27.93,\n \"cp2\": 8166.6,\n \"cp7\": 215,\n \"ttl\": 1787973431,\n \"cp9\": 95,\n \"cp8\": 154,\n \"state\": 0,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.09,\n \"vsys\": 4.15,\n \"can1\": [\n {\n \"data\": \"5ED6D06E35000ED1\",\n \"id\": 217056256\n },\n {\n \"data\": \"CD5035FFF44235FF\",\n \"id\": 217055747\n },\n {\n \"data\": \"FF4E4DFFFFFFFFFF\",\n \"id\": 419362304\n },\n {\n \"data\": \"D4FA5FFFFFFFFFFF\",\n \"id\": 217056000\n },\n {\n \"data\": \"8DE8038D20443136\",\n \"id\": 418383107\n }\n ],\n \"cycle\": 100,\n \"cp17\": 19,\n \"cp18\": 21,\n \"aws_ts\": 1724901431,\n \"cp13\": 90.7,\n \"wifi_rssi\": -36,\n \"light\": 1,\n \"cp14\": 200,\n \"cp15\": 14,\n \"cp16\": 32.9,\n \"cp10\": 16,\n \"cp11\": 119.8,\n \"cp12\": 31.9,\n \"vin\": 12.31\n },\n {\n \"ts\": 1724901461.8,\n \"cp1\": 601.2,\n \"ambient\": 27.9,\n \"cp2\": 8160,\n \"cp7\": 215,\n \"ttl\": 1787973461,\n \"cp9\": 12,\n \"cp8\": 144,\n \"state\": 0,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.07,\n \"vsys\": 4.15,\n \"can1\": [\n {\n \"data\": \"507D82CA12030E83\",\n \"id\": 217056256\n },\n {\n \"data\": \"DC8700FFF47A04FF\",\n \"id\": 217055747\n },\n {\n \"data\": \"FF0148FFFFFFFFFF\",\n \"id\": 419362304\n },\n {\n \"data\": \"D1000CFFF4A504FF\",\n \"id\": 217056000\n },\n {\n \"data\": \"7F9F287F20442032\",\n \"id\": 418383107\n }\n ],\n \"cycle\": 101,\n \"cp17\": 19,\n \"cp18\": 21,\n \"aws_ts\": 1724901461,\n \"cp13\": 90.7,\n \"wifi_rssi\": -36,\n \"light\": 1,\n \"cp14\": 200,\n \"cp15\": 14,\n \"cp16\": 32.9,\n \"cp10\": 2,\n \"cp11\": 119.8,\n \"cp12\": 31.9,\n \"vin\": 12.24\n },\n {\n \"ts\": 1724901491.8,\n \"cp1\": 1291.4,\n \"ambient\": 27.9,\n \"cp2\": 8166.9,\n \"cp7\": 215,\n \"ttl\": 1787973491,\n \"cp9\": 0,\n \"cp8\": 170,\n \"state\": 0,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.07,\n \"vsys\": 4.15,\n \"can1\": [\n {\n \"data\": \"0E7D7D5B2800827D\",\n \"id\": 217056256\n },\n {\n \"data\": \"CD4137FFF06628FF\",\n \"id\": 217055747\n },\n {\n \"data\": \"1C1155FFFFFFFFFF\",\n \"id\": 419362304\n },\n {\n \"data\": \"D10000FFFF0F587D\",\n \"id\": 217056000\n },\n {\n \"data\": \"8FDA028F20443138\",\n \"id\": 418383107\n }\n ],\n \"cycle\": 102,\n \"cp17\": 19,\n \"cp18\": 21,\n \"aws_ts\": 1724901491,\n \"cp13\": 90.7,\n \"wifi_rssi\": -36,\n \"light\": 1,\n \"cp14\": 200,\n \"cp15\": 14,\n \"cp16\": 32.9,\n \"cp10\": 18,\n \"cp11\": 119.8,\n \"cp12\": 31.9,\n \"vin\": 12.21\n },\n {\n \"ts\": 1724901521.8,\n \"cp1\": 1345.6,\n \"ambient\": 27.93,\n \"cp2\": 8166.1,\n \"cp7\": 4,\n \"ttl\": 1787973521,\n \"cp9\": 37,\n \"cp8\": 138,\n \"state\": 0,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.08,\n \"vsys\": 4.17,\n \"can1\": [\n {\n \"data\": \"21A4A40D2A000EA4\",\n \"id\": 217056256\n },\n {\n \"data\": \"CD1331FFF4042AFF\",\n \"id\": 217055747\n },\n {\n \"data\": \"FF25452C2AFCCCFF\",\n \"id\": 419362304\n },\n {\n \"data\": \"D08825FFFF0FA47D\",\n \"id\": 217056000\n },\n {\n \"data\": \"8E58038E20443137\",\n \"id\": 418383107\n }\n ],\n \"cycle\": 103,\n \"cp17\": 19,\n \"cp18\": 21,\n \"aws_ts\": 1724901521,\n \"cp13\": 90.7,\n \"wifi_rssi\": -36,\n \"light\": 1,\n \"cp14\": 200,\n \"cp15\": 14,\n \"cp16\": 32.9,\n \"cp10\": 17,\n \"cp11\": 119.8,\n \"cp12\": 31.9,\n \"vin\": 12.28\n },\n {\n \"ts\": 1724901551.8,\n \"cp1\": 1514.2,\n \"ambient\": 27.93,\n \"cp2\": 876,\n \"cp7\": 215,\n \"ttl\": 1787973551,\n \"cp9\": 93,\n \"cp8\": 156,\n \"state\": 0,\n \"wifi_ip\": \"192.168.1.216\",\n \"deviceid\": \"ZSBDH91FF\",\n \"vreg\": 9.11,\n \"vsys\": 4.16,\n \"can1\": [\n {\n \"data\": \"6EDED4522F000ED5\",\n \"id\": 217056256\n },\n {\n \"data\": \"CD1B601B7CD77587\",\n \"id\": 217055747\n },\n {\n \"data\": \"FF194EFFFFFFFFFF\",\n \"id\": 419362304\n },\n {\n \"data\": \"D4FA5DFFFF4FE97D\",\n \"id\": 217056000\n },\n {\n \"data\": \"8A51068A20443133\",\n \"id\": 418383107\n }\n ],\n \"cycle\": 104,\n \"cp17\": 19,\n \"cp18\": 21,\n \"aws_ts\": 1724901551,\n \"cp13\": 90.7,\n \"wifi_rssi\": -36,\n \"light\": 1,\n \"cp14\": 200,\n \"cp15\": 14,\n \"cp16\": 32.9,\n \"cp10\": 13,\n \"cp11\": 119.8,\n \"cp12\": 31.9,\n \"vin\": 12.31\n }\n ],\n \"lastEvaluatedTime\": null,\n \"deviceid\": \"ZSBDH91FF\",\n \"dataCount\": 9,\n \"message\": \"OK\"\n}"},{"id":"9dee9551-f37a-439f-a346-6aac31efe9f6","name":"Specific data keys","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/data?relative=10m&dataKeys=vin&dataKeys=ambient","host":["https://api.senquip.com/cloud-api-v2"],"path":["device","DEVICEID","data"],"query":[{"key":"relative","value":"10m","description":"Relative time period from now. Possible options:\n1m = One minute,\n3d = Three days,\n5w = Five weeks,\n2M = Two months.\nIf this parameter is present, it overrides the fromTime and toTime."},{"key":"dataPoints","value":"","description":"Maximum number of data points to return.","disabled":true},{"key":"fromTime","value":"","description":"Timestamp to start from (Unix timestamps in seconds).","disabled":true},{"key":"toTime","value":"","description":"Timestamp to end at (Unix timestamps in seconds).","disabled":true},{"key":"pageStartTime","value":"","description":"Starting timestamp for paginated queries.","type":"text","disabled":true},{"key":"dataKeys","value":"vin","description":"A data key to return. This param can be repeated for each key."},{"key":"dataKeys","value":"ambient"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"201"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 20 Oct 2024 22:04:27 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-67157e6a-12a0c18126d6d91c20d97f93;Parent=5ffb4db097b3aab3;Sampled=0;Lineage=1:1b85cbe5:0"},{"key":"x-amzn-RequestId","value":"f9b680c4-34c7-456c-ae94-6be625aa2a4a"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"f-CwuH8XywMEH3Q="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 30d965dd3bd4ca28c3aa1ccfc6be7c36.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD3-P1"},{"key":"X-Amz-Cf-Id","value":"EjavV713GI3eFToWY_fsR6OZ-BInGBYvToJ8PlGQhmRgna1Cz-b81w=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"ts\": 1729461281.7,\n \"vin\": 12.09,\n \"ambient\": 24.35\n },\n {\n \"ts\": 1729461341.7,\n \"vin\": 12.12,\n \"ambient\": 24.38\n },\n {\n \"ts\": 1729461401.7,\n \"vin\": 12.15,\n \"ambient\": 24.35\n },\n {\n \"ts\": 1729461461.7,\n \"vin\": 12.12,\n \"ambient\": 24.4\n },\n {\n \"ts\": 1729461521.7,\n \"vin\": 12.15,\n \"ambient\": 24.4\n },\n {\n \"ts\": 1729461581.7,\n \"vin\": 12.15,\n \"ambient\": 24.43\n },\n {\n \"ts\": 1729461641.7,\n \"vin\": 12.15,\n \"ambient\": 24.45\n },\n {\n \"ts\": 1729461701.7,\n \"vin\": 12.12,\n \"ambient\": 24.43\n },\n {\n \"ts\": 1729461761.7,\n \"vin\": 12.18,\n \"ambient\": 24.45\n },\n {\n \"ts\": 1729461821.7,\n \"vin\": 12.15,\n \"ambient\": 24.48\n }\n ],\n \"lastEvaluatedTime\": null,\n \"deviceid\": \"ZSBDH91FF\",\n \"dataCount\": 10,\n \"message\": \"OK\"\n}"},{"id":"beee3774-8743-4cad-943f-85a6b1ff50d9","name":"ERROR: No Permissions","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/data","host":["https://api.senquip.com/cloud-api-v2"],"path":["device","DEVICEID","data"],"query":[{"key":"relative","value":"1M","description":"Relative time period from now. Possible options:\n1m = One minute\n3d = Three days\n5w = Five weeks\n2M = Two months","disabled":true},{"key":"dataPoints","value":"6","description":"Maximum number of data points to return.","disabled":true},{"key":"fromTime","value":"1728857423","description":"Timestamp to start from (Unix timestamps in seconds).","disabled":true},{"key":"toTime","value":"1728857303","description":"Timestamp to end at (Unix timestamps in seconds).","disabled":true},{"key":"pageStartTime","value":"1726613627.5","description":"Starting timestamp for paginated queries.","type":"text","disabled":true},{"key":"dataKeys","value":"vin","description":"A data key to return. This param can be repeated for each key.","disabled":true},{"key":"dataKeys","value":"ambient","description":"A data key to return. This param can be repeated for each key.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"60"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 18 Oct 2024 01:48:03 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6711be52-5de356a55328a92b375fa0d2;Parent=3ad2d167c0bdb563;Sampled=0;Lineage=2:1b85cbe5:0"},{"key":"x-amzn-RequestId","value":"1e2a717f-1aa8-4acd-8926-b6b0e54a66a2"},{"key":"x-amz-apigw-id","value":"f0qs-HB8ywMEjRA="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 212ddd6c8eb82cf3007eedad5f05dca8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD62-P1"},{"key":"X-Amz-Cf-Id","value":"pqBlmvA0kMTl2CIKYcbFV50a8RCjRxYyXGHxcmFVp-rbW8f5T3-dwQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"User does not have permissions for this device\"\n}"},{"id":"b233ee27-6221-4bbc-81bc-d89aa77cf834","name":"ERROR: Relative and absolute time set","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/data?relative=5m&fromTime=1723100000&toTime=1723590000","host":["https://api.senquip.com/cloud-api-v2"],"path":["device","DEVICEID","data"],"query":[{"key":"relative","value":"5m","description":"Relative time period from now. Possible options:\n1m = One minute,\n3d = Three days,\n5w = Five weeks,\n2M = Two months.\nIf this parameter is present, it overrides the fromTime and toTime."},{"key":"fromTime","value":"1723100000","description":"Timestamp to start from (Unix timestamps in seconds)."},{"key":"toTime","value":"1723590000","description":"Timestamp to end at (Unix timestamps in seconds)."},{"key":"pageStartTime","value":"1723547172.2","description":"Starting timestamp for paginated queries.","disabled":true},{"key":"dataKeys","value":"vin_invlid","description":"A data key to return. This param can be repeated for each key.","disabled":true},{"key":"downsample","value":"2","type":"text","disabled":true},{"key":"dataPoints","value":"-1","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"67"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 25 Jun 2025 00:38:37 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-685b450b-49381914574c600a0b3645ee;Parent=67e457a5809450cb;Sampled=0;Lineage=2:40ca2b7d:0"},{"key":"x-amzn-RequestId","value":"0f605dc8-b4c7-43d1-b5e5-77772c29937b"},{"key":"x-amz-apigw-id","value":"Mse50H_FSwMEofA="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 b798288227eabcd45c0b7368df2cc344.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD1-C1"},{"key":"X-Amz-Cf-Id","value":"I8z0mrjrE6j3jTsy-Fho1zU69P9GUUM2x9uqWd2gX6Ggyt8TOBZVxg=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"fromTime and toTime cannot be used with relative time\"\n}"}],"_postman_id":"8dae6997-e88d-471e-b1aa-45e76c938a5e"}],"id":"24a88418-e72c-4b64-b6dd-b50780e8d6d4","description":"

Endpoints to access data on a device.

\n","_postman_id":"24a88418-e72c-4b64-b6dd-b50780e8d6d4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"API_KEY"}]},"isInherited":true,"source":{"_postman_id":"45924e2f-b898-4f77-8f3b-9895fdd31fd8","id":"45924e2f-b898-4f77-8f3b-9895fdd31fd8","name":"Senquip Cloud API Documentation","type":"collection"}}},{"name":"Configuration","item":[{"name":"Get Device Config","id":"0cafc11c-bee2-4eaf-ae1d-8d2bf43638f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/config","description":"

Retrieve the device settings for a specific device identified by the deviceid in the path. The request does not require a request body.

It is important to note that this endpoint returns the last known values sent from the device to the Senquip Portal. It is possible to modify values on the device via the local webserver, or the device may be configured so it does not send settings to the Senquip Portal. Use the ts value in the response to check the timestamp of the settings.

There are two query parameters available to provide more succinct response. Setting changesOnly to true will return only the settings on the device that have changed from the defaults. Setting removeUnique to true will remove settings that are unique to the device, such as ID, name, firmware etc.

Path Parameters

deviceid: The identifier of the device for which the script is being retrieved.

Response

ts (number): The timestamp of the settings.
\n
settings (object): A object containing the last known settings recieved from the device.
\n
message (string): Informational status message.
\n

(boolean, optional, default: false) Only return the changes from the default settings.

\n","type":"text/plain"},"key":"changesOnly","value":""},{"disabled":true,"description":{"content":"

(boolean, optional, default: false) Remove settings that are unique to the device, such as ID, name, firmware etc.

\n","type":"text/plain"},"key":"removeUnique","value":""}],"variable":[]}},"response":[{"id":"7522b975-0fe4-41e7-9efe-61a872d6deb6","name":"Full Config","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/config","host":["https://api.senquip.com/cloud-api-v2"],"path":["device","DEVICEID","config"],"query":[{"key":"changesOnly","value":"true","description":"Only return the changes from the default settings.","disabled":true},{"key":"removeUnique","value":"true","description":"Remove settings that are unique to the device, such as ID, name, firmware etc.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1957"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 25 Nov 2024 03:32:46 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6743efde-738bdd427128558c75cb119b;Parent=06e85d4c54e2b850;Sampled=0;Lineage=2:d0b48a92:0"},{"key":"x-amzn-RequestId","value":"6c724a91-1296-44a3-917b-760434cdd3a5"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"ByJq4GzEywMEUVA="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 0b26d7ef0f265884570bdb3e6c3750b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD1-C1"},{"key":"X-Amz-Cf-Id","value":"5ikl94jo-LNohE0aonJjX2zlG_s_vfNXI5zhXGNR_PdihTJfeh8g6Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"deviceid\": \"XXXXXXXXX\",\n \"ts\": 1732504987,\n \"changesOnly\": false,\n \"removeUnique\": false,\n \"settings\": {\n \"device\": {\n \"id\": \"XXXXXXXXX\",\n \"available\": true,\n \"model\": \"ORB-X1-G\",\n \"fw\": \"SFW001-8.2.0\",\n \"fw_timestamp\": \"2023-07-20T01:05:57Z\",\n \"hw\": \"2\",\n \"name\": \"Changed from API\",\n \"base_interval\": 60,\n \"transmit_interval\": 1,\n \"exception_interval\": 1,\n \"always_on\": true,\n \"batch_tx_enable\": false,\n \"web_always_on\": false,\n \"sq_interval\": 0,\n \"vin\": {\n \"alert_enable\": false,\n \"sleep_enable\": true,\n \"sleep_interval\": 21600,\n \"sleep_delay\": 5,\n \"count_hours\": false\n },\n \"batt\": {\n \"alert_enable\": false,\n \"threshold\": 4.8\n },\n \"vsys\": {\n \"threshold\": 3.5\n }\n },\n \"debug\": {\n \"udp_log_addr\": \"\",\n \"level\": 1,\n \"stdout_uart\": -1,\n \"stderr_uart\": -1,\n \"mbedtls_level\": 0\n },\n \"sntp\": {\n \"enable\": true,\n \"server\": \"pool.ntp.org\",\n \"update_interval\": 43200\n },\n \"bt\": {\n \"enable\": true,\n \"keep_enabled\": true\n },\n \"wifi\": {\n \"available\": true,\n \"sta\": {\n \"enable\": true,\n \"ssid\": \"Provision\",\n \"pass\": \"********\",\n \"user\": \"\",\n \"anon_identity\": \"\",\n \"cert\": \"\",\n \"key\": \"\",\n \"ca_cert\": \"\",\n \"ip\": \"\",\n \"netmask\": \"\",\n \"gw\": \"\",\n \"nameserver\": \"\",\n \"dhcp_hostname\": \"ORB-XXXXX\"\n },\n \"ap\": {\n \"enable\": false,\n \"ssid\": \"ORB-XXXXX\",\n \"pass\": \"********\",\n \"hidden\": false,\n \"channel\": 6,\n \"max_connections\": 10,\n \"ip\": \"192.168.4.1\",\n \"netmask\": \"255.255.255.0\",\n \"gw\": \"192.168.4.1\",\n \"dhcp_start\": \"192.168.4.2\",\n \"dhcp_end\": \"192.168.4.100\",\n \"hostname\": \"senquip\",\n \"keep_enabled\": true\n }\n },\n \"mjs\": {\n \"enable\": false,\n \"send_errors\": false\n },\n \"gsm\": {\n \"available\": true,\n \"enable\": true,\n \"auto_apn\": false,\n \"auto_apn_version\": 1,\n \"apn\": \"telstra.m2m\",\n \"user\": \"\",\n \"pass\": \"\",\n \"scan_mode\": 3,\n \"lte_mode\": 0,\n \"roaming\": false,\n \"bands\": \"\"\n },\n \"tamper\": {\n \"available\": true,\n \"name\": \"Tamper\",\n \"enable\": false\n },\n \"magnet\": {\n \"available\": false,\n \"mode\": \"Disabled\"\n },\n \"humidity\": {\n \"available\": false\n },\n \"pressure\": {\n \"available\": true,\n \"interval\": 1\n },\n \"ambient\": {\n \"available\": true,\n \"name\": \"Internal Temp\",\n \"interval\": 1,\n \"hysteresis\": 1,\n \"warning\": \"0,-10,50\",\n \"alarm\": \"0,-20,60\"\n },\n \"accel\": {\n \"available\": true,\n \"name\": \"Accelerometer\",\n \"interval\": 0,\n \"outputxyz\": false,\n \"hysteresis\": 1,\n \"pitch\": {\n \"warning\": \"0,-45,45\",\n \"alarm\": \"0,-60,60\"\n },\n \"roll\": {\n \"warning\": \"0,-45,45\",\n \"alarm\": \"0,-60,60\"\n },\n \"angle\": {\n \"warning\": \"0,0,45\",\n \"alarm\": \"0,0,60\"\n },\n \"motion\": {\n \"warning\": \"0,0,100\",\n \"alarm\": \"0,0,500\",\n \"wake_from_hibernate\": false,\n \"wake_threshold\": 100,\n \"wake_config\": \"0,87,9\",\n \"count_hours\": false\n }\n },\n \"ble\": {\n \"available\": true,\n \"name\": \"Bluetooth\",\n \"addr\": \"246F280FB442\",\n \"interval\": 0,\n \"scan_time\": 5,\n \"id_list\": \"\",\n \"send_data\": false\n },\n \"gps\": {\n \"available\": true,\n \"name\": \"GPS\",\n \"interval\": 0,\n \"maxtime\": 180,\n \"position\": {\n \"alert\": {\n \"enable\": false,\n \"radius\": 20,\n \"hysteresis\": 10,\n \"lat\": -32.93197,\n \"lon\": 151.77882\n }\n },\n \"speed\": {\n \"count_hours\": false,\n \"alert\": {\n \"enable\": false,\n \"threshold\": 20,\n \"hysteresis\": 1\n }\n }\n },\n \"input1\": {\n \"available\": true,\n \"name\": \"Input 1\",\n \"interval\": 0,\n \"mode\": \"Digital\",\n \"digital\": {\n \"threshold\": 6,\n \"hysteresis\": 1,\n \"count_hours\": false,\n \"alert\": {\n \"enable\": false\n }\n },\n \"cal\": \"0,10,0,10\",\n \"unit\": \"Volts\",\n \"warning\": \"0,10,15\",\n \"alarm\": \"0,5,30\",\n \"hysteresis\": 1,\n \"pulse\": {\n \"enable\": false,\n \"reset_value\": 10000,\n \"scaling\": 1,\n \"unit\": \"Counts\",\n \"warning\": \"0,-1,2000\",\n \"alarm\": \"0,-1,5000\"\n },\n \"duty\": {\n \"invert\": false,\n \"tolerance\": 3\n }\n },\n \"input2\": {\n \"available\": true,\n \"name\": \"Input 2\",\n \"interval\": 0,\n \"mode\": \"Digital\",\n \"digital\": {\n \"threshold\": 6,\n \"hysteresis\": 1,\n \"count_hours\": false,\n \"alert\": {\n \"enable\": false\n }\n },\n \"cal\": \"0,10,0,10\",\n \"unit\": \"Volts\",\n \"warning\": \"0,10,15\",\n \"alarm\": \"0,5,30\",\n \"hysteresis\": 1\n },\n \"output1\": {\n \"available\": true,\n \"name\": \"Output 1\",\n \"interval\": 0,\n \"mode\": \"Output\",\n \"warnings\": false,\n \"alarms\": false,\n \"alerts\": false,\n \"hold_time\": 2,\n \"digital\": {\n \"alert\": {\n \"enable\": false\n }\n },\n \"cal\": \"0,10,0,10\",\n \"unit\": \"Volts\",\n \"warning\": \"0,10,15\",\n \"alarm\": \"0,5,30\",\n \"hysteresis\": 1\n },\n \"tc1\": {\n \"available\": true,\n \"name\": \"Thermocouple 1\",\n \"interval\": 0,\n \"hysteresis\": 5,\n \"type\": \"K\",\n \"warning\": \"0,0,90\",\n \"alarm\": \"0,-10,100\"\n },\n \"can1\": {\n \"available\": false,\n \"name\": \"CAN 1\",\n \"interval\": 0,\n \"nominal_baud\": 250,\n \"capture_time\": 2,\n \"tx_enable\": false,\n \"id_list\": \"\",\n \"send_data\": false\n },\n \"can2\": {\n \"available\": false,\n \"name\": \"CAN 2\",\n \"interval\": 0,\n \"nominal_baud\": 250,\n \"capture_time\": 2,\n \"tx_enable\": false,\n \"id_list\": \"\",\n \"send_data\": false\n },\n \"current1\": {\n \"available\": true,\n \"name\": \"Current 1\",\n \"interval\": 0,\n \"mode\": \"Current\",\n \"always_on\": false,\n \"start_time\": 0.5,\n \"digital\": {\n \"threshold\": 0,\n \"alert\": {\n \"enable\": false\n }\n },\n \"cal\": \"0,100,0,100\",\n \"unit\": \"mA\",\n \"warning\": \"0,20,80\",\n \"alarm\": \"0,10,90\",\n \"hysteresis\": 1\n },\n \"current2\": {\n \"available\": true,\n \"name\": \"Current 2\",\n \"interval\": 0,\n \"mode\": \"Current\",\n \"always_on\": false,\n \"start_time\": 0.5,\n \"digital\": {\n \"threshold\": 0,\n \"alert\": {\n \"enable\": false\n }\n },\n \"cal\": \"0,100,0,100\",\n \"unit\": \"mA\",\n \"warning\": \"0,20,80\",\n \"alarm\": \"0,10,90\",\n \"hysteresis\": 1\n },\n \"serial1\": {\n \"available\": true,\n \"name\": \"Capture 1\",\n \"interval\": 0,\n \"type\": \"RS232\",\n \"fast_rs232\": false,\n \"rx_linger_micros\": 15,\n \"rx_buf_size\": 512,\n \"tx_buf_size\": 256,\n \"termination\": false,\n \"mode\": \"Capture\",\n \"baud\": 57600,\n \"settings\": \"8N1\",\n \"capture\": {\n \"start\": \"\",\n \"start_idle_time\": 0,\n \"end\": \"\",\n \"request\": \"\",\n \"maxtime\": 5,\n \"maxchars\": 500,\n \"alert\": false\n },\n \"modbus\": {\n \"timeout\": 0.2\n }\n },\n \"mod1\": {\n \"name\": \"Modbus 1\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod2\": {\n \"name\": \"Modbus 2\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod3\": {\n \"name\": \"Modbus 3\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod4\": {\n \"name\": \"Modbus 4\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod5\": {\n \"name\": \"Modbus 5\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod6\": {\n \"name\": \"Modbus 6\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod7\": {\n \"name\": \"Modbus 7\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod8\": {\n \"name\": \"Modbus 8\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod9\": {\n \"name\": \"Modbus 9\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod10\": {\n \"name\": \"Modbus 10\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod11\": {\n \"name\": \"Modbus 11\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod12\": {\n \"name\": \"Modbus 12\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod13\": {\n \"name\": \"Modbus 13\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod14\": {\n \"name\": \"Modbus 14\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod15\": {\n \"name\": \"Modbus 15\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod16\": {\n \"name\": \"Modbus 16\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod17\": {\n \"name\": \"Modbus 17\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod18\": {\n \"name\": \"Modbus 18\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod19\": {\n \"name\": \"Modbus 19\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"mod20\": {\n \"name\": \"Modbus 20\",\n \"settings\": \"\",\n \"cal\": \"\",\n \"unit\": \"\",\n \"warning\": \"0,0,80\",\n \"alarm\": \"0,0,100\"\n },\n \"endpoint\": {\n \"available\": true,\n \"config_to_portal\": true,\n \"data_to_portal\": true,\n \"buffer_enable\": false,\n \"addtimedate\": false,\n \"network_report\": true,\n \"sq_data_format\": true,\n \"udp\": {\n \"enable\": false,\n \"address\": \"server:port\"\n },\n \"http\": {\n \"enable\": false,\n \"address\": \"example.com/api:80\",\n \"ssl_ca_file\": \"\",\n \"ssl_client_cert_file\": \"\",\n \"ssl_client_key_file\": \"\",\n \"ssl_server_name\": \"\"\n },\n \"mqtt\": {\n \"enable\": false,\n \"server\": \"\",\n \"client_id\": \"\",\n \"data_topic\": \"\",\n \"user\": \"\",\n \"pass\": \"\",\n \"ssl_cert\": \"\",\n \"ssl_key\": \"\",\n \"ssl_ca_cert\": \"\",\n \"ssl_cipher_suites\": \"\",\n \"ssl_psk_identity\": \"\",\n \"ssl_psk_key\": \"\",\n \"ssl_server_name\": \"\",\n \"azure_cs\": \"\",\n \"azure_token_ttl\": 3600\n }\n },\n \"script\": {\n \"num1\": 0,\n \"num2\": 0,\n \"num3\": 0,\n \"num4\": 0,\n \"num5\": 0,\n \"num6\": 0,\n \"num7\": 0,\n \"num8\": 0,\n \"num9\": 0,\n \"num10\": 0,\n \"str1\": \"\",\n \"str2\": \"\",\n \"str3\": \"\",\n \"str4\": \"\",\n \"str5\": \"\",\n \"str6\": \"\",\n \"str7\": \"\",\n \"str8\": \"\",\n \"str9\": \"\",\n \"str10\": \"\"\n },\n \"sys\": {\n \"diag_interval\": 3600\n }\n },\n \"message\": \"OK\"\n}"},{"id":"2aa17260-f4ea-436b-bccf-1238037989cd","name":"Minimal config","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/config?changesOnly=true&removeUnique=true","host":["https://api.senquip.com/cloud-api-v2"],"path":["device","DEVICEID","config"],"query":[{"key":"changesOnly","value":"true","description":"Only return the changes from the default settings."},{"key":"removeUnique","value":"true","description":"Remove settings that are unique to the device, such as ID, name, firmware etc."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"256"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 25 Nov 2024 03:34:00 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6743f028-62b3e8a16da2ba071619c010;Parent=0c432c5c4c3874f9;Sampled=0;Lineage=2:d0b48a92:0"},{"key":"x-amzn-RequestId","value":"1c1fb847-7fff-4407-8e6b-8791dd077bd2"},{"key":"x-amz-apigw-id","value":"ByJ2YEfTSwMEM9w="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c7c43876ee4a62a2ceabf450cd898d7c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD1-C1"},{"key":"X-Amz-Cf-Id","value":"_FABDrhw1XDxuYD17RKK6qfeiaELG04mG32_LXy1ckD5kmp3CT2Zsg=="}],"cookie":[],"responseTime":null,"body":"{\n \"deviceid\": \"XXXXXXXXX\",\n \"ts\": 1732504987,\n \"changesOnly\": true,\n \"removeUnique\": true,\n \"settings\": {\n \"device\": {\n \"vsys\": {\n \"threshold\": 3.5\n }\n },\n \"wifi\": {\n \"sta\": {\n \"enable\": true,\n \"ssid\": \"Provision\",\n \"pass\": \"********\"\n }\n },\n \"gsm\": {\n \"auto_apn\": false,\n \"apn\": \"telstra.m2m\"\n }\n },\n \"message\": \"OK\"\n}"}],"_postman_id":"0cafc11c-bee2-4eaf-ae1d-8d2bf43638f1"},{"name":"Update Device Config","id":"8fe8bf3d-3610-47aa-a968-1130940d06e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"config\": {\n \"mqtt\": {\n \"name\": \"Changed from API #2\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/config","description":"

Update device configuration for a specific device identified by the deviceid. The config given in the request is sent to the device's command queue. If device is online it should receieve the changes straight away, otherwise changes are sent when it next makes contact with the Senquip Portal.

The configuration set depends on the device's model. A full configuration can be requested using the Get Device Config endpoint.

Some configuration keys are read only or reserved for system use. If it is not possible to set a value, the key will appear in the failedKeys list in the response.

There is currently no validation on extraneous configuration keys or mistakes/typos, the device will simply ignore these keys.

The request requires a request body.

Required device permission level: ADMIN or USER

Path Parameters

deviceid: The identifier of the device.

Body Parameters

config (object): A JSON object containing the new settings.
\n
dryRun (boolean): Optional. If set to true, the config is validated but is not sent to the queue. If omitted defaults to false.
\n

Response

message (string): Informational status message.
\n
failedKeys (array): An array of keys that could not be updated.
\n
id (number): The identifier of the queued message, or zero if no change was made.
\n

This endpoint queues a file to be sent to the device. The device is identified by the deviceid in the path. This endpoint is typically used to load unique client certificates or custom configuration files on to the device.

The request requires a request body.

This endpoint queues a command to be sent to the device. It will be actioned when the device is online and connected to the Senquip Portal.

Required device permission level: ADMIN or USER

Note: To get files, remove files or list files please see the 'Send Device Command' endpoint.

Restrictions

To avoid conflicts on the device, there are some file name restrictions.

File names cannot start with slashes or dots. Eg: ./test.log
\n
File names cannot start with a single letter and underscore (reserved for system use). Eg: d_ or i_
\n
Valid filenames must match this regex: /^[a-zA-Z0-9_.()-]+$/
\n
For MQTT and HTTP certificates, the valid file names are:
\n
1. mqtt_client.key
  \n
2. mqtt_client.crt
  \n
3. mqtt_ca.pem
  \n
4. https_client.key
  \n
5. https_client.crt
  \n
6. https_ca.pem
  \n
\n

If a file with the same fileName exists on the device it will be overwritten.

Path Parameters

deviceid: The identifier of the device.

Body Parameters

fileDataBase64 (string): The contents of the file encoded in Base 64 format.
\n
fileName (string): The filename used to write the file on the device.
\n

Response

message (string): Informational status message.

Allows import of a configuration file for a device.

Body Parameters

dryRun (boolean): Optional. Set to true to perform a dry run import. The import file is validated, but no changes are made.
\n
overrideFirmwareVersion (boolean): Optional. Set to true to override the firmware version check during import.
\n
overrideFirmwareNumber (boolean): Optional. Set to true to override the firmware number check during import.
\n
importFileBase64 (string): The Base64 encoded configuration file.
\n

Response

importResults (array): An array of results for each import category.
\n
warnings (array): An array of warning messages raised during the import.
\n
message (string): Informational status message.
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"API_KEY"}]},"isInherited":true,"source":{"_postman_id":"45924e2f-b898-4f77-8f3b-9895fdd31fd8","id":"45924e2f-b898-4f77-8f3b-9895fdd31fd8","name":"Senquip Cloud API Documentation","type":"collection"}},"urlObject":{"path":["device","DEVICEID","import"],"host":["https://api.senquip.com/cloud-api-v2"],"query":[],"variable":[]}},"response":[{"id":"6a993e13-9eea-44dd-90aa-2e2570307882","name":"Success with warnings","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"overrideFirmwareVersion\": true,\n \"overrideFirmwareNumber\": true,\n \"importFileBase64\": \"redacted for example\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/import"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"336"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 18 Nov 2024 05:01:38 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-673aca32-34fb0d791adfe2f7199f6c0a;Parent=3dc8aaf97f4f5247;Sampled=0;Lineage=1:d27bcc46:0"},{"key":"x-amzn-RequestId","value":"0734d2fa-3404-448d-b72f-30b9287e4c51"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"BbSH6GZdywMEcKg="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 3fb80f1162ff0374e396394904e92ee4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD1-C1"},{"key":"X-Amz-Cf-Id","value":"yr5TTzb1XggPWl5MM1nFfv7368FEFB4vKFTNRyGLdtYpc4Kikgu5pQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"warnings\": [\n \"The settings file originates from a different firmware number [SFW002]. Device settings may not be compatible.\"\n ],\n \"importResults\": [\n {\n \"importName\": \"Display Settings\",\n \"result\": \"success\",\n \"message\": \"Settings imported successfully.\"\n },\n {\n \"importName\": \"Device Notes\",\n \"result\": \"na\",\n \"message\": \"No device notes to import.\"\n },\n {\n \"importName\": \"Notification Settings\",\n \"result\": \"success\",\n \"message\": \"Settings imported successfully.\"\n },\n {\n \"importName\": \"Script\",\n \"result\": \"error\",\n \"message\": \"Failed to update. Script has been locked by another user.\"\n },\n {\n \"importName\": \"API Settings\",\n \"result\": \"na\",\n \"message\": \"No API settings to import.\"\n },\n {\n \"importName\": \"Device Settings\",\n \"result\": \"success\",\n \"message\": \"Configuration queued successfully.\"\n }\n ],\n \"message\": \"OK\"\n}"},{"id":"9cb1b337-db45-425a-9821-d5ee96c2a3d0","name":"Successful dry run","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"dryRun\": true,\n \"overrideFirmwareVersion\": true,\n \"overrideFirmwareNumber\": true,\n \"importFileBase64\": \"redacted for example\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/import"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"359"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 18 Nov 2024 04:53:32 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-673ac84a-4a359eca2c516c0d0ebe9df0;Parent=3a9e523fa346f9b1;Sampled=0;Lineage=2:d27bcc46:0"},{"key":"x-amzn-RequestId","value":"6e75c0e0-c952-4c37-be37-4b8ef8fe275b"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"BbQ7vFnXSwMEt7w="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 1c8c09a2d2295d49b2248ce893dbb6c6.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD1-C1"},{"key":"X-Amz-Cf-Id","value":"EQZ0K6uB88iYOF_EEUgTOlk7qcpHbpaA9Dp9UHbZBsmr7ue6COikhg=="}],"cookie":[],"responseTime":null,"body":"{\n \"warnings\": [\n \"Dry run enabled. No changes were made.\",\n \"The settings file originates from a different firmware number [SFW002]. Device settings may not be compatible.\"\n ],\n \"importResults\": [\n {\n \"importName\": \"Display Settings\",\n \"result\": \"success\",\n \"message\": \"Settings valid (dry run).\"\n },\n {\n \"importName\": \"Device Notes\",\n \"result\": \"na\",\n \"message\": \"No device notes to import.\"\n },\n {\n \"importName\": \"Notification Settings\",\n \"result\": \"success\",\n \"message\": \"Settings valid (dry run).\"\n },\n {\n \"importName\": \"Script\",\n \"result\": \"success\",\n \"message\": \"Script is valid (dry run).\"\n },\n {\n \"importName\": \"Script Lock\",\n \"result\": \"error\",\n \"message\": \"Script locked by another user user@example.com\"\n },\n {\n \"importName\": \"API Settings\",\n \"result\": \"na\",\n \"message\": \"No API settings to import.\"\n },\n {\n \"importName\": \"Device Settings\",\n \"result\": \"success\",\n \"message\": \"Configuration valid (dry run).\"\n }\n ],\n \"dryRun\": true,\n \"message\": \"OK\"\n}"}],"_postman_id":"ce9fb81e-684b-4066-9d3d-23a2cc635d88"},{"name":"Update Firmware","id":"2ffb76f5-52ed-45c7-8a51-32d8df9babb6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"firmwareName\": \"SFW001-latest\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/firmware","description":"

This endpoint queues a command to update a device's firmware. The device is identified by the deviceid in the path.

The request requires a request body.

This endpoint queues a command to be sent to the device. It will be actioned when the device is online and connected to the Senquip Portal.

Required device permission level: ADMIN or USER

Path Parameters

deviceid: The identifier of the device.

Body Parameters

firmwareName (string): The firmware name/version to update to.

Response

message (string): Informational status message.

This endpoint queues a command to be sent to the device. It will be actioned when the device is online and connected to the Senquip Portal. The device is identified by the deviceid in the path.

The request requires a request body.

Required device permission level:

ADMIN or USER may use any method.
\n
OPERATOR may use the Admin.Trigger method only.
\n

Path Parameters

deviceid: The identifier of the device.

Body Parameters

method (string): The command method. Possible options are:
\n
- Sys.Reboot - Reboot the device.
  \n
- Admin.FreightMode - Put device into a low power freight mode.
  \n
- Admin.Trigger - Trigger a custom scripted action. Arguments required:
  \n
  - index (number): the custom trigger index.
  \n
- Admin.FSGet - Request a file from the device's filesystem. The file data will be in the Command Queue response. Arguments required:
  \n
  - filename (string): the name of the file to request.
  \n
- Admin.FSList - Request that the device list the files on the filesystem. The result will be in the Command Queue response.
  \n
- Admin.FSRemove - Request deletion/removal of a file from the device's filesystem. Check Command Queue response for the result.
  \n
  - filename (string): the name of the file to delete.
  \n
\n
args (object): Arguments for the chosen method. Some methods require no arguments and the args parameter can be omitted.
\n

Response

id (number): Identifier of the queued command.
\n
deviceid (string): Device ID used for the request.
\n
method (string): Method specified in the request.
\n
message (string): Informational status message.
\n

A successful response (Status: 200) means the message was accepted to the server's command queue. It does not mean that the device has performed the action successfully.

Retrieve the device command queue. The command queue contains the pending or completed messages sent to the device. The last 20 messages are retrieved.

Path Parameters

deviceid: The identifier of the device.

Response

data (array): An array of command response objects. See below for explaination.
\n
message (string): Informational status message.
\n

Command Response Object

ts (number) Timestamp of command in milliseconds.
\n
priority (number) Priority of the command. Lower value = higher priority. A value of zero indicates the command is complete.
\n
device_response (string) A response message from the device. Omitted if device has not sent a response.
\n
rpcmethod (string) The command method.
\n
complete_ts (number) A timestamp of when the command was completed, if applicable.
\n
ota_status (object) Firmware update status information. Only exists for the OTA.Update command when the update has started.
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"API_KEY"}]},"isInherited":true,"source":{"_postman_id":"45924e2f-b898-4f77-8f3b-9895fdd31fd8","id":"45924e2f-b898-4f77-8f3b-9895fdd31fd8","name":"Senquip Cloud API Documentation","type":"collection"}},"urlObject":{"path":["device","DEVICEID","command"],"host":["https://api.senquip.com/cloud-api-v2"],"query":[],"variable":[]}},"response":[{"id":"5b6533ff-78d8-4186-8afc-a7b64eb52004","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/command"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"942"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 04 Jul 2025 04:45:00 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-68675c4c-2ed8addd1be9bb554cdf648c;Parent=1f93487951de448b;Sampled=0;Lineage=2:2a7f00a8:0"},{"key":"x-amzn-RequestId","value":"d94dbdd3-780b-47b6-a05c-642aa5860e45"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"NKtb8EheywMEPmA="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 3a3fd4c6610f69913daebe1ea7239b1a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD1-C1"},{"key":"X-Amz-Cf-Id","value":"WPmxPpdJZEQDL7IdZkLUkqdg7gPcCdjKtP3kj6ctoaPxeJm3K0iFzA=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"ts\": 1751603866651,\n \"args\": {\n \"url\": \"\",\n \"fw\": \"SFW003-5.2.0.zip\"\n },\n \"priority\": 0,\n \"complete_ts\": 1751604018184,\n \"rpcmethod\": \"OTA.Update\",\n \"deviceid\": \"TS2E8L2GF\",\n \"ota_status\": {\n \"progress\": 97,\n \"aws_ts\": 1751604009,\n \"state\": \"Waiting for data\",\n \"ts\": 1751604010.8\n },\n \"device_response\": \"true\",\n \"retries\": 0\n },\n {\n \"rpcmethod\": \"Config.Set\",\n \"ts\": 1751602824685,\n \"deviceid\": \"TS2E8L2GF\",\n \"args\": {\n \"config\": {\n \"endpoint\": {\n \"http\": {\n \"ssl_ca_file\": \"https_ca.pem\",\n \"ssl_client_cert_file\": null,\n \"address\": \"https://example.com/api:80\",\n \"ssl_client_key_file\": null,\n \"enable\": true,\n \"ssl_server_name\": null\n }\n }\n }\n },\n \"device_response\": \"{\\\"code\\\":0,\\\"message\\\":\\\"Success\\\"}\",\n \"priority\": 0,\n \"complete_ts\": 1751602828299,\n \"retries\": 1\n },\n {\n \"rpcmethod\": \"FS.Put\",\n \"ts\": 1751602822328,\n \"deviceid\": \"TS2E8L2GF\",\n \"args\": {\n \"data\": \"\",\n \"append\": false,\n \"filename\": \"https_ca.pem\"\n },\n \"device_response\": \"{\\\"code\\\":0,\\\"message\\\":\\\"Success\\\"}\",\n \"priority\": 0,\n \"complete_ts\": 1751602826081,\n \"retries\": 0\n },\n {\n \"rpcmethod\": \"Admin.Trigger\",\n \"ts\": 1751599227448,\n \"deviceid\": \"TS2E8L2GF\",\n \"args\": {\n \"index\": 2\n },\n \"device_response\": \"{\\\"code\\\":0,\\\"message\\\":\\\"Success\\\"}\",\n \"priority\": 0,\n \"complete_ts\": 1751599228168,\n \"retries\": 0\n },\n {\n \"rpcmethod\": \"Admin.Trigger\",\n \"ts\": 1751599181489,\n \"deviceid\": \"TS2E8L2GF\",\n \"args\": {\n \"index\": 2\n },\n \"device_response\": \"{\\\"code\\\":0,\\\"message\\\":\\\"Success\\\"}\",\n \"priority\": 0,\n \"complete_ts\": 1751599181770,\n \"retries\": 0\n },\n {\n \"rpcmethod\": \"Admin.Trigger\",\n \"ts\": 1751599130561,\n \"deviceid\": \"TS2E8L2GF\",\n \"args\": {\n \"index\": \"2\"\n },\n \"device_response\": \"{\\\"code\\\":0,\\\"message\\\":\\\"Success\\\"}\",\n \"priority\": 0,\n \"complete_ts\": 1751599130972,\n \"retries\": 0\n },\n {\n \"rpcmethod\": \"Sys.Reboot\",\n \"ts\": 1751599102459,\n \"deviceid\": \"TS2E8L2GF\",\n \"args\": {\n \"delay_ms\": 5000\n },\n \"device_response\": \"{\\\"code\\\":0,\\\"message\\\":\\\"Success\\\"}\",\n \"priority\": 0,\n \"complete_ts\": 1751599102840,\n \"retries\": 0\n },\n {\n \"rpcmethod\": \"FS.Put\",\n \"ts\": 1751599098865,\n \"deviceid\": \"TS2E8L2GF\",\n \"args\": {\n \"data\": \"\",\n \"append\": false,\n \"filename\": \"init.js\"\n },\n \"device_response\": \"{\\\"code\\\":0,\\\"message\\\":\\\"Success\\\"}\",\n \"priority\": 0,\n \"complete_ts\": 1751599099483,\n \"retries\": 0\n },\n {\n \"rpcmethod\": \"Admin.Trigger\",\n \"ts\": 1751599022511,\n \"deviceid\": \"TS2E8L2GF\",\n \"args\": {\n \"index\": \"2\"\n },\n \"device_response\": \"{\\\"code\\\":-1,\\\"message\\\":\\\"No Handler Set\\\"}\",\n \"priority\": 0,\n \"complete_ts\": 1751599022807,\n \"retries\": 0\n },\n {\n \"rpcmethod\": \"Admin.Trigger\",\n \"ts\": 1751598903671,\n \"deviceid\": \"TS2E8L2GF\",\n \"args\": {},\n \"device_response\": \"{\\\"code\\\":-1,\\\"message\\\":\\\"Trigger index required\\\"}\",\n \"priority\": 0,\n \"complete_ts\": 1751598923476,\n \"retries\": 1\n },\n {\n \"rpcmethod\": \"Admin.FreightMode\",\n \"ts\": 1751598836716,\n \"deviceid\": \"TS2E8L2GF\",\n \"args\": {},\n \"device_response\": \"{\\\"code\\\":0,\\\"message\\\":\\\"Success\\\"}\",\n \"priority\": 0,\n \"complete_ts\": 1751598837334,\n \"retries\": 0\n },\n {\n \"rpcmethod\": \"Config.Set\",\n \"ts\": 1751598791069,\n \"deviceid\": \"TS2E8L2GF\",\n \"args\": {\n \"config\": {\n \"device\": {\n \"vin\": {\n \"sleep_enable\": false\n }\n }\n }\n },\n \"device_response\": \"{\\\"code\\\":0,\\\"message\\\":\\\"Success\\\"}\",\n \"priority\": 0,\n \"complete_ts\": 1751598793004,\n \"retries\": 0\n },\n {\n \"rpcmethod\": \"Sys.Reboot\",\n \"ts\": 1751598706938,\n \"deviceid\": \"TS2E8L2GF\",\n \"args\": {\n \"delay_ms\": 5000\n },\n \"device_response\": \"{\\\"code\\\":0,\\\"message\\\":\\\"Success\\\"}\",\n \"priority\": 0,\n \"complete_ts\": 1751598707509,\n \"retries\": 0\n },\n {\n \"rpcmethod\": \"Sys.Reboot\",\n \"ts\": 1751598184312,\n \"deviceid\": \"TS2E8L2GF\",\n \"args\": {\n \"delay_ms\": 5000\n },\n \"device_response\": \"{\\\"code\\\":0,\\\"message\\\":\\\"Success\\\"}\",\n \"priority\": 0,\n \"complete_ts\": 1751598185271,\n \"retries\": 0\n },\n {\n \"rpcmethod\": \"Config.Set\",\n \"ts\": 1751596308227,\n \"deviceid\": \"TS2E8L2GF\",\n \"args\": {\n \"config\": {\n \"device\": {\n \"always_on\": true\n }\n }\n },\n \"device_response\": \"{\\\"code\\\":0,\\\"message\\\":\\\"Success\\\"}\",\n \"priority\": 0,\n \"complete_ts\": 1751596321868,\n \"retries\": 1\n }\n ],\n \"message\": \"OK\"\n}"}],"_postman_id":"0329aaf2-025e-4901-bf13-fd218e8f94a5"}],"id":"130e9097-9646-4b93-9e87-892e9e1c9cf5","_postman_id":"130e9097-9646-4b93-9e87-892e9e1c9cf5","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"API_KEY"}]},"isInherited":true,"source":{"_postman_id":"45924e2f-b898-4f77-8f3b-9895fdd31fd8","id":"45924e2f-b898-4f77-8f3b-9895fdd31fd8","name":"Senquip Cloud API Documentation","type":"collection"}}},{"name":"Script","item":[{"name":"Get Device Script","id":"689b8033-b0a0-41ee-913b-c65a5ce6233f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.senquip.com/cloud-api-v2/device/DEVICEID/script","description":"

Retrieve the script for a specific device identified by the deviceid in the path. The request does not require a request body.

It is important to note that this endpoint returns the last server-side script queued or sent to the device. It does not mean the device is currently running this script.

Required device permission level: ADMIN or USER

Request Parameters

deviceid: The identifier of the device for which the script is being retrieved.

Response

data (string): The last script sent to the device as a Base 64 encoded string.
\n
message (string): Informational status message.
\n

Update the script for a specific device identified by the deviceid. The script file given in the request is saved to the Senquip Cloud and sent to the device's command queue.

The request requires a request body.

This endpoint queues a command to be sent to the device. It will be actioned when the device is online and connected to the Senquip Portal.

Required device permission level: ADMIN or USER

Body Parameters

scriptFileBase64 (string): The Base64 encoded script file to use for the update.
\n
reboot (boolean): Optional. Queue a reboot command after the script update.
\n

Response

message (string): Informational status message.

Lock or unlock the script for a specific device identified by the deviceid. A locked script cannot be accessed by anyone except the user that created the lock.

The request requires a request body.

Required device permission level: ADMIN or USER

Body Parameters

lock (boolean): Set to true to lock the script. Set to false to unlock the script.

Response

message (string): Informational status message.

Endpoints to access or update scripting functions.

\n","_postman_id":"7cd764a6-4bb4-4527-963f-64865bbc2118","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"API_KEY"}]},"isInherited":true,"source":{"_postman_id":"45924e2f-b898-4f77-8f3b-9895fdd31fd8","id":"45924e2f-b898-4f77-8f3b-9895fdd31fd8","name":"Senquip Cloud API Documentation","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"API_KEY"}]}},"event":[{"listen":"prerequest","script":{"id":"0135e61a-a13a-4e05-9571-0777a91dbb57","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ad230af1-cd30-43a9-8e61-fafda1efe2de","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.senquip.com/cloud-api-v2"},{"key":"token","value":"API_KEY","type":"string"},{"key":"deviceid","value":"DEVICEID","type":"default"}]}