{"_id":"588f722cbcace50f0052ba2e","user":"565f3941ea46251700972783","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"},"__v":0,"parentDoc":null,"project":"565f5fa26bafd40d0030a064","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-21T21:37:41.185Z","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 POST -d '{\"remote_endpoint\":{\"type\":\"http\",\"name\":\"Employee - GET\",\"codename\":\"employee\",\"description\":\"Read employee by ID. URL will be set in proxy endpoint logic.\",\"status\":null,\"status_message\":null,\"method\":\"GET\",\"wsdl\":null,\"service_name\":null,\"auth_scheme\":null,\"url\":null,\"schema\":null,\"sslmode\":\"prefer\",\"server\":null,\"port\":null,\"database\":null,\"transactions\":false,\"timeout\":null,\"maxopen\":null,\"maxidle\":null,\"limit\":16,\"username\":null,\"password\":null,\"interpreter\":null,\"filepath\":null,\"script\":null,\"environment_data\":[],\"hosts\":[],\"data\":{\"headers\":{},\"query\":{},\"url\":null,\"method\":\"GET\"}}}' https://dashboard.nanoscale.io/apis/13/remote_endpoints"}]},"method":"post","results":{"codes":[{"code":"{\n    \"remote_endpoint\": {\n        \"api_id\": 13,\n        \"id\": 381,\n        \"name\": \"Employee - GET\",\n        \"codename\": \"employee\",\n        \"description\": \"Read employee by ID. URL will be set in proxy endpoint logic.\",\n        \"type\": \"http\",\n        \"status\": null,\n        \"status_message\": null,\n        \"data\": {\n            \"headers\": {},\n            \"query\": {},\n            \"url\": null,\n            \"method\": \"GET\"\n        },\n        \"environment_data\": []\n    }\n}","name":"","status":200,"language":"json"}]},"settings":"","auth":"required","params":[],"url":"/remote_endpoints"},"isReference":true,"order":18,"body":"Creates a single remote endpoint.\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\": \"type\",\n    \"1-0\": \"name\",\n    \"2-0\": \"codename\",\n    \"3-0\": \"description\",\n    \"4-0\": \"status\",\n    \"5-0\": \"status_message\",\n    \"6-0\": \"method\",\n    \"7-0\": \"wsdl\",\n    \"8-0\": \"service_name\",\n    \"9-0\": \"auth_scheme\",\n    \"10-0\": \"url\",\n    \"11-0\": \"schema\",\n    \"12-0\": \"sslmode\",\n    \"13-0\": \"server\",\n    \"14-0\": \"port\",\n    \"15-0\": \"database\",\n    \"16-0\": \"transactions\",\n    \"17-0\": \"timeout\",\n    \"18-0\": \"maxopen\",\n    \"19-0\": \"maxidle\",\n    \"20-0\": \"limit\",\n    \"21-0\": \"username\",\n    \"22-0\": \"password\",\n    \"23-0\": \"interpreter\",\n    \"24-0\": \"filepath\",\n    \"25-0\": \"script\",\n    \"26-0\": \"environment_data\",\n    \"27-0\": \"hosts\",\n    \"28-0\": \"data\",\n    \"28-1\": \"`object`\",\n    \"0-1\": \"`string`\",\n    \"0-2\": \"The type of remote endpoint. It can be one of the following types: `http`, `soap`, `sqlserver`, `postgres`, `mysql`, `mongodb`\",\n    \"1-1\": \"`string`\",\n    \"1-2\": \"The name of the remote endpoint\",\n    \"2-1\": \"`string`\",\n    \"2-2\": \"The variable name that is used to refer to the remote endpoint from javascript.\",\n    \"3-1\": \"`string`\",\n    \"3-2\": \"The description of the remote endpoint\",\n    \"4-1\": \"`string`\",\n    \"4-2\": \"indicates whether the latest background processing operation was successful, failed, or is in process. It can be one of the following types: `\\\"Pending\\\"`, `\\\"Processing\\\"`, `\\\"Failed\\\"`, `\\\"Success\\\"`.\\n\\nStatus is used for asynchronous processing (currently only with SOAP remote endpoints) related to a remote endpoint.  when a SOAP endpoint is created, some background processing is done to ingest the WSDL and generate code using the Java JAX-WS framework.\\n\\nThis field only applies to remote endpoints of the following type(s): `soap`\",\n    \"5-1\": \"`string`\",\n    \"5-2\": \"A human readable description of what went wrong, in the case that status indicates `error`.\\n\\nThis field only applies to remote endpoints of the following type(s): `soap`\",\n    \"6-1\": \"`string`\",\n    \"6-2\": \"The method of the remote endpoint call. It can be any of the following types: `GET`, `PUT`, `POST`, `DELETE`.\",\n    \"7-2\": \"The file that describes the SOAP web service (WSDL stands for web services description language).  Describes the structure and contents of the messages that are passed back and forth between the client and the service, as well as the various operations that may be performed by the service.\\n\\nThis value is sent as a data URI encoded string.\\n\\nThis field only applies to remote endpoints of the following type(s): `soap`\",\n    \"8-2\": \"The name of the SOAP web service.\\n\\nThis field only applies to remote endpoints of the following type(s): `soap`\",\n    \"9-2\": \"The authentication scheme the SOAP web service uses.\\n\\nThis field only applies to remote endpoints of the following type(s): `soap`\",\n    \"8-1\": \"`string`\",\n    \"7-1\": \"`string`\",\n    \"9-1\": \"`string`\",\n    \"10-1\": \"`string`\",\n    \"10-2\": \"The url of the remote endpoint.\\n\\nThis field only applies to remote endpoints of the following type(s): `http`, `soap`\",\n    \"11-1\": \"`string`\",\n    \"11-2\": \"The name of the schema within the database.\\n\\nThis field only applies to remote endpoints of the following type(s): `sqlserver`\",\n    \"12-1\": \"`string`\",\n    \"12-2\": \"Indicates to the PostgreSQL instance how to establish SSL connectivity. It can be one of the following types: `disable`, `allow`, `prefer`, `require`, `verify-ca`, `verify-full`.\\n\\nMore information can be found [here](http://www.postgresql.org/docs/9.1/static/libpq-ssl.html).\\n\\nThis field only applies to remote endpoints of the following type(s): `postgres`\",\n    \"13-1\": \"`string`\",\n    \"13-2\": \"The host name or ip address of the server running the database instance.\\n\\nThis field only applies to remote endpoints of the following type(s): `mysql`, `sqlserver`\",\n    \"14-1\": \"`number`\",\n    \"14-2\": \"The port on the server that the databaseL instance is running on.\\n\\nThis field only applies to remote endpoints of the following type(s): `mongodb`, `sqlserver`, `postgres`, `mysql`\",\n    \"15-1\": \"`string`\",\n    \"16-1\": \"`boolean`\",\n    \"15-2\": \"The name of the database in the instance.\\n\\nThis field only applies to remote endpoints of the following type(s): `mongodb`, `sqlserver`, `postgres`, `mysql`\",\n    \"16-2\": \"Indicates wether the database supports transactions. If set to `true` then db queries are done in a transaction.\\n\\nThis field only applies to remote endpoints of the following type(s): `sqlserver`, `postgres`, `mysql`\",\n    \"20-2\": \"The size of the database pool. This refers to the maximum number of simultaneous clients that can be supported.\\n\\nThis field only applies to remote endpoints of the following type(s): `mongodb`, `sqlserver`, `postgres`, `mysql`\",\n    \"17-2\": \"The number of seconds before the connection to the database times out.\\n\\nThis field only applies to remote endpoints of the following type(s): `sqlserver`, `mysql`\",\n    \"18-2\": \"The maximum number of simultaneous open connections the database supports.\\n\\nThis field only applies to remote endpoints of the following type(s): `sqlserver`, `postgres`, `mysql`\",\n    \"19-2\": \"The maximum number of simultaneous idle connections the database supports.\\n\\nThis field only applies to remote endpoints of the following type(s): `sqlserver`, `postgres`, `mysql`\",\n    \"20-1\": \"`number`\",\n    \"18-1\": \"`number`\",\n    \"17-1\": \"`number`\",\n    \"19-1\": \"`number`\",\n    \"21-2\": \"The username of the user for the database or service (for `soap` endpoints).\\n\\nThis field only applies to remote endpoints of the following type(s): `soap`, `mongodb`, `sqlserver`, `postgres`, `mysql`\",\n    \"22-2\": \"The password of the user for the database or service (for `soap` endpoints).\\n\\nThis field only applies to remote endpoints of the following type(s): `soap`, `mongodb`, `sqlserver`, `postgres`, `mysql`\",\n    \"21-1\": \"`string`\",\n    \"22-1\": \"`string`\",\n    \"28-2\": \"Configuration properties that pertain to the remote endpoint.\\n\\nExplained [below](http://google.com)\",\n    \"23-1\": \"TODO\",\n    \"23-2\": \"TODO\",\n    \"24-1\": \"TODO\",\n    \"24-2\": \"TODO\",\n    \"25-1\": \"TODO\",\n    \"25-2\": \"TODO\",\n    \"26-1\": \"`object`\",\n    \"26-2\": \"Environment-specific overrides for the values in the data configuration object.\",\n    \"27-1\": \"`array`\",\n    \"27-2\": \"The array of servers running the mongoDB instance(s).\\n\\nThis field only applies to remote endpoints of the following type(s): `mongodb`\"\n  },\n  \"cols\": 3,\n  \"rows\": 29\n}\n[/block]\nThe following data configuration properties pertain to their respective remote endpoint types.\n\n## HTTP\n\nHere is a list of fields that can be provided for data configuration objects for remote endpoints of type `http`:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"headers\",\n    \"1-0\": \"query\",\n    \"2-0\": \"url\",\n    \"3-0\": \"method\",\n    \"2-1\": \"`string`\",\n    \"1-1\": \"`object`\",\n    \"0-1\": \"`object`\",\n    \"3-1\": \"`string`\",\n    \"0-2\": \"The headers sent to the remote endpoint.\",\n    \"1-2\": \"The query parameters sent to the remote endpoint.\",\n    \"2-2\": \"The url of the remote endpoint.\",\n    \"3-2\": \"The method of the remote endpoint call. It can be any of the following types: `GET`, `PUT`, `POST`, `DELETE`.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\nHere is an example of the `JSON` used to create a remote endpoint of type `http`:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"remote_endpoint\\\": {\\n        \\\"type\\\": \\\"http\\\",\\n        \\\"name\\\": \\\"Event - POST\\\",\\n        \\\"codename\\\": \\\"createEvent\\\",\\n        \\\"description\\\": \\\"Create a new event.\\\",\\n        \\\"status\\\": null,\\n        \\\"status_message\\\": null,\\n        \\\"method\\\": \\\"POST\\\",\\n        \\\"wsdl\\\": null,\\n        \\\"service_name\\\": null,\\n        \\\"auth_scheme\\\": null,\\n        \\\"url\\\": \\\"https://mocks.nanoscaleapi.io/v1/events/create\\\",\\n        \\\"schema\\\": null,\\n        \\\"sslmode\\\": \\\"prefer\\\",\\n        \\\"server\\\": null,\\n        \\\"port\\\": null,\\n        \\\"database\\\": null,\\n        \\\"transactions\\\": false,\\n        \\\"timeout\\\": null,\\n        \\\"maxopen\\\": null,\\n        \\\"maxidle\\\": null,\\n        \\\"limit\\\": 16,\\n        \\\"username\\\": null,\\n        \\\"password\\\": null,\\n        \\\"interpreter\\\": null,\\n        \\\"filepath\\\": null,\\n        \\\"script\\\": null,\\n        \\\"environment_data\\\": [],\\n        \\\"hosts\\\": [],\\n        \\\"data\\\": {\\n            \\\"headers\\\": {\\n              \\\"Authorization\\\": \\\"Basic YW55cHJlc2VuY2U6cGFzc3dvcmQ=\\\"\\n            },\\n            \\\"query\\\": {},\\n            \\\"url\\\": \\\"https://mocks.nanoscaleapi.io/v1/events/create\\\",\\n            \\\"method\\\": \\\"POST\\\"\\n        }\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## SOAP\n\nHere is a list of fields that can be provided for data configuration objects for remote endpoints of type `soap`:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"headers\",\n    \"1-0\": \"query\",\n    \"2-0\": \"wsdl\",\n    \"3-0\": \"serviceName\",\n    \"4-0\": \"url\",\n    \"5-0\": \"wssePasswordCredentials\",\n    \"6-0\": \"wssePasswordCredentials/username\",\n    \"7-0\": \"wssePasswordCredentials/password\",\n    \"0-1\": \"`object`\",\n    \"1-1\": \"`object`\",\n    \"2-1\": \"`string`\",\n    \"3-1\": \"`string`\",\n    \"4-1\": \"`string`\",\n    \"5-1\": \"`object`\",\n    \"6-1\": \"`string`\",\n    \"7-1\": \"`string`\",\n    \"0-2\": \"The headers sent to the remote endpoint.\",\n    \"1-2\": \"The query parameters sent to the remote endpoint.\",\n    \"2-2\": \"The file that describes the SOAP web service (WSDL stands for web services description language).  Describes the structure and contents of the messages that are passed back and forth between the client and the service, as well as the various operations that may be performed by the service.\\n\\nThis value is sent as a data URI encoded string.\",\n    \"3-2\": \"The name of the SOAP service.\",\n    \"4-2\": \"The url of the remote endpoint.\",\n    \"5-2\": \"The credentials for authenticating via WSSE against the SOAP endpoint.\",\n    \"7-2\": \"The password of the user for the SOAP service.\",\n    \"6-2\": \"The username of the user for the SOAP service.\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\nHere is an example of the `JSON` used to create a remote endpoint of type `soap`:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"remote_endpoint\\\": {\\n        \\\"type\\\": \\\"soap\\\",\\n        \\\"name\\\": \\\"weatherAPI\\\",\\n        \\\"codename\\\": \\\"weather\\\",\\n        \\\"description\\\": \\\"SOAP endpoint to collect weather data.\\\",\\n        \\\"status\\\": null,\\n        \\\"status_message\\\": null,\\n        \\\"method\\\": null,\\n        \\\"wsdl\\\": \\\"data:text/xml;base64,PD94bWwgd...\\\",\\n        \\\"service_name\\\": \\\"weather\\\",\\n        \\\"auth_scheme\\\": \\\"wsse\\\",\\n        \\\"url\\\": \\\"http://weather.data/service\\\",\\n        \\\"schema\\\": null,\\n        \\\"sslmode\\\": \\\"prefer\\\",\\n        \\\"server\\\": null,\\n        \\\"port\\\": null,\\n        \\\"database\\\": null,\\n        \\\"transactions\\\": false,\\n        \\\"timeout\\\": null,\\n        \\\"maxopen\\\": null,\\n        \\\"maxidle\\\": null,\\n        \\\"limit\\\": 16,\\n        \\\"username\\\": \\\"admin\\\",\\n        \\\"password\\\": \\\"admin\\\",\\n        \\\"interpreter\\\": null,\\n        \\\"filepath\\\": null,\\n        \\\"script\\\": null,\\n        \\\"environment_data\\\": [],\\n        \\\"hosts\\\": [],\\n        \\\"data\\\": {\\n            \\\"headers\\\": {},\\n            \\\"query\\\": {},\\n            \\\"wsdl\\\": \\\"data:text/xml;base64,PD94bWwgd...\\\",\\n            \\\"serviceName\\\": \\\"weather\\\",\\n            \\\"url\\\": \\\"http://weather.data/service\\\",\\n            \\\"wssePasswordCredentials\\\": {\\n                \\\"username\\\": \\\"admin\\\",\\n                \\\"password\\\": \\\"admin\\\"\\n            }\\n        }\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## MongoDB\n\nHere is a list of fields that can be provided for data configuration objects for remote endpoints of type `mongodb`:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"headers\",\n    \"1-0\": \"query\",\n    \"2-0\": \"config\",\n    \"3-0\": \"config/hosts\",\n    \"4-0\": \"config/host/host\",\n    \"5-0\": \"config/host/port\",\n    \"6-0\": \"config/host/remote_endpoint_id\",\n    \"7-0\": \"config/host/environment_datum_id\",\n    \"8-0\": \"config/database\",\n    \"10-0\": \"config/password\",\n    \"9-0\": \"config/username\",\n    \"0-1\": \"`object`\",\n    \"0-2\": \"The headers sent to the remote endpoint.\",\n    \"1-1\": \"`object`\",\n    \"1-2\": \"The query parameters sent to the remote endpoint.\",\n    \"2-1\": \"`object`\",\n    \"2-2\": \"The configuration properties specific to the database.\",\n    \"3-1\": \"`array`\",\n    \"3-2\": \"The array of servers running the mongoDB instance(s).\",\n    \"4-1\": \"`string`\",\n    \"4-2\": \"The host name or ip address of the server running the mongoDB instance.\",\n    \"5-1\": \"`number`\",\n    \"5-2\": \"The port on the server that the mongoDB instance is running on.\",\n    \"8-1\": \"`string`\",\n    \"9-1\": \"`string`\",\n    \"10-1\": \"`string`\",\n    \"8-2\": \"The name of the database in the mongoDB instance.\",\n    \"9-2\": \"The password of the user for the database.\",\n    \"10-2\": \"The username of the user for the database.\",\n    \"6-1\": \"`number`\",\n    \"7-1\": \"`number`\",\n    \"6-2\": \"The remote endpoint identifier.\",\n    \"7-2\": \"The environment datum identifier.\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]\nHere is an example of the `JSON` used to create a remote endpoint of type `mongodb`:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"remote_endpoint\\\": {\\n        \\\"type\\\": \\\"mongodb\\\",\\n        \\\"name\\\": \\\"MongoLab\\\",\\n        \\\"codename\\\": \\\"mongo\\\",\\n        \\\"description\\\": \\\"MongoDB\\\",\\n        \\\"status\\\": null,\\n        \\\"status_message\\\": null,\\n        \\\"method\\\": null,\\n        \\\"wsdl\\\": null,\\n        \\\"service_name\\\": null,\\n        \\\"auth_scheme\\\": null,\\n        \\\"url\\\": null,\\n        \\\"schema\\\": null,\\n        \\\"sslmode\\\": \\\"prefer\\\",\\n        \\\"server\\\": null,\\n        \\\"port\\\": null,\\n        \\\"database\\\": \\\"prototype\\\",\\n        \\\"transactions\\\": false,\\n        \\\"timeout\\\": null,\\n        \\\"maxopen\\\": null,\\n        \\\"maxidle\\\": null,\\n        \\\"limit\\\": 16,\\n        \\\"username\\\": \\\"admin\\\",\\n        \\\"password\\\": \\\"admin\\\",\\n        \\\"interpreter\\\": null,\\n        \\\"filepath\\\": null,\\n        \\\"script\\\": null,\\n        \\\"environment_data\\\": [],\\n        \\\"data\\\": {\\n            \\\"headers\\\": {},\\n            \\\"query\\\": {},\\n            \\\"config\\\": {\\n                \\\"hosts\\\": [\\n                    {\\n                        \\\"host\\\": \\\"https://mongolab.com/\\\",\\n                        \\\"port\\\": 27017,\\n                        \\\"remote_endpoint_id\\\": null,\\n                        \\\"environment_datum_id\\\": null\\n                    }\\n                ],\\n                \\\"database\\\": \\\"prototype\\\",\\n                \\\"username\\\": \\\"admin\\\",\\n                \\\"password\\\": \\\"admin\\\"\\n            },\\n            \\\"limit\\\": 16\\n        }\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## SQL Server\n\nHere is a list of fields that can be provided for data configuration objects for remote endpoints of type `sqlserver`:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"headers\",\n    \"1-0\": \"query\",\n    \"2-0\": \"config\",\n    \"3-0\": \"config/server\",\n    \"4-0\": \"config/port\",\n    \"5-0\": \"config/user id\",\n    \"6-0\": \"config/password\",\n    \"7-0\": \"config/database\",\n    \"8-0\": \"config/schema\",\n    \"9-0\": \"config/connection timeout\",\n    \"10-0\": \"transactions\",\n    \"11-0\": \"maxIdleConn\",\n    \"12-0\": \"maxOpenConn\",\n    \"0-1\": \"`object`\",\n    \"0-2\": \"The headers sent to the remote endpoint.\",\n    \"1-1\": \"`object`\",\n    \"2-1\": \"`object`\",\n    \"1-2\": \"The query parameters sent to the remote endpoint.\",\n    \"2-2\": \"The configuration properties specific to the database.\",\n    \"3-1\": \"`string`\",\n    \"3-2\": \"The host name or ip address of the server running the SQL Server instance.\",\n    \"4-1\": \"`number`\",\n    \"11-1\": \"`number`\",\n    \"12-1\": \"`number`\",\n    \"9-1\": \"`number`\",\n    \"4-2\": \"The port on the server that the SQL Server instance is running on.\",\n    \"5-1\": \"`string`\",\n    \"6-1\": \"`string`\",\n    \"7-1\": \"`string`\",\n    \"8-1\": \"`string`\",\n    \"10-1\": \"`boolean`\",\n    \"5-2\": \"The user id of the user for the database.\",\n    \"6-2\": \"The password of the user for the database.\",\n    \"7-2\": \"The name of the database in the SQL Server instance.\",\n    \"8-2\": \"The name of the schema within the database.\",\n    \"9-2\": \"The number of seconds before the connection to the database times out.\",\n    \"10-2\": \"Indicates wether the database supports transactions. If set to `true` then db queries are done in a transaction.\",\n    \"11-2\": \"The maximum number of simultaneous idle connections the database supports.\",\n    \"12-2\": \"The maximum number of simultaneous open connections the database supports.\"\n  },\n  \"cols\": 3,\n  \"rows\": 13\n}\n[/block]\nHere is an example of the `JSON` used to create a remote endpoint of type `sqlserver`:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"remote_endpoint\\\": {\\n        \\\"type\\\": \\\"sqlserver\\\",\\n        \\\"name\\\": \\\"MsSqlServer\\\",\\n        \\\"codename\\\": \\\"mssql\\\",\\n        \\\"description\\\": \\\"Microsoft SQL Server\\\",\\n        \\\"status\\\": null,\\n        \\\"status_message\\\": null,\\n        \\\"method\\\": null,\\n        \\\"wsdl\\\": null,\\n        \\\"service_name\\\": null,\\n        \\\"auth_scheme\\\": null,\\n        \\\"url\\\": null,\\n        \\\"schema\\\": \\\"mssql\\\",\\n        \\\"sslmode\\\": \\\"prefer\\\",\\n        \\\"server\\\": \\\"http://mssql.data\\\",\\n        \\\"port\\\": 666,\\n        \\\"database\\\": \\\"prototype\\\",\\n        \\\"transactions\\\": true,\\n        \\\"timeout\\\": 30,\\n        \\\"maxopen\\\": 30,\\n        \\\"maxidle\\\": 30,\\n        \\\"limit\\\": 16,\\n        \\\"username\\\": \\\"admin\\\",\\n        \\\"password\\\": \\\"admin\\\",\\n        \\\"interpreter\\\": null,\\n        \\\"filepath\\\": null,\\n        \\\"script\\\": null,\\n        \\\"environment_data\\\": [],\\n        \\\"hosts\\\": [],\\n        \\\"data\\\": {\\n            \\\"headers\\\": {},\\n            \\\"query\\\": {},\\n            \\\"config\\\": {\\n                \\\"server\\\": \\\"http://mssql.data\\\",\\n                \\\"port\\\": 1433,\\n                \\\"user id\\\": \\\"admin\\\",\\n                \\\"password\\\": \\\"admin\\\",\\n                \\\"database\\\": \\\"prototype\\\",\\n                \\\"schema\\\": \\\"mssql\\\",\\n                \\\"connection timeout\\\": 30\\n            },\\n            \\\"transactions\\\": true,\\n            \\\"maxIdleConn\\\": 30,\\n            \\\"maxOpenConn\\\": 30\\n        }\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## PostgreSQL\n\nHere is a list of fields that can be provided for data configuration objects for remote endpoints of type `postgres`:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"headers\",\n    \"1-0\": \"query\",\n    \"2-0\": \"config\",\n    \"3-0\": \"config/host\",\n    \"4-0\": \"config/port\",\n    \"5-0\": \"config/user\",\n    \"6-0\": \"config/password\",\n    \"7-0\": \"config/dbname\",\n    \"8-0\": \"config/sslmode\",\n    \"9-0\": \"transactions\",\n    \"10-0\": \"maxIdleConn\",\n    \"11-0\": \"maxOpenConn\",\n    \"0-1\": \"`object`\",\n    \"1-1\": \"`object`\",\n    \"2-1\": \"`object`\",\n    \"0-2\": \"The headers sent to the remote endpoint.\",\n    \"1-2\": \"The query parameters sent to the remote endpoint.\",\n    \"2-2\": \"The configuration properties specific to the database.\",\n    \"3-1\": \"`string`\",\n    \"3-2\": \"The host name or ip address of the server running the PostgreSQL instance.\",\n    \"4-1\": \"`number`\",\n    \"4-2\": \"The port on the server that the PostgreSQL instance is running on.\",\n    \"5-1\": \"`string`\",\n    \"5-2\": \"The name of the user for the database.\",\n    \"6-1\": \"`string`\",\n    \"6-2\": \"The password of the user for the database.\",\n    \"7-1\": \"`string`\",\n    \"7-2\": \"The name of the database in the PostgreSQL instance.\",\n    \"8-1\": \"`string`\",\n    \"8-2\": \"Indicates to the PostgreSQL instance how to establish SSL connectivity. It can be one of the following types: `disable`, `allow`, `prefer`, `require`, `verify-ca`, `verify-full`.\\n\\nMore information can be found [here](http://www.postgresql.org/docs/9.1/static/libpq-ssl.html).\",\n    \"11-1\": \"`number`\",\n    \"11-2\": \"The maximum number of simultaneous open connections the database supports.\",\n    \"9-1\": \"`boolean`\",\n    \"9-2\": \"Indicates wether the database supports transactions. If set to `true` then db queries are done in a transaction.\",\n    \"10-1\": \"`number`\",\n    \"10-2\": \"The maximum number of simultaneous idle connections the database supports.\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]\nHere is an example of the `JSON` used to create a remote endpoint of type `postgres`:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"remote_endpoint\\\": {\\n        \\\"type\\\": \\\"postgres\\\",\\n        \\\"name\\\": \\\"Pg\\\",\\n        \\\"codename\\\": \\\"Pg\\\",\\n        \\\"description\\\": \\\"Postgres database\\\",\\n        \\\"status\\\": null,\\n        \\\"status_message\\\": null,\\n        \\\"method\\\": null,\\n        \\\"wsdl\\\": null,\\n        \\\"service_name\\\": null,\\n        \\\"auth_scheme\\\": null,\\n        \\\"url\\\": null,\\n        \\\"schema\\\": null,\\n        \\\"sslmode\\\": \\\"prefer\\\",\\n        \\\"server\\\": \\\"http://postgres.data\\\",\\n        \\\"port\\\": 5432,\\n        \\\"database\\\": \\\"prototype\\\",\\n        \\\"transactions\\\": false,\\n        \\\"timeout\\\": null,\\n        \\\"maxopen\\\": 30,\\n        \\\"maxidle\\\": 30,\\n        \\\"limit\\\": 16,\\n        \\\"username\\\": \\\"admin\\\",\\n        \\\"password\\\": \\\"admin\\\",\\n        \\\"interpreter\\\": null,\\n        \\\"filepath\\\": null,\\n        \\\"script\\\": null,\\n        \\\"environment_data\\\": [],\\n        \\\"hosts\\\": [],\\n        \\\"data\\\": {\\n            \\\"headers\\\": {},\\n            \\\"query\\\": {},\\n            \\\"config\\\": {\\n                \\\"host\\\": \\\"http://postgres.data\\\",\\n                \\\"port\\\": 5432,\\n                \\\"user\\\": \\\"admin\\\",\\n                \\\"password\\\": \\\"admin\\\",\\n                \\\"dbname\\\": \\\"prototype\\\",\\n                \\\"sslmode\\\": \\\"prefer\\\"\\n            },\\n            \\\"transactions\\\": false,\\n            \\\"maxIdleConn\\\": 30,\\n            \\\"maxOpenConn\\\": 30\\n        }\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## MySQL\n\nHere is a list of fields that can be provided for data configuration objects for remote endpoints of type `mysql`:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"headers\",\n    \"1-0\": \"query\",\n    \"2-0\": \"config\",\n    \"3-0\": \"config/server\",\n    \"4-0\": \"config/port\",\n    \"5-0\": \"config/username\",\n    \"6-0\": \"config/password\",\n    \"7-0\": \"config/dbname\",\n    \"8-0\": \"config/timeout\",\n    \"9-0\": \"transactions\",\n    \"10-0\": \"maxIdleConn\",\n    \"11-0\": \"maxOpenConn\",\n    \"2-1\": \"`object`\",\n    \"1-1\": \"`object`\",\n    \"0-1\": \"`object`\",\n    \"0-2\": \"The headers sent to the remote endpoint.\",\n    \"1-2\": \"The query parameters sent to the remote endpoint.\",\n    \"2-2\": \"The configuration properties specific to the database.\",\n    \"3-1\": \"`string`\",\n    \"5-1\": \"`string`\",\n    \"6-1\": \"`string`\",\n    \"7-1\": \"`string`\",\n    \"8-1\": \"`string`\",\n    \"4-1\": \"`number`\",\n    \"10-1\": \"`number`\",\n    \"11-1\": \"`number`\",\n    \"9-1\": \"`boolean`\",\n    \"3-2\": \"The host name or ip address of the server running the MySQL instance.\",\n    \"4-2\": \"The port on the server that the MySQL instance is running on.\",\n    \"5-2\": \"The username of the user for the database.\",\n    \"6-2\": \"The password of the user for the database.\",\n    \"7-2\": \"The name of the database in the MySQL instance.\",\n    \"8-2\": \"The number of seconds before the connection to the database times out.\",\n    \"9-2\": \"Indicates wether the database supports transactions. If set to `true` then db queries are done in a transaction.\",\n    \"10-2\": \"The maximum number of simultaneous idle connections the database supports.\",\n    \"11-2\": \"The maximum number of simultaneous open connections the database supports.\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]\nHere is an example of the `JSON` used to create a remote endpoint of type `mysql`:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"remote_endpoint\\\": {\\n        \\\"type\\\": \\\"mysql\\\",\\n        \\\"name\\\": \\\"MySQL\\\",\\n        \\\"codename\\\": \\\"MySQL\\\",\\n        \\\"description\\\": \\\"MySQL database\\\",\\n        \\\"status\\\": null,\\n        \\\"status_message\\\": null,\\n        \\\"method\\\": null,\\n        \\\"wsdl\\\": null,\\n        \\\"service_name\\\": null,\\n        \\\"auth_scheme\\\": null,\\n        \\\"url\\\": null,\\n        \\\"schema\\\": null,\\n        \\\"sslmode\\\": \\\"prefer\\\",\\n        \\\"server\\\": \\\"http://mysql.data\\\",\\n        \\\"port\\\": 5000,\\n        \\\"database\\\": \\\"prototype\\\",\\n        \\\"transactions\\\": true,\\n        \\\"timeout\\\": 30,\\n        \\\"maxopen\\\": 30,\\n        \\\"maxidle\\\": 30,\\n        \\\"limit\\\": 16,\\n        \\\"username\\\": \\\"admin\\\",\\n        \\\"password\\\": \\\"admin\\\",\\n        \\\"interpreter\\\": null,\\n        \\\"filepath\\\": null,\\n        \\\"script\\\": null,\\n        \\\"environment_data\\\": [],\\n        \\\"hosts\\\": [],\\n        \\\"data\\\": {\\n            \\\"headers\\\": {},\\n            \\\"query\\\": {},\\n            \\\"config\\\": {\\n                \\\"server\\\": \\\"http://testMysql\\\",\\n                \\\"port\\\": 5000,\\n                \\\"username\\\": \\\"admin\\\",\\n                \\\"password\\\": \\\"admin\\\",\\n                \\\"dbname\\\": \\\"prototype\\\",\\n                \\\"timeout\\\": \\\"30s\\\"\\n            },\\n            \\\"transactions\\\": false,\\n            \\\"maxIdleConn\\\": 30,\\n            \\\"maxOpenConn\\\": 30\\n        }\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"remote_endpoints-1","type":"endpoint","title":"/remote_endpoints"}

post/remote_endpoints


Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


Documentation

Creates a single remote endpoint. Here is a list of fields that can be provided: [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "type", "1-0": "name", "2-0": "codename", "3-0": "description", "4-0": "status", "5-0": "status_message", "6-0": "method", "7-0": "wsdl", "8-0": "service_name", "9-0": "auth_scheme", "10-0": "url", "11-0": "schema", "12-0": "sslmode", "13-0": "server", "14-0": "port", "15-0": "database", "16-0": "transactions", "17-0": "timeout", "18-0": "maxopen", "19-0": "maxidle", "20-0": "limit", "21-0": "username", "22-0": "password", "23-0": "interpreter", "24-0": "filepath", "25-0": "script", "26-0": "environment_data", "27-0": "hosts", "28-0": "data", "28-1": "`object`", "0-1": "`string`", "0-2": "The type of remote endpoint. It can be one of the following types: `http`, `soap`, `sqlserver`, `postgres`, `mysql`, `mongodb`", "1-1": "`string`", "1-2": "The name of the remote endpoint", "2-1": "`string`", "2-2": "The variable name that is used to refer to the remote endpoint from javascript.", "3-1": "`string`", "3-2": "The description of the remote endpoint", "4-1": "`string`", "4-2": "indicates whether the latest background processing operation was successful, failed, or is in process. It can be one of the following types: `\"Pending\"`, `\"Processing\"`, `\"Failed\"`, `\"Success\"`.\n\nStatus is used for asynchronous processing (currently only with SOAP remote endpoints) related to a remote endpoint. when a SOAP endpoint is created, some background processing is done to ingest the WSDL and generate code using the Java JAX-WS framework.\n\nThis field only applies to remote endpoints of the following type(s): `soap`", "5-1": "`string`", "5-2": "A human readable description of what went wrong, in the case that status indicates `error`.\n\nThis field only applies to remote endpoints of the following type(s): `soap`", "6-1": "`string`", "6-2": "The method of the remote endpoint call. It can be any of the following types: `GET`, `PUT`, `POST`, `DELETE`.", "7-2": "The file that describes the SOAP web service (WSDL stands for web services description language).  Describes the structure and contents of the messages that are passed back and forth between the client and the service, as well as the various operations that may be performed by the service.\n\nThis value is sent as a data URI encoded string.\n\nThis field only applies to remote endpoints of the following type(s): `soap`", "8-2": "The name of the SOAP web service.\n\nThis field only applies to remote endpoints of the following type(s): `soap`", "9-2": "The authentication scheme the SOAP web service uses.\n\nThis field only applies to remote endpoints of the following type(s): `soap`", "8-1": "`string`", "7-1": "`string`", "9-1": "`string`", "10-1": "`string`", "10-2": "The url of the remote endpoint.\n\nThis field only applies to remote endpoints of the following type(s): `http`, `soap`", "11-1": "`string`", "11-2": "The name of the schema within the database.\n\nThis field only applies to remote endpoints of the following type(s): `sqlserver`", "12-1": "`string`", "12-2": "Indicates to the PostgreSQL instance how to establish SSL connectivity. It can be one of the following types: `disable`, `allow`, `prefer`, `require`, `verify-ca`, `verify-full`.\n\nMore information can be found [here](http://www.postgresql.org/docs/9.1/static/libpq-ssl.html).\n\nThis field only applies to remote endpoints of the following type(s): `postgres`", "13-1": "`string`", "13-2": "The host name or ip address of the server running the database instance.\n\nThis field only applies to remote endpoints of the following type(s): `mysql`, `sqlserver`", "14-1": "`number`", "14-2": "The port on the server that the databaseL instance is running on.\n\nThis field only applies to remote endpoints of the following type(s): `mongodb`, `sqlserver`, `postgres`, `mysql`", "15-1": "`string`", "16-1": "`boolean`", "15-2": "The name of the database in the instance.\n\nThis field only applies to remote endpoints of the following type(s): `mongodb`, `sqlserver`, `postgres`, `mysql`", "16-2": "Indicates wether the database supports transactions. If set to `true` then db queries are done in a transaction.\n\nThis field only applies to remote endpoints of the following type(s): `sqlserver`, `postgres`, `mysql`", "20-2": "The size of the database pool. This refers to the maximum number of simultaneous clients that can be supported.\n\nThis field only applies to remote endpoints of the following type(s): `mongodb`, `sqlserver`, `postgres`, `mysql`", "17-2": "The number of seconds before the connection to the database times out.\n\nThis field only applies to remote endpoints of the following type(s): `sqlserver`, `mysql`", "18-2": "The maximum number of simultaneous open connections the database supports.\n\nThis field only applies to remote endpoints of the following type(s): `sqlserver`, `postgres`, `mysql`", "19-2": "The maximum number of simultaneous idle connections the database supports.\n\nThis field only applies to remote endpoints of the following type(s): `sqlserver`, `postgres`, `mysql`", "20-1": "`number`", "18-1": "`number`", "17-1": "`number`", "19-1": "`number`", "21-2": "The username of the user for the database or service (for `soap` endpoints).\n\nThis field only applies to remote endpoints of the following type(s): `soap`, `mongodb`, `sqlserver`, `postgres`, `mysql`", "22-2": "The password of the user for the database or service (for `soap` endpoints).\n\nThis field only applies to remote endpoints of the following type(s): `soap`, `mongodb`, `sqlserver`, `postgres`, `mysql`", "21-1": "`string`", "22-1": "`string`", "28-2": "Configuration properties that pertain to the remote endpoint.\n\nExplained [below](http://google.com)", "23-1": "TODO", "23-2": "TODO", "24-1": "TODO", "24-2": "TODO", "25-1": "TODO", "25-2": "TODO", "26-1": "`object`", "26-2": "Environment-specific overrides for the values in the data configuration object.", "27-1": "`array`", "27-2": "The array of servers running the mongoDB instance(s).\n\nThis field only applies to remote endpoints of the following type(s): `mongodb`" }, "cols": 3, "rows": 29 } [/block] The following data configuration properties pertain to their respective remote endpoint types. ## HTTP Here is a list of fields that can be provided for data configuration objects for remote endpoints of type `http`: [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "headers", "1-0": "query", "2-0": "url", "3-0": "method", "2-1": "`string`", "1-1": "`object`", "0-1": "`object`", "3-1": "`string`", "0-2": "The headers sent to the remote endpoint.", "1-2": "The query parameters sent to the remote endpoint.", "2-2": "The url of the remote endpoint.", "3-2": "The method of the remote endpoint call. It can be any of the following types: `GET`, `PUT`, `POST`, `DELETE`." }, "cols": 3, "rows": 4 } [/block] Here is an example of the `JSON` used to create a remote endpoint of type `http`: [block:code] { "codes": [ { "code": "{\n \"remote_endpoint\": {\n \"type\": \"http\",\n \"name\": \"Event - POST\",\n \"codename\": \"createEvent\",\n \"description\": \"Create a new event.\",\n \"status\": null,\n \"status_message\": null,\n \"method\": \"POST\",\n \"wsdl\": null,\n \"service_name\": null,\n \"auth_scheme\": null,\n \"url\": \"https://mocks.nanoscaleapi.io/v1/events/create\",\n \"schema\": null,\n \"sslmode\": \"prefer\",\n \"server\": null,\n \"port\": null,\n \"database\": null,\n \"transactions\": false,\n \"timeout\": null,\n \"maxopen\": null,\n \"maxidle\": null,\n \"limit\": 16,\n \"username\": null,\n \"password\": null,\n \"interpreter\": null,\n \"filepath\": null,\n \"script\": null,\n \"environment_data\": [],\n \"hosts\": [],\n \"data\": {\n \"headers\": {\n \"Authorization\": \"Basic YW55cHJlc2VuY2U6cGFzc3dvcmQ=\"\n },\n \"query\": {},\n \"url\": \"https://mocks.nanoscaleapi.io/v1/events/create\",\n \"method\": \"POST\"\n }\n }\n}", "language": "json" } ] } [/block] ## SOAP Here is a list of fields that can be provided for data configuration objects for remote endpoints of type `soap`: [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "headers", "1-0": "query", "2-0": "wsdl", "3-0": "serviceName", "4-0": "url", "5-0": "wssePasswordCredentials", "6-0": "wssePasswordCredentials/username", "7-0": "wssePasswordCredentials/password", "0-1": "`object`", "1-1": "`object`", "2-1": "`string`", "3-1": "`string`", "4-1": "`string`", "5-1": "`object`", "6-1": "`string`", "7-1": "`string`", "0-2": "The headers sent to the remote endpoint.", "1-2": "The query parameters sent to the remote endpoint.", "2-2": "The file that describes the SOAP web service (WSDL stands for web services description language).  Describes the structure and contents of the messages that are passed back and forth between the client and the service, as well as the various operations that may be performed by the service.\n\nThis value is sent as a data URI encoded string.", "3-2": "The name of the SOAP service.", "4-2": "The url of the remote endpoint.", "5-2": "The credentials for authenticating via WSSE against the SOAP endpoint.", "7-2": "The password of the user for the SOAP service.", "6-2": "The username of the user for the SOAP service." }, "cols": 3, "rows": 8 } [/block] Here is an example of the `JSON` used to create a remote endpoint of type `soap`: [block:code] { "codes": [ { "code": "{\n \"remote_endpoint\": {\n \"type\": \"soap\",\n \"name\": \"weatherAPI\",\n \"codename\": \"weather\",\n \"description\": \"SOAP endpoint to collect weather data.\",\n \"status\": null,\n \"status_message\": null,\n \"method\": null,\n \"wsdl\": \"data:text/xml;base64,PD94bWwgd...\",\n \"service_name\": \"weather\",\n \"auth_scheme\": \"wsse\",\n \"url\": \"http://weather.data/service\",\n \"schema\": null,\n \"sslmode\": \"prefer\",\n \"server\": null,\n \"port\": null,\n \"database\": null,\n \"transactions\": false,\n \"timeout\": null,\n \"maxopen\": null,\n \"maxidle\": null,\n \"limit\": 16,\n \"username\": \"admin\",\n \"password\": \"admin\",\n \"interpreter\": null,\n \"filepath\": null,\n \"script\": null,\n \"environment_data\": [],\n \"hosts\": [],\n \"data\": {\n \"headers\": {},\n \"query\": {},\n \"wsdl\": \"data:text/xml;base64,PD94bWwgd...\",\n \"serviceName\": \"weather\",\n \"url\": \"http://weather.data/service\",\n \"wssePasswordCredentials\": {\n \"username\": \"admin\",\n \"password\": \"admin\"\n }\n }\n }\n}", "language": "json" } ] } [/block] ## MongoDB Here is a list of fields that can be provided for data configuration objects for remote endpoints of type `mongodb`: [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "headers", "1-0": "query", "2-0": "config", "3-0": "config/hosts", "4-0": "config/host/host", "5-0": "config/host/port", "6-0": "config/host/remote_endpoint_id", "7-0": "config/host/environment_datum_id", "8-0": "config/database", "10-0": "config/password", "9-0": "config/username", "0-1": "`object`", "0-2": "The headers sent to the remote endpoint.", "1-1": "`object`", "1-2": "The query parameters sent to the remote endpoint.", "2-1": "`object`", "2-2": "The configuration properties specific to the database.", "3-1": "`array`", "3-2": "The array of servers running the mongoDB instance(s).", "4-1": "`string`", "4-2": "The host name or ip address of the server running the mongoDB instance.", "5-1": "`number`", "5-2": "The port on the server that the mongoDB instance is running on.", "8-1": "`string`", "9-1": "`string`", "10-1": "`string`", "8-2": "The name of the database in the mongoDB instance.", "9-2": "The password of the user for the database.", "10-2": "The username of the user for the database.", "6-1": "`number`", "7-1": "`number`", "6-2": "The remote endpoint identifier.", "7-2": "The environment datum identifier." }, "cols": 3, "rows": 11 } [/block] Here is an example of the `JSON` used to create a remote endpoint of type `mongodb`: [block:code] { "codes": [ { "code": "{\n \"remote_endpoint\": {\n \"type\": \"mongodb\",\n \"name\": \"MongoLab\",\n \"codename\": \"mongo\",\n \"description\": \"MongoDB\",\n \"status\": null,\n \"status_message\": null,\n \"method\": null,\n \"wsdl\": null,\n \"service_name\": null,\n \"auth_scheme\": null,\n \"url\": null,\n \"schema\": null,\n \"sslmode\": \"prefer\",\n \"server\": null,\n \"port\": null,\n \"database\": \"prototype\",\n \"transactions\": false,\n \"timeout\": null,\n \"maxopen\": null,\n \"maxidle\": null,\n \"limit\": 16,\n \"username\": \"admin\",\n \"password\": \"admin\",\n \"interpreter\": null,\n \"filepath\": null,\n \"script\": null,\n \"environment_data\": [],\n \"data\": {\n \"headers\": {},\n \"query\": {},\n \"config\": {\n \"hosts\": [\n {\n \"host\": \"https://mongolab.com/\",\n \"port\": 27017,\n \"remote_endpoint_id\": null,\n \"environment_datum_id\": null\n }\n ],\n \"database\": \"prototype\",\n \"username\": \"admin\",\n \"password\": \"admin\"\n },\n \"limit\": 16\n }\n }\n}", "language": "json" } ] } [/block] ## SQL Server Here is a list of fields that can be provided for data configuration objects for remote endpoints of type `sqlserver`: [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "headers", "1-0": "query", "2-0": "config", "3-0": "config/server", "4-0": "config/port", "5-0": "config/user id", "6-0": "config/password", "7-0": "config/database", "8-0": "config/schema", "9-0": "config/connection timeout", "10-0": "transactions", "11-0": "maxIdleConn", "12-0": "maxOpenConn", "0-1": "`object`", "0-2": "The headers sent to the remote endpoint.", "1-1": "`object`", "2-1": "`object`", "1-2": "The query parameters sent to the remote endpoint.", "2-2": "The configuration properties specific to the database.", "3-1": "`string`", "3-2": "The host name or ip address of the server running the SQL Server instance.", "4-1": "`number`", "11-1": "`number`", "12-1": "`number`", "9-1": "`number`", "4-2": "The port on the server that the SQL Server instance is running on.", "5-1": "`string`", "6-1": "`string`", "7-1": "`string`", "8-1": "`string`", "10-1": "`boolean`", "5-2": "The user id of the user for the database.", "6-2": "The password of the user for the database.", "7-2": "The name of the database in the SQL Server instance.", "8-2": "The name of the schema within the database.", "9-2": "The number of seconds before the connection to the database times out.", "10-2": "Indicates wether the database supports transactions. If set to `true` then db queries are done in a transaction.", "11-2": "The maximum number of simultaneous idle connections the database supports.", "12-2": "The maximum number of simultaneous open connections the database supports." }, "cols": 3, "rows": 13 } [/block] Here is an example of the `JSON` used to create a remote endpoint of type `sqlserver`: [block:code] { "codes": [ { "code": "{\n \"remote_endpoint\": {\n \"type\": \"sqlserver\",\n \"name\": \"MsSqlServer\",\n \"codename\": \"mssql\",\n \"description\": \"Microsoft SQL Server\",\n \"status\": null,\n \"status_message\": null,\n \"method\": null,\n \"wsdl\": null,\n \"service_name\": null,\n \"auth_scheme\": null,\n \"url\": null,\n \"schema\": \"mssql\",\n \"sslmode\": \"prefer\",\n \"server\": \"http://mssql.data\",\n \"port\": 666,\n \"database\": \"prototype\",\n \"transactions\": true,\n \"timeout\": 30,\n \"maxopen\": 30,\n \"maxidle\": 30,\n \"limit\": 16,\n \"username\": \"admin\",\n \"password\": \"admin\",\n \"interpreter\": null,\n \"filepath\": null,\n \"script\": null,\n \"environment_data\": [],\n \"hosts\": [],\n \"data\": {\n \"headers\": {},\n \"query\": {},\n \"config\": {\n \"server\": \"http://mssql.data\",\n \"port\": 1433,\n \"user id\": \"admin\",\n \"password\": \"admin\",\n \"database\": \"prototype\",\n \"schema\": \"mssql\",\n \"connection timeout\": 30\n },\n \"transactions\": true,\n \"maxIdleConn\": 30,\n \"maxOpenConn\": 30\n }\n }\n}", "language": "json" } ] } [/block] ## PostgreSQL Here is a list of fields that can be provided for data configuration objects for remote endpoints of type `postgres`: [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "headers", "1-0": "query", "2-0": "config", "3-0": "config/host", "4-0": "config/port", "5-0": "config/user", "6-0": "config/password", "7-0": "config/dbname", "8-0": "config/sslmode", "9-0": "transactions", "10-0": "maxIdleConn", "11-0": "maxOpenConn", "0-1": "`object`", "1-1": "`object`", "2-1": "`object`", "0-2": "The headers sent to the remote endpoint.", "1-2": "The query parameters sent to the remote endpoint.", "2-2": "The configuration properties specific to the database.", "3-1": "`string`", "3-2": "The host name or ip address of the server running the PostgreSQL instance.", "4-1": "`number`", "4-2": "The port on the server that the PostgreSQL instance is running on.", "5-1": "`string`", "5-2": "The name of the user for the database.", "6-1": "`string`", "6-2": "The password of the user for the database.", "7-1": "`string`", "7-2": "The name of the database in the PostgreSQL instance.", "8-1": "`string`", "8-2": "Indicates to the PostgreSQL instance how to establish SSL connectivity. It can be one of the following types: `disable`, `allow`, `prefer`, `require`, `verify-ca`, `verify-full`.\n\nMore information can be found [here](http://www.postgresql.org/docs/9.1/static/libpq-ssl.html).", "11-1": "`number`", "11-2": "The maximum number of simultaneous open connections the database supports.", "9-1": "`boolean`", "9-2": "Indicates wether the database supports transactions. If set to `true` then db queries are done in a transaction.", "10-1": "`number`", "10-2": "The maximum number of simultaneous idle connections the database supports." }, "cols": 3, "rows": 12 } [/block] Here is an example of the `JSON` used to create a remote endpoint of type `postgres`: [block:code] { "codes": [ { "code": "{\n \"remote_endpoint\": {\n \"type\": \"postgres\",\n \"name\": \"Pg\",\n \"codename\": \"Pg\",\n \"description\": \"Postgres database\",\n \"status\": null,\n \"status_message\": null,\n \"method\": null,\n \"wsdl\": null,\n \"service_name\": null,\n \"auth_scheme\": null,\n \"url\": null,\n \"schema\": null,\n \"sslmode\": \"prefer\",\n \"server\": \"http://postgres.data\",\n \"port\": 5432,\n \"database\": \"prototype\",\n \"transactions\": false,\n \"timeout\": null,\n \"maxopen\": 30,\n \"maxidle\": 30,\n \"limit\": 16,\n \"username\": \"admin\",\n \"password\": \"admin\",\n \"interpreter\": null,\n \"filepath\": null,\n \"script\": null,\n \"environment_data\": [],\n \"hosts\": [],\n \"data\": {\n \"headers\": {},\n \"query\": {},\n \"config\": {\n \"host\": \"http://postgres.data\",\n \"port\": 5432,\n \"user\": \"admin\",\n \"password\": \"admin\",\n \"dbname\": \"prototype\",\n \"sslmode\": \"prefer\"\n },\n \"transactions\": false,\n \"maxIdleConn\": 30,\n \"maxOpenConn\": 30\n }\n }\n}", "language": "json" } ] } [/block] ## MySQL Here is a list of fields that can be provided for data configuration objects for remote endpoints of type `mysql`: [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "headers", "1-0": "query", "2-0": "config", "3-0": "config/server", "4-0": "config/port", "5-0": "config/username", "6-0": "config/password", "7-0": "config/dbname", "8-0": "config/timeout", "9-0": "transactions", "10-0": "maxIdleConn", "11-0": "maxOpenConn", "2-1": "`object`", "1-1": "`object`", "0-1": "`object`", "0-2": "The headers sent to the remote endpoint.", "1-2": "The query parameters sent to the remote endpoint.", "2-2": "The configuration properties specific to the database.", "3-1": "`string`", "5-1": "`string`", "6-1": "`string`", "7-1": "`string`", "8-1": "`string`", "4-1": "`number`", "10-1": "`number`", "11-1": "`number`", "9-1": "`boolean`", "3-2": "The host name or ip address of the server running the MySQL instance.", "4-2": "The port on the server that the MySQL instance is running on.", "5-2": "The username of the user for the database.", "6-2": "The password of the user for the database.", "7-2": "The name of the database in the MySQL instance.", "8-2": "The number of seconds before the connection to the database times out.", "9-2": "Indicates wether the database supports transactions. If set to `true` then db queries are done in a transaction.", "10-2": "The maximum number of simultaneous idle connections the database supports.", "11-2": "The maximum number of simultaneous open connections the database supports." }, "cols": 3, "rows": 12 } [/block] Here is an example of the `JSON` used to create a remote endpoint of type `mysql`: [block:code] { "codes": [ { "code": "{\n \"remote_endpoint\": {\n \"type\": \"mysql\",\n \"name\": \"MySQL\",\n \"codename\": \"MySQL\",\n \"description\": \"MySQL database\",\n \"status\": null,\n \"status_message\": null,\n \"method\": null,\n \"wsdl\": null,\n \"service_name\": null,\n \"auth_scheme\": null,\n \"url\": null,\n \"schema\": null,\n \"sslmode\": \"prefer\",\n \"server\": \"http://mysql.data\",\n \"port\": 5000,\n \"database\": \"prototype\",\n \"transactions\": true,\n \"timeout\": 30,\n \"maxopen\": 30,\n \"maxidle\": 30,\n \"limit\": 16,\n \"username\": \"admin\",\n \"password\": \"admin\",\n \"interpreter\": null,\n \"filepath\": null,\n \"script\": null,\n \"environment_data\": [],\n \"hosts\": [],\n \"data\": {\n \"headers\": {},\n \"query\": {},\n \"config\": {\n \"server\": \"http://testMysql\",\n \"port\": 5000,\n \"username\": \"admin\",\n \"password\": \"admin\",\n \"dbname\": \"prototype\",\n \"timeout\": \"30s\"\n },\n \"transactions\": false,\n \"maxIdleConn\": 30,\n \"maxOpenConn\": 30\n }\n }\n}", "language": "json" } ] } [/block]