Get Kafka Connector

This endpoint gets details of a kafka connector.

GET /v2/kafka/connector/{id}

curl

curl -X GET \
  https://api.upstash.com/v2/kafka/connector/:id \
  -u 'EMAIL:API_KEY'

import requests

response = requests.get('https://api.upstash.com/v2/kafka/connector/:id', auth=('EMAIL', 'API_KEY'))
response.content

client := &http.Client{}
req, err := http.NewRequest("GET", "https://api.upstash.com/v2/kafka/connector/:id", nil)
if err != nil {
    log.Fatal(err)
}
req.SetBasicAuth("email", "api_key")
resp, err := client.Do(req)
if err != nil {
    log.Fatal(err)
}
bodyText, err := ioutil.ReadAll(resp.Body)
if err != nil {
    log.Fatal(err)
}
fmt.Printf("%s\n", bodyText);

200 OK

{
  "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": "failed",
  "state_error_message": "Connector configuration is invalid and contains the following 1 error(s):\nInvalid value connection-uri-update for configuration connection.uri: The connection string is invalid. Connection strings must start with either 'mongodb://' or 'mongodb+srv://\n",
  "connector_state": "",
  "tasks": [],
  "topics": [],
  "connector_class": "com.mongodb.kafka.connect.MongoSourceConnector",
  "properties": {
    "connection.uri": "connection-uri-update",
    "connector.class": "com.mongodb.kafka.connect.MongoSourceConnector"
  },
  "encoded_username": "YXBwYXJlbnQta2l0ZS0xMTMwMiTIqFhTItzgDdE56au6LgnnbtlN7ITzh4QATDw"
}

URL Parameters

id · string · required

The ID of the Kafka Connector

Response Parameters

connector_id · string

ID of the Kafka connector

name · string

Name of the Kafka connector

cluster_id · string

ID of the kafka cluster of the connector

creation_time · int

Creation time of the topic

customer_id · string

Owner of the connector

state · string

State of the connector

state_error_message · string

Error message, if the connector failed

connector_state · string

State of the connector

tasks · Array<object>

Tasks for the connector

topics · Array<string>

Topics that are given with properties config

connector_class · string

Class of the created connector

properties · object

Properties that the connector was configured with

encoded_username · string

Encoded username for the connector

curl

curl -X GET \
  https://api.upstash.com/v2/kafka/connector/:id \
  -u 'EMAIL:API_KEY'

import requests

response = requests.get('https://api.upstash.com/v2/kafka/connector/:id', auth=('EMAIL', 'API_KEY'))
response.content

client := &http.Client{}
req, err := http.NewRequest("GET", "https://api.upstash.com/v2/kafka/connector/:id", nil)
if err != nil {
    log.Fatal(err)
}
req.SetBasicAuth("email", "api_key")
resp, err := client.Do(req)
if err != nil {
    log.Fatal(err)
}
bodyText, err := ioutil.ReadAll(resp.Body)
if err != nil {
    log.Fatal(err)
}
fmt.Printf("%s\n", bodyText);

200 OK

{
  "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": "failed",
  "state_error_message": "Connector configuration is invalid and contains the following 1 error(s):\nInvalid value connection-uri-update for configuration connection.uri: The connection string is invalid. Connection strings must start with either 'mongodb://' or 'mongodb+srv://\n",
  "connector_state": "",
  "tasks": [],
  "topics": [],
  "connector_class": "com.mongodb.kafka.connect.MongoSourceConnector",
  "properties": {
    "connection.uri": "connection-uri-update",
    "connector.class": "com.mongodb.kafka.connect.MongoSourceConnector"
  },
  "encoded_username": "YXBwYXJlbnQta2l0ZS0xMTMwMiTIqFhTItzgDdE56au6LgnnbtlN7ITzh4QATDw"
}