Skip to main content


Timeplus integrates with a wide range of systems as data sources, such as Apache Kafka.

You can define one or more sources to set up the background jobs to load data into Timeplus. Please check the Data Ingestion section for more details.

Source API

If you need to call an API to create a source, here are the references.


refer to

brokersyesSpecifies the list of broker addresses. This is a comma-separated string. such as kafka1:9092,kafka2:9092,kafka3:9092
topicyesSpecifies the Kafka topic to connect
offsetyesSpecifies the Kafka offset configuration. support latest,earliest
data_typeyesSpecifies the data type to use for creating the stream. support json,text,avro,debezium-json,debezium-json-upsert
groupnoSpecifies the Kafka consumer group. use the source uuid with prefix timeplus-source- as the default value if user does not specify ittimeplus-source-<uuid>
saslnoSpecifies the Simple Authentication and Security Layer (SASL) mechanism for authentication. support none,plain,scram-sha-256,scram-sha-512none
usernamenoSpecifies the username for authentication
passwordnoSpecifies the password for authentication
tls.disablenoIf set to true, disables TLS encryptionfalse
tls.skip_verify_servernoIf set to true, skips server certificate verification when using TLSfalse
schema_registry_addressnoSpecifies the URL of the Schema Registry for Kafka, only applies when the data_type is avro
schema_registry_api_keynoSpecifies the API key for Schema Registry authentication
schema_registry_api_secretnoSpecifies the API secret for Schema Registry authentication


a source that generates randome data for test

templateyesSpecifies the template used to generate data, support iot,user_logins,devops
intervalnoSpecifies the event interval. for example 200ms200ms


refer to

topicyesSpecifies the topic of the pulsar to connect to
broker_urlyesSpecifies the URL of the broker to connect to
auth_typeyesSpecifies the authentication type to use. support ,oauth2,token
auth_paramsnoSpecifies authentication parameters as key-value pairs{}


refer to

intervalyesSpecifies the pulling interval to livepeer api. for example 300s
api_keyyesSpecifies the API key of livepeer
data_typeyesSpecifies the data type to use for creating the stream. support json,text


refer to

api_keyyesThe api_key property is a string used to authenticate and authorize access to the Ably service. It represents the API key associated with the Ably account, which is required for making authenticated requests to Ably's services
channelyesThe channel property specifies the name of the channel to which messages will be sent or from which messages will be received. Channels in Ably are used to group and categorize messages. This property allows you to select the target channel for your interactions