Sign in
Kafka_Connect_Custom_Plugins

Initiate a custom plugin file upload

Creates an organization_custom_plugin_files record and returns a presigned S3 PUT URL the client must use to upload the JAR directly. Poll GET to check file_status until it reaches READY or FAILED.

post/organization/{organization_id}/kafka-connect/custom-plugin-files

Path parameters

organization_idstring required

ID of an organization

Request body

content_type'application/java-archive' | 'application/zip'

MIME type of the plugin file being uploaded. Use 'application/java-archive' for a single JAR file or 'application/zip' for a ZIP plugin bundle. Defaults to 'application/java-archive' when omitted.

file_descriptionstring

Optional human-readable change notes specific to this plugin version.

plugin_descriptionstring

Optional human-readable description of the plugin (applies to all versions).

plugin_namestring required

User-provided name identifying this custom plugin (e.g. 'my-custom-connectors').

plugin_versionstring required

User-provided version string for this plugin upload. Must be a valid PEP 440 version (e.g. '2.7.14', '1.0.0a1', '2.7.14.dev0').

service_type'kafka_connect' required

The Aiven service type this plugin is intended for.

Response

Response

created_atstring required

Creation timestamp in ISO 8601 format, always in UTC.

created_bystring required

Email address of the user who created this entity.

file_descriptionstring

Optional human-readable change notes specific to this plugin version.

file_sha256string

SHA-256 hash of the uploaded file, populated after successful verification.

file_sizeinteger

Size of the uploaded file in bytes, populated after successful verification.

file_status'INITIAL' | 'READY' | 'FAILED' required

Verification status of the uploaded JAR. INITIAL: upload pending or in progress. READY: verified and plugin classes discovered. FAILED: verification failed.

plugin_file_idstring required

Unique identifier for this custom plugin file upload.

plugin_idstring required

Unique identifier for the plugin identity record (shared across all versions).

plugin_namestring required

User-provided name identifying this custom plugin.

plugin_versionstring required

User-provided version string for this plugin upload.

updated_atstring required

Last update timestamp in ISO 8601 format, always in UTC.

updated_bystring

Email address of the user who last updated this entity.

verify_error_codeinteger

Machine-readable error code when file_status is FAILED.

verify_error_messagestring

Human-readable error message when file_status is FAILED.

Changes