{"_id":"582789abbe5c080f00a5a82e","__v":0,"category":{"_id":"582789abbe5c080f00a5a806","version":"582789aabe5c080f00a5a7fe","project":"568bdc1483d2061900d86cdc","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-17T20:31:36.079Z","from_sync":false,"order":8,"slug":"clients","title":"Clients"},"user":"573b7f42fdc9d320001b777d","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","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-31T01:37:09.777Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"http","code":"POST https://ioe.droplit.io/api/clients HTTP/1.1\nauthorization: AUTH_TOKEN\ncontent-type: application/json\n\n{\n  \"ecosystemId\": \"C573b86eeee43dd7ba0244f8a\",\n  \"type\": \"server\",\n  \"name\": \"test client\",\n  \"description\": \"a client created to test the ability to create clients\"\n}"}]},"method":"post","results":{"codes":[{"status":201,"language":"json","code":"{\n  \"id\": \"L574cea940ac9f7726607b96a\",\n  \"ecosystemId\": \"C573b86eeee43dd7ba0244f8a\",\n  \"type\": \"server\",\n  \"name\": \"test client\",\n  \"description\": \"a client created to test the ability to create clients\",\n  \"createdAt\": \"2016-05-31T01:34:48.172Z\"\n}","name":""},{"name":"","status":400,"language":"json","code":"{\n  \"errorType\": \"InvalidParams\",\n  \"errors\": [\n    {\n      \"in\": \"body\",\n      \"message\": \"field is required\",\n      \"path\": \"ecosystemId\"\n    }\n  ]\n}"},{"status":401,"language":"text","code":""},{"status":403,"language":"text","code":""},{"language":"text","code":"Ecosystem with id C573b86eeee43dd7ba0244f8b does not exist.","status":404}]},"settings":"572c39957c8eff0e00aaa18b","auth":"required","params":[{"_id":"574ceac5cf99610e00ef7f6c","ref":"","in":"body","required":true,"desc":"parent [ecosystem](doc:ecosystems) Id","default":"","type":"string","name":"ecosystemId"},{"_id":"574ceac5cf99610e00ef7f6b","ref":"","in":"body","required":true,"desc":"the type of client (_application_ or _server_)","default":"","type":"string","name":"type"},{"_id":"574ceac5cf99610e00ef7f6a","ref":"","in":"body","required":false,"desc":"a name for the client","default":"","type":"string","name":"name"},{"_id":"574ceac5cf99610e00ef7f69","ref":"","in":"body","required":false,"desc":"a description for the client","default":"","type":"string","name":"description"}],"url":"/clients"},"isReference":true,"order":1,"body":"This endpoint is used to create clients. Clients are accounts used to provide 3rd party access to the Droplit API: from [applications](doc:clients) or [servers](doc:server-to-server-api).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Parameter notes\"\n}\n[/block]\n## type\nThe allowed types are _application_ and _server_. Application is intended for use by client applications and server is intended for use by cloud APIs.","excerpt":"Create a new client","slug":"create-clients","type":"endpoint","title":"Create"}

postCreate

Create a new client

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

ecosystemId:
required
string
parent [ecosystem](doc:ecosystems) Id
type:
required
string
the type of client (_application_ or _server_)
name:
string
a name for the client
description:
string
a description for the client

Examples


Result Format


Documentation

This endpoint is used to create clients. Clients are accounts used to provide 3rd party access to the Droplit API: from [applications](doc:clients) or [servers](doc:server-to-server-api). [block:api-header] { "type": "basic", "title": "Parameter notes" } [/block] ## type The allowed types are _application_ and _server_. Application is intended for use by client applications and server is intended for use by cloud APIs.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}