Specify how to connect to the data source, end point URL, method (GET/POST). Each data source has its own set of properties.
GET /datasources/{id}/properties
| Description | Get the properties for the specific data source ID. |
| Permissions | dashboard.library |
| Resource URL | https://app.klipfolio.com/api/1.0/datasources/{id}/properties |
| Parameters | id={datasource id} |
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
}
}
PUT /datasources/{id}/properties
| Description | Create or update the properties for this data source. If the property exists, it will be updated. If the specified property does not already exist, it is created. |
| Permissions | datasource.edit |
| Resource URL | https://app.klipfolio.com/api/1.0/datasources/{id}/properties |
| Parameters | id={datasource id} |
Example Request
curl -X PUT https://app.klipfolio.com/api/1/datasources/0123456789abcdef0123456789abcdef/properties -d "{'properties': {'endpoint_url': 'http://abcd.com', 'other_example_prop': 'something'}}"
Example Response
"meta": {
"status": 200,
"success": true
}
DELETE /datasources/{id}/properties
| Description | Delete a specific datasource property. |
| Permissions | datasource.edit |
| Resource URL | https://app.klipfolio.com/api/1.0/datasources/{id}/properties?= |
| Parameters | None. |
Example Request
DELETE https://app.klipfolio.com/api/1/datasources/0123456789abcdef0123456789abcdef/properties?name='Stuff'
Example Response
{
"meta": {
"status": 200,
"success": true
}
}