{"_id":"588f722cbcace50f0052ba28","project":"565f5fa26bafd40d0030a064","user":"565f3941ea46251700972783","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"},"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"},"parentDoc":null,"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-06T20:59:52.166Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"proxy_endpoint\": {\n        \"api_id\": 4,\n        \"endpoint_group_id\": 22,\n        \"environment_id\": 4,\n        \"id\": 69,\n        \"name\": \"A Hello World proxy\",\n        \"description\": \"A simple hello world endpoint to test whether your nanoscale.io instance is running correctly.\",\n        \"active\": true,\n        \"cors_enabled\": true,\n        \"routes\": [\n            {\n                \"id\": 1,\n                \"path\": \"/helloworld\",\n                \"get_method\": true,\n                \"post_method\": false,\n                \"put_method\": false,\n                \"delete_method\": false,\n                \"proxy_endpoint_id\": 69,\n                \"methods\": [\n                    \"GET\"\n                ]\n            }\n        ],\n        \"components\": [\n            {\n                \"id\": 71,\n                \"conditional\": \"\",\n                \"conditional_positive\": true,\n                \"type\": \"js\",\n                \"data\": \"response.body = \\\"Hello world! Your nanoscale.io instance is running correctly.\\\";\"\n            },\n            {\n                \"id\": 106,\n                \"conditional\": \"1 == 1\",\n                \"conditional_positive\": false,\n                \"type\": \"single\",\n                \"before\": [\n                    {\n                        \"id\": 205,\n                        \"type\": \"js\",\n                        \"data\": \"var a = 1;\"\n                    }\n                ],\n                \"after\": [\n                    {\n                        \"id\": 206,\n                        \"type\": \"js\",\n                        \"data\": \"b == 3\"\n                    }\n                ],\n                \"call\": {\n                    \"id\": 100,\n                    \"remote_endpoint_id\": 46,\n                    \"endpoint_name_override\": \"Geolocation Override\",\n                    \"conditional\": \"2 == 2\",\n                    \"conditional_positive\": true\n                },\n                \"data\": \"\"\n            },\n            {\n                \"id\": 107,\n                \"conditional\": \"1 == 1\",\n                \"conditional_positive\": true,\n                \"type\": \"multi\",\n                \"before\": [\n                    {\n                        \"id\": 207,\n                        \"type\": \"js\",\n                        \"data\": \"var c = 1;\"\n                    }\n                ],\n                \"after\": [\n                    {\n                        \"id\": 208,\n                        \"type\": \"js\",\n                        \"data\": \"var d = 2;\"\n                    }\n                ],\n                \"calls\": [\n                    {\n                        \"id\": 101,\n                        \"remote_endpoint_id\": 46,\n                        \"endpoint_name_override\": \"geolocation override\",\n                        \"conditional\": \"\",\n                        \"conditional_positive\": true,\n                        \"before\": [\n                            {\n                                \"id\": 209,\n                                \"type\": \"js\",\n                                \"data\": \"\"\n                            }\n                        ],\n                        \"after\": [\n                            {\n                                \"id\": 210,\n                                \"type\": \"js\",\n                                \"data\": \"\"\n                            }\n                        ]\n                    },\n                    {\n                        \"id\": 102,\n                        \"remote_endpoint_id\": 49,\n                        \"endpoint_name_override\": \"\",\n                        \"conditional\": \"\",\n                        \"conditional_positive\": true,\n                        \"before\": [\n                            {\n                                \"id\": 211,\n                                \"type\": \"js\",\n                                \"data\": \"\"\n                            }\n                        ],\n                        \"after\": [\n                            {\n                                \"id\": 212,\n                                \"type\": \"js\",\n                                \"data\": \"\"\n                            }\n                        ]\n                    }\n                ],\n                \"data\": \"\"\n            }\n        ],\n        \"tests\": [\n            {\n                \"id\": 31,\n                \"name\": \"TestCase1\",\n                \"methods\": [\n                    \"GET\"\n                ],\n                \"route\": \"/helloworld\",\n                \"body\": \"\",\n                \"pairs\": [\n                    {\n                        \"id\": 22,\n                        \"type\": \"header\",\n                        \"key\": \"auth\",\n                        \"value\": \"token\"\n                    },\n                    {\n                        \"id\": 23,\n                        \"type\": \"get\",\n                        \"key\": \"query\",\n                        \"value\": \"param\"\n                    },\n                    {\n                        \"id\": 24,\n                        \"type\": \"path\",\n                        \"key\": \"argument\",\n                        \"value\": \"one\"\n                    }\n                ],\n                \"data\": null\n            }\n        ]\n    }\n}\n","name":""}]},"settings":"","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/149"}]},"method":"get","auth":"required","params":[{"_id":"568d815be4d4fe0d007bc0b0","ref":"","in":"path","required":true,"desc":"The proxy endpoint's id","default":"","type":"string","name":"id"}],"url":"/proxy_endpoints/:id"},"isReference":true,"order":12,"body":"Calling the `proxy_endpoints/:id` endpoint will return the full `proxy_endpoint` JSON object.\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\": \"endpoint_group_id\",\n    \"2-0\": \"environment_id\",\n    \"3-0\": \"id\",\n    \"4-0\": \"name\",\n    \"5-0\": \"description\",\n    \"6-0\": \"active\",\n    \"8-0\": \"routes\",\n    \"9-0\": \"routes/id\",\n    \"10-0\": \"routes/path\",\n    \"11-0\": \"routes/methods\",\n    \"12-0\": \"routes/get_method\",\n    \"13-0\": \"routes/put_method\",\n    \"14-0\": \"routes/post_method\",\n    \"15-0\": \"routes/delete_method\",\n    \"16-0\": \"routes/proxy_endpoint_id\",\n    \"17-0\": \"components\",\n    \"18-0\": \"components/id\",\n    \"19-0\": \"components/conditional\",\n    \"20-0\": \"components/conditional_positive\",\n    \"21-0\": \"components/type\",\n    \"22-0\": \"components/data\",\n    \"46-0\": \"tests\",\n    \"47-0\": \"tests/id\",\n    \"48-0\": \"tests/name\",\n    \"49-0\": \"tests/methods\",\n    \"50-0\": \"tests/route\",\n    \"51-0\": \"tests/body\",\n    \"57-0\": \"tests/data\",\n    \"0-1\": \"`number`\",\n    \"7-0\": \"cors_enabled\",\n    \"23-0\": \"components/before\",\n    \"24-0\": \"components/before/id\",\n    \"25-0\": \"components/before/type\",\n    \"26-0\": \"components/before/data\",\n    \"27-0\": \"components/after\",\n    \"28-0\": \"components/after/id\",\n    \"29-0\": \"components/after/type\",\n    \"30-0\": \"components/after/data\",\n    \"31-0\": \"components/call\",\n    \"33-0\": \"components/call/id\",\n    \"34-0\": \"components/call/remote_endpoint_id\",\n    \"35-0\": \"components/call/endpoint_name_override\",\n    \"36-0\": \"components/call/conditional\",\n    \"37-0\": \"components/call/conditional_positive\",\n    \"38-0\": \"components/call/before\",\n    \"32-0\": \"components/calls\",\n    \"39-0\": \"components/call/before/id\",\n    \"40-0\": \"components/call/before/type\",\n    \"41-0\": \"components/call/before/data\",\n    \"42-0\": \"components/call/after\",\n    \"43-0\": \"components/call/after/id\",\n    \"44-0\": \"components/call/after/type\",\n    \"45-0\": \"components/call/after/data\",\n    \"1-1\": \"`number`\",\n    \"2-1\": \"`number`\",\n    \"3-1\": \"`number`\",\n    \"4-1\": \"`string`\",\n    \"5-1\": \"`string`\",\n    \"6-1\": \"`boolean`\",\n    \"7-1\": \"`boolean`\",\n    \"8-1\": \"`array`\",\n    \"9-1\": \"`number`\",\n    \"10-1\": \"`string`\",\n    \"11-1\": \"`array`\",\n    \"12-1\": \"`boolean`\",\n    \"13-1\": \"`boolean`\",\n    \"14-1\": \"`boolean`\",\n    \"15-1\": \"`boolean`\",\n    \"16-1\": \"`number`\",\n    \"17-1\": \"`array`\",\n    \"18-1\": \"`number`\",\n    \"19-1\": \"`string`\",\n    \"20-1\": \"`boolean`\",\n    \"21-1\": \"`string`\",\n    \"22-1\": \"`string`\",\n    \"23-1\": \"`array`\",\n    \"24-1\": \"`number`\",\n    \"25-1\": \"`string`\",\n    \"26-1\": \"`string`\",\n    \"27-1\": \"`array`\",\n    \"28-1\": \"`number`\",\n    \"29-1\": \"`string`\",\n    \"30-1\": \"`string`\",\n    \"31-1\": \"`object`\",\n    \"32-1\": \"`array`\",\n    \"33-1\": \"`number`\",\n    \"34-1\": \"`number`\",\n    \"35-1\": \"`string`\",\n    \"36-1\": \"`string`\",\n    \"37-1\": \"`boolean`\",\n    \"38-1\": \"`array`\",\n    \"42-1\": \"`array`\",\n    \"39-1\": \"`number`\",\n    \"43-1\": \"`number`\",\n    \"40-1\": \"`string`\",\n    \"44-1\": \"`string`\",\n    \"45-1\": \"`string`\",\n    \"41-1\": \"`string`\",\n    \"46-1\": \"`array`\",\n    \"47-1\": \"`number`\",\n    \"48-1\": \"`string`\",\n    \"49-1\": \"`array`\",\n    \"50-1\": \"`string`\",\n    \"51-1\": \"`string`\",\n    \"57-1\": \"`string`\",\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    \"7-2\": \"Indicates if the proxy endpoint is CORS enabled\",\n    \"8-2\": \"An array of objects representing the routes belonging to the proxy endpoint\",\n    \"9-2\": \"The route identifier\",\n    \"10-2\": \"The url path of the route\",\n    \"11-2\": \"The array of HTTP methods the route accepts\",\n    \"12-2\": \"Indicates if the route accepts GET requests\",\n    \"13-2\": \"Indicates if the route accepts PUT requests\",\n    \"14-2\": \"Indicates if the route accepts POST requests\",\n    \"15-2\": \"Indicates if the route accepts DELETE requests\",\n    \"16-2\": \"The identifier of the proxy endpoint the route\",\n    \"17-2\": \"The array of workflow components belonging to the proxy endpoint\",\n    \"18-2\": \"The component identifier\",\n    \"19-2\": \"The type of conditional logic check\",\n    \"20-2\": \"Indicates if the conditional statement is \\\"if\\\" or \\\"unless\\\"\",\n    \"21-2\": \"The type of workflow component\",\n    \"22-2\": \"The conditional logic\",\n    \"23-2\": \"The before request logic object\",\n    \"24-2\": \"The before request logic object identifier\",\n    \"25-2\": \"The before request logic type\",\n    \"26-2\": \"The before request logic\",\n    \"27-2\": \"The after request logic object\",\n    \"28-2\": \"The after request logic object identifier\",\n    \"29-2\": \"The after request logic type\",\n    \"30-2\": \"The after request logic\",\n    \"31-2\": \"The remote endpoint call object\",\n    \"32-2\": \"The array of remote endpoint call objects\",\n    \"33-2\": \"The remote endpoint call identifier\",\n    \"34-2\": \"The remote endpoint identifier\",\n    \"35-2\": \"The name overriding the remote endpoint name\",\n    \"36-2\": \"The type of conditional logic\",\n    \"37-2\": \"Indicates if the conditional statement is \\\"if\\\" or \\\"unless\\\"\",\n    \"38-2\": \"The before request logic object\",\n    \"39-2\": \"The before request logic object identifier\",\n    \"40-2\": \"The before request logic type\",\n    \"41-2\": \"The before request logic\",\n    \"42-2\": \"The after request logic object\",\n    \"43-2\": \"The after request logic object identifier\",\n    \"44-2\": \"The after request logic type\",\n    \"45-2\": \"The after request logic\",\n    \"46-2\": \"The array of tests\",\n    \"47-2\": \"The test identifier\",\n    \"48-2\": \"The test name\",\n    \"49-2\": \"The array of HTTP methods the route accepts\",\n    \"50-2\": \"The url path of the route\",\n    \"52-0\": \"tests/pairs\",\n    \"53-0\": \"tests/pair/id\",\n    \"54-0\": \"tests/pair/type\",\n    \"55-0\": \"tests/pair/key\",\n    \"56-0\": \"tests/pair/value\",\n    \"52-2\": \"The array of test meta data pairs\",\n    \"52-1\": \"`array`\",\n    \"53-1\": \"`number`\",\n    \"54-1\": \"`string`\",\n    \"55-1\": \"`string`\",\n    \"56-1\": \"`string`\",\n    \"51-2\": \"The test request body\",\n    \"53-2\": \"The test meta data pair identifier\",\n    \"54-2\": \"The the test meta data pair type (header, query parameter, or type)\",\n    \"55-2\": \"The the test meta data pair key\",\n    \"56-2\": \"The the test meta data pair value\",\n    \"57-2\": \"The test data\"\n  },\n  \"cols\": 3,\n  \"rows\": 58\n}\n[/block]","excerpt":"","slug":"proxy_endpointsid-1","type":"endpoint","title":"/proxy_endpoints/:id"}

get/proxy_endpoints/:id


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The proxy endpoint's id

Examples


Result Format


Documentation

Calling the `proxy_endpoints/:id` endpoint will return the full `proxy_endpoint` JSON object. [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "api_id", "1-0": "endpoint_group_id", "2-0": "environment_id", "3-0": "id", "4-0": "name", "5-0": "description", "6-0": "active", "8-0": "routes", "9-0": "routes/id", "10-0": "routes/path", "11-0": "routes/methods", "12-0": "routes/get_method", "13-0": "routes/put_method", "14-0": "routes/post_method", "15-0": "routes/delete_method", "16-0": "routes/proxy_endpoint_id", "17-0": "components", "18-0": "components/id", "19-0": "components/conditional", "20-0": "components/conditional_positive", "21-0": "components/type", "22-0": "components/data", "46-0": "tests", "47-0": "tests/id", "48-0": "tests/name", "49-0": "tests/methods", "50-0": "tests/route", "51-0": "tests/body", "57-0": "tests/data", "0-1": "`number`", "7-0": "cors_enabled", "23-0": "components/before", "24-0": "components/before/id", "25-0": "components/before/type", "26-0": "components/before/data", "27-0": "components/after", "28-0": "components/after/id", "29-0": "components/after/type", "30-0": "components/after/data", "31-0": "components/call", "33-0": "components/call/id", "34-0": "components/call/remote_endpoint_id", "35-0": "components/call/endpoint_name_override", "36-0": "components/call/conditional", "37-0": "components/call/conditional_positive", "38-0": "components/call/before", "32-0": "components/calls", "39-0": "components/call/before/id", "40-0": "components/call/before/type", "41-0": "components/call/before/data", "42-0": "components/call/after", "43-0": "components/call/after/id", "44-0": "components/call/after/type", "45-0": "components/call/after/data", "1-1": "`number`", "2-1": "`number`", "3-1": "`number`", "4-1": "`string`", "5-1": "`string`", "6-1": "`boolean`", "7-1": "`boolean`", "8-1": "`array`", "9-1": "`number`", "10-1": "`string`", "11-1": "`array`", "12-1": "`boolean`", "13-1": "`boolean`", "14-1": "`boolean`", "15-1": "`boolean`", "16-1": "`number`", "17-1": "`array`", "18-1": "`number`", "19-1": "`string`", "20-1": "`boolean`", "21-1": "`string`", "22-1": "`string`", "23-1": "`array`", "24-1": "`number`", "25-1": "`string`", "26-1": "`string`", "27-1": "`array`", "28-1": "`number`", "29-1": "`string`", "30-1": "`string`", "31-1": "`object`", "32-1": "`array`", "33-1": "`number`", "34-1": "`number`", "35-1": "`string`", "36-1": "`string`", "37-1": "`boolean`", "38-1": "`array`", "42-1": "`array`", "39-1": "`number`", "43-1": "`number`", "40-1": "`string`", "44-1": "`string`", "45-1": "`string`", "41-1": "`string`", "46-1": "`array`", "47-1": "`number`", "48-1": "`string`", "49-1": "`array`", "50-1": "`string`", "51-1": "`string`", "57-1": "`string`", "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", "7-2": "Indicates if the proxy endpoint is CORS enabled", "8-2": "An array of objects representing the routes belonging to the proxy endpoint", "9-2": "The route identifier", "10-2": "The url path of the route", "11-2": "The array of HTTP methods the route accepts", "12-2": "Indicates if the route accepts GET requests", "13-2": "Indicates if the route accepts PUT requests", "14-2": "Indicates if the route accepts POST requests", "15-2": "Indicates if the route accepts DELETE requests", "16-2": "The identifier of the proxy endpoint the route", "17-2": "The array of workflow components belonging to the proxy endpoint", "18-2": "The component identifier", "19-2": "The type of conditional logic check", "20-2": "Indicates if the conditional statement is \"if\" or \"unless\"", "21-2": "The type of workflow component", "22-2": "The conditional logic", "23-2": "The before request logic object", "24-2": "The before request logic object identifier", "25-2": "The before request logic type", "26-2": "The before request logic", "27-2": "The after request logic object", "28-2": "The after request logic object identifier", "29-2": "The after request logic type", "30-2": "The after request logic", "31-2": "The remote endpoint call object", "32-2": "The array of remote endpoint call objects", "33-2": "The remote endpoint call identifier", "34-2": "The remote endpoint identifier", "35-2": "The name overriding the remote endpoint name", "36-2": "The type of conditional logic", "37-2": "Indicates if the conditional statement is \"if\" or \"unless\"", "38-2": "The before request logic object", "39-2": "The before request logic object identifier", "40-2": "The before request logic type", "41-2": "The before request logic", "42-2": "The after request logic object", "43-2": "The after request logic object identifier", "44-2": "The after request logic type", "45-2": "The after request logic", "46-2": "The array of tests", "47-2": "The test identifier", "48-2": "The test name", "49-2": "The array of HTTP methods the route accepts", "50-2": "The url path of the route", "52-0": "tests/pairs", "53-0": "tests/pair/id", "54-0": "tests/pair/type", "55-0": "tests/pair/key", "56-0": "tests/pair/value", "52-2": "The array of test meta data pairs", "52-1": "`array`", "53-1": "`number`", "54-1": "`string`", "55-1": "`string`", "56-1": "`string`", "51-2": "The test request body", "53-2": "The test meta data pair identifier", "54-2": "The the test meta data pair type (header, query parameter, or type)", "55-2": "The the test meta data pair key", "56-2": "The the test meta data pair value", "57-2": "The test data" }, "cols": 3, "rows": 58 } [/block]