Translate Self Managed Connector Plugin Configurations to Fully Managed Connector Plugin Configurations
PUT/connect/v1/environments/:environment_id/clusters/:kafka_cluster_id/connector-plugins/:plugin_name/config/translate?mask_sensitive=true
Translate the provided Self Managed configuration values. This API performs configuration translation
and returns the translated fully managed configuration along with any errors or warnings.
Query Parameter mask_sensitive=true redacts sensitive config values in response.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
Connector Plugin translation result.
Bad Request
Unauthorized
Forbidden
Not Found
Rate Limit Exceeded
Response Headers
X-Request-Id
The unique identifier for the API request.
X-RateLimit-Limit
The maximum number of requests you're permitted to make per time period.
X-RateLimit-Remaining
The number of requests remaining in the current rate limit window.
X-RateLimit-Reset
The relative time in seconds until the current rate-limit window resets.
Important: This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues.
Retry-After
The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached.
Internal Server Error
OpenAPI definition (YAML)
paths:
? /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/translate?mask_sensitive=true
: put:
x-lifecycle-stage: General Availability
operationId: translateConnectv1ConnectorPlugin
description: "[](#section/Versioning/API-Lifecycle-Policy)\n\
\nTranslate the provided Self Managed configuration values. This API performs configuration translation\n\
and returns the translated fully managed configuration along with any errors or warnings. \nQuery\
\ Parameter `mask_sensitive=true` redacts sensitive config values in response."
tags:
- Managed Connector Plugins (connect/v1)
security:
- cloud-api-key: []
- confluent-sts-access-token: []
requestBody:
content:
application/json:
schema:
type: object
description: Configuration parameters for the self managed connector. All values should
be strings.
additionalProperties:
type: string
description: Configuration parameters for the self managed connector. All values should
be strings. See the self managed connector's docs for the list of options.
example:
topics: nidhi_topic
input.data.format: JSON
connector.class: io.confluent.connect.datadog.metrics.DatadogMetricsSinkConnector
name: DatadogMetricsSinkConnector_87
datadog.api.key: 535069c094cdfd1a55fb3e80eba09241
datadog.domain: COM
max.retry.time.ms: '5000'
behavior.on.error: log
tasks.max: '1'
errors.tolerance: all
errors.deadletterqueue.context.headers.enable: 'true'
errors.log.include.messages: 'true'
errors.log.enable: 'true'
reporter.bootstrap.servers: localhost:9092
reporter.error.topic.replication.factor: '1'
confluent.topic.bootstrap.servers: localhost:9092
confluent.topic.replication.factor: '1'
description: Configuration parameters for the connector. All values should be strings.
responses:
'200':
description: Connector Plugin translation result.
content:
application/json:
schema:
type: object
properties:
config:
type: object
description: The translated configuration
additionalProperties:
type: string
errors:
type: array
description: List of configuration errors
items:
type: object
properties:
field:
type: string
description: The field name that has an error
message:
type: string
description: The error message
required:
- field
- message
warnings:
type: array
description: List of configuration warnings
items:
type: object
properties:
field:
type: string
description: The field name that has a warning
message:
type: string
description: The warning message
required:
- field
- message
example:
config:
connector.class: DatadogMetricsSink
name: DatadogMetricsSinkConnector_87
topics: nidhi_topic
datadog.api.key: '****************'
datadog.domain: COM
max.retry.time.ms: '5000'
behavior.on.error: log
tasks.max: '1'
errors.tolerance: all
errors.deadletterqueue.context.headers.enable: 'true'
errors.log.include.messages: 'true'
errors.log.enable: 'true'
confluent.topic.bootstrap.servers: localhost:9092
input.data.format: JSON
max.poll.interval.ms: '300000'
max.poll.records: '500'
errors:
- field: datadog.site
message: Required config is missing.
warnings:
- field: confluent.topic.bootstrap.servers
message: Customer given value is ignored. Default value is used.
- field: reporter.error.topic.replication.factor
message: Customer given value is ignored. Default value is used.
- field: confluent.topic.replication.factor
message: Customer given value is ignored. Default value is used.
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
error:
type: object
description: Connector Error with error code and message.
properties:
code:
type: integer
description: Error code for the type of error
message:
type: string
description: Human readable error message
title: connect.v1.ConnectorError
example:
error:
code: 400
message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error:
type: object
description: Connector Error with error code and message.
properties:
code:
type: integer
description: Error code for the type of error
message:
type: string
description: Human readable error message
title: connect.v1.ConnectorError
example:
error:
code: 401
message: Unauthorized
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
error:
type: object
description: Connector Error with error code and message.
properties:
code:
type: integer
description: Error code for the type of error
message:
type: string
description: Human readable error message
title: connect.v1.ConnectorError
example:
error:
code: 403
message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
error:
type: object
description: Connector Error with error code and message.
properties:
code:
type: integer
description: Error code for the type of error
message:
type: string
description: Human readable error message
title: connect.v1.ConnectorError
example:
error:
code: 404
message: resource not found
'429':
description: Rate Limit Exceeded
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
X-RateLimit-Limit:
schema:
type: integer
description: The maximum number of requests you're permitted to make per time period.
X-RateLimit-Remaining:
schema:
type: integer
description: The number of requests remaining in the current rate limit window.
X-RateLimit-Reset:
schema:
type: integer
description: "The relative time in seconds until the current rate-limit window resets. \
\ \n \n**Important:** This differs from Github and Twitter's same-named header which\
\ uses UTC epoch seconds. We use relative time to avoid client/server time synchronization\
\ issues."
Retry-After:
schema:
type: integer
description: The number of seconds to wait until the rate limit window resets. Only sent
when the rate limit is reached.
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
error:
type: object
description: Connector Error with error code and message.
properties:
code:
type: integer
description: Error code for the type of error
message:
type: string
description: Human readable error message
title: connect.v1.ConnectorError
example:
error:
code: 500
message: Oops, something went wrong
parameters:
- name: plugin_name
in: path
schema:
type: string
required: true
description: The unique name of the connector plugin.
- name: environment_id
in: path
schema:
type: string
required: true
description: The unique identifier of the environment this resource belongs to.
- name: kafka_cluster_id
in: path
schema:
type: string
required: true
description: The unique identifier for the Kafka cluster.
- name: mask_sensitive
in: query
required: false
schema:
type: string
maxLength: 255
description: Indicates whether to redact sensitive config values in response.
servers:
- url: https://api.confluent.cloud
description: Confluent Cloud API
jsonRequestBodyExample: {}