COconfluent
Exporters (v1)

Update schema exporter by name

Updates the information or configurations of the schema exporter. All attributes in request body are optional.

put/exporters/{name}

Request

  • Base URL
    https://psrc-00000.region.provider.confluent.cloud
  • URL
    https://psrc-00000.region.provider.confluent.cloud/exporters/{name}
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://api.confluent.cloud/sts/v1/oauth2/token

Path parameters

namestring required

Name of the exporter

Request body

contextTypestring

Context type of the exporter. One of CUSTOM, NONE or AUTO (default)

contextstring

Customized context of the exporter if contextType equals CUSTOM.

subjectsstring[]

Name of each exporter subject

kekRenameFormatstring

Format string for the KEK name in the destination cluster, which may contain ${kek} as a placeholder for the originating KEK name. For example, dc_${kek} for the KEK aws_key will map to the destination KEK name dc_aws_key.

subjectRenameFormatstring

Format string for the subject name in the destination cluster, which may contain ${subject} as a placeholder for the originating subject name. For example, dc_${subject} for the subject orders will map to the destination subject name dc_orders.

configobject

The map containing exporter's configurations

Example request

{
  "contextType": "CUSTOM",
  "context": "User"
}

Response

The original request.

namestring

Name of the exporter

Example response

{
  "name": "test-exporter"
}

Changes

No recorded changes to this operation across all 7 revisions of this API.