SingleStore Flow Ingest API
On this page
The Ingest API enables you to configure pipelines for moving data from a supported source database into SingleStore.
-
Configure and test connections to supported source databases and the destination database (SingleStore).
-
Retrieve connection details for source and destination databases.
-
Set and retrieve schedules for data transfers, including modes such as manual, periodic, daily, weekly, and monthly.
-
List all databases selected for ingestion.
-
Perform pipeline operations, including full extract, sync struct, sync new tables, and manual delta.
Base URL
All Ingest API requests must be sent to the following base URL:
http://<host>:<port>/ingest/api/ingest
Where <host>
is the hostname or IP address and <port>
is the port number where the Ingest service is running.
Ingest API Reference
The following endpoints include HTTP methods, required headers, request and response formats, and example requests.
List Databases
Get Selected Tables
Returns all databases that are selected for Ingest.
Endpoint
GET /list-db/{database}/{schema}
Example Request
curl -X GET http://localhost:8081/ingest/api/ingest/list-db
Responses
200 OK - Success
[
{"name": "customers", "selected": true, "id": "customers"},
{"name": "employees", "selected": false, "id": "employees"},
{"name": "offices", "selected": false, "id": "offices"},
{"name": "orderdetails", "selected": false, "id": "orderdetails"},
{"name": "orderdetails2", "selected": false, "id": "orderdetails2"},
{"name": "orders", "selected": false, "id": "orders"},
{"name": "payments", "selected": false, "id": "payments"},
{"name": "productlines", "selected": false, "id": "productlines"},
{"name": "products", "selected": false, "id": "products"}
]
Additional Information
Supported Database Types
Source Database |
Extract Type |
Type |
---|---|---|
Oracle |
Log Miner |
rds. |
Oracle |
Fast Log Miner |
rds. |
Oracle |
Remote Log Miner |
rds. |
Oracle |
Continuous Log Miner |
rds. |
Oracle |
Full extracts |
rds. |
Oracle |
Timestamps |
rds. |
Oracle (Pluggable Database) |
Fast Log Miner |
rds. |
Oracle (Pluggable Database) |
Continuous Log Miner |
rds. |
Oracle (RAC) |
Log Miner |
rds. |
Oracle (RAC) |
Continuous Log Miner |
rds. |
Oracle (RAC) (Pluggable Database) |
Log Miner |
rds. |
Oracle 19c |
Continuous Log Miner |
rds. |
Oracle 19c (Pluggable Database) |
Continuous Log Miner |
rds. |
Microsoft SQL Server |
Change Tracking |
rds. |
Microsoft SQL Server |
CDC |
rds. |
Microsoft SQL Server |
Full extracts |
rds. |
Microsoft SQL Server |
Timestamps |
rds. |
MySQL 5. |
Log |
rds. |
MySQL 5. |
Continuous |
rds. |
Postgres |
Log |
rds. |
MongoDB |
Self-managed |
rds. |
MongoDB |
Atlas |
rds. |
Any Database |
Full Extracts |
rds. |
Default Ports
Source Database |
Default Port |
---|---|
Oracle |
1521 |
Microsoft SQL Server |
1433 |
MySQL 5. |
3306 |
Postgres |
5432 |
Last modified: October 8, 2025