{"_id":"564b523ce5d9d61700d580e0","category":{"_id":"563a252e50bf950d00e0979c","project":"563a252d50bf950d00e09798","pages":["563a252f50bf950d00e0979e","563a35ac1846790d0089532c","563d1407d8f2d20d00448d3c","563d1d3f9799fb0d0004776a","564509aa2c74cf1900da48c7","56453b7e9f3f550d00fa3c7b","564b498aeed7de0d003672c3","564b523ce5d9d61700d580e0","564b58ea1a8e610d006bfd49","564b59baee12850d00958656","564b6773d969330d00aba984","564b69b2d7b95d0d00ed050f","564b7fa8cc472d0d00da9447","564b905fa8a0ba21002ad6b1","564ba051288b1a2b00b3ae83","564ba6275cc43717009bcff1","564bb2138841060d00abb2e0","564bb74e05c99e1700161dd1","564c8ad60ddedc210051e582","564cca42d0c5b42b002305e8","564cca8ecfa4452b0019926d","564ce34f404ce53500fdb255","564cea76404ce53500fdb272","564cedb77d4d31170028dd2e","564cefc1bc81632100b10468","564cf17d1f42792b00820515","564cf5462248461700bd4017","564ddd49a8671617004e7b90","564ddf9ead1d5217003e2e18","564de1dea8671617004e7b99","564de3c11133043500f4bf96","564de669e39c4435005a1f65","564df3f16eaa3a2100868961","5655d3519347d30d00d7e8e2"],"version":"563a252d50bf950d00e0979b","__v":34,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-04T15:33:02.244Z","from_sync":false,"order":9999,"slug":"documentation","title":"Documentation"},"parentDoc":null,"version":{"_id":"563a252d50bf950d00e0979b","__v":7,"project":"563a252d50bf950d00e09798","createdAt":"2015-11-04T15:33:01.701Z","releaseDate":"2015-11-04T15:33:01.701Z","categories":["563a252e50bf950d00e0979c","563a2a691846790d008952fe","563a3394daf1c00d00136d9b","563a3467d25e8919005f3f0c","563a347850bf950d00e097b4","570e5cec10aa423200391fb5","5890d358d6cb8e2500a3f311"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"user":"54c7fdeae317000d007c2765","__v":3,"project":"563a252d50bf950d00e09798","updates":["5949394d2ef87900103711f8"],"next":{"pages":[],"description":""},"createdAt":"2015-11-17T16:13:48.361Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":12,"body":"[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /datasources/{id}/properties\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"0-1\": \"Get the properties for the specific data source ID.\",\n    \"1-1\": \"dashboard.library\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/datasources/{id}/properties\",\n    \"3-1\": \"id={datasource id}\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\nGET https://app.klipfolio.com/api/1/datasources/0123456789abcdef0123456789abcdef/properties\n\n##Example Response\n```\n{\n\"data\": {\n    \"properties\":\"The response here depends on the datasource type”\n},\n\"meta\": {\n   \"status\": 200,\n   \"success\": true\n}\n}\n```\n\n[block:api-header]\n{\n  \"type\": \"put\",\n  \"title\": \"PUT /datasources/{id}/properties\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Create or update the properties for this data source.\\n\\nAll properties must be updated at once, even unchanging fields. If the property exists, it will be updated. If the specified property does not already exist, it is created.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"datasource.edit\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/datasources/{id}/properties\",\n    \"3-1\": \"id={datasource id}\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\nPUT https://app.klipfolio.com/api/1/datasources/0123456789abcdef0123456789abcdef -d {'properties': {'endpoint_url': 'http://abcd.com', 'other_example_prop': 'something'}\n\n##Example Response\n```\n\"meta\": {\n   \"status\": 200,\n   \"success\": true\n}\n```\n[block:api-header]\n{\n  \"type\": \"delete\",\n  \"title\": \"DELETE /datasources/{id}/properties\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Delete a specific datasource property.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"3-1\": \"None.\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/datasources/{id}/properties?<field>=<value>\",\n    \"1-1\": \"datasource.edit\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\nDELETE https://app.klipfolio.com/api/1/datasources/0123456789abcdef0123456789abcdef/properties?name='Stuff'\n\n##Example Response\n```\n{\n\"meta\": {\n      \"status\": 200,\n      \"success\": true\n  }\n}\n```","excerpt":"Specify how to connect to the data source, end point URL, method (GET/POST). Each data source has its own set of properties.","slug":"data-source-properties","type":"basic","title":"Data Source Properties"}

Data Source Properties

Specify how to connect to the data source, end point URL, method (GET/POST). Each data source has its own set of properties.

[block:api-header] { "type": "get", "title": "GET /datasources/{id}/properties" } [/block] [block:parameters] { "data": { "0-0": "Description", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "0-1": "Get the properties for the specific data source ID.", "1-1": "dashboard.library", "2-1": "https://app.klipfolio.com/api/1.0/datasources/{id}/properties", "3-1": "id={datasource id}" }, "cols": 2, "rows": 4 } [/block] ##Example Request GET https://app.klipfolio.com/api/1/datasources/0123456789abcdef0123456789abcdef/properties ##Example Response ``` { "data": { "properties":"The response here depends on the datasource type” }, "meta": { "status": 200, "success": true } } ``` [block:api-header] { "type": "put", "title": "PUT /datasources/{id}/properties" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Create or update the properties for this data source.\n\nAll properties must be updated at once, even unchanging fields. If the property exists, it will be updated. If the specified property does not already exist, it is created.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "datasource.edit", "2-1": "https://app.klipfolio.com/api/1.0/datasources/{id}/properties", "3-1": "id={datasource id}" }, "cols": 2, "rows": 4 } [/block] ##Example Request PUT https://app.klipfolio.com/api/1/datasources/0123456789abcdef0123456789abcdef -d {'properties': {'endpoint_url': 'http://abcd.com', 'other_example_prop': 'something'} ##Example Response ``` "meta": { "status": 200, "success": true } ``` [block:api-header] { "type": "delete", "title": "DELETE /datasources/{id}/properties" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Delete a specific datasource property.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "3-1": "None.", "2-1": "https://app.klipfolio.com/api/1.0/datasources/{id}/properties?<field>=<value>", "1-1": "datasource.edit" }, "cols": 2, "rows": 4 } [/block] ##Example Request DELETE https://app.klipfolio.com/api/1/datasources/0123456789abcdef0123456789abcdef/properties?name='Stuff' ##Example Response ``` { "meta": { "status": 200, "success": true } } ```