{"__v":1,"_id":"54db60b01a1431210031396e","category":{"__v":7,"_id":"54fdad6e660db63700c23b82","pages":["55fbef82af72eb0d0007df93","55fbf623e013770d008fcba8","5617bd3a26e3db230054fba4","5617c4a6f8c9632100ac74f5","561ed6fd0a04340d00d8a0b0","562156adf4e0352100cbf268","562a5c846049f20d0032520b"],"project":"54d0fd1d095c470d00d1646d","version":"54d0fd1e095c470d00d16470","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-03-09T14:25:50.133Z","from_sync":false,"order":2,"slug":"api-reference","title":"API Reference"},"editedParams":true,"editedParams2":true,"project":"54d0fd1d095c470d00d1646d","user":"54db525474dfff3700f161e9","version":{"__v":20,"_id":"54d0fd1e095c470d00d16470","project":"54d0fd1d095c470d00d1646d","createdAt":"2015-02-03T16:53:50.090Z","releaseDate":"2015-02-03T16:53:50.090Z","categories":["54d0fd1e095c470d00d16471","54d8b5e68934140d00496544","54db6361c6a4d40d0034b8f7","54db638208ea010d00ab1fdd","54db639008ea010d00ab1fde","54db6547c6a4d40d0034b8fd","54db83482092743700ea6ee1","54db84afc6a4d40d0034b93c","54db8805c6a4d40d0034b93f","54db8de9c6a4d40d0034b961","54db931ac6a4d40d0034b96d","54e49219e4365521006fd9ee","54e74fcc652d7c1900cbe737","54e74ffd3c1e111700d05762","54e77e0a523b1b2f00e6f313","54e784affdabe62500fcddcf","54e784fa523b1b2f00e6f319","54e785de8ae8911900cd42c5","54fdad6e660db63700c23b82","54fdff31f7b1202100a25e06"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-02-11T14:01:20.167Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  \"database\": {\n    \"database_name\": \"db\",\n    \"description\": \"Database 01\",\n  \t\"user_id\": \"5335d4e377656254e6000001\",\n    \"id\": \"5335d84b7765625460000001\"\n  }\n}","language":"json","status":200},{"name":"","code":"{\n    \"error\": \"database id or name (db01) is invalid\"\n}","language":"json","status":400}]},"auth":"required","params":[{"_id":"54db97fd7dadb32300511412","ref":"","in":"path","required":true,"desc":"The database_name or id to update.","default":"","type":"string","name":"database_id"},{"_id":"54db60b01a1431210031396f","ref":"","in":"body","required":true,"desc":"The description text to change.","default":"","type":"string","name":"description"}],"url":"/databases/:database_id"},"isReference":false,"order":4,"body":"Changes a given database informations, identified by its name or id. Returns a JSON object with the updated database attributes.\n\n**Note:** You can only change the database `description` field. The `database_name` can't be changed after its creation.\n\n### Sample Request\n\nThis request changes the description of *db* database to *\"Database 01\"*.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --user <API-KEY>:\\\"\\\" -k -H \\\"Content-Type: application/json\\\" -XPUT https://api.gogeo.io/1.0/databases/db -d '{\\n   \\\"description\\\": \\\"Database 01\\\" \\n}' \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n### Sample Response\n\nThe result is a JSON with the new information for the database.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"database\\\": {\\n    \\\"database_name\\\": \\\"db\\\",\\n    \\\"description\\\": \\\"Database 01\\\",\\n    \\\"user_id\\\": \\\"5335d4e377656254e6000001\\\",\\n    \\\"id\\\": \\\"5335d84b7765625460000001\\\"\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nWhen the database does not exist you should receive an error like this.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"error\\\": \\\"database id or name (missing_database) is invalid\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<div class=\\\"panel panel-info teste\\\" >\\n  <div class=\\\"panel-body\\\">\\n    This endpoint requires an API key. See <a href=\\\"basic-auth\\\">Basic Authentication</a> for more information about the goGeo authentication system.\\n\\t\\t<br><br>\\n\\t  If you don't have an access key yet, <a href=\\\"https://console.gogeo.io/signup\\\">sign up</a> and take yours!\\n  </div>\\n</div>\\n\"\n}\n[/block]\n---\n[block:html]\n{\n  \"html\": \"<div class='div-middle'> \\n  <a href='#'>\\n    Top page &spades; </div>\\n  </a>\\n</div>\\n\\n<div class='div-back'> \\n  <a href='/v1.0/docs/get-a-database'>\\n    &laquo; Back \\n  </a>\\n</div>\\n\\n<style>\\n\\t.div-back {\\n  \\tpadding-left: 15px;\\n\\t\\tmargin-top: -20px;\\n  }\\n  \\n  .div-middle {\\n  \\ttext-align: center;\\n\\t\\tmargin-top: -15px;\\n  }\\n  \\n  .div-forward {\\n  \\tfloat: right;\\n    padding-right: 15px;\\n\\t\\tmargin-top: -20px;\\n  }\\n</style>\"\n}\n[/block]","excerpt":"Update a given database informations.","slug":"update-a-database","type":"put","title":"Update a database"}

putUpdate a database

Update a given database informations.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

database_id:
required
string
The database_name or id to update.

Body Params

description:
required
string
The description text to change.

Result Format


Documentation

Changes a given database informations, identified by its name or id. Returns a JSON object with the updated database attributes. **Note:** You can only change the database `description` field. The `database_name` can't be changed after its creation. ### Sample Request This request changes the description of *db* database to *"Database 01"*. [block:code] { "codes": [ { "code": "curl --user <API-KEY>:\"\" -k -H \"Content-Type: application/json\" -XPUT https://api.gogeo.io/1.0/databases/db -d '{\n \"description\": \"Database 01\" \n}' ", "language": "json" } ] } [/block] ### Sample Response The result is a JSON with the new information for the database. [block:code] { "codes": [ { "code": "{\n \"database\": {\n \"database_name\": \"db\",\n \"description\": \"Database 01\",\n \"user_id\": \"5335d4e377656254e6000001\",\n \"id\": \"5335d84b7765625460000001\"\n }\n}", "language": "json" } ] } [/block] When the database does not exist you should receive an error like this. [block:code] { "codes": [ { "code": "{\n \"error\": \"database id or name (missing_database) is invalid\"\n}", "language": "json" } ] } [/block] [block:html] { "html": "<div class=\"panel panel-info teste\" >\n <div class=\"panel-body\">\n This endpoint requires an API key. See <a href=\"basic-auth\">Basic Authentication</a> for more information about the goGeo authentication system.\n\t\t<br><br>\n\t If you don't have an access key yet, <a href=\"https://console.gogeo.io/signup\">sign up</a> and take yours!\n </div>\n</div>\n" } [/block] --- [block:html] { "html": "<div class='div-middle'> \n <a href='#'>\n Top page &spades; </div>\n </a>\n</div>\n\n<div class='div-back'> \n <a href='/v1.0/docs/get-a-database'>\n &laquo; Back \n </a>\n</div>\n\n<style>\n\t.div-back {\n \tpadding-left: 15px;\n\t\tmargin-top: -20px;\n }\n \n .div-middle {\n \ttext-align: center;\n\t\tmargin-top: -15px;\n }\n \n .div-forward {\n \tfloat: right;\n padding-right: 15px;\n\t\tmargin-top: -20px;\n }\n</style>" } [/block]

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