{"_id":"59c0373f1b2d07001a9d2d0c","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":"59c035e42126e10028effb12","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-18T21:08:52.843Z","from_sync":false,"order":9,"slug":"clients-api","title":"Clients API"},"user":"58cc41f21751ce2f003be3b7","__v":3,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-18T21:14:39.003Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[]},"settings":"59a74f2dcce3a7002729229b","auth":"required","params":[{"_id":"59c0373f1b2d07001a9d2d0d","ref":"","in":"query","required":true,"desc":"","default":"","type":"string","name":"ecosystemId"}],"url":"/"},"isReference":false,"order":0,"body":"# Details\n\nList clients in an ecosystem.\n\nAn account token or 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# Responses\n\n## 200\n\n```\n{\n    \"items\": [\n        {\n            \"id\": \"CLIENT-ID\",\n            \"ecosystemId\": \"ECOSYSTEM-ID\",\n            \"type\": \"CLIENT-TYPE\",\n            \"name\": \"CLIENT-NAME\",\n            \"description\": \"CLIENT-DESCRIPTION\",\n            \"createdAt\": \"YYYY-MM-DD HH:MM:SS ENCODED\"\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- __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- __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 Not Found:__ This error means that an ecosystem with the given ID was not found. This is distinct from an invalid ecosystem ID being specified; this means that the ecosystem ID once existed, but no longer does.\n\n# Examples\n\n## HTTP\n\n```\nGET https://ioe.droplit.io/api/clients?ecosystemId=ECOSYSTEM-ID HTTP/1.1\nauthorization: TOKEN\n```\n\n## Droplit Console\n\n```\ndroplit client list --ecosystemId ECOSYSTEM-ID\n```","excerpt":"","slug":"clients-list","type":"endpoint","title":"List clients in an ecosystem."}

getList clients in an ecosystem.


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

ecosystemId:
required
string

Documentation

# Details List clients in an ecosystem. An account token or 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). # Responses ## 200 ``` { "items": [ { "id": "CLIENT-ID", "ecosystemId": "ECOSYSTEM-ID", "type": "CLIENT-TYPE", "name": "CLIENT-NAME", "description": "CLIENT-DESCRIPTION", "createdAt": "YYYY-MM-DD HH:MM:SS ENCODED" } ] } ``` ## 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. - __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. - __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 Not Found:__ This error means that an ecosystem with the given ID was not found. This is distinct from an invalid ecosystem ID being specified; this means that the ecosystem ID once existed, but no longer does. # Examples ## HTTP ``` GET https://ioe.droplit.io/api/clients?ecosystemId=ECOSYSTEM-ID HTTP/1.1 authorization: TOKEN ``` ## Droplit Console ``` droplit client list --ecosystemId ECOSYSTEM-ID ```

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