HTTP Sink V2 Connector for Confluent Cloud

The fully-managed HTTP Sink V2 connector for Confluent Cloud integrates Apache Kafka® with an API using HTTP or HTTPS. It allows you to configure one or more APIs seamlessly with an OpenAPI/Swagger specification file, reducing overall configuration time and helping you achieve better performance when compared to the HTTP Sink Connector for Confluent Cloud. In this page, you will find all the features the HTTP Sink V2 connector offers and discover everything you need to begin using the connector.

Note

If you require private networking for fully-managed connectors, make sure to set up the proper networking beforehand. For more information, see Manage Networking for Confluent Cloud Connectors.

Features

The HTTP Sink V2 connector includes the following features:

Multiple API path support: The connector allows you to configure up to 15 API paths having the same base URL and authentication mechanism.
Upsert support: The connector supports upsert operations. For more information, see Manage Upserts.
OpenAPI Specification-based configuration: The connector provides seamless configuration through an OpenAPI specification file.
Secure access and data exchange: The connector supports the following authentication mechanisms:
- Basic
- Bearer
- OAuth 2.0 Client Credentials grant flow
- API key (only supported in Confluent CLI)
Client-side field level encryption (CSFLE) support: The connector supports CSFLE for sensitive data. For more information about CSFLE setup, see the Manage CSFLE for connectors.
API error reporting management: You can configure the connector to notify you when an API error occurs through email or through the Confluent Cloud user interface. You also can configure the connector to ignore when an API error occurs.
API validation: The connector allows you to test the API using a test record and view the test API response logs in the Confluent Cloud user interface.
Template variables: The connector allows you to specify template variables, such as ${topic} and ${key}, along with fields from the Kafka record for use in an HTTP request:
- Headers
- Query parameters
- Path parameters
- Body parameters
The connector constructs a unique URL using these parameters and enables substitution of template variables in headers, parameters, and body content.
Supported data formats: The connector supports String, Avro, Bytes, JSON (schemaless), JSON Schema, and Protobuf data formats. Schema Registry must be enabled to use a Schema Registry-based format like Avro, JSON Schema, or Protobuf. For additional information, see Schema Registry Enabled Environments.
Custom offset support: The connector allows you to configure custom offsets using the Confluent Cloud user interface to prevent data loss and data duplication.
Configurable retry functionality: The connector allows you to customize retry settings based on your requirements.

For more information and examples to use with the Confluent Cloud API for Connect, see the Confluent Cloud API for Connect Usage Examples section.

Manage CSFLE

If you plan to enable CSFLE for the HTTP Sink V2 connector, take care of the following sensitive information that may get written to your Kafka topics:

Warning

Error topic: The error topic may include sensitive data from the API response.
Success topic: The success topic may include sensitive data from the API response.

Manage Upserts

The connector supports upsert operations using the following API-level configuration properties:

upsert.method: Use this to define the HTTP method for upsert operations. For example, set it to POST to enable upsert operations.
upsert.api.path: Use this to set the API path for upsert operations. The connector sends HTTP requests to this path.
upsert.on.field.value: Use this to specify a field within your Kafka record value to determine whether the connector should update or insert a record.

When an upsert is triggered, the connector sends an HTTP request to the API path specified by upsert.api.path, using the HTTP method from upsert.method. The connector triggers an upsert in two scenarios:

If you specify upsert.on.field.value (for example, "jsonPath=expected_value"), the connector checks the Kafka record value. If the field at jsonPath exists and matches expected_value, the connector performs an upsert.
If you do not specify upsert.on.field.value, the connector performs an upsert when the Kafka record key is null or empty.

Limitations

Be sure to review the following information.

For connector limitations, see HTTP Sink V2 Connector limitations.
If you plan to use one or more Single Message Transformations (SMTs), see SMT Limitations.
If you plan to use Confluent Cloud Schema Registry, see Schema Registry Enabled Environments.

Error records and status codes

The connector may report status_code = -1 in error records when no HTTP response code is available. This usually happens with client-side or transport failures that occur before the server can respond. For example, DNS failures, connection refused errors, connect/read timeouts, or TLS handshake errors.

When the server responds with a non-2xx status, the connector reports the actual HTTP code, for example, 400 or 500.

Test API

Use the Test API functionality to test the API with a sample record and view the logs directly in the Confluent Cloud user interface.

Important

This feature is only available for publicly accessible endpoints.
Invoking the Test API on an API may change data on the end system, depending on the API’s behavior.

When using this feature with the HTTP Sink V2 connector, add your details to the following fields:

${topic}: Topic that the API is expected to consume from. Note that the connector will not actually read anything from the topic, and the topic name configured here will be used wherever you have configured the ${topic} template variable.
Test message: This message should reflect the data present in the Kafka topic. You must configure the expected Kafka key, headers, and values as applicable depending on the value of request.body.format.
By default, request.body.format is set to JSON format. In this case, value should be a valid JSON string escaped and enclosed as a string, as shown below:
```
{
  "key": "key1",
  "headers": [
    {
      "header1": "h1"
    },
    {
      "header2": "h2"
    }
  ],
  "value": "{\"msg\": \"hello world\"}"
}
```
When request.body.format set to string format, you can use value as any string, as shown below:
```
{
  "key": "key1",
  "headers": [
    {
      "header1": "h1"
    },
    {
      "header2": "h2"
    }
  ],
  "value": "hello world"
}
```

Moving from V1 to V2

Confluent recommends upgrading from version 1 to version 2 of this connector to take advantage of the latest features, including support for CSFLE and configuration through an OpenAPI/Swagger specification file.

Use the following steps to migrate to version 2 connector. Implement and validate any connector changes in a pre-production environment before promoting to production.

Pause the V1 connector.
Get the offset for the V1 connector.

Create the V2 connector using the offset from the previous step.

confluent connect cluster create [flags]

For example:

Create a configuration file with connector configs and offsets.

{
  "name": "(connector-name)",
  "config": {
      ... // connector specific configuration
  },
  "offsets": [
      {
          "partition": {
      ... // connector specific configuration
          },
          "offset": {
      ... // connector specific configuration
          }
      }
  ]
}

Create a V2 connector in the current or specified Kafka cluster context.

confluent connect cluster create --config-file config.json

Verify the migration and confirm that the connector is running successfully with the V1 payloads.
Delete the V1 connector.

For more information on offsets, see Manage Offsets for Fully-Managed Connectors in Confluent Cloud.

Note

Optionally, you can use HTTP V2 Sink migration tool to migrate to the V2 connector.

Configuration Properties

Use the following configuration properties with the fully-managed HTTP V2 Sink connector.

Which topics do you want to get data from?

topics

Identifies the topic name or a comma-separated list of topic names.

Type: list
Importance: high

errors.deadletterqueue.topic.name

The name of the topic to be used as the dead letter queue (DLQ) for messages that result in an error when processed by this sink connector, or its transformations or converters. Defaults to ‘dlq-${connector}’ if not set. The DLQ topic will be created automatically if it does not exist. You can provide ${connector} in the value to use it as a placeholder for the logical cluster ID.

Type: string
Default: dlq-${connector}
Importance: low

reporter.result.topic.name

The name of the topic to produce records to after successfully processing a sink record. Defaults to ‘success-${connector}’ if not set. You can provide ${connector} in the value to use it as a placeholder for the logical cluster ID.

Type: string
Default: success-${connector}
Importance: low

reporter.error.topic.name

The name of the topic to produce records to after each unsuccessful record sink attempt. Defaults to ‘error-${connector}’ if not set. You can provide ${connector} in the value to use it as a placeholder for the logical cluster ID.

Type: string
Default: error-${connector}
Importance: low

Schema Config

schema.context.name

Add a schema context name. A schema context represents an independent scope in Schema Registry. It is a separate sub-schema tied to topics in different Kafka clusters that share the same Schema Registry instance. If not used, the connector uses the default schema configured for Schema Registry in your Confluent Cloud environment.

Type: string
Default: default
Importance: medium

Input messages

input.data.format

Sets the input Kafka record value format. Valid entries are AVRO, JSON_SR, PROTOBUF, JSON, BYTES or STRING. Note that you need to have Confluent Cloud Schema Registry configured if using a schema-based message format like AVRO, JSON_SR, and PROTOBUF.

Type: string
Default: JSON
Importance: high

How should we connect to your data?

name

Sets a name for your connector.

Type: string
Valid Values: A string at most 64 characters long
Importance: high

Kafka Cluster credentials

kafka.auth.mode

Kafka Authentication mode. It can be one of KAFKA_API_KEY or SERVICE_ACCOUNT. It defaults to KAFKA_API_KEY mode.

Type: string
Default: KAFKA_API_KEY
Valid Values: KAFKA_API_KEY, SERVICE_ACCOUNT
Importance: high

kafka.api.key

Kafka API Key. Required when kafka.auth.mode==KAFKA_API_KEY.

Type: password
Importance: high

kafka.service.account.id

The Service Account that will be used to generate the API keys to communicate with Kafka Cluster.

Type: string
Importance: high

kafka.api.secret

Secret associated with Kafka API key. Required when kafka.auth.mode==KAFKA_API_KEY.

Type: password
Importance: high

Reporter

report.errors.as

Dictates the content of records produced to the error topic. If set to Error string the value would be a human readable string describing the failure. The value will include some or all of the following information if available: http response code, reason phrase, submitted payload, url, response content, exception and error message. If set to http_response, the value would be the plain response content for the request which failed to write the record. In both modes, any information about the failure will also be included in the error records headers.

Type: string
Default: Error string
Importance: low

Consumer configuration

max.poll.interval.ms

The maximum delay between subsequent consume requests to Kafka. This configuration property may be used to improve the performance of the connector, if the connector cannot send records to the sink system. Defaults to 300000 milliseconds (5 minutes).

Type: long
Default: 300000 (5 minutes)
Valid Values: [60000,…,1800000] for non-dedicated clusters and [60000,…] for dedicated clusters
Importance: low

max.poll.records

The maximum number of records to consume from Kafka in a single request. This configuration property may be used to improve the performance of the connector, if the connector cannot send records to the sink system. Defaults to 500 records.

Type: long
Default: 500
Valid Values: [1,…,500] for non-dedicated clusters and [1,…] for dedicated clusters
Importance: low

Number of tasks for this connector

tasks.max

Maximum number of tasks for the connector.

Type: int
Valid Values: [1,…]
Importance: high

Authentication

http.api.base.url

The HTTP API Base URL. For example: http://example.com/absenceManagement/v1.

Type: string
Importance: high

auth.type

Authentication type of the endpoint. Valid values are NONE, BASIC, OAUTH2 (Client Credentials grant type only), BEARER, API_KEY

Type: string
Default: NONE
Importance: high

connection.user

The username to be used with an endpoint requiring basic authentication.

Type: string
Importance: medium

connection.password

The password to be used with an endpoint requiring basic authentication.

Type: password
Importance: medium

bearer.token

The bearer authentication token to be used with an endpoint requiring bearer token based authentication.

Type: password
Importance: medium

oauth2.token.url

The URL to be used for fetching the OAuth2 token. Client Credentials is the only supported grant type.

Type: string
Importance: medium

oauth2.client.id

The client id used when fetching the OAuth2 token.

Type: string
Importance: medium

oauth2.client.secret

The client secret used when fetching the OAuth2 token.

Type: password
Importance: medium

oauth2.token.property

The name of the property containing the OAuth2 token returned by the OAuth2 token URL (defaults to access_token).

Type: string
Default: access_token
Importance: medium

oauth2.client.scope

The scope parameter sent to the service when fetching the OAuth2 token.

Type: string
Default: any
Importance: medium

oauth2.client.auth.mode

Specifies how to encode client_id and client_secret in the OAuth2 authorization request. If set to header, the credentials are encoded as an ‘Authorization: Basic <base-64 encoded client_id:client_secret>’ HTTP header. If set to ‘url’, then client_id and client_secret are sent as URL encoded parameters.

Type: string
Default: header
Importance: medium

oauth2.client.headers

HTTP headers to be included in the OAuth2 client endpoint. Individual headers should be separated by |. This configuration can be set via CLI only.

Type: password
Importance: low

oauth2.client.header.separator

Separator character used in OAuth2 Client Headers. This configuration can be set via CLI only.

Type: string
Default: |
Importance: low

https.ssl.enabled

Controls whether to enforce TLSv1.3 for HTTPS connections. If false, the connector uses the JVM default TLS configuration (typically TLSv1.2). If true, TLSv1.3 is enforced. Note that, even when disabled, HTTPS connections still use TLS. This setting only controls TLS version enforcement.

Type: boolean
Default: false
Importance: medium

https.ssl.keystorefile

The keystore that contains the client certificate and private key. Supported formats are JKS or PKCS12. File system paths are not supported.

Type: password
Default: [hidden]
Importance: low

https.ssl.keystore.password

The store password for the key store file.

Type: password
Importance: high

https.ssl.key.password

The password for the private key in the key store file.

Type: password
Importance: high

https.ssl.truststorefile

The truststore that contains the server CA certificate(s). Supported formats are JKS or PKCS12. File system paths are not supported.

Type: password
Default: [hidden]
Importance: high

https.ssl.truststore.password

The trust store password containing a server CA certificate.

Type: password
Importance: high

https.ssl.protocol

The protocol to use for SSL connections

Type: string
Default: TLSv1.3
Importance: medium

api.key.location

Specifies where the API key is included in the HTTP request. Choose HEADER to send the API key as an HTTP header (for example, X-API-KEY: your-api-key), or QUERY to include it as a query parameter in the URL (for example, ?api_key=your-api-key). The default is HEADER which is the most common and secure approach.

Type: string
Default: HEADER
Importance: medium

https.host.verifier.enabled

True if SSL host verification should be enabled. This configuration can be set via CLI only.

Type: boolean
Default: true
Importance: medium

api.key.name

The identifier for the API key used in authentication. The format depends on the api.key.location configuration. If location is HEADER, use the HTTP header name (for example, X-API-KEY). If location is QUERY, use the query parameter name (for example, api_key, app_id). The default value X-API-KEY is commonly used for header-based authentication.

Type: string
Default: X-API-KEY
Importance: medium

api.key.value

The API key to be used with an endpoint that requires API key-based authentication

Type: password
Importance: medium

http.proxy.host

The host or IP address of the HTTP proxy.

Type: string
Importance: medium

http.proxy.port

The port number of the HTTP proxy.

Type: int
Valid Values: [0,…,65535]
Importance: medium

http.proxy.user

The username to be used for proxy authentication.

Type: string
Importance: medium

http.proxy.password

The password to be used for proxy authentication.

Type: password
Importance: medium

Behavior on error

behavior.on.error

Error handling behavior setting for handling error response from HTTP requests.

Type: string
Default: FAIL
Importance: low

APIs

apis.num

The number of http(s) APIs to configure. This value should be less than or equal to 15

Type: int
Default: 1
Importance: high

Additional Configs

consumer.override.auto.offset.reset

Defines the behavior of the consumer when there is no committed position (which occurs when the group is first initialized) or when an offset is out of range. You can choose either to reset the position to the “earliest” offset (the default) or the “latest” offset. You can also select “none” if you would rather set the initial offset yourself and you are willing to handle out of range errors manually. More details: https://docs.confluent.io/platform/current/installation/configuration/consumer-configs.html#auto-offset-reset

Type: string
Importance: low

consumer.override.isolation.level

Controls how to read messages written transactionally. If set to read_committed, consumer.poll() will only return transactional messages which have been committed. If set to read_uncommitted (the default), consumer.poll() will return all messages, even transactional messages which have been aborted. Non-transactional messages will be returned unconditionally in either mode. More details: https://docs.confluent.io/platform/current/installation/configuration/consumer-configs.html#isolation-level

Type: string
Importance: low

header.converter

The converter class for the headers. This is used to serialize and deserialize the headers of the messages.

Type: string
Importance: low

value.converter.allow.optional.map.keys

Allow optional string map key when converting from Connect Schema to Avro Schema. Applicable for Avro Converters.

Type: boolean
Importance: low

value.converter.auto.register.schemas

Specify if the Serializer should attempt to register the Schema.

Type: boolean
Importance: low

value.converter.connect.meta.data

Allow the Connect converter to add its metadata to the output schema. Applicable for Avro Converters.

Type: boolean
Importance: low

value.converter.enhanced.avro.schema.support

Enable enhanced schema support to preserve package information and Enums. Applicable for Avro Converters.

Type: boolean
Importance: low

value.converter.enhanced.protobuf.schema.support

Enable enhanced schema support to preserve package information. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.flatten.unions

Whether to flatten unions (oneofs). Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.generate.index.for.unions

Whether to generate an index suffix for unions. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.generate.struct.for.nulls

Whether to generate a struct variable for null values. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.int.for.enums

Whether to represent enums as integers. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.latest.compatibility.strict

Verify latest subject version is backward compatible when use.latest.version is true.

Type: boolean
Importance: low

value.converter.object.additional.properties

Whether to allow additional properties for object schemas. Applicable for JSON_SR Converters.

Type: boolean
Importance: low

value.converter.optional.for.nullables

Whether nullable fields should be specified with an optional label. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.optional.for.proto2

Whether proto2 optionals are supported. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.scrub.invalid.names

Whether to scrub invalid names by replacing invalid characters with valid characters. Applicable for Avro and Protobuf Converters.

Type: boolean
Importance: low

value.converter.use.latest.version

Use latest version of schema in subject for serialization when auto.register.schemas is false.

Type: boolean
Importance: low

value.converter.use.optional.for.nonrequired

Whether to set non-required properties to be optional. Applicable for JSON_SR Converters.

Type: boolean
Importance: low

value.converter.wrapper.for.nullables

Whether nullable fields should use primitive wrapper messages. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.wrapper.for.raw.primitives

Whether a wrapper message should be interpreted as a raw primitive at root level. Applicable for Protobuf Converters.

Type: boolean
Importance: low

errors.tolerance

Use this property if you would like to configure the connector’s error handling behavior. WARNING: This property should be used with CAUTION for SOURCE CONNECTORS as it may lead to dataloss. If you set this property to ‘all’, the connector will not fail on errant records, but will instead log them (and send to DLQ for Sink Connectors) and continue processing. If you set this property to ‘none’, the connector task will fail on errant records.

Type: string
Default: all
Importance: low

key.converter.key.subject.name.strategy

How to construct the subject name for key schema registration.

Type: string
Default: TopicNameStrategy
Importance: low

value.converter.decimal.format

Specify the JSON/JSON_SR serialization format for Connect DECIMAL logical type values with two allowed literals:

BASE64 to serialize DECIMAL logical types as base64 encoded binary data and

NUMERIC to serialize Connect DECIMAL logical type values in JSON/JSON_SR as a number representing the decimal value.

Type: string
Default: BASE64
Importance: low

value.converter.flatten.singleton.unions

Whether to flatten singleton unions. Applicable for Avro and JSON_SR Converters.

Type: boolean
Default: false
Importance: low

value.converter.ignore.default.for.nullables

When set to true, this property ensures that the corresponding record in Kafka is NULL, instead of showing the default column value. Applicable for AVRO,PROTOBUF and JSON_SR Converters.

Type: boolean
Default: false
Importance: low

value.converter.reference.subject.name.strategy

Set the subject reference name strategy for value. Valid entries are DefaultReferenceSubjectNameStrategy or QualifiedReferenceSubjectNameStrategy. Note that the subject reference name strategy can be selected only for PROTOBUF format with the default strategy being DefaultReferenceSubjectNameStrategy.

Type: string
Default: DefaultReferenceSubjectNameStrategy
Importance: low

value.converter.replace.null.with.default

Whether to replace fields that have a default value and that are null to the default value. When set to true, the default value is used, otherwise null is used. Applicable for JSON Converter.

Type: boolean
Default: true
Importance: low

value.converter.schemas.enable

Include schemas within each of the serialized values. Input messages must contain schema and payload fields and may not contain additional fields. For plain JSON data, set this to false. Applicable for JSON Converter.

Type: boolean
Default: false
Importance: low

value.converter.value.subject.name.strategy

Determines how to construct the subject name under which the value schema is registered with Schema Registry.

Type: string
Default: TopicNameStrategy
Importance: low

json.decimal.format

Specify the Request Body JSON serialization format for Connect DECIMAL logical type values with two allowed literals : BASE64 to serialize DECIMAL logical types as base64 encoded binary data and NUMERIC to serialize Connect DECIMAL logical type values in JSON Request Body as a number representing the decimal value. Applicable when request.body.format is json. This configuration can be set via CLI only.

Type: string
Default: BASE64
Importance: medium

API-1 Configs

api1.http.api.path

The HTTP API path together with the ‘http.api.base.url’ will form the complete HTTP(S) URL. This path can be templated with offset information. For example: /resource1/${offset} where ${offset} will be substituted with the offset generated from the previous request’s response (or if it’s the first request, from ‘http.initial.offset’).

Type: string
Importance: high

api1.topics

List of topics for this API

Type: list
Default: “”
Importance: high

api1.http.request.headers

HTTP headers to be included in each request. Header names and values should be separated by :. Distinct headers should be separated by |. For example: From:abcxyz@confluent.io|Content-Length:348.

Type: string
Importance: medium

api1.http.request.method

The HTTP method to use. This supports POST, PUT, PATCH, GET and DELETE. If DELETE is selected, the body is omitted when making the API call. In addition, if the api1.http.api.path doesn’t have ${key} or ${topic} placeholders, /${key} is appended to the API path.

Type: string
Default: POST
Importance: high

api1.http.request.parameters

HTTP parameters to be added to each request. Parameter names and values should be separated by =. Distinct parameters should be separated by &.

Type: string
Importance: medium

api1.http.connect.timeout.ms

The time in milliseconds to wait for a connection to be established

Type: int
Default: 30000 (30 seconds)
Valid Values: [1,…,600000]
Importance: medium

api1.http.request.timeout.ms

The time in milliseconds to wait for a request response from the server

Type: int
Default: 30000 (30 seconds)
Valid Values: [1,…,600000]
Importance: medium

api1.behavior.on.null.values

How to handle records with a non-null key and a null value (i.e. Kafka tombstone records). Valid options are IGNORE, DELETE and FAIL

Type: string
Default: IGNORE
Importance: low

api1.max.retries

The maximum number of times to retry on errors before failing the task.

Type: int
Default: 5
Importance: medium

api1.request.body.format

The format of the request body. Valid options are JSON or String. The default value is JSON. Note that if input.data.format is STRING, you should also set api1.request.body.format to STRING.

Type: string
Default: JSON
Importance: medium

api1.batch.key.pattern

Pattern used to build the key for a given batch. ${key} and ${topic} can be used to include message attributes here

Type: string
Importance: high

api1.retry.backoff.policy

The backoff policy to use in terms of retry - CONSTANT_VALUE or EXPONENTIAL_WITH_JITTER

Type: string
Default: EXPONENTIAL_WITH_JITTER
Importance: medium

api1.max.batch.size

The number of records accumulated in a batch before the HTTP API is invoked. Note that Basic and Standard Clusters may experience throughput limitations, even with a higher batch size.

Type: int
Default: 1
Importance: high

api1.retry.backoff.ms

The initial duration in milliseconds to wait following an error before a retry attempt is made. Subsequent backoff attempts can be a constant value or exponential with jitter (can be configured using api*.retry.backoff.policy parameter). Jitter adds randomness to the exponential backoff algorithm to prevent synchronized retries.

Type: int
Default: 3000 (3 seconds)
Valid Values: [20,…]
Importance: medium

api1.batch.prefix

Prefix added to record batches. This is applied once at the beginning of the batch of records

Type: string
Importance: high

api1.retry.on.status.codes

Comma-separated list of HTTP status codes or range of codes to retry on. Ranges are specified with start and optional end code. Range boundaries are inclusive. For instance, 400- includes all codes greater than or equal to 400. 400-500 includes codes from 400 to 500, including 500. Multiple ranges and single codes can be specified together to achieve fine-grained control over retry behavior. For example, 404,408,500- will retry on 404 NOT FOUND, 408 REQUEST TIMEOUT, and all 5xx error codes. Note that some status codes will always be retried, such as unauthorized, timeouts and too many requests.

Type: string
Default: 400-
Importance: medium

api1.batch.suffix

Suffix added to record batches. This is applied once at the end of the batch of records

Type: string
Importance: high

api1.http.request.headers.separator

The character that separates multiple distinct headers within http.request.headers. This configuration can be set via CLI only.

Type: string
Default: |
Importance: medium

api1.batch.separator

Separator for records in a batch. This configuration can be set via CLI only.

Type: string
Default: ,
Importance: high

api1.http.request.parameters.separator

The character that separates multiple distinct request parameters within http.request.parameters. This configuration can be set via CLI only.

Type: string
Default: &
Importance: medium

api1.batch.json.as.array

Whether or not to use an array to bundle json records. Only used when request.body.format is set to json. This can be disabled only when max.batch.size is set to 1.

Type: boolean
Default: false
Importance: high

api1.regex.patterns

Regular expression patterns used for replacements in the message sent to the HTTP service. Multiple regular expression patterns can be specified, but must be separated by regex.separator. This configuration can be set via CLI only.

Type: string
Importance: medium

api1.regex.replacements

Regex replacements to use with the patterns in regex.patterns. Multiple replacements can be specified, but must be separated by regex.separator. ${key} and ${topic} can be used here. This configuration can be set via CLI only.

Type: string
Importance: medium

api1.regex.separator

Separator character used in regex.patterns and regex.replacements property. This configuration can be set via CLI only.

Type: string
Importance: medium

api1.http.request.sensitive.headers

Sensitive HTTP headers to include in each request. Sensitive header names and values should be separated by :. Distinct headers should be separated by |. For example: From:abcxyz@confluent.io|Content-Length:348. If a key is present in both regular and sensitive headers, the value in sensitive headers takes priority. This is a CLI-only feature.

Type: password
Importance: medium

api1.allow.get.request.body

Allow Request Body in case of GET call. This configuration can be set via CLI only.

Type: boolean
Default: false
Importance: medium

api1.http.request.body

The custom payload that will be send to the destination instead of record. The value can be templated with key, topic and any other record key (for example: search_after: ${key}) where ${key} will be substituted with the key obtained from the record.

Type: string
Importance: medium

api1.report.only.status.code.to.success.topic

Whether to report only the status code to the success topic. If the API response payload is huge, it is recommended to set this to true, for better throughput. Please note that this is a CLI only feature.

Type: boolean
Default: false
Importance: medium

api1.http.path.parameters

HTTP path parameters to be added to the request. Parameter names and values should be separated by :. Distinct parameters should be separated by |. Parameter values can be templated with different template values like ${key}, ${topic}, or other field references from Kafka record.

Type: string
Importance: medium

api1.http.path.parameters.separator

The character that separates multiple distinct path parameters within http.path.parameters. This configuration can be set via CLI only.

Type: string
Default: |
Importance: medium

api1.upsert.method

The HTTP method to use for upserting. Valid options are POST or NONE. Setting the value to NONE disables upsert. The connector does not support batching for upsert operations.

Type: string
Default: NONE
Valid Values: NONE, POST
Importance: medium

api1.upsert.on.field.value

When this property is set, the connector performs an upsert if the record value has a matching jsonPath=expected_value. This property must not be set if api1.upsert.method is NONE.

Type: string
Default: “”
Importance: medium

api1.upsert.api.path

The API path the connector uses when performing an UPSERT. This is mandatory when api1.upsert.method is set to POST. This property must not be set if api1.upsert.method is NONE.

Type: string
Default: “”
Importance: medium

api1.forward.kafka.headers

Whether to forward Kafka record headers as HTTP headers. When set to false, Kafka headers are ignored for HTTP request construction and batching grouping.

Type: boolean
Default: true
Importance: medium

Auto-restart policy

auto.restart.on.user.error

Enable connector to automatically restart on user-actionable errors.

Type: boolean
Default: true
Importance: medium

Next Steps

For an example that shows fully-managed Confluent Cloud connectors in action with Confluent Cloud for Apache Flink, see the Cloud ETL Demo. This example also shows how to use Confluent CLI to manage your resources in Confluent Cloud.

HTTP Sink V2 Connector for Confluent Cloud

Features

Manage CSFLE

Manage Upserts

Limitations

Quick Start

Using the Confluent Cloud Console

Step 1: Launch your Confluent Cloud cluster

Step 2: Add a connector

Step 3: Select your connector

Step 4: Enter the connector details

Step 5: Check for records

Using the Confluent CLI

Step 1: List the available connectors

Step 2: List the connector configuration properties

Step 3: Create the connector configuration file

Step 4: Load the properties file and create the connector

Step 5: Check the connector status

Step 6: Check for records