Sign in
Custom Connector Plugins (connect/v1)

Read a Custom Connector Plugin

General Availability

Make a request to read a custom connector plugin.

get/connect/v1/custom-connector-plugins/{id}

Path parameters

idstring required

The unique identifier for the custom connector plugin.

Response

Custom Connector Plugin.

api_version'connect/v1' required

APIVersion defines the schema version of this representation of a resource.

kind'CustomConnectorPlugin' required

Kind defines the object this REST resource represents.

idstring required

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

display_namestring required

Display name of Custom Connector Plugin.

content_formatstring

Archive format of Custom Connector Plugin.

descriptionstring

Description of Custom Connector Plugin.

documentation_linkstring

Document link of Custom Connector Plugin.

connector_classstring required

Java class or alias for connector. You can get connector class from connector documentation provided by developer.

connector_typestring required

Custom Connector type.

cloudstring

Cloud provider where the Custom Connector Plugin archive is uploaded.

sensitive_config_propertiesstring[]

A sensitive property is a connector configuration property that must be hidden after a user enters property value when setting up connector.

runtime_languagestring

Runtime language of Custom Connector Plugin.

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/connect/v1/custom-connector-plugins/ccp-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/custom-connector-plugin=ccp-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "content_format": "ZIP",
  "documentation_link": "https://github.com/confluentinc/kafka-connect-datagen",
  "connector_class": "io.confluent.kafka.connect.datagen.DatagenConnector",
  "connector_type": "SOURCE",
  "cloud": "AWS",
  "sensitive_config_properties": [
    "passwords",
    "keys",
    "tokens"
  ],
  "upload_source": {
    "location": "PRESIGNED_URL_LOCATION",
    "upload_id": "e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66"
  },
  "runtime_language": "JAVA"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.