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.

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

Droplit SDK

droplit.clients.list("ECOSYSTEM-ID");