{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/","auth":"required","method":"post","examples":{"codes":[{"language":"http","code":"POST https://ioe.droplit.io/api/devices HTTP/1.1\nauthorization: AUTH_TOKEN\ncontent-type: application/json\n\n{\n\t\"environmentId\" : \"E5a870afa39ab8f8c2286aa97\",\n\t\"alias\" : \"newDevice\",\n\t\"services\" : [\n\t\t\"Thermostat\",\n\t\t\"Temperature\"\n\t],\n\t\"localId\" : \"231155978771\",\n\t\"conduitActivationId\" : \"5ba5377f4c29b8b95af79773\"\n}"},{"name":"Console","language":"text","code":"droplit device create --environmentId E5a870afa39ab8f8c2286aa97"},{"name":"Droplit SDK","language":"javascript","code":"droplit.devices.create({\n  \"environmentId\" : \"E5a870afa39ab8f8c2286aa97\",\n\t\"alias\" : \"newDevice\",\n\t\"services\" : [\n\t\t\"Thermostat\",\n\t\t\"Temperature\"\n\t],\n\t\"localId\" : \"231155978771\",\n\t\"conduitActivationId\" : \"5ba5377f4c29b8b95af79773\"\n});"}]},"results":{"codes":[{"name":"","code":"{\n    \"id\": \"D5b963e3e4a782a30bb227301\",\n    \"ecosystemId\": \"C5751a3f3f3d9f27e3e61b131\",\n    \"environmentId\": \"E5a870afa39ab8f8c2286aa97\",\n    \"type\": \"physical\",\n    \"localId\": \"231155978771\",\n    \"meta\": {},\n    \"conduitType\": \"droplit-ecobee-ems\",\n    \"conduitId\": \"5bc53e5d8f33048a9a80b286\",\n    \"conduitActivationId\": \"5ba5377f4c29b8b95af79773\",\n    \"services\": [\n        \"Thermostat\",\n        \"Temperature\"\n    ],\n    \"createdAt\": \"2018-07-11T17:07:09.777Z\"\n}","language":"json","status":201},{"name":"Missing Required Body Parameter","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"path\": \"#\",\n            \"message\": \"required properties are missing: environmentId\"\n        }\n    ]\n}","language":"json","status":400},{"status":400,"name":"Invalid Body Parameter","language":"text","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"path\": \"#\",\n            \"message\": \"property invalid is used for a schema that does not allow additional properties\"\n        }\n    ]\n}"},{"status":400,"name":"Invalid Environment","language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"path\": \"#/environmentId\",\n            \"message\": \"invalid id\"\n        }\n    ]\n}"},{"status":404,"name":"Environment Not Found","language":"text","code":"Environment with id E5a770afa99ac8f8c21865a91 does not exist."}]},"settings":"59a750fbd61777001b6c47ed","params":[{"name":"environmentId","type":"string","default":"","desc":"The ID of the environment to which the device will be provisioned.","required":true,"in":"body","ref":"","_id":"59c07e176466f9001050950e"},{"name":"alias","type":"string","default":"","desc":"A user-defined, human-readable name for the device.","required":false,"in":"body","ref":"","_id":"59c07e176466f9001050950c"},{"name":"meta","type":"object","default":"","desc":"Any metadata to be associated with the device.","required":false,"in":"body","ref":"","_id":"59c07e176466f9001050950d"},{"name":"services","type":"array_string","default":"","desc":"The names of the service classes the device is to implement.","required":false,"in":"body","ref":"","_id":"59c07e176466f9001050950b"},{"name":"localId","type":"string","default":"","desc":"The conduit-provided ID of a physical local device.","required":false,"in":"body","ref":"","_id":"5b463aae7a339100038909b1"},{"name":"conduitActivationId","type":"string","default":"","desc":"The ID of the conduit activation to which a physical local device is to be attached.","required":false,"in":"body","ref":"","_id":"5b463aae7a339100038909b0"},{"name":"authorization","type":"string","default":"","desc":"The user's authorization token.","required":true,"in":"header","ref":"","_id":"5b463aae7a339100038909af"},{"name":"x-system-metadata-prefix","type":"string","default":"$","desc":"May be set to a custom metadata prefix.","required":false,"in":"header","ref":"","_id":"59c07e176466f9001050950f"}]},"next":{"description":"","pages":[]},"title":"Create a device.","type":"endpoint","slug":"devices-create","excerpt":"","body":"An account token, server token, or user token may be used to run this endpoint.","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"59c07e176466f9001050950a","project":"568bdc1483d2061900d86cdc","version":{"version":"0","version_clean":"0.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"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"],"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","__v":35},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Devices API","slug":"devices-api","order":19,"from_sync":false,"reference":false,"_id":"59c06c40df5b3c0010584a13","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","createdAt":"2017-09-19T01:00:48.384Z","__v":0},"user":"58cc41f21751ce2f003be3b7","createdAt":"2017-09-19T02:16:55.237Z","githubsync":"","__v":9,"parentDoc":null}

postCreate a device.


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

environmentId:
required
string
The ID of the environment to which the device will be provisioned.
alias:
string
A user-defined, human-readable name for the device.
meta:
object
Any metadata to be associated with the device.
services:
array of strings
The names of the service classes the device is to implement.
localId:
string
The conduit-provided ID of a physical local device.
conduitActivationId:
string
The ID of the conduit activation to which a physical local device is to be attached.

Headers

authorization:
required
string
The user's authorization token.
x-system-metadata-prefix:
string$
May be set to a custom metadata prefix.

Examples


Result Format


Documentation

An account token, server token, or user token may be used to run this endpoint.

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