{"_id":"582789acbe5c080f00a5a84f","user":"568bdbc4fe6fcc0d006dc970","parentDoc":null,"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"},"__v":2,"project":"568bdc1483d2061900d86cdc","category":{"_id":"582789abbe5c080f00a5a803","__v":0,"version":"582789aabe5c080f00a5a7fe","project":"568bdc1483d2061900d86cdc","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-05T15:14:04.838Z","from_sync":false,"order":9,"slug":"something","title":"Devices"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-16T07:39:01.923Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","status":200,"language":"text","code":" "},{"code":"{\n  \"errorType\": \"InvalidParams\",\n  \"errors\": [\n    {\n      \"in\": \"body\",\n      \"message\": \"expected field to be a object\",\n      \"path\": \"meta\"\n    }\n  ]\n}","name":"","status":400,"language":"json"},{"status":401,"language":"text","code":""},{"code":"","status":403,"language":"text"},{"language":"text","code":"Device with id D573bc694ae9ac9419f028b62 does not exist.","status":404}]},"settings":"572c39957c8eff0e00aaa18b","examples":{"codes":[{"language":"http","code":"PUT https://ioe.droplit.io/api/devices/D573bc694ae9ac9419f028b61 HTTP/1.1\nauthorization: AUTH_TOKEN\ncontent-type: application/json\n\n{\n  \"meta\": {\n    \"$label\": \"My new label\"\n  }\n}"},{"name":"droplit console","language":"text","code":"droplit device update"}]},"method":"put","auth":"required","params":[{"_id":"5699f39580d43a0d00304f88","ref":"","in":"path","required":true,"desc":"[device](doc:devices) id or [alias](doc:aliases)","default":"","type":"string","name":"id"},{"_id":"573bcd27fd7f2e3400cf8b15","ref":"","in":"body","required":false,"desc":"[metadata](doc:metadata) attached to the [device](doc:devices)","default":"","type":"string","name":"meta"},{"_id":"573bcd27fd7f2e3400cf8b14","ref":"","in":"body","required":false,"desc":"an [alias](doc:aliases) for the [device](doc:devices)","default":"","type":"string","name":"alias"},{"_id":"573bcd27fd7f2e3400cf8b13","ref":"","in":"body","required":false,"desc":"[services](doc:services) this [device](doc:devices) implements","default":"","type":"array_string","name":"services"},{"_id":"5846329a42ca810f006bf458","ref":"","in":"header","required":false,"desc":"[metadata](doc:metadata) prefix","default":"$","type":"string","name":"x-system-meta-prefix"}],"url":"/devices/:id"},"isReference":true,"order":3,"body":"You can update device information with this endpoint.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Parameter notes\"\n}\n[/block]\n## alias\nDevice aliases are scoped to the environment such that they must be unique among aliases used at this level. Data using environment-level aliases include both devices and zones.\n\n## services\nThe services parameter is an array of strings representing the names of the service classes that the device implements. It is allowed to be able to specify services that are not installed to the Ecosystem that the device is under.","excerpt":"Update device record","slug":"update-devices","type":"endpoint","title":"Update"}

putUpdate

Update device record

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
[device](doc:devices) id or [alias](doc:aliases)

Body Params

meta:
string
[metadata](doc:metadata) attached to the [device](doc:devices)
alias:
string
an [alias](doc:aliases) for the [device](doc:devices)
services:
array of strings
[services](doc:services) this [device](doc:devices) implements

Headers

x-system-meta-prefix:
string$
[metadata](doc:metadata) prefix

Examples


Result Format


Documentation

You can update device information with this endpoint. [block:api-header] { "type": "basic", "title": "Parameter notes" } [/block] ## alias Device aliases are scoped to the environment such that they must be unique among aliases used at this level. Data using environment-level aliases include both devices and zones. ## services The services parameter is an array of strings representing the names of the service classes that the device implements. It is allowed to be able to specify services that are not installed to the Ecosystem that the device is under.

User Information

Try It Out

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