Sign in
Custom Connect Plugin Versions (ccpm/v1)

Read a Custom Connect Plugin Version

General Availability

Make a request to read a custom connect plugin version.

get/ccpm/v1/plugins/{plugin_id}/versions/{id}

Path parameters

plugin_idstring required

The Plugin

idstring required

The unique identifier for the custom connect plugin version.

Query parameters

environmentstring required

Filter a collection by a string search

Scope the operation to the given environment.

Response

Custom Connect Plugin Version.

api_version'ccpm/v1' required

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

kind'CustomConnectPluginVersion' 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").

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/ccpm/v1/plugins/ccp-12345/versions/ver-12345?environment=env-abc123",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/custom-connect-plugin=ccp-12345/version=ver-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"
  },
  "spec": {
    "sensitive_config_properties": [
      "passwords",
      "keys",
      "tokens"
    ],
    "documentation_link": "https://github.com/confluentinc/kafka-connect-datagen",
    "content_format": "ZIP",
    "connector_classes": [
      {
        "class_name": "io.confluent.kafka.connect.datagen.DatagenConnector",
        "type": "SOURCE"
      }
    ],
    "upload_source": {
      "location": "PRESIGNED_URL_LOCATION",
      "upload_id": "e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66"
    },
    "environment": {
      "id": "env-00000",
      "related": "https://api.confluent.cloud/v2/environments/env-00000",
      "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
    }
  },
  "status": {
    "phase": "PROCESSING",
    "error_message": "Version creation failed due to invalid plugin archive."
  }
}

Changes

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