{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/:id/services/:selector","auth":"required","method":"put","examples":{"codes":[{"code":"PUT https://ioe.droplit.io/api/environments/E81eb1eae078bcbf40ae3fd25/services/BinarySwitch.switch HTTP/1.1\nauthorization: AUTH_TOKEN\nContent-Type: application/json\n\n{\n\t\"value\": \"on\"\n}","language":"http"},{"name":"Droplit SDK","language":"javascript","code":"droplit.environments.setServiceProperty(\"E81eb1eae078bcbf40ae3fd25\", \"BinarySwitch.switch\", { \"value\" : \"on\" });"}]},"results":{"codes":[{"name":"","code":"{\n    \"transactionId\": \"5a8ab1053b2ef8f958e8bfda\"\n}","language":"json","status":200},{"name":"Environment Invalid","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"path\",\n            \"message\": \"invalid id\",\n            \"path\": \"id\"\n        }\n    ]\n}","language":"json","status":400},{"status":400,"name":"No Query String Allowed","language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"query\",\n            \"message\": \"contains fields that are not allowed: [ query ]\",\n            \"path\": \"additional parameters\"\n        }\n    ]\n}"},{"status":400,"name":"Body Parameters Missing","language":"json","code":"{\n    \"errorType\": \"InvalidBody\",\n    \"errors\": [\n        {\n            \"path\": \"value\",\n            \"message\": \"value was undefined\"\n        }\n    ]\n}"},{"status":404,"name":"Environment Not Found","language":"text","code":"Environment with id E59eb8eae278b6bf402e39d21 does not exist."}]},"settings":"59a75f6e757d030019b85f83","params":[{"name":"id","type":"string","default":"","desc":"The ID of the environment","required":true,"in":"path","ref":"","_id":"59c32759190c90003cb0d067"},{"name":"selector","type":"string","default":"","desc":"The full name of the service property of the format SERVICE_NAME.PROPERTY","required":true,"in":"path","ref":"","_id":"59c32759190c90003cb0d066"},{"name":"value","type":"string","default":"","desc":"The desired value of the specified service property","required":true,"in":"body","ref":"","_id":"59c32953185f99001034d946"},{"name":"authorization","type":"string","default":"","desc":"The user's authorization token","required":true,"in":"header","ref":"","_id":"5aaabced311eea001e60e888"},{"name":"content-type","type":"string","default":"","desc":"Specify that the sent data will be a JSON object","required":true,"in":"header","ref":"","_id":"5aaabced311eea001e60e887"}]},"next":{"description":"","pages":[]},"title":"Update Service Property","type":"endpoint","slug":"environments-services-update","excerpt":"","body":"Update environment service properties.\n\nIf the property is not implemented on a device within an environment, that device is skipped.\n\nAn account token, server token, or user token may be used to run this endpoint.","updates":[],"order":8,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5aaabb89cedfa700127818d4","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":"Environments API","slug":"environments-api","order":21,"from_sync":false,"reference":false,"_id":"59c2fb00b2b45c0010b7a3d7","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","createdAt":"2017-09-20T23:34:24.298Z","__v":0},"user":"5a6a26281895510045b2cd40","createdAt":"2018-03-15T18:29:29.786Z","githubsync":"","__v":22,"parentDoc":null}

putUpdate Service Property


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the environment
selector:
required
string
The full name of the service property of the format SERVICE_NAME.PROPERTY

Body Params

value:
required
string
The desired value of the specified service property

Headers

authorization:
required
string
The user's authorization token
content-type:
required
string
Specify that the sent data will be a JSON object

Examples


Result Format


Documentation

Update environment service properties. If the property is not implemented on a device within an environment, that device is skipped. An account token, server token, or user token may be used to run this endpoint.

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