{"_id":"5b2d56631235f10003177291","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":35,"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","59f76fef8581dc0010593e6f","5a0c003680a35b0012c35db0","5a8358722e78660075e45f42","5a846645b5ec3a001203517e","5b258091bc7a6700033b9cb5","5b26e48e024807000315a740","5b44edff3306680003663f5c","5b468abd3d4a9e0003789111","5b468d8f3dcb6a0003c6e374","5b47b0b93d4a9e000378a33a","5b538d114ea24f00033c726f","5b6a0efe402b32000336c33f","5bba5e5d7ba7710003bd902a","5bc2703349ac3a0013eec3e5","5c351061191e2b002b4988a8","5c8b01b199b56e00440aa018"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"59c1a5852cabe5002641a3e7","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-19T23:17:25.014Z","from_sync":false,"order":20,"slug":"ecosystems-a","title":"Ecosystems API"},"user":"5a6a26281895510045b2cd40","githubsync":"","__v":8,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-06-22T20:04:51.567Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"redirect\": \"https://yo.droplit.io/auth/activate?session=AErcPDC0zcQbq52_5INmc9Ixi7Eq-QBmh14hpdMIOv2\",\n \"ttl\": 1800\n}","name":""},{"status":500,"name":"Invalid Conduit Name","language":"text","code":""},{"status":400,"name":"Invalid Environment","language":"json","code":"{\n \"errorType\": \"InvalidParams\",\n \"errors\": [\n {\n \"in\": \"query\",\n \"message\": \"invalid environment id\",\n \"path\": \"environmentId\"\n }\n ]\n}"},{"status":404,"name":"Ecosystem Not Found","language":"text","code":"user with id auth0|5af1fd9d04eb0b243f1e896d does not exist."},{"status":500,"name":"Conduit Name Not Found","language":"text","code":""},{"status":404,"name":"Environment Not Found","language":"text","code":"Environment with id E591b89aec7816b940ae34d21 does not exist."},{"name":"User Not Found","language":"text","code":"user with id auth0|5af9fd9104e70b2e3f11896a does not exist.","status":404}]},"settings":"59a75ffc4836990031f5ec2f","examples":{"codes":[{"code":"GET https://ioe.droplit.io/api/ecosystems/C5aebfea1278b9bfe02639d21/conduits/droplit-nest/activate?environmentId=E59e78ea527816bf902e59d2a&uniqueId=demo_user HTTP/1.1\nauthorization: AUTH_TOKEN","language":"http"},{"code":"droplit.conduits.activateByName(\"C5aebfea1278b9bfe02639d21\", \"droplit-nest\", \"E59e78ea527816bf902e59d2a\", \"demo_user\");","language":"javascript","name":"Droplit SDK"}]},"method":"get","auth":"required","params":[{"_id":"5b2d59561235f100031772b3","ref":"","in":"path","required":true,"desc":"The ID of the ecosystem.","default":"","type":"string","name":"id"},{"_id":"5b2d59561235f100031772b2","ref":"","in":"path","required":true,"desc":"The name of the conduit to be activated.","default":"","type":"string","name":"conduitName"},{"_id":"5b2d59561235f100031772b1","ref":"","in":"query","required":false,"desc":"Optionally activate the conduit for only a specific environment. All devices using this conduit will be provisioned for this environment.","default":"","type":"string","name":"environmentId"},{"_id":"5b2d59561235f100031772b0","ref":"","in":"query","required":false,"desc":"The unique ID of the user for which the conduit is being activated. The `environmentId` property MUST also be set to an environment to which this user has access.","default":"","type":"string","name":"uniqueId"},{"_id":"5b2d59561235f100031772af","ref":"","in":"header","required":true,"desc":"The user's authorization token.","default":"","type":"string","name":"authorization"}],"url":"/:id/conduits/:conduitName/activate"},"isReference":false,"order":10,"body":"Activate an ecosystem's conduit for use within an environment. Optional granularity exists where the conduit may only be activated for specific users.","excerpt":"Activate an ecosystem's conduit for use within a particular environment.","slug":"activate-conduit","type":"endpoint","title":"Activate Conduit"}
getActivate Conduit
Activate an ecosystem's conduit for use within a particular environment.
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Path Params
id:
required
string
The ID of the ecosystem.
conduitName:
required
string
The name of the conduit to be activated.
Query Params
environmentId:
string
Optionally activate the conduit for only a specific environment. All devices using this conduit will be provisioned for this environment.
uniqueId:
string
The unique ID of the user for which the conduit is being activated. The `environmentId` property MUST also be set to an environment to which this user has access.
Headers
authorization:
required
string
The user's authorization token.