---
title: "Read a Connect Artifact"
method: GET
path: "/cam/v1/connect-artifacts/{id}"
tags: ["Connect Artifacts (cam/v1)"]
---

# Read a Connect Artifact

`GET /cam/v1/connect-artifacts/{id}`

[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)

Make a request to read a connect artifact.

## Path parameters

- `id` string, required

## Query parameters

- `spec.cloud` string, required — Filter a collection by a string search
- `environment` string, required — Filter a collection by a string search

## Response `200`

Connect Artifact.

- object — `Connect Artifact` objects represent collection of Custom SMTs, user-defined message transformations that can be applied to Kafka connectors. The API allows you to upload, retrieve, and delete Connect Artifact, as well as list all available Connect Artifact for use in your connectors. Currently, Connect Artifacts can only be used by connectors running on Enterprise, Freight, or Dedicated Kafka Connect clusters on AWS, configured with one of the following network types: PrivateLink, Peering/Transit Gateway, or PNI. ## The Connect Artifacts Model <SchemaDefinition schemaRef="#/components/schemas/cam.v1.ConnectArtifact" />
  - `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.
  - `id` string, 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").
  - `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
    - `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time
    - `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name
    - `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC.
    - `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC.
    - `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC.
  - `spec` CamV1ConnectArtifactSpec, required — Connect Artifact objects represent Custom SMTs on Confluent Cloud.
    - `cloud` string, required — Cloud provider where the Connect Artifact archive is uploaded.
    - `environment` string, required — Environment the Connect Artifact belongs to.
    - `display_name` string, required — Unique name of the Connect Artifact archive per cloud, environment scope.
    - `description` string — Description of the Connect Artifact.
    - `content_format` string — Archive format of the Connect Artifact.
    - `upload_source` object — Presigned URL of the uploaded Connect Artifact archive.
      - `location` string, required — Location of the Connect Artifact source.
      - `upload_id` string, required — Upload ID returned by the `/presigned-upload-url` API. This field returns an empty string in all responses.
    - `plugins` CamV1Plugins[] — List of classes present in the Connect Artifact uploaded
      - `class` string — Java class or alias for the artifact as provided by developer.
    - `usages` CamV1Usages[] — List of resources using this Connect artifact, identified by CRN and connector type.
      - `connector_crn` string, uri, required — The Confluent Resource Name (CRN) of the resource that is using the artifact. This is typically the CRN of a specific connector.
      - `connector_type` string, required — The type of the connector using the artifact, indicating if it's a source or a sink.
  - `status` CamV1ConnectArtifactStatus, required — The status of the Connect Artifact
    - `phase` string, required — Specifies the current processing state of a CloudConnectArtifact.

## Other responses

- `400` — Bad Request
- `401` — The request lacks valid authentication credentials for this resource.
- `403` — The access credentials were considered insufficient to grant access
- `404` — Not Found
- `429` — Rate Limit Exceeded
- `500` — Oops, something went wrong!

---

[API](https://skmtc.dev/confluent/apis/confluent-cloud-apis.md) · [All operations](https://skmtc.dev/confluent/apis/confluent-cloud-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/confluent/confluent-cloud-apis/revisions/a6a73f98a698/schema)