{"_id":"59c07e176466f9001050950a","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":"59c06c40df5b3c0010584a13","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-19T01:00:48.384Z","from_sync":false,"order":10,"slug":"devices-api","title":"Devices API"},"user":"58cc41f21751ce2f003be3b7","__v":3,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-19T02:16:55.237Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[]},"results":{"codes":[]},"settings":"59a750fbd61777001b6c47ed","auth":"required","params":[{"_id":"59c07e176466f9001050950f","ref":"","in":"header","required":false,"desc":"","default":"","type":"string","name":"x-system-metadata-prefix"},{"_id":"59c07e176466f9001050950e","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"environmentId"},{"_id":"59c07e176466f9001050950d","ref":"","in":"body","required":false,"desc":"","default":"","type":"object","name":"meta"},{"_id":"59c07e176466f9001050950c","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"alias"},{"_id":"59c07e176466f9001050950b","ref":"","in":"body","required":false,"desc":"","default":"","type":"array_string","name":"services"}],"url":"/"},"isReference":false,"order":1,"body":"# Details\n\nCreate a device.\n\nAn account token, server token, or user token may be used to run this endpoint.\n\n# Parameters\n\n## body\n\n- environmentId (required): The ID of the [environment](https://docs.droplit.io/docs/containers#section-environments).\n- alias (optional): The [alias](https://docs.droplit.io/docs/identifiers#section-aliases) associated with the [device](https://docs.droplit.io/docs/containers#section-devices).\n- services (optional): The names of the services this [device](https://docs.droplit.io/docs/containers#section-devices) implements.\n- meta (optional): The [metadata](https://docs.droplit.io/docs/metadata) associated with the [device](https://docs.droplit.io/v0.2/docs/containers#section-devices).\n\n## header\n\n- x-system-metadata-prefix (optional): A customized [metadata](https://docs.droplit.io/docs/metadata) prefix. The default is “$.”\n\n# Responses\n\n## 201\n\n```\n{\n    \"createdAt\": \"YYYY-MM-DD HH:MM:SS ENCODED\",\n    \"ecosystemId\": \"ECOSYSTEM-ID\",\n    \"environmentId\": \"ENVIRONMENT-ID\",\n    \"id\": \"DEVICE-ID\",\n    \"meta\": {},\n    \"type\": \"DEVICE-TYPE\"\n}\n```\n\n## 400\n\n- __Body Parameters Missing:__ The standard error structure defines this error as invalid parameters, and contains all required body parameters. If this error occurs when the JSON structure of the body parameters is syntactically correct, this means that the “content-type” header is incorrectly specified. The content-type header should be “application/json.”\n- __No Query String Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that no query string is allowed at all when calling this endpoint.\n- __Environment Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID linked to the parameter that designates the environment ID. In this context, it means that the ID given for an environment was not valid.\n- __Environment Missing:__ The standard error structure defines this error as invalid parameters. In this context, it means that the environment ID is missing, and was required.\n- __Alias Invalid:__ The standard error structure defines this error as invalid parameters. The error means that an alias given for an object is not valid. However, this invalid alias does not necessarily mean that any other object references are invalid. This error refers only to the alias itself.\n- __Alias Exists:__ The standard error structure defines this error as an invalid body. The error means that an object with the same alias already exists. The best way to avoid this error is to make sure all aliases are unique strings, regardless of where they are accessed from.\n- __Metadata Format Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that metadata, when specified, should have been formatted as a valid JSON object, and it was not formatted that way.\n\n## 404\n\n- __Environment Not Found:__ This error means that an environment with the given ID was not found. This is distinct from an invalid environment ID being specified; this means that the environment ID once existed, but no longer does.\n\n# Examples\n\n## HTTP\n\n```\nPOST https://ioe.droplit.io/api/devices HTTP/1.1\nauthorization: TOKEN\ncontent-type: application/json\n{\n    \"environmentId\": \"ENVIRONMENT-ID\",\n    \"meta\": {},\n    \"alias\": \"DEVICE-ALIAS\"\n}\n```\n\n## Droplit Console\n\n```\ndroplit device create --environmentId ENVIRONMENT-ID\n```","excerpt":"","slug":"devices-create","type":"endpoint","title":"Create a device."}

postCreate a device.


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

environmentId:
required
string
meta:
object
alias:
string
services:
array of strings

Headers

x-system-metadata-prefix:
string

Documentation

# Details Create a device. An account token, server token, or user token may be used to run this endpoint. # Parameters ## body - environmentId (required): The ID of the [environment](https://docs.droplit.io/docs/containers#section-environments). - alias (optional): The [alias](https://docs.droplit.io/docs/identifiers#section-aliases) associated with the [device](https://docs.droplit.io/docs/containers#section-devices). - services (optional): The names of the services this [device](https://docs.droplit.io/docs/containers#section-devices) implements. - meta (optional): The [metadata](https://docs.droplit.io/docs/metadata) associated with the [device](https://docs.droplit.io/v0.2/docs/containers#section-devices). ## header - x-system-metadata-prefix (optional): A customized [metadata](https://docs.droplit.io/docs/metadata) prefix. The default is “$.” # Responses ## 201 ``` { "createdAt": "YYYY-MM-DD HH:MM:SS ENCODED", "ecosystemId": "ECOSYSTEM-ID", "environmentId": "ENVIRONMENT-ID", "id": "DEVICE-ID", "meta": {}, "type": "DEVICE-TYPE" } ``` ## 400 - __Body Parameters Missing:__ The standard error structure defines this error as invalid parameters, and contains all required body parameters. If this error occurs when the JSON structure of the body parameters is syntactically correct, this means that the “content-type” header is incorrectly specified. The content-type header should be “application/json.” - __No Query String Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that no query string is allowed at all when calling this endpoint. - __Environment Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID linked to the parameter that designates the environment ID. In this context, it means that the ID given for an environment was not valid. - __Environment Missing:__ The standard error structure defines this error as invalid parameters. In this context, it means that the environment ID is missing, and was required. - __Alias Invalid:__ The standard error structure defines this error as invalid parameters. The error means that an alias given for an object is not valid. However, this invalid alias does not necessarily mean that any other object references are invalid. This error refers only to the alias itself. - __Alias Exists:__ The standard error structure defines this error as an invalid body. The error means that an object with the same alias already exists. The best way to avoid this error is to make sure all aliases are unique strings, regardless of where they are accessed from. - __Metadata Format Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that metadata, when specified, should have been formatted as a valid JSON object, and it was not formatted that way. ## 404 - __Environment Not Found:__ This error means that an environment with the given ID was not found. This is distinct from an invalid environment ID being specified; this means that the environment ID once existed, but no longer does. # Examples ## HTTP ``` POST https://ioe.droplit.io/api/devices HTTP/1.1 authorization: TOKEN content-type: application/json { "environmentId": "ENVIRONMENT-ID", "meta": {}, "alias": "DEVICE-ALIAS" } ``` ## Droplit Console ``` droplit device create --environmentId ENVIRONMENT-ID ```

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