Confluent Cloud Custom SMT APIs for Managed Connectors¶

The Custom SMT API is a part of the Confluent Cloud APIs and focuses on managing the Custom SMT configurations.

Prerequisites¶

Authorized access to a Confluent Cloud cluster on Amazon Web Services (AWS).
The Confluent CLI installed and configured for the cluster. For information on how to install the CLI, see the CLI documentation.
cURL and jq installed to use the API request examples in this document.
A Confluent Cloud API key to authenticate with the Confluent Cloud API. Every API request must include the resource key and secret encoded as Base64. For information about how to create a Confluent Cloud API key, see Manage API Keys.
The EnvironmentAdmin role to upload custom artifact file. If you do not have the appropriate role, reach out to your EnvironmentAdmin.

Manage Custom SMTs¶

Using requests to the Custom SMT API, you can perform the following actions:

List Custom SMTs
Create a Custom SMT
Describe a Custom SMT
Delete a Custom SMT artifact file

Before you run any cURL requests, be sure to complete the prerequisites.

List Custom SMTs¶

Use the following API request to list Custom SMT artifacts:

curl --request GET \
  --url 'https://api.confluent.cloud/cam/v1/connect-artifacts?environment=<Env_ID>&spec.cloud=<Cloud_Provider>' \
  --header 'accept: application/json' \
  --header 'authorization: Basic <Replace_Basic_Auth>' \
  --header 'content-type: application/json' | jq

Example request:

curl --request GET \
  --url 'https://api.confluent.cloud/cam/v1/connect-artifacts?environment=env-stgcznox3d&spec.cloud=AWS' \
  --header 'accept: application/json' \
  --header 'authorization: Basic blah==' \
  --header 'content-type: application/json' | jq

Example response:

{
  "api_version": "cam/v1",
  "data": [
    {
      "api_version": "cam/v1",
      "id": "cca-stgcyoj9dj",
      "kind": "ConnectArtifact",
      "metadata": {
          "created_at": "2025-04-14T05:35:19.544012Z",
          "resource_name": "crn://confluent.cloud/organization=31d218ba-d8e8-49a5-9ad1-f93327d3b4b7/environment=env-stgcznox3d/connect-artifact=cca-stgcyoj9dj",
          "self": "https://confluent.cloud/cam/v1/connect-artifacts/cca-stgcyoj9dj",
          "updated_at": "2025-04-14T05:35:20.002593Z"
        },
      "spec": {
          "cloud": "aws",
          "content_format": "ZIP",
          "description": "Conflent Custom SMT Example",
          "display_name": "Confluent_Custom_SMT",
          "environment": "env-stgcznox3d",
          "usages": []
        },
      "status": {
          "phase": "READY"
        }
    }
    ],
      "kind": "ConnectArtifactList",
      "metadata": {
          "first": "https://confluent.cloud/cam/v1/connect-artifacts",
          "next": "",
          "total_size": 1
        }
}

Create a Custom SMT¶

Use the following API request to create a custom connector SMT. The following are required configuration properties:

display_name: A meaningful Custom SMT name to be displayed in the UI and CLI.
upload_source: For this property, you use the values PRESIGNED_URL_LOCATION and the upload ID.
description (Optional): A meaningful description for the plugin.

curl --request POST \
    --url 'https://api.confluent.cloud/cam/v1/connect-artifacts?environment=<Env_ID>&spec.cloud=<Cloud_Provider>' \
    --header 'accept: application/json' \
    --header 'authorization: Basic <Replace_Basic_Auth>' \
    --header 'content-type: application/json' \
    --data '{
    "spec": {
      "display_name": "<Custom_SMT_Name>",
      "description": "<Description>",
      "upload_source": {
          "location": "<Presigned_URL_Location>",
          "upload_id": "<Upload_ID>"
        }
    }
}'

Example Request:

curl --request POST \
    --url 'https://api.confluent.cloud/cam/v1/connect-artifacts?environment=<Env_ID>&spec.cloud=<Cloud_Provider>' \
    --header 'accept: application/json' \
    --header 'authorization: Basic blah==' \
    --header 'content-type: application/json' \
    --data '{
    "spec": {
      "display_name": "Confluent_Custom_SMT",
      "description": "Confluent Custom SMT Example",
      "upload_source": {
          "location": "PRESIGNED_URL_LOCATION",
          "upload_id": "748d7b70-a885-46ed-a02e-4d32836957ca"
        }
    }
}'

Example Response:

{
  "api_version": "cam/v1",
  "id": "cca-stgcyoj9dj",
  "kind": "ConnectArtifact",
  "metadata": {
     "created_at": "2025-04-14T05:35:19.544012Z",
     "resource_name": "crn://confluent.cloud/organization=31d218ba-d8e8-49a5-9ad1-f93327d3b4b7/environment=env-stgcznox3d/connect-artifact=cca-stgcyoj9dj",
     "self": "https://stag.cpdev.cloud/cam/v1/connect-artifacts/cca-stgcyoj9dj",
     "updated_at": "2025-04-14T05:35:19.544012Z"
    },
  "spec": {
     "cloud": "aws",
     "content_format": "ZIP",
     "description": "Conflent Custom SMT Example",
     "display_name": "Confuemt_Custom_SMT",
     "environment": "env-stgcznox3d",
     "usages": []
    },
  "status": {
     "phase": "READY"
    }
}

Describe a Custom SMT¶

Get the details about an artifact in your environment by sending a GET request to the read artifact endpoint.

curl --request GET \
  --url 'https://api.confluent.cloud/cam/v1/connect-artifacts/<Custom_SMT_Artifact_ID>?environment=<Env_ID>&spec.cloud=<Cloud_Provider>' \
  --header 'accept: application/json' \
  --header 'authorization: <Replace_Basic_Auth>' \
  --header 'content-type: application/json' | jq

Example request:

curl --request GET \
  --url 'https://api.confluent.cpdev.cloud/cam/v1/connect-artifacts/cca-stgcyoj9dj?environment=env-stgcznox3d&spec.cloud=AWS' \
  --header 'accept: application/json' \
  --header 'authorization: Basic blah==' \
  --header 'content-type: application/json' | jq

Example response:

{
  "api_version": "cam/v1",
  "id": "cca-stgcyoj9dj",
  "kind": "ConnectArtifact",
  "metadata": {
      "created_at": "2025-04-14T05:35:19.544012Z",
      "resource_name": "crn://confluent.cloud/organization=31d218ba-d8e8-49a5-9ad1-f93327d3b4b7/environment=env-stgcznox3d/connect-artifact=cca-stgcyoj9dj",
      "self": "https://confluent.cloud/cam/v1/connect-artifacts/cca-stgcyoj9dj",
      "updated_at": "2025-04-14T05:35:20.002593Z"
    },
  "spec": {
      "cloud": "aws",
      "content_format": "ZIP",
      "description": "Conflent Custom SMT Example",
      "display_name": "Confluent_Custom_SMT",
      "environment": "env-stgcznox3d",
      "usages": []
    },
  "status": {
      "phase": "READY"
    }
}

Delete a Custom SMT artifact file¶

Delete a Custom SMT artifact in your environment by sending a DELETE request to the Delete artifact endpoint:

curl --request DELETE \
  --url 'https://api.confluent.cloud/cam/v1/connect-artifacts/<Custom_SMT_artifact_ID>?spec.cloud=<Cloud_Provider>&environment=<Env_ID>' \
  --header 'accept: application/json' \
  --header 'authorization: Basic <Replace_Basic_Auth>' \
  --header 'content-type: application/json' | jq

Example request:

curl --request DELETE \
  --url 'https://api.confluent.cloud/cam/v1/connect-artifacts/cca-stgcyoj9dj?spec.cloud=aws&environment=env-stgcznox3d' \
  --header 'accept: application/json' \
  --header 'authorization: Basic bleh==' \
  --header 'content-type: application/json' | jq