{"_id":"588f722cbcace50f0052ba3f","project":"565f5fa26bafd40d0030a064","__v":0,"category":{"_id":"588f722bbcace50f0052b9e6","__v":0,"project":"565f5fa26bafd40d0030a064","version":"588f722bbcace50f0052b9e1","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-25T18:09:36.891Z","from_sync":false,"order":4,"slug":"dashboard-api","title":"Dashboard API"},"version":{"_id":"588f722bbcace50f0052b9e1","project":"565f5fa26bafd40d0030a064","__v":1,"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"},"parentDoc":null,"user":"565f3941ea46251700972783","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-19T18:25:58.397Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n    \"endpoint_groups\": [\n        {\n            \"api_id\": 95,\n            \"id\": 268,\n            \"name\": \"Event Calls\",\n            \"description\": \"\"\n        },\n        {\n            \"api_id\": 95,\n            \"id\": 269,\n            \"name\": \"Hello World\",\n            \"description\": \"Simple Hello World examples\"\n        },\n        {\n            \"api_id\": 95,\n            \"id\": 270,\n            \"name\": \"JS Proxies\",\n            \"description\": \"\"\n        },\n        {\n            \"api_id\": 95,\n            \"id\": 271,\n            \"name\": \"Mongo\",\n            \"description\": \"\"\n        },\n        {\n            \"api_id\": 95,\n            \"id\": 272,\n            \"name\": \"MsSql\",\n            \"description\": \"\"\n        },\n        {\n            \"api_id\": 95,\n            \"id\": 273,\n            \"name\": \"Multi-call\",\n            \"description\": \"Examples that show multiple remote endpoint calls.\"\n        },\n        {\n            \"api_id\": 95,\n            \"id\": 274,\n            \"name\": \"Notifications\",\n            \"description\": \"\"\n        },\n        {\n            \"api_id\": 95,\n            \"id\": 275,\n            \"name\": \"PostGres\",\n            \"description\": \"\"\n        },\n        {\n            \"api_id\": 95,\n            \"id\": 276,\n            \"name\": \"RSS\",\n            \"description\": \"\"\n        }\n    ]\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"code":"curl -b cookies.txt -c cookies.txt -X GET \"https://api.nanoscale.io/apis/95/endpoint_groups\"","language":"curl"}]},"method":"get","auth":"required","params":[],"url":"/endpoint_groups"},"isReference":true,"order":35,"body":"Calling the `/endpoint_groups` endpoint will return a collection of the defined `endpoint_groups` sorted alphabetically by name in ascending order.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"`endpoint_groups`\",\n    \"0-1\": \"`array`\",\n    \"0-2\": \"array of the defined endpoint groups\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\nEach `endpoint_group` will have the following keys:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"api_id\",\n    \"1-0\": \"id\",\n    \"2-0\": \"name\",\n    \"3-0\": \"description\",\n    \"0-1\": \"`number`\",\n    \"1-1\": \"`number`\",\n    \"2-1\": \"`string`\",\n    \"3-1\": \"`string`\",\n    \"0-2\": \"The API identifier.\",\n    \"1-2\": \"The endpoint group identifier.\",\n    \"2-2\": \"The name of the endpoint group.\",\n    \"3-2\": \"The description of the endpoint group.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","excerpt":"","slug":"endpoint_groups","type":"endpoint","title":"/endpoint_groups"}

get/endpoint_groups


Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


Documentation

Calling the `/endpoint_groups` endpoint will return a collection of the defined `endpoint_groups` sorted alphabetically by name in ascending order. [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "`endpoint_groups`", "0-1": "`array`", "0-2": "array of the defined endpoint groups" }, "cols": 3, "rows": 1 } [/block] Each `endpoint_group` will have the following keys: [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "api_id", "1-0": "id", "2-0": "name", "3-0": "description", "0-1": "`number`", "1-1": "`number`", "2-1": "`string`", "3-1": "`string`", "0-2": "The API identifier.", "1-2": "The endpoint group identifier.", "2-2": "The name of the endpoint group.", "3-2": "The description of the endpoint group." }, "cols": 3, "rows": 4 } [/block]