Siren Platform User Guide

Datasource management

The endpoint for datasource management is at /_siren/connector/datasources.

Datasource creation and modification

A datasource with a specific id can be updated by issuing a PUT request as follows:

PUT /_siren/connector/datasource/<id>
{
  "jdbc": {
    "username": "username",
    "password": "password",
    "driver": "com.db.Driver",
    "url": "jdbc:db://localhost:5432/default"
  }
}

Body parameters:

  • jdbc: The JDBC configuration of the datasource.

JDBC configuration parameters:

  • driver: The class name of the JDBC driver.

  • url: the JDBC URL of the datasource.

  • username (optional): The username that will be passed to the JDBC driver when getting a connection.

  • password (optional): The password that will be passed to the JDBC driver when getting a connection.

  • timezone: If date and timestamp fields are stored in a timezone other than UTC, specifying this parameter will instruct the plugin to convert dates and times to/from the specified timezone when performing queries and retrieving results.

Datasource deletion

To delete a datasource, issue a DELETE request:

DELETE /_siren/connector/datasource/<id>
Datasource listing

To list the datasources configured in the system, issue a GET request:

GET /_siren/connector/datasource/_search
Datasource validation

To validate the connection to a datasource, issue a POST request:

POST /_siren/connector/datasource/<id>/_validate