Syrus 4 API Postman documentation.
\nBe sure to use the Postman Desktop Agent when making the requests (you can select the agent on the bottom right section of the Postman app).
\nNote that the GET requests don't require authentication, but POST requests do require Basic Auth.
\nFor more information head to https://syrus.digitalcomtech.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"389172","collectionId":"851524d7-d034-4c2e-b07c-5826927cabf7","publishedId":"UVC9gkAd","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"005596"},"publishDate":"2021-11-15T20:43:28.000Z"},"item":[{"name":"Accelerometer","item":[{"name":"Get configuration","id":"73b9e755-3413-42a1-879e-22b0d3c123d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Returns the current state of the accelerometer.
\nResponse fields
\nNote that the fields that begin with CFG_ require that the self_alignment procedure be completed.
Starts the auto alignment procedure.
\nThe alignment process can be summarized as follow:
\nCurrent state of the calibration/self alignment procedure
\n","urlObject":{"protocol":"http","path":["accel","isAutoAligning"],"host":["syrus-867698040023056","local"],"query":[],"variable":[]}},"response":[],"_postman_id":"4e1a8145-7c4e-4606-83cb-e37234f7f35b"}],"id":"45f03154-bdd6-48b3-85a5-d317fc0678db","description":"Accelerometer related information.
\n","_postman_id":"45f03154-bdd6-48b3-85a5-d317fc0678db","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Application manager.
\n","_postman_id":"32704734-96eb-4949-b299-966148704d3b","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Returns the status of the device's inputs/outputs
\n","urlObject":{"protocol":"http","path":["io","all"],"host":["syrus-867698040023056","local"],"query":[],"variable":[]}},"response":[{"id":"f7920b43-862c-455b-8bac-a72c430bbfd9","name":"Success","originalRequest":{"method":"GET","header":[],"url":"http://syrus-867698040023056.local/io/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"MOT\": false,\n \"IGN\": true,\n \"IN1\": false,\n \"IN2\": false,\n \"IN3\": false,\n \"IN4\": false,\n \"IN5\": false,\n \"IN6\": false,\n \"IN7\": false,\n \"PWR\": true,\n \"SO1\": false,\n \"SO2\": false,\n \"SO3\": false,\n \"SO4\": false,\n \"TIG\": false,\n \"OUT1\": false,\n \"OUT2\": false,\n \"OUT3\": false,\n \"OUT4\": false,\n \"BAT\": 4.051,\n \"AN1\": 0,\n \"AN2\": 0,\n \"DAN\": 0\n}"}],"_postman_id":"848a4ce4-d19c-48a3-bb36-0e96cf764b48"},{"name":"Activate/deactivate output","id":"f956406b-6be3-4e96-86ef-2115d662f625","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Manage the device's outputs. \nThere are 4 possible outputs.
\nout1 out2 out3 and out4
Output to activate, can be out1, out2, out3, or out4
\n","type":"text/plain"},"type":"any","value":"out1","key":"output"},{"description":{"content":"Boolean, true to activate, false to deactivate
\n","type":"text/plain"},"type":"any","value":"true","key":"state"}]}},"response":[],"_postman_id":"f956406b-6be3-4e96-86ef-2115d662f625"}],"id":"8e91892f-a9f8-4579-8d69-d1deeb13d8ea","description":"Device's inputs/outputs info.
\n","_postman_id":"8e91892f-a9f8-4579-8d69-d1deeb13d8ea","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Returns json data about GNSS/GPS location information
\n","urlObject":{"protocol":"http","path":["gps","position"],"host":["syrus-867698040023056","local"],"query":[],"variable":[]}},"response":[{"id":"c4a8d3d1-e077-4c1f-9c38-c3d77a683930","name":"Success","originalRequest":{"method":"GET","header":[],"url":"http://syrus-867698040023056.local/gps/position"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"263"},{"key":"ETag","value":"W/\"107-z+AF7GY8CzB4XFjpY61JRGbeFpM\""},{"key":"Date","value":"Fri, 12 Nov 2021 20:26:23 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"coords\": {\n \"latitude\": 25.782976,\n \"longitude\": -80.293276,\n \"speed\": 0.272777996,\n \"accuracy\": 3.75,\n \"altitude\": 32.229,\n \"bearing\": 190.83,\n \"altitudeAccuracy\": 5.5\n },\n \"timestamp\": 1636748782,\n \"extras\": {\n \"hdop\": 0.75,\n \"vdop\": 1.1,\n \"pdop\": 1.33,\n \"fix\": 3,\n \"satsActive\": 11,\n \"criteria\": \"signal\"\n }\n}"}],"_postman_id":"500735b8-bdf9-4c26-9e28-2302241ec4cf"},{"name":"Get location Copy","id":"30b18a9e-8a33-406e-aa9e-a50bb94c4ac2","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true,"host":true}},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"http://syrus-867698040023056.local/gps/position","description":"Returns json data about GNSS/GPS location information
\n","urlObject":{"protocol":"http","path":["gps","position"],"host":["syrus-867698040023056","local"],"query":[],"variable":[]}},"response":[{"id":"5bc115f1-50c7-4c81-ad2c-f21b0b2930d6","name":"Success","originalRequest":{"method":"GET","header":[],"url":"http://syrus-867698040023056.local/gps/position"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"263"},{"key":"ETag","value":"W/\"107-z+AF7GY8CzB4XFjpY61JRGbeFpM\""},{"key":"Date","value":"Fri, 12 Nov 2021 20:26:23 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"coords\": {\n \"latitude\": 25.782976,\n \"longitude\": -80.293276,\n \"speed\": 0.272777996,\n \"accuracy\": 3.75,\n \"altitude\": 32.229,\n \"bearing\": 190.83,\n \"altitudeAccuracy\": 5.5\n },\n \"timestamp\": 1636748782,\n \"extras\": {\n \"hdop\": 0.75,\n \"vdop\": 1.1,\n \"pdop\": 1.33,\n \"fix\": 3,\n \"satsActive\": 11,\n \"criteria\": \"signal\"\n }\n}"}],"_postman_id":"30b18a9e-8a33-406e-aa9e-a50bb94c4ac2"}],"id":"5c12ebe5-26fe-4fb3-8fe6-eeaff7de07a1","description":"GNSS/GPS information.
\n","_postman_id":"5c12ebe5-26fe-4fb3-8fe6-eeaff7de07a1","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Set ethernet configuration method, whether to obtain its IP address automatically or configure it manually.
\n","urlObject":{"protocol":"http","path":["ethernet","setconfiguration"],"host":["syrus-867698040023056","local"],"query":[],"variable":[]}},"response":[],"_postman_id":"9da0191f-ce4d-4844-a220-2ff099dd88fe"},{"name":"Set ethernet routing","id":"3b538ac0-ecc1-485e-9cc0-b750955ccf6b","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true,"host":true}},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Use this option for forwarding the ethernet traffic to another interface, it allows you to have internet access by specifying the output interface.
\n","urlObject":{"protocol":"http","path":["ethernet","routing"],"host":["syrus-867698040023056","local"],"query":[],"variable":[]}},"response":[{"id":"69e19070-72ee-44f7-9360-e072010b3190","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"option\": \"wlan0\"\n}","options":{"raw":{"language":"json"}}},"url":"http://syrus-867698040023056.local/ethernet/routing"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"32"},{"key":"ETag","value":"W/\"20-X7+F2Wh9FVQ5FHvoXhRD8uaOnns\""},{"key":"Date","value":"Fri, 12 Nov 2021 21:46:53 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"option\": \"wlan0\"\n}"}],"_postman_id":"3b538ac0-ecc1-485e-9cc0-b750955ccf6b"},{"name":"Wifi state","id":"bca75ceb-771c-4dfa-a2c3-491c667a4ce9","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true,"host":true}},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"http://syrus-867698040023056.local/wifi/state","description":"Returns the state of the wifi.
\n","urlObject":{"protocol":"http","path":["wifi","state"],"host":["syrus-867698040023056","local"],"query":[],"variable":[]}},"response":[{"id":"e5066317-582c-4e7d-93c7-204597510774","name":"Success","originalRequest":{"method":"GET","header":[],"url":"http://syrus-867698040023056.local/wifi/state"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"mac\": \"50:33:8B:D8:07:D2\",\n \"state\": \"completed\",\n \"ssid\": \"DCTWIFI\",\n \"signal\": \"-40\",\n \"key_mgmt\": \"WPA2-PSK\",\n \"ip\": \"192.168.1.158\",\n \"rx_bytes\": \"168522524\",\n \"tx_bytes\": \"88410556\"\n}"}],"_postman_id":"bca75ceb-771c-4dfa-a2c3-491c667a4ce9"},{"name":"Wifi start","id":"f017eca1-eb79-4e82-93d3-671481683b95","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true,"host":true}},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"http://syrus-867698040023056.local/wifi/start","description":"Enables the wifi interface on the device.
\n","urlObject":{"protocol":"http","path":["wifi","start"],"host":["syrus-867698040023056","local"],"query":[],"variable":[]}},"response":[],"_postman_id":"f017eca1-eb79-4e82-93d3-671481683b95"},{"name":"Wifi stop","id":"ff2b43aa-a9ba-451e-8436-99e5768c161b","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true,"host":true}},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"http://syrus-867698040023056.local/wifi/stop","description":"Stops the wifi interface
\n","urlObject":{"protocol":"http","path":["wifi","stop"],"host":["syrus-867698040023056","local"],"query":[],"variable":[]}},"response":[],"_postman_id":"ff2b43aa-a9ba-451e-8436-99e5768c161b"},{"name":"Wifi scan","id":"13416e2d-1477-4f87-995b-b37ba28e0762","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true,"host":true}},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"http://syrus-867698040023056.local/wifi/scan","description":"Scan available wireless networks. Note that the Syrus4G only supports 2.4GHz networks.
\n","urlObject":{"protocol":"http","path":["wifi","scan"],"host":["syrus-867698040023056","local"],"query":[],"variable":[]}},"response":[{"id":"2ba8494f-2d49-40d9-8efd-ae010fdc7af0","name":"Success","originalRequest":{"method":"GET","header":[],"url":"http://syrus-867698040023056.local/wifi/scan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"nets\": [\n {\n \"ssid\": \"DCTWIFI2G\",\n \"signal\": -42,\n \"auth\": \"PSK\"\n },\n {\n \"ssid\": \"WTC.Miami.WiFi\",\n \"signal\": -50,\n \"auth\": \"PSK\"\n },\n {\n \"ssid\": \"Syrus4G\",\n \"signal\": -44,\n \"auth\": \"PSK\"\n },\n {\n \"ssid\": \"oneConnect\",\n \"signal\": -57,\n \"auth\": \"IEEE\"\n },\n {\n \"ssid\": \"oneConnect-Guest\",\n \"signal\": -57,\n \"auth\": \"\"\n },\n {\n \"ssid\": \"FS-WiFi-503cc103\",\n \"signal\": -63,\n \"auth\": \"PSK\"\n },\n {\n \"ssid\": \"hotspotlab\",\n \"signal\": -50,\n \"auth\": \"PSK\"\n },\n {\n \"ssid\": \"ATT3JT9fMS\",\n \"signal\": -65,\n \"auth\": \"PSK\"\n }\n ]\n}"}],"_postman_id":"13416e2d-1477-4f87-995b-b37ba28e0762"},{"name":"Wifi list saved networks","id":"31ce44b0-ed6d-48a7-b6c1-4a10786c9838","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true,"host":true}},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"http://syrus-867698040023056.local/wifi/list","description":"Lists saved networks.
\n","urlObject":{"protocol":"http","path":["wifi","list"],"host":["syrus-867698040023056","local"],"query":[],"variable":[]}},"response":[{"id":"0c87a828-2111-43bc-94f7-a6bf92713eea","name":"Success","originalRequest":{"method":"GET","header":[],"url":"http://syrus-867698040023056.local/wifi/state"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"ssids\": [\n \"syrus\",\n \"DCTWIFI\",\n \"myWorkWifi 5G\"\n ]\n}"}],"_postman_id":"31ce44b0-ed6d-48a7-b6c1-4a10786c9838"},{"name":"Wifi add network","id":"10b9144b-9e9b-495f-969f-932d17f842e8","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true,"host":true}},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Add a wifi with the SSID and Password
\n","urlObject":{"protocol":"http","path":["wifi","add"],"host":["syrus-867698040023056","local"],"query":[],"variable":[]}},"response":[{"id":"00b0ad7a-b746-4176-b346-9a8c2a955f59","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"ssid\": \"work wifi\",\n \"pass\": \"password\"\n}","options":{"raw":{"language":"json"}}},"url":"http://syrus-867698040023056.local/wifi/add"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Saved network\", \n \"data\": \"\"\n}"}],"_postman_id":"10b9144b-9e9b-495f-969f-932d17f842e8"},{"name":"Wifi remove network","id":"25c4eab0-e827-462f-baca-4c760f5f57ed","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true,"host":true}},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Add a wifi with the SSID and Password
\n","urlObject":{"protocol":"http","path":["wifi","remove",":ssid"],"host":["syrus-867698040023056","local"],"query":[],"variable":[{"description":{"content":"Saved wifi network to remove
\n","type":"text/plain"},"type":"any","value":"myWorkWifi%202G","key":"ssid"}]}},"response":[],"_postman_id":"25c4eab0-e827-462f-baca-4c760f5f57ed"}],"id":"7c6abb5f-49ef-42e1-b66f-e8ad33b66809","description":"Network related APIs.
\n","_postman_id":"7c6abb5f-49ef-42e1-b66f-e8ad33b66809","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Checks if there's an update available. \nThe possible responses are
\n\n\n\"Up To Date\"
\n
\n\n\"Update available\"
\n
\n\n\"Update in progress. This will take a few minutes\"
\n
\n\n\"Successfully updated. Device will be restarted in any moment\"
\n
\n\n\"Error getting file. Try again\"
\n
If there is an update available you can use the /exec api to send the following command:
\nPOST /exec
\n{\n \"command\": \"apx-os-update start\"\n}\nGeneral system information.
\n","_postman_id":"70073c14-78db-4465-80dd-fa1340ac2946","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Returns the version of the API.
\n","urlObject":{"protocol":"http","path":["system-info","api-version"],"host":["syrus-867698040023056","local"],"query":[],"variable":[]}},"response":[{"id":"c3b33e48-97fc-4ee9-a1fc-732fc8e3d3fa","name":"Success","originalRequest":{"method":"GET","header":[],"url":"http://syrus-867698040023056.local/system-info/api-version"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"39"},{"key":"ETag","value":"W/\"27-Mutp2fpq65EQFfYBJ9hQXMBqA/c\""},{"key":"Date","value":"Fri, 12 Nov 2021 20:34:11 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"syrus-api\",\n \"version\": \"1.13.6\"\n}"}],"_postman_id":"7cc876e7-979a-4456-98ec-c6f3bd4e0237"},{"name":"Check user","id":"f50f5186-76a8-4d88-9614-be7ea6ae3a71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"syrus4g\",\n \"password\": \"123456\"\n}","options":{"raw":{"language":"json"}}},"url":"http://syrus-867698040023056.local/auth/login","description":"Login method that returns a token that can be used for subsequent POST requests.
\n","urlObject":{"protocol":"http","path":["auth","login"],"host":["syrus-867698040023056","local"],"query":[],"variable":[]}},"response":[{"id":"1cf3a5f6-3ed3-4f11-bb61-0ae3a8d2d41d","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"syrus4g\",\n \"password\": \"123456\"\n}","options":{"raw":{"language":"json"}}},"url":"http://syrus-867698040023056.local/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"27"},{"key":"ETag","value":"W/\"1b-FupJkx4b2zQBKaoCJLdNSFyBhWA\""},{"key":"Date","value":"Fri, 12 Nov 2021 20:28:25 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"user\": {\n \"name\": \"syrus4g\"\n }\n}"},{"id":"3ed0b82c-25e7-4ace-b45b-cf7d4a5074d4","name":"Invalid user or pass","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"syrus4g\",\n \"password\": \"12345\"\n}","options":{"raw":{"language":"json"}}},"url":"http://syrus-867698040023056.local/auth/login"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"232"},{"key":"ETag","value":"W/\"e8-qG24t3VdQPMcKx7/g1inLTm2Dx0\""},{"key":"Date","value":"Fri, 12 Nov 2021 20:29:49 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"command\": \"sudo apx-user checkuser \\\"syrus4g\\\" \\\"12345\\\"\",\n \"error\": {\n \"killed\": false,\n \"code\": 1,\n \"signal\": null,\n \"cmd\": \"sudo apx-user checkuser \\\"syrus4g\\\" \\\"12345\\\"\"\n },\n \"errorText\": \"\",\n \"output\": \"\\\"Invalid Username or Password\\\"\\n\"\n }\n}"}],"_postman_id":"f50f5186-76a8-4d88-9614-be7ea6ae3a71"},{"name":"Execute a command","id":"62552210-dab5-4a99-97b3-6cd0dd67af0f","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true,"host":true}},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Executes a command via the shell and returns the result.\nYou can use it to send some linux commands and all apx- commands. Note that you don't need to use sudo.