{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/","auth":"required","settings":"59a75f6e757d030019b85f83","results":{"codes":[{"name":"","code":"{\n    \"items\": [\n        {\n            \"id\": \"E59e347bcaa0961c9631d6da1\",\n            \"ecosystemId\": \"C599343aecca8fba8297a3195\",\n            \"meta\": {\n                \"$label\": \"Production Hub\"\n            },\n            \"createdAt\": \"2017-06-16T03:08:44.404Z\",\n            \"edgeIds\": [\n                \"b3:2b:e3:5a:08:21\"\n            ]\n        }\n    ]\n}","language":"json","status":200},{"status":400,"name":"Ecosystem Invalid","language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"query\",\n            \"path\": \"ecosystemId\",\n            \"message\": \"invalid id\"\n        }\n    ]\n}"},{"status":400,"name":"Filter Invalid","language":"json","code":"{\n    \"errorType\": \"InvalidBody\",\n    \"errors\": [\n        {\n            \"path\": \"query\",\n            \"message\": \"Invalid input 'invalid' from filter 'invalid'. Expected 'AND','OR','NOR','NOT','EQUALS','NOTEQUALS','LESSTHAN','LESSTHANOREQUAL','GREATERTHAN','GREATERTHANOREQUAL','IN','NOTIN','TYPE','EXISTS','NOTEXISTS','CONTAINS','NCONTAINS' after ''\"\n        }\n    ]\n}"},{"status":404,"name":"Ecosystem Not Found","language":"text","code":"Ecosystem with id C59b343ae9ca1fbc8287a3196 does not exist."}]},"examples":{"codes":[{"code":"GET https://ioe.droplit.io/api/environments/?ecosystemId=C599343aecca8fba8297a3195 HTTP/1.1\nauthorization: AUTH_TOKEN","language":"http"},{"name":"Console","language":"text","code":"droplit environment list"},{"name":"Droplit SDK","language":"javascript","code":"droplit.environments.list(\"C599343aecca8fba8297a3195\", 'eq(meta.$label, \"Production Hub\")');"}]},"method":"get","params":[{"name":"ecosystemId","type":"string","default":"","desc":"The ID of the ecosystem.","required":true,"in":"query","ref":"","_id":"59c2fbae185f99001034d25c"},{"name":"edgeId","type":"string","default":"","desc":"Get only environments with a particular edgeId.","required":false,"in":"query","ref":"","_id":"59e7b9b8d099830024aa0444"},{"name":"filter","type":"string","default":"","desc":"Get only environments whose properties fulfill the conditions of a [filter](doc:filters).","required":false,"in":"query","ref":"","_id":"5b5b4239faf2c40003dbccfc"},{"name":"authorization","type":"string","default":"","desc":"The user's authorization token.","required":true,"in":"header","ref":"","_id":"5b5b4399faf2c40003dbcd08"},{"name":"x-system-metadata-prefix","type":"string","default":"$","desc":"Allows for a metadata prefix other than the default.","required":false,"in":"header","ref":"","_id":"5b5b4399faf2c40003dbcd07"}]},"next":{"description":"","pages":[]},"title":"List environments.","type":"endpoint","slug":"environments-list","excerpt":"Get all the environments in an ecosystem.","body":"A server or user token may be used to run this endpoint.","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b5b4045b22ba300037b3e15","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":"Environments API","slug":"environments-api","order":21,"from_sync":false,"reference":false,"_id":"59c2fb00b2b45c0010b7a3d7","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","createdAt":"2017-09-20T23:34:24.298Z","__v":0},"user":"5a6a26281895510045b2cd40","createdAt":"2018-07-27T15:54:45.303Z","githubsync":"","__v":7,"parentDoc":null}

getList environments.

Get all the environments in an ecosystem.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

ecosystemId:
required
string
The ID of the ecosystem.
edgeId:
string
Get only environments with a particular edgeId.
filter:
string
Get only environments whose properties fulfill the conditions of a [filter](doc:filters).

Headers

authorization:
required
string
The user's authorization token.
x-system-metadata-prefix:
string$
Allows for a metadata prefix other than the default.

Examples


Result Format


Documentation

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