{"_id":"582789acbe5c080f00a5a84e","parentDoc":null,"user":"568bdbc4fe6fcc0d006dc970","category":{"_id":"582789abbe5c080f00a5a803","__v":0,"version":"582789aabe5c080f00a5a7fe","project":"568bdc1483d2061900d86cdc","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-05T15:14:04.838Z","from_sync":false,"order":9,"slug":"something","title":"Devices"},"__v":1,"project":"568bdc1483d2061900d86cdc","version":{"_id":"582789aabe5c080f00a5a7fe","__v":10,"project":"568bdc1483d2061900d86cdc","createdAt":"2016-11-12T21:29:14.915Z","releaseDate":"2016-11-12T21:29:14.915Z","categories":["582789abbe5c080f00a5a7ff","582789abbe5c080f00a5a800","582789abbe5c080f00a5a801","582789abbe5c080f00a5a802","582789abbe5c080f00a5a803","582789abbe5c080f00a5a804","582789abbe5c080f00a5a805","582789abbe5c080f00a5a806","582789abbe5c080f00a5a807","582789abbe5c080f00a5a808","5827ea984ca29e0f00137a9e","583df597887db62f00644283","583df5d9c622791900e78da5","5845cd8763c11b250037967d","5845d13063c11b2500379681","5859e859e3306d1900126725","587aeb9a01cf3a0f008359eb","587c422af45e2d0f005e200d","587d84dc82f6f30f004ceee5"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"beta2","version_clean":"0.0.0","version":"0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-05T15:14:46.877Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": \"D573bc694ae9ac9419f028b61\",\n  \"ecosystemId\": \"C573b86eeee43dd7ba0244f8a\",\n  \"environmentId\": \"E573bb9ffd717111220812c3a\",\n  \"type\": \"virtual\",\n  \"alias\": \"dev1\",\n  \"meta\": {\n    \"$label\": \"My awesome device\"\n  },\n  \"product\": {\n    \"productName\": \"Awesome Device™\",\n    \"productType\": \"Device o’ awesome\"\n  },\n  \"createdAt\": \"2016-05-18T01:50:00.669Z\"\n}","name":""},{"status":401,"language":"text","code":""},{"language":"text","code":"","status":403},{"status":404,"language":"text","code":"Device with id D573bc694ae9ac9419f028b62 does not exist."}]},"settings":"572c39957c8eff0e00aaa18b","examples":{"codes":[{"language":"http","code":"GET https://ioe.droplit.io/api/devices/D573bc694ae9ac9419f028b61 HTTP/1.1\nauthorization: AUTH_TOKEN"},{"name":"droplit console","language":"text","code":"droplit device get D573bc694ae9ac9419f028b61"}]},"method":"get","auth":"required","params":[{"_id":"568be5be176a6c0d00a2a016","ref":"","in":"path","required":true,"desc":"[device](doc:devices) id or [alias](doc:aliases)","default":"","type":"string","name":"id"},{"_id":"58463280cdb4f10f00141606","ref":"","in":"header","required":false,"desc":"[metadata](doc:metadata) prefix","default":"$","type":"string","name":"x-system-meta-prefix"}],"url":"/device/:id"},"isReference":true,"order":2,"body":"This endpoint returns information about the specified device.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Edge Device meta\",\n  \"body\": \"Devices discovered through Edge Servers have metadata keys that are controlled by the Edge Server. These should not be written to outside of the Edge Server as they may be overridden at any time.\\n\\nMore information: [device meta](https://docs.droplit.io/v0/docs/creating-plugins#section-devicemeta)\"\n}\n[/block]","excerpt":"Get device info","slug":"read-devices","type":"endpoint","title":"Read"}

getRead

Get device info

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
[device](doc:devices) id or [alias](doc:aliases)

Headers

x-system-meta-prefix:
string$
[metadata](doc:metadata) prefix

Examples


Result Format


Documentation

This endpoint returns information about the specified device. [block:callout] { "type": "info", "title": "Edge Device meta", "body": "Devices discovered through Edge Servers have metadata keys that are controlled by the Edge Server. These should not be written to outside of the Edge Server as they may be overridden at any time.\n\nMore information: [device meta](https://docs.droplit.io/v0/docs/creating-plugins#section-devicemeta)" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}