Skip to main content

Datasource API Overview

The Informer Datasource API provides comprehensive endpoints for managing database connections, field mappings, and data source capabilities. All routes are prefixed with /api.

Features

  • CRUD Operations - Create, read, update, and delete datasources
  • Drivers - Support for multiple database types (MySQL, PostgreSQL, SQL Server, MongoDB, etc.)
  • Connection Testing - Verify datasource connectivity
  • Field Mappings - Map external field types to Informer types
  • Templates - Pre-configured datasource templates
  • Features - Database capability detection
  • Links - Relationships between datasources
  • Suites - Datasource collections

Datasource Structure

A datasource consists of:

ComponentDescription
idUnique identifier
nameDisplay name
typeDriver type (mysql, postgres, mssql, etc.)
hostServer hostname/IP
portConnection port
databaseDatabase name
usernameAuthentication username
passwordAuthentication password (encrypted)
optionsDriver-specific options
sslSSL/TLS configuration

Supported Drivers

Common datasource types:

TypeDescription
mysqlMySQL database
postgresPostgreSQL database
mssqlMicrosoft SQL Server
mongodbMongoDB database
oracleOracle database
snowflakeSnowflake data warehouse
bigqueryGoogle BigQuery
redshiftAmazon Redshift

Authentication

All Datasource API endpoints require authentication via session cookies or API tokens.

Common Permission Patterns

  • Create datasources - datasources:create permission
  • Edit datasource - datasource:write permission
  • Test connection - datasource:test permission
  • Delete datasource - datasource:write permission

Next Steps

Explore the specific endpoint categories: