{"_id":"582789abbe5c080f00a5a83b","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"},"project":"568bdc1483d2061900d86cdc","user":"568bdbc4fe6fcc0d006dc970","__v":1,"category":{"_id":"582789abbe5c080f00a5a802","__v":0,"version":"582789aabe5c080f00a5a7fe","project":"568bdc1483d2061900d86cdc","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-16T07:43:25.407Z","from_sync":false,"order":11,"slug":"environment-api","title":"Environments"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-16T07:48:29.666Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"put","results":{"codes":[{"name":"","code":" ","language":"text","status":200},{"name":"","code":"{\n  \"errorType\": \"InvalidParams\",\n  \"errors\": [\n    {\n      \"in\": \"body\",\n      \"message\": \"expected field to be a object\",\n      \"path\": \"meta\"\n    }\n  ]\n}","language":"json","status":400},{"status":401,"language":"text","code":""},{"status":403,"language":"text","code":""},{"status":404,"language":"text","code":"Environment with id E573bb9ffd717111220812c3b does not exist."}]},"settings":"572c39957c8eff0e00aaa18b","examples":{"codes":[{"language":"http","code":"PUT https://ioe.droplit.io/api/environments/E573bb9ffd717111220812c3a HTTP/1.1\nauthorization: AUTH_TOKEN\ncontent-type: application/json\n\n{\n  \"meta\": {\n    \"$label\": \"My Environment\"\n  }\n}"},{"name":"droplit console","language":"text","code":"droplit environment update E573bb9ffd717111220812c3a"}]},"auth":"required","params":[{"_id":"5699f5cde9e7e00d007ec0be","ref":"","in":"path","required":true,"desc":"[environment](doc:environments) id or [alias](doc:aliases)","default":"","type":"string","name":"id"},{"_id":"573bc3407ac6f6170033bd3b","ref":"","in":"body","required":false,"desc":"[metadata](doc:metadata) attached to the [environment](doc:environments)","default":"","type":"object","name":"meta"},{"_id":"57ce1e6f5f5adc0e0075c62c","ref":"","in":"body","required":false,"desc":"an [alias](doc:aliases) for the [environment](doc:environments)","default":"","type":"string","name":"alias"},{"_id":"58464962cdb4f10f00141613","ref":"","in":"header","required":false,"desc":"[metadata](doc:metadata) prefix","default":"$","type":"string","name":"x-system-meta-prefix"}],"url":"/environments/:id"},"isReference":true,"order":3,"body":"You can update an environment's metadata using this endpoint.","excerpt":"Update environment info","slug":"update-environments","type":"endpoint","title":"Update"}

putUpdate

Update environment info

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
[environment](doc:environments) id or [alias](doc:aliases)

Body Params

meta:
object
[metadata](doc:metadata) attached to the [environment](doc:environments)
alias:
string
an [alias](doc:aliases) for the [environment](doc:environments)

Headers

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

Examples


Result Format


Documentation

You can update an environment's metadata using 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 }}