{"_id":"582789abbe5c080f00a5a838","category":{"_id":"582789abbe5c080f00a5a802","__v":0,"version":"582789aabe5c080f00a5a7fe","project":"568bdc1483d2061900d86cdc","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-16T07:43:25.407Z","from_sync":false,"order":11,"slug":"environment-api","title":"Environments"},"user":"568bdbc4fe6fcc0d006dc970","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","__v":1,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-16T07:44:29.116Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"http","code":"GET https://ioe.droplit.io/api/environments?ecosystemId=C573b86eeee43dd7ba0244f8a HTTP/1.1\nauthorization: AUTH_TOKEN"},{"name":"droplit console","language":"text","code":"droplit environment list"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"items\": [\n    {\n      \"id\": \"E573bb9ffd717111220812c3a\",\n      \"ecosystemId\": \"C573b86eeee43dd7ba0244f8a\",\n      \"meta\":{\n        \"$label\": \"Sample Environment\"\n      },\n      \"createdAt\": \"2016-05-18T00:41:03.208Z\"\n    }\n  ]\n}","language":"json","status":200},{"status":400,"language":"json","code":"{\n  \"errorType\": \"InvalidParams\",\n  \"errors\": [\n    {\n      \"in\": \"query\",\n      \"message\": \"invalid id\",\n      \"path\": \"ecosystemId\"\n    }\n  ]\n}"},{"code":"","status":401,"language":"text"},{"language":"text","code":"","status":403},{"status":404,"language":"text","code":"Ecosystem with id C573b86eeee43dd7ba0244f8b does not exist."}]},"settings":"572c39957c8eff0e00aaa18b","auth":"required","params":[{"_id":"572c4188beb99b2000ab4ffd","ref":"","in":"path","required":true,"desc":"parent [ecosystem](doc:ecosystems) id","default":"","type":"string","name":"ecosystemId"},{"_id":"58464912c42d272300def6f4","ref":"","in":"header","required":false,"desc":"[metadata](doc:metadata) prefix","default":"$","type":"string","name":"x-system-meta-prefix"}],"url":"/environments?ecosystemId=:ecosystemId"},"isReference":true,"order":0,"body":"You can use this endpoint to list the environments contained in an ecosystem. Each item contains basic information for an environment.","excerpt":"List all environments","slug":"list-environments","type":"endpoint","title":"List"}

getList

List all environments

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ecosystemId:
required
string
parent [ecosystem](doc:ecosystems) id

Headers

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

Examples


Result Format


Documentation

You can use this endpoint to list the environments contained in an ecosystem. Each item contains basic information for 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 }}