{"_id":"582789acbe5c080f00a5a84c","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"},"parentDoc":null,"project":"568bdc1483d2061900d86cdc","user":"568bdbc4fe6fcc0d006dc970","__v":1,"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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-16T07:23:14.192Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"http","code":"GET https://ioe.droplit.io/api/devices?environmentId=E573bb9ffd717111220812c3a HTTP/1.1\nauthorization: AUTH_TOKEN"},{"name":"droplit console","language":"text","code":"droplit device list"}]},"method":"get","results":{"codes":[{"status":200,"name":"","code":"{\n  \"items\":[\n    {\n      \"id\": \"D573bc694ae9ac9419f028b61\",\n      \"ecosystemId\": \"C573b86eeee43dd7ba0244f8a\",\n      \"environmentId\": \"E573bb9ffd717111220812c3a\",\n      \"type\": \"virtual\",\n      \"meta\": {},\n      \"createdAt\": \"2016-05-18T01:32:57.958Z\"\n    }\n  ]\n}","language":"json"},{"language":"json","code":"{\n  \"errorType\": \"InvalidParams\",\n  \"errors\": [\n    {\n      \"in\": \"query\",\n      \"message\": \"invalid id\",\n      \"path\": \"environmentId\"\n    }\n  ]\n}","status":400},{"status":401,"language":"text","code":""},{"status":403,"language":"text","code":""},{"code":"Environment with id E573bb9ffd717111220812c3b does not exist.","status":404,"language":"text"}]},"settings":"572c39957c8eff0e00aaa18b","auth":"required","params":[{"_id":"57309c2d41186a2b00549b38","ref":"","in":"path","required":true,"desc":"parent [environment](doc:environments) id or environment [alias](doc:aliases)","default":"","type":"string","name":"environmentId"},{"_id":"584631f30cd3b80f00aeacf1","ref":"","in":"header","required":false,"desc":"[metadata](doc:metadata) prefix","default":"$","type":"string","name":"x-system-meta-prefix"}],"url":"/devices?environmentId=:environmentId"},"isReference":true,"order":0,"body":"List the devices contained in an environment.","excerpt":"List all devices in an environment","slug":"list-devices","type":"endpoint","title":"List"}

getList

List all devices in an environment

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

environmentId:
required
string
parent [environment](doc:environments) id or environment [alias](doc:aliases)

Headers

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

Examples


Result Format


Documentation

List the devices contained in an environment.

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