Connectors
Create Kafka Connector
This endpoint creates a new kafka connector in a cluster.
POST
/
v2
/
kafka
/
connector
Authorization
Body
curl -X POST \
https://api.upstash.com/v2/kafka/connector \
-u 'EMAIL:API_KEY' \
-d '{"name":"connectorName","cluster_id":"7568431c-88d5-4409-a808-2167f22a7133", "properties":{"connector.class": "com.mongodb.kafka.connect.MongoSourceConnector","connection.uri": "connection-uri"}}'
{
"connector_id":"431ec970-b59d-4b00-95fe-5f3abcc52c2f",
"name":"connectorName",
"customer_id":"EMAIL",
"cluster_id":"7568431c-88d5-4409-a808-2167f22a7133",
"creation_time":1684369147,
"deletion_time":0,
"state":"pending",
"state_error_message":"",
"connector_state":"",
"tasks":[],
"topics":[],
"connector_class":"com.mongodb.kafka.connect.MongoSourceConnector",
"encoded_username":"YXBwYXJlbnQta2l0ZS0xMTMwMiTIqFhTItzgDdE56au6LgnnbtlN7ITzh4QATDw",
"TTL":1684370947
}
Request Parameters
name
string
requiredName of the new kafka topic
cluster_id
string
requiredID of the cluster the topic will be deployed in
properties
Object
requiredProperties of the connector. Custom config for different types of connectors.
Response Parameters
connector_id
string
ID of the new kafka connector
name
string
Name of the new kafka connector
customer_id
string
Owner of the connector
cluster_id
string
ID of the kafka cluster of the connector
creation_time
int
Creation time of the topic
deletion_time
int
Creation time of the topic
state
string
State of the connector
state_error_message
string
Error message, if the connector failed
connector_state
string
State of the connector
tasks
????????
Tasks for the connector
topics
?????????
Topics that are given with properties config
connector_class
string
Class of the created connector
encoded_username
string
Encoded username for the connector
TTL
int
Time to live for connector
Was this page helpful?
curl -X POST \
https://api.upstash.com/v2/kafka/connector \
-u 'EMAIL:API_KEY' \
-d '{"name":"connectorName","cluster_id":"7568431c-88d5-4409-a808-2167f22a7133", "properties":{"connector.class": "com.mongodb.kafka.connect.MongoSourceConnector","connection.uri": "connection-uri"}}'
{
"connector_id":"431ec970-b59d-4b00-95fe-5f3abcc52c2f",
"name":"connectorName",
"customer_id":"EMAIL",
"cluster_id":"7568431c-88d5-4409-a808-2167f22a7133",
"creation_time":1684369147,
"deletion_time":0,
"state":"pending",
"state_error_message":"",
"connector_state":"",
"tasks":[],
"topics":[],
"connector_class":"com.mongodb.kafka.connect.MongoSourceConnector",
"encoded_username":"YXBwYXJlbnQta2l0ZS0xMTMwMiTIqFhTItzgDdE56au6LgnnbtlN7ITzh4QATDw",
"TTL":1684370947
}