{"_id":"59c2fbae185f99001034d25b","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":19,"createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"59c2fb00b2b45c0010b7a3d7","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-20T23:34:24.298Z","from_sync":false,"order":12,"slug":"environments-api","title":"Environments API"},"user":"58cc41f21751ce2f003be3b7","__v":5,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-20T23:37:18.175Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[]},"settings":"59a75f6e757d030019b85f83","auth":"required","params":[{"_id":"59c2fbae185f99001034d25c","ref":"","in":"query","required":true,"desc":"The ID of the ecosystem.","default":"","type":"string","name":"ecosystemId"},{"_id":"59e7b9b8d099830024aa0444","ref":"","in":"query","required":false,"desc":"Filter environment to the matching edge id","default":"","type":"string","name":"edgeId"}],"url":"/"},"isReference":false,"order":0,"body":"# Details\n\nList environments in an ecosystem.\n\nA server token may be used to run this endpoint.\n\n# Parameters\n\n## query\n\n- ecosystemId (required): The ID of the [ecosystem](https://docs.droplit.io/docs/containers#section-ecosystems).\n\n- edgeId: Filter environment to the matching edge id.\n\n## header\n\n- x-system-metadata-prefix (optional): A customized [metadata](https://docs.droplit.io/docs/metadata) prefix. The default is “$.”\n\n# Responses\n\n## 200\n\n```\n{\n    \"items\": [\n        {\n            \"createdAt\": \"YYYY-MM-DD HH:MM:SS ENCODED\",\n            \"ecosystemId\": \"ECOSYSTEM-ID\",\n            \"id\": \"ENVIRONMENT-ID\",\n            \"meta\": {}\n        }\n    ]\n}\n```\n\n## 400\n\n- __Ecosystem Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID linked to the parameter that designates the ecosystem ID. In this context, it means that the ID given for an ecosystem was not valid.\n- __Query Field Not Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that one or more query string fields are incorrect. They do not match the name(s) of the query string field(s) that are allowed for this endpoint.\n\n## 404\n\n- __Ecosystem Missing:__ The standard error structure defines this error as both an invalid parameter name and a missing parameter. In this context, it means that the parameter which is used to specify an ecosystem ID is not present.\n\n# Examples\n\n## HTTP\n\n```\nGET https://ioe.droplit.io/api/environments HTTP/1.1\nauthorization: TOKEN\n```\n\n## Droplit Console\n\n```\ndroplit environment list\n```","excerpt":"","slug":"environments-list","type":"endpoint","title":"List environments in an ecosystem."}

getList environments in an ecosystem.


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

ecosystemId:
required
string
The ID of the ecosystem.
edgeId:
string
Filter environment to the matching edge id

Documentation

# Details List environments in an ecosystem. A server token may be used to run this endpoint. # Parameters ## query - ecosystemId (required): The ID of the [ecosystem](https://docs.droplit.io/docs/containers#section-ecosystems). - edgeId: Filter environment to the matching edge id. ## header - x-system-metadata-prefix (optional): A customized [metadata](https://docs.droplit.io/docs/metadata) prefix. The default is “$.” # Responses ## 200 ``` { "items": [ { "createdAt": "YYYY-MM-DD HH:MM:SS ENCODED", "ecosystemId": "ECOSYSTEM-ID", "id": "ENVIRONMENT-ID", "meta": {} } ] } ``` ## 400 - __Ecosystem Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID linked to the parameter that designates the ecosystem ID. In this context, it means that the ID given for an ecosystem was not valid. - __Query Field Not Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that one or more query string fields are incorrect. They do not match the name(s) of the query string field(s) that are allowed for this endpoint. ## 404 - __Ecosystem Missing:__ The standard error structure defines this error as both an invalid parameter name and a missing parameter. In this context, it means that the parameter which is used to specify an ecosystem ID is not present. # Examples ## HTTP ``` GET https://ioe.droplit.io/api/environments HTTP/1.1 authorization: TOKEN ``` ## Droplit Console ``` droplit environment list ```

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