{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/:id","auth":"required","method":"get","examples":{"codes":[{"name":"without 'expand'","language":"http","code":"GET https://ioe.droplit.io/api/devices/D5a22e634e44f8cd804132f27 HTTP/1.1\nauthorization: AUTH_TOKEN"},{"name":"with 'expand'","language":"http","code":"GET https://ioe.droplit.io/api/devices/D5a22e634e44f8cd804132f27?expand=ServiceProperties HTTP/1.1\nauthorization: AUTH_TOKEN"},{"name":"console","language":"text","code":"droplit device info D5a22e634e44f8cd804132f27"},{"name":"Droplit SDK","language":"javascript","code":"droplit.devices.info(\"D5a22e634e44f8cd804132f27\");"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"id\": \"D5a22e634e44f8cd804132f27\",\n    \"ecosystemId\": \"C59eb8eae278b6bf402e39d25\",\n    \"environmentId\": \"E598b82ae288b6ff4a2e89d22\",\n    \"type\": \"virtual\",\n    \"alias\": \"Light\",\n    \"meta\": {\n        \"$label\": \"Light\"\n    },\n    \"label\": \"Light\",\n    \"services\": [\n        \"BinarySwitch\"\n    ],\n    \"createdAt\": \"2018-08-01T23:23:53.512Z\"\n}","name":"without 'expand'"},{"status":200,"language":"json","code":"{\n    \"id\": \"D5b624109def4f50ca4a7be08\",\n    \"ecosystemId\": \"C59434aae4ca2fb182b7af191\",\n    \"environmentId\": \"E5b623bb9def4f50ca4a7bd7e\",\n    \"type\": \"virtual\",\n    \"alias\": \"Light\",\n    \"meta\": {\n        \"$label\": \"Light\"\n    },\n    \"label\": \"Light\",\n    \"services\": [\n        \"BinarySwitch\"\n    ],\n    \"serviceProperties\": {\n        \"BinarySwitch\": {\n            \"0\": {\n                \"switch\": \"off\"\n            }\n        }\n    },\n    \"createdAt\": \"2018-08-01T23:23:53.512Z\"\n}","name":"with 'expand'"},{"name":"Device Invalid","status":400,"language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"path\",\n            \"path\": \"id\",\n            \"message\": \"invalid id\"\n        }\n    ]\n}"},{"status":400,"name":"Expand Parameter Invalid","language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"query\",\n            \"path\": \"expand/0\",\n            \"message\": \"value 'invalid' is not defined in enum\"\n        }\n    ]\n}"},{"status":404,"name":"Device Not Found","language":"text","code":"Device with id D5be247091efcf59ca4a78e01 does not exist."}]},"settings":"59a750fbd61777001b6c47ed","params":[{"name":"id","type":"string","default":"","desc":"The ID of the desired device.","required":true,"in":"path","ref":"","_id":"59c08604a00f90001cd75dc3"},{"name":"expand","type":"string","default":"","desc":"Expand either the devices' service properties by setting to \"ServiceProperties\".","required":false,"in":"query","ref":"","_id":"5b8848e7f991b60003519cb5"},{"name":"authorization","type":"string","default":"","desc":"The user's authorization token.","required":true,"in":"header","ref":"","_id":"5b8848e7f991b60003519cb4"}]},"next":{"description":"","pages":[]},"title":"Get a device.","type":"endpoint","slug":"devices-info","excerpt":"List the information of a particular device.","body":"An account token, server token, or user token may be used to run this endpoint.","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"59c08604a00f90001cd75dc2","project":"568bdc1483d2061900d86cdc","version":{"version":"0","version_clean":"0.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255","59f76fef8581dc0010593e6f","5a0c003680a35b0012c35db0","5a8358722e78660075e45f42","5a846645b5ec3a001203517e","5b258091bc7a6700033b9cb5","5b26e48e024807000315a740","5b44edff3306680003663f5c","5b468abd3d4a9e0003789111","5b468d8f3dcb6a0003c6e374","5b47b0b93d4a9e000378a33a","5b538d114ea24f00033c726f","5b6a0efe402b32000336c33f","5bba5e5d7ba7710003bd902a","5bc2703349ac3a0013eec3e5","5c351061191e2b002b4988a8","5c8b01b199b56e00440aa018"],"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","__v":35},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Devices API","slug":"devices-api","order":19,"from_sync":false,"reference":false,"_id":"59c06c40df5b3c0010584a13","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","createdAt":"2017-09-19T01:00:48.384Z","__v":0},"user":"58cc41f21751ce2f003be3b7","createdAt":"2017-09-19T02:50:44.320Z","githubsync":"","__v":7,"parentDoc":null}

getGet a device.

List the information of a particular device.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the desired device.

Query Params

expand:
string
Expand either the devices' service properties by setting to "ServiceProperties".

Headers

authorization:
required
string
The user's authorization token.

Examples


Result Format


Documentation

An account token, server token, or user token may be used to run this endpoint.

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 }}