Specifies how the API connects to the data source instance: end point URL, method. Each instance has its own set of properties. A data source instance is a copy of an original data source.

GET /datasource-instances/{id}/properties

Description

Get the properties for the specific

Permissions

dashboard.library

Resource URL

https://app.klipfolio.com/api/1.0/datasource-instances/{id}/properties

Parameters

id={datasource-instance id}

Example Request

GET https://app.klipfolio.com/api/1/datasource-instances/0123456789abcdef0123456789abcdef/properties
##Example Response

{
"data": {
    "properties":{...}
},
"meta": {
   "status": 200,
   "success": true
}
}

PUT /datasource-instances/{id}/properties

Description

Create or update properties for this data source instance. If the specified property does not already exist it is created, otherwise the existing property is updated.

Permissions

dashboard.library

Resource URL

https://app.klipfolio.com/api/1.0/datasource-instances/{id}/properties

Parameters

id={datasource-instance id}

Example Request

PUT https://app.klipfolio.com/api/1/datasource-instances/0123456789abcdef0123456789abcdef/properties -d "{'properties':{'Stuff':'NewStuff'}}"
##Example Response

{
"meta": {
   "status": 200,
   "success": true
}
}

DELETE /datasource-instances/{id}/properties

Description

Delete a specified data source instance.

Permissions

dashboard.library

Resource URL

https://app.klipfolio.com/api/1.0/datasource-instances/{id}/properties?name=

Parameters

id={datasource-instance id}, name=

Example Request

DELETE https://app.klipfolio.com/api/1/datasource-instances/0123456789abcdef0123456789abcdef/properties?name=’Stuff’
##Example Response

{
"meta": {
   "status": 200,
   "success": true
}
}