{"__v":0,"_id":"588f722cbcace50f0052ba42","category":{"version":"588f722bbcace50f0052b9e1","project":"565f5fa26bafd40d0030a064","_id":"588f722bbcace50f0052b9e6","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-25T18:09:36.891Z","from_sync":false,"order":4,"slug":"dashboard-api","title":"Dashboard API"},"parentDoc":null,"project":"565f5fa26bafd40d0030a064","user":"565f3941ea46251700972783","version":{"__v":1,"_id":"588f722bbcace50f0052b9e1","project":"565f5fa26bafd40d0030a064","createdAt":"2017-01-30T17:04:43.410Z","releaseDate":"2017-01-30T17:04:43.410Z","categories":["588f722bbcace50f0052b9e2","588f722bbcace50f0052b9e3","588f722bbcace50f0052b9e4","588f722bbcace50f0052b9e5","588f722bbcace50f0052b9e6","588f722bbcace50f0052b9e7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"5.3.0","version":"5.3.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-19T22:10:43.093Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -b cookies.txt -c cookies.txt -H \"Content-Type: application/json\" -X PUT -d '{\"endpoint_group\":{\"name\":\"mongo proxies\",\"description\":\"MongoDB proxy endpoints\"}}' \"https://api.nanoscale.io/apis/95/endpoint_groups/271\""}]},"method":"put","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"endpoint_group\": {\n        \"api_id\": 95,\n        \"id\": 271,\n        \"name\": \"mongo proxies\",\n        \"description\": \"MongoDB proxy endpoints\"\n    }\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"56c792e3379b311700ed8fc9","ref":"","in":"path","required":true,"desc":"The endpoint group's id","default":"","type":"string","name":"id"}],"url":"/endpoint_groups/:id"},"isReference":true,"order":38,"body":"Updates a single endpoint group.\n\nHere is a list of fields that can be provided.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"name\",\n    \"1-0\": \"description\",\n    \"0-1\": \"`string`\",\n    \"1-1\": \"`string`\",\n    \"0-2\": \"The name of the endpoint group.\",\n    \"1-2\": \"The description of the endpoint group.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\nHere is an example of the `JSON` used to update an endpoint group:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"endpoint_group\\\": {\\n        \\\"name\\\": \\\"mongo proxies\\\",\\n        \\\"description\\\": \\\"MongoDB proxy endpoints\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"endpoint_groupsid-1","type":"endpoint","title":"/endpoint_groups/:id"}

put/endpoint_groups/:id


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The endpoint group's id

Examples


Result Format


Documentation

Updates a single endpoint group. Here is a list of fields that can be provided. [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "name", "1-0": "description", "0-1": "`string`", "1-1": "`string`", "0-2": "The name of the endpoint group.", "1-2": "The description of the endpoint group." }, "cols": 3, "rows": 2 } [/block] Here is an example of the `JSON` used to update an endpoint group: [block:code] { "codes": [ { "code": "{\n \"endpoint_group\": {\n \"name\": \"mongo proxies\",\n \"description\": \"MongoDB proxy endpoints\"\n }\n}", "language": "json" } ] } [/block]