# SingleStore Flow Ingest API > **📝 Note**: This is a Preview feature. The Ingest API enables you to configure pipelines for moving data from a supported source database into SingleStore. You can use this API to: * 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 available tables and their selection status for ingestion. * Perform pipeline operations, including full extract, sync struct, sync new tables, and manual delta. Refer to the [Example Flow API Scripts](https://docs.singlestore.com/cloud/load-data/load-data-with-singlestore-flow/singlestore-flow-api/example-flow-api-scripts.md) for sample Python and bash applications that use the API. ## Base URL All Ingest API requests must be sent to the following base URL: ```http http://:/ingest/api/ingest ``` Where `` is the hostname or IP address and `` 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. * *Save Source Database Configuration* ## Save Source Database ConfigurationSaves a new connection or updates an existing connection to a source database.## EndpointPATCH /conn-src## Request Headers| Header | Required | Value | Description | | ------------ | -------- | ---------------- | --------------------------- | | Content-Type | Yes | application/json | Media type of request body. |## Request BodyA JSON array of key-value pairs. Each object must contain both `name` and `value` keys, where `name` specifies the parameter name and `value` specifies its corresponding value.```json [ {"name":"host","value":""}, {"name": "port", "value": ""}, {"name":"uid","value":""}, {"name":"pwd","value":""}, {"name":"pwd2","value":""}, {"name":"type","value":""} ] ```## Body Parameters| Name | Required | Type | Description | | ---- | ------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | host | Yes | string | IP address or hostname of the source database server. | | port | Yes | string | Port used to connect to the database. Refer to[Default Ports](https://docs.singlestore.com/cloud/load-data/load-data-with-singlestore-flow/singlestore-flow-api/singlestore-flow-ingest-api/#additional-information-2.md). | | uid | Yes | string | Database user ID. | | pwd | Yes | string | Password for the database user. | | pwd2 | Yes | string | Confirmation of the password. Must match`pwd`. | | type | Yes | string | Type of database. Refer to[Supported Database Types](https://docs.singlestore.com/cloud/load-data/load-data-with-singlestore-flow/singlestore-flow-api/singlestore-flow-ingest-api/#additional-information-3.md). | | db | No | string | Database or schema name. | | drv | Yes if type =`rds.jdbcfe` | string | JDBC driver for the database server. | | url | Yes if type =`rds.jdbcfe` | string | JDBC connection string for the database server. |## Example Request```shell curl -X PATCH http://localhost:8081/ingest/api/ingest/conn-src \ -H "Content-Type: application/json" \ -d '[ {"name": "host","value": "127.0.0.1"}, {"name": "port","value": "3306"}, {"name": "uid","value": "admin"}, {"name": "pwd","value": ""}, {"name": "pwd2","value": ""}, {"name": "type","value": "rds.mysqlc"} ]' ```## Responses204 No Content**Note**: This endpoint only saves the connection information. To verify if the connection is successful, use `/conn-src/test`. * *Test Source Database Connection* ## Test Source Database ConnectionTests connection to a source database.## EndpointPOST /conn-src/test## Request Headers| Header | Required | Value | Description | | ------------ | -------- | ---------------- | --------------------------- | | Content-Type | Yes | application/json | Media type of request body. |## Request BodyA JSON array of key-value pairs. Each object must contain both `name` and `value` keys, where `name` specifies the parameter name and `value` specifies its corresponding value.```json [ {"name":"host","value":""}, {"name": "port", "value": ""}, {"name":"uid","value":""}, {"name":"pwd","value":""}, {"name":"pwd2","value":""}, {"name":"type","value":""} ] ```## Body Parameters| Name | Required | Type | Description | | ---- | ------------------------ | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | host | Yes | string | IP address or hostname of the source database server. | | port | Yes | string | Port used to connect to the database. Refer to[Default Ports](https://docs.singlestore.com/cloud/load-data/load-data-with-singlestore-flow/singlestore-flow-api/singlestore-flow-ingest-api/#additional-information-4.md). | | uid | Yes | string | Database user ID. | | pwd | Yes | string | Password for the database user. | | pwd2 | Yes | string | Confirmation of the password. Must match pwd. | | type | Yes | string | Type of database. Refer to[Supported Database Types](https://docs.singlestore.com/cloud/load-data/load-data-with-singlestore-flow/singlestore-flow-api/singlestore-flow-ingest-api/#additional-information-5.md). | | db | No | string | Database or schema name. | | drv | Yes if type = rds.jdbcfe | string | JDBC driver for the database server. | | url | Yes if type = rds.jdbcfe | string | JDBC connection string for the database server. |## Example Request```shell curl -X POST http://localhost:8081/ingest/api/ingest/conn-src/test \ -H "Content-Type: application/json" \ -d '[ {"name": "host", "value": "127.0.0.1"}, {"name": "port", "value": "3306"}, {"name": "uid", "value": "admin"}, {"name": "pwd", "value": ""}, {"name": "pwd2", "value": ""}, {"name": "type", "value": "rds.mysqlc"} ]' ```## Responses200 OK - Success```json {"success":true} ```200 OK - Invalid configuration```json { "messageList": [ { "topic": "db", "message": "Connection string is invalid. Unable to parse.", "status": "E" } ], "success": false, "status": "N" } ```200 OK - Invalid type or Driver not found```json { "messageList":[ { "topic": null, "message":"Error: Driver not found for rds.", "status":"E" } ], "success":false, "status":"N" } ``` * *Get Source Database Details* ## Get Source Database DetailsRetrieves information about the source database connection.## EndpointGET /conn-src## Example Request```shell curl -X GET http://localhost:8081/ingest/api/ingest/conn-src ```## Responses200 OK - Success```json [ {"name":"host", "value":"127.0.0.1"}, {"name":"id", "value":"CDCSRC"}, {"name":"port", "value":"3306"}, {"name":"pwd", "value":" ``````output ***"}, {"name":"pwd2", "value":"***"}, {"name":"status", "value":"Y"}, {"name":"type", "value":"rds.mysqlc"}, {"name":"uid", "value":"admin"} ] ```The `status` field shows whether the source connection is successful (`"Y"`) or unsuccessful (`"N"`). * *Save Destination Database Configuration* ## Save Destination Database ConfigurationSaves or updates a connection to the destination database (SingleStore).## EndpointPATCH /conn-dst## Request Headers| Header | Required | Value | Description | | ------------ | -------- | ---------------- | --------------------------- | | Content-Type | Yes | application/json | Media type of request body. |## Request BodyA JSON array of key-value pairs. Each object must contain both `name` and `value` keys, where `name` specifies the parameter name and `value` specifies its corresponding value.```json [ {"name":"host","value":""}, {"name":"port","value":""}, {"name":"uid","value":""}, {"name":"pwd","value":""}, {"name":"pwd2","value":""}, {"name":"type","value":""} ] ```## Body Parameters| Name | Required | Type | Description | | ---- | -------- | ------ | ----------------------------------------------------------------------------- | | host | Yes | string | IP address or hostname of the destination database server. | | port | Yes | string | Port used to connect to the database. The default port forSingleStoreis 3306. | | uid | Yes | string | Database user ID. | | pwd | Yes | string | Password for the database user. | | pwd2 | Yes | string | Confirmation of the password. Must match`pwd`. | | type | Yes | string | Type of database. Use`rds.sstorem`. | | db | No | string | Database or schema name. |## Example Request```shell curl -X PATCH http://localhost:8081/ingest/api/ingest/conn-dst \ -H "Content-Type: application/json" \ -d '[ {"name": "host", "value": "svc-b394b187-873b-453b-bd88-51ba4bcea04-dml.aws-virginia-8.svc.singlestore.com"}, {"name": "port", "value": "3306"}, {"name": "uid", "value": "admin"}, {"name": "pwd", "value": ""}, {"name": "pwd2", "value": ""}, {"name": "type", "value": "rds.sstorem"} ]' ```## Responses204 No Content**Note**: This endpoint only saves the connection information. To verify if the connection is successful, use `/conn-dst/test`. * *Test Destination Database Connection* ## Test Destination Database ConnectionTests connection to the destination database.## EndpointPOST /conn-dst/test## Request Headers| Header | Required | Value | Description | | ------------ | -------- | ---------------- | --------------------------- | | Content-Type | Yes | application/json | Media type of request body. |## Request BodyA JSON array of key-value pairs. Each object must contain both `name` and `value` keys, where `name` specifies the parameter name and `value` specifies its corresponding value.```json [ {"name":"host","value":""}, {"name": "port", "value": ""}, {"name":"uid","value":""}, {"name":"pwd","value":""}, {"name":"pwd2","value":""}, {"name":"type","value":""} ] ```## Body Parameters| Name | Required | Type | Description | | ---- | -------- | ------ | ------------------------------------------------------------------------------ | | host | Yes | string | IP address or hostname of the destination database server. | | port | Yes | string | Port used to connect to the database. The default port forSingleStoreis`3306`. | | uid | Yes | string | Database user ID. | | pwd | Yes | string | Password for the database user. | | pwd2 | Yes | string | Confirmation of the password. Must match`pwd`. | | type | Yes | string | Type of database. Use`rds.sstorem`. | | db | No | string | Database or schema name. |## Example Request```shell curl -X POST http://localhost:8081/ingest/api/ingest/conn-dst/test \ -H "Content-Type: application/json" \ -d '[ {"name": "host", "value": "svc-b394b187-873b-453b-bd88-51ba4b1ea04-dml.aws-virginia-8.svc.singlestore.com"}, {"name": "port", "value": "3306"}, {"name": "uid", "value": "admin"}, {"name": "pwd", "value": ""}, {"name": "pwd2", "value": ""}, {"name": "type", "value": "rds.sstorem"} ]' ```## Responses200 OK - Success```json {"success":true} ```200 OK - Invalid Configuration```json { "messageList": [ { "topic": "db", "message": "Connection string is invalid. Unable to parse.", "status": "E" } ], "success": false, "status": "N" } ```200 OK - Invalid type or Driver not found```json { "messageList":[ { "topic": null, "message":"Error: Driver not found for rds.", "status":"E" } ], "success":false, "status":"N" } ```200 OK - Connection Failure```json { "messageList": [ { "topic": null, "message": "Socket fail to connect to host:address=(host=svc-7a3c6c96-5392-4edd-aa04--dml.aws-oregon-4.svc.singlestore.com)(port=3306). svc-7a3c6c96-5392-4edd-aa04--dml.aws-oregon-4.svc.singlestore.com", "status": "E" } ], "success": false, "status": "N" } ``` * *Get Destination Database Details* ## Get Destination Database DetailsRetrieves information about the destination database connection.## EndpointGET /conn-dst## Example Request```shell curl -X GET http://localhost:8081/ingest/api/ingest/conn-dst ```## Responses200 OK - Success```json [ {"name":"host", "value":"svc-7a3c6c96-5392-4edd-aa04-0ffdf8101520-dml.aws-oregon-4.svc.singlestore.com"}, {"name":"id", "value":"CDCDST"}, {"name":"port", "value":"3306"}, {"name":"pwd", "value":" ``````output ***"}, {"name":"pwd2", "value":"***"}, {"name":"status", "value":"Y"}, {"name":"type", "value":"rds.sstorem"}, {"name":"uid", "value":"admin"} ] ```The status field shows whether the destination connection is successful (`"Y"`) or unsuccessful (`"N"`). * *Save a New License Key* ## Save a New License KeySaves or updates the license information for Ingest.## EndpointPATCH /config-var/licence## Request Headers| Header | Required | Value | Description | | ------------ | -------- | ---------------- | --------------------------- | | Content-Type | Yes | application/json | Media type of request body. |## Request BodyA JSON array containing the license key.```json [ {"name":"_lic_key","value":""} ] ```## Body Parameters| Name | Required | Type | Description | | ---------- | -------- | ------ | ------------ | | \_lic\_key | Yes | string | License key. |## Example Request```shell curl -X PATCH http://localhost:8081/ingest/api/ingest/config-var/licence \ -H "Content-Type: application/json" \ -d '[ {"name": "_lic_key", "value": "YYXY2-4X3USJ-SXXEXB-K6EZS-PXJMR-XXXXX"} ]' ```## Responses204 No Content * *Get License Information* ## Get License InformationRetrieves the license status, license key, and the product ID for the Ingest instance.## EndpointGET /config-var/licence## Example Request```shell curl -X GET http://localhost:8081/ingest/api/ingest/config-var/licence ```## Responses200 OK - License is valid```json [ {"name": "_lic_status", "value":"Expires on 01 Sep 2025 (8 units)"}, {"name": "_lic_key","value":"YYXY2-4X3USJ-SXXEXB-K6EZS-PXJMR-XXXXX"}, {"name": "_lic_prod","value":"IDB-AGWTC-1RX3A-HDHDS-SADHDS-HVV6G-YUYDAM"} ] ```200 OK - License expired or invalid```json [ {"name": "_lic_status","value":"Licence expired"}, {"name": "_lic_key","value":""}, {"name": "_lic_prod","value":"SBD-YHBCSG-SJNJS-ADJBH-KJKHH-KJKJH-SSDOPS"} ] ``` * *Save Schedule Settings* ## Save Schedule SettingsSets up the data transfer schedule by specifying one of the available modes: `manual`, `auto`, `periodic`, `daily`, or `weekly`.## EndpointPATCH /config-sched## Request Headers| Header | Required | Value | Description | | ------------ | -------- | ---------------- | --------------------------- | | Content-Type | Yes | application/json | Media type of request body. |## Request BodyA JSON object of schedule configurations. Example:```json { "type": "", "duration": "", "offset": "" } ```## Body Parameters| Name | Required | Type | Description | | --------- | --------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | type | Yes | string | Schedule type. Valid values:`manual`,`auto`,`periodic`,`daily`,`weekly`. | | duration | Required for`periodic`,`daily`,`weekly` | string | For`daily`and`weekly`, specifies what time of day the schedule should run, in`HHh``MMm`format (e.g., 14h46m).For periodic, specifies the interval between runs, in`DdHHhMMmSSs`format (e.g.,`1d02h05m10s`)Not applicable for`manual`or`auto`types. | | offset | No (Optional for`periodic`) | string | Offset from the base time in`DdHHhMMm`format. | | weekFlags | Required for`weekly` | string | The days of week in the`YYYYYYY`format, where each character represents a day of the week starting from Sunday to Saturday.
  • Y means the day is included.
  • N means the day is excluded.
For example:
  • YNNNNNN - Sunday only
  • NYYYYYN - Monday through Friday excluding Sunday and Saturday
|## Example Request```shell curl -X PATCH http://localhost:8081/ingest/api/ingest/config-sched \ -H "Content-Type: application/json" \ -d '{"type":"manual"}' ``````json curl -X PATCH http://localhost:8081/ingest/api/ingest/config-sched \ -H "Content-Type: application/json" \ -d '{ "type": "periodic", "duration": "0d00h05m00s", "offset": "0d00h01m" }' ```## Responses204 No Content * *Get Schedule Settings* ## Get Schedule SettingsRetrieves information about the configured data transfer schedule, including its type and frequency.## EndpointGET /config-sched## Example Request```shell curl -X GET http://localhost:8081/ingest/api/ingest/config-sched ```## Responses200 OK```json { "duration":"0d10h01m00s", "offset":"0d00h00m", "isScheduled":true, "type":"periodic", "weekFlags":null } ``````json { "duration":"04h00m", "offset":"0d00h00m", "isScheduled":true, "type":"daily", "weekFlags":null } ``` * *Select a Table for Ingestion* ## Select a Table for IngestionSelect a specific table for data ingestion from the given database and schema.## EndpointPATCH /config-tab/{database}/{schema}/{table}## Request Headers| Header | Required | Value | Description | | ------------ | -------- | ---------------- | --------------------------- | | Content-Type | Yes | application/json | Media type of request body. |## Path Parameters| Name | Required | Type | Description | | -------- | -------- | ------ | ------------------------------------- | | database | Yes | string | The name of the database. | | schema | Yes | string | The schema that contains the table. | | table | Yes | string | The name of the table to be selected. |## Request BodyA JSON object specifying the select flag.```json {"select":"Y"} ```## Body Parameters| Name | Required | Type | Description | | ------ | -------- | ------ | ------------------------------------------- | | select | Yes | string | Set to`Y`to select the table for ingestion. |## Example Request```shell curl -X PATCH http://localhost:8081/ingest/api/ingest/config-tab/mydb/classicmodels/customers \ -H "Content-Type: application/json" \ -d '{"select": "Y"}' ```## Responses204 No Content * *List Available Tables with Selection Status* ## List Available Tables with Selection StatusReturns all tables available in the specified database and schema. Each table includes a selected field indicating whether it is currently selected for ingestion.## EndpointGET /list-db/{database}/{schema}## Example Request```shell curl -X GET http://localhost:8081/ingest/api/ingest/list-db/mydb/classicmodels ```## Responses200 OK - Success```json [ {"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": "orders", "selected": false, "id": "orders"}, {"name": "payments", "selected": false, "id": "payments"}, {"name": "productlines", "selected": false, "id": "productlines"}, {"name": "products", "selected": false, "id": "products"} ] ``` * *Execute an Operation in Ingest* ## Execute an Operation in IngestInitiates a specific data operation by specifying the required operation type. Supported actions include: run a full extract, sync new tables, synchronize schema, or perform a manual delta operation.## EndpointPOST /ops/extract/{operation}## Request Headers| Header | Required | Value | Description | | ------------ | -------- | ---------------- | --------------------------- | | Content-Type | Yes | application/json | Media type of request body. |## Path Parameters| Name | Required | Type | Description | | --------- | -------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | operation | Yes | string | Valid values:`full`,`syncnew`,`syncstruct`,`delta`.
  • full: Extract and load all tables selected in the pipeline (except the ones set to be skipped).
  • syncnew: Extract and load the newly added tables in the pipeline.
  • syncstruct: Synchronize schema changes from source to the destination.
  • delta: Run a manual delta operation.
|## Example Request```shell curl -X POST http://localhost:8081/ingest/api/ingest/ops/extract/full ```## Responses200 OK - Valid OperationExamples:```json { "success": true, "message": "Full Extract requested" } ``````json { "success": true, "message": "Synchronize Structure requested" } ```200 OK - Operation failure```json { "success": false, "message":"Full Extract requested" } ``` ## Additional Information ## Supported Database Types | Source Database | Extract Type | Type | | --------------------------------- | -------------------- | ------------------ | | Oracle | Log Miner | rds.oracle11lm | | Oracle | Fast Log Miner | rds.oracle11lfm | | Oracle | Remote Log Miner | rds.oracle11lmrm | | Oracle | Continuous Log Miner | rds.oracle11lmc | | Oracle | Full extracts | rds.oraclefem | | Oracle | Timestamps | rds.oraclets | | Oracle (Pluggable Database) | Fast Log Miner | rds.oracle11lmp | | Oracle (Pluggable Database) | Continuous Log Miner | rds.oracle11lmcp | | Oracle (RAC) | Log Miner | rds.oracle11lmrac | | Oracle (RAC) | Continuous Log Miner | rds.oracle11lmcrac | | Oracle (RAC) (Pluggable Database) | Log Miner | rds.oracle11lmracp | | Oracle 19c | Continuous Log Miner | rds.oracle11lmc19 | | Oracle 19c (Pluggable Database) | Continuous Log Miner | rds.oracle11lmcp19 | | Microsoft SQL Server | Change Tracking | rds.msadbctm | | Microsoft SQL Server | CDC | rds.mscdcm | | Microsoft SQL Server | Full extracts | rds.msfull | | Microsoft SQL Server | Timestamps | rds.msts | | MySQL 5.1 or higher | Log | rds.mysql | | MySQL 5.1 or higher | Continuous | rds.mysqlc | | Postgres | Log | rds.pgres | | MongoDB | Self-managed | rds.mongo | | MongoDB | Atlas | rds.mongoatlas | | Any Database | Full Extracts | rds.jdbcfe | ## Default Ports | Source Database | Default Port | | -------------------- | ------------ | | Oracle | 1521 | | Microsoft SQL Server | 1433 | | MySQL 5.1 or higher | 3306 | | Postgres | 5432 | *** Modified at: February 3, 2026 Source: [/cloud/load-data/load-data-with-singlestore-flow/singlestore-flow-api/singlestore-flow-ingest-api/](https://docs.singlestore.com/cloud/load-data/load-data-with-singlestore-flow/singlestore-flow-api/singlestore-flow-ingest-api/) (An index of the documentation is available at /llms.txt)