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:
| Component | Description |
|---|---|
| id | Unique identifier |
| name | Display name |
| type | Driver type (mysql, postgres, mssql, etc.) |
| host | Server hostname/IP |
| port | Connection port |
| database | Database name |
| username | Authentication username |
| password | Authentication password (encrypted) |
| options | Driver-specific options |
| ssl | SSL/TLS configuration |
Supported Drivers
Common datasource types:
| Type | Description |
|---|---|
| mysql | MySQL database |
| postgres | PostgreSQL database |
| mssql | Microsoft SQL Server |
| mongodb | MongoDB database |
| oracle | Oracle database |
| snowflake | Snowflake data warehouse |
| bigquery | Google BigQuery |
| redshift | Amazon Redshift |
Authentication
All Datasource API endpoints require authentication via session cookies or API tokens.
Common Permission Patterns
- Create datasources -
datasources:createpermission - Edit datasource -
datasource:writepermission - Test connection -
datasource:testpermission - Delete datasource -
datasource:writepermission
Next Steps
Explore the specific endpoint categories:
- Core CRUD - Basic datasource operations
- Drivers & Templates - Available drivers and templates
- Connection Testing - Test datasource connections
- Field Mappings - Type mapping configuration
- Features - Database capabilities
- Links & Suites - Datasource relationships