Sign in
Connect Artifacts (cam/v1)

Read a Connect Artifact

General Availability

Make a request to read a connect artifact.

get/cam/v1/connect-artifacts/{id}

Path parameters

idstring required

The unique identifier for the connect artifact.

Query parameters

spec.cloudstring required

Filter a collection by a string search

Scope the operation to the given spec.cloud.

environmentstring required

Filter a collection by a string search

Scope the operation to the given environment.

Response

Connect Artifact.

api_version'cam/v1' required

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

kind'ConnectArtifact' 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/cam/v1/connect-artifacts/ca-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/connect-artifact=ca-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": {
    "cloud": "AWS",
    "environment": "env-00000",
    "content_format": "JAR",
    "upload_source": {
      "location": "PRESIGNED_URL_LOCATION",
      "upload_id": "e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66"
    },
    "plugins": [
      {
        "class": "io.confluent.example.CustomSMTExample"
      }
    ],
    "usages": [
      {
        "connector_crn": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector",
        "connector_type": "SINK"
      }
    ]
  },
  "status": {
    "phase": "WAITING_FOR_PROCESSING"
  }
}

Changes

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