Skip to content

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:

bash
curl -X GET "http://127.0.0.1:8020/api/v1/user/configs" \
  -H "X-API-Key: your_api_key_here"

This endpoint loads all user configurations including existing connections and stream configurations. Make sure to call this endpoint:

  • When starting your application
  • Before listing or managing connections
  • Before creating or managing streams

DBConvert Streams - event driven replication for databases