{"_id":"588f722cbcace50f0052ba27","parentDoc":null,"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"},"__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"},"project":"565f5fa26bafd40d0030a064","user":"565f3941ea46251700972783","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-05T22:25:04.464Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -b cookies.txt -c cookies.txt -H \"Accept: application/json\" -H \"Content-Type: application/json\" -X GET  https://api.nanoscale.io/apis/13/proxy_endpoints"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"proxy_endpoints\": [\n\t\t\t\t....\n        {\n            \"api_id\": 13,\n            \"endpoint_group_id\": 45,\n            \"environment_id\": 9,\n            \"id\": 150,\n            \"name\": \"A JSON Hello World proxy\",\n            \"description\": \"A simple hello world endpoint that returns JSON\",\n            \"active\": true\n        },\n\t      ....\n    ]\n}","name":""}]},"settings":"","auth":"required","params":[],"url":"/proxy_endpoints"},"isReference":true,"order":11,"body":"Calling the `/proxy_endpoints` endpoint will return a collection of the defined `proxy_endpoints` sorted alphabetically by name in ascending order.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"description\",\n    \"0-0\": \"`proxy_endpoints`\",\n    \"0-1\": \"array of the defined proxy endpoints\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\nEach `proxy_endpoint` will have the following keys:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"0-0\": \"api_id\",\n    \"1-0\": \"endpoint_group_id\",\n    \"2-0\": \"environment_id\",\n    \"3-0\": \"id\",\n    \"4-0\": \"name\",\n    \"5-0\": \"description\",\n    \"5-1\": \"`string`\",\n    \"6-0\": \"active\",\n    \"0-1\": \"`number`\",\n    \"1-1\": \"`number`\",\n    \"2-1\": \"`number`\",\n    \"3-1\": \"`number`\",\n    \"4-1\": \"`string`\",\n    \"6-1\": \"`boolean`\",\n    \"h-2\": \"description\",\n    \"0-2\": \"The API identifier\",\n    \"1-2\": \"The endpoint group identifier\",\n    \"2-2\": \"The environment identifier\",\n    \"3-2\": \"The proxy endpoint identifier\",\n    \"4-2\": \"The name of the proxy endpoint\",\n    \"5-2\": \"The description of the proxy endpoint\",\n    \"6-2\": \"Indicates if the proxy endpoint is active or inactive\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]","excerpt":"Returns a collection of your API's proxy endpoints","slug":"proxy_endpoints","type":"endpoint","title":"/proxy_endpoints"}

get/proxy_endpoints

Returns a collection of your API's proxy endpoints

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


Documentation

Calling the `/proxy_endpoints` endpoint will return a collection of the defined `proxy_endpoints` sorted alphabetically by name in ascending order. [block:parameters] { "data": { "h-0": "key", "h-1": "description", "0-0": "`proxy_endpoints`", "0-1": "array of the defined proxy endpoints" }, "cols": 2, "rows": 1 } [/block] Each `proxy_endpoint` will have the following keys: [block:parameters] { "data": { "h-0": "key", "h-1": "type", "0-0": "api_id", "1-0": "endpoint_group_id", "2-0": "environment_id", "3-0": "id", "4-0": "name", "5-0": "description", "5-1": "`string`", "6-0": "active", "0-1": "`number`", "1-1": "`number`", "2-1": "`number`", "3-1": "`number`", "4-1": "`string`", "6-1": "`boolean`", "h-2": "description", "0-2": "The API identifier", "1-2": "The endpoint group identifier", "2-2": "The environment identifier", "3-2": "The proxy endpoint identifier", "4-2": "The name of the proxy endpoint", "5-2": "The description of the proxy endpoint", "6-2": "Indicates if the proxy endpoint is active or inactive" }, "cols": 3, "rows": 7 } [/block]