DBConvert Streams API Reference

DBConvert Streams provides a comprehensive REST API that allows you to programmatically control and manage your data streaming operations. The API enables you to:

Configure database connections
Create and manage data streams
Monitor running streams and their statistics
Control stream lifecycle

Important

Before using any connection or stream endpoints, you must first call the /user/configs endpoint to load existing configurations:

Here's a quick example of a basic API call:

bash

curl -X GET "http://YOUR_SERVER/api/user/configs" \
  -H "accept: application/json" \
  -H "x-api-key: YOUR_API_KEY"

All API endpoints are accessible at the base URL http://YOUR_SERVER/api/, where YOUR_SERVER is your server's hostname or IP address.

DBConvert Streams API Reference ​

DBConvert Streams API Reference