Headers

• Connect-Protocol-Version number Required

  Define the version of the Connect protocol

  Value is 1.

• Connect-Timeout-Ms number

  Define the timeout, in ms

Responses

• 200 application/json

  Success

  Hide response attribute Show response attribute object

  • shadowLink object

    The shadow link that was retrieved

    Additional properties are NOT allowed.

    Hide shadowLink attributes Show shadowLink attributes object

    • configurations object

      Shadow link configuration

      Additional properties are NOT allowed.

      Hide configurations attributes Show configurations attributes object

      • clientOptions object

        Configuration for the internal kafka client

        Additional properties are NOT allowed.

        Hide clientOptions attributes Show clientOptions attributes object

        • authenticationConfiguration object

          Authentication settings

          One of:

          plain_configuration object scram_configuration object

          Hide attribute Show attribute

          • plainConfiguration object Required

            SASL/PLAIN configuration

            Additional properties are NOT allowed.

            Hide plainConfiguration attributes Show plainConfiguration attributes object

            • passwordSet boolean

              Indicates that the password has been set

            • passwordSetAt string(date-time)

              Timestamp of when the password was last set - only valid if password_set is true

            • username string

              PLAIN username

          Hide attribute Show attribute

          • scramConfiguration object Required

            SASL/SCRAM configuration

            Additional properties are NOT allowed.

            Hide scramConfiguration attributes Show scramConfiguration attributes object

            • passwordSet boolean

              Indicates that the password has been set

            • passwordSetAt string(date-time)

              Timestamp of when the password was last set - only valid if password_set is true

            • scramMechanism string

              The SCRAM mechanism to use

              Values are SCRAM_MECHANISM_UNSPECIFIED, SCRAM_MECHANISM_SCRAM_SHA_256, or SCRAM_MECHANISM_SCRAM_SHA_512.

            • username string

              SCRAM username

        • bootstrapServers array[string] Required

          The bootstrap servers to use

        • clientId string

          The Client ID for the Kafka RPC requests setn by this cluster to the source cluster

        • connectionTimeoutMs integer(int32)

          Connection timeout. If 0 is provided, defaults to 1 second

        • effectiveConnectionTimeoutMs integer(int32)

          The effective connection timeout in milliseconds

        • effectiveFetchMaxBytes integer(int32)

          The effective fetch max bytes

        • effectiveFetchMinBytes integer(int32)

          The effective fetch min bytes

        • effectiveFetchPartitionMaxBytes integer(int32)

          The effective fetch partition max bytes

        • effectiveFetchWaitMaxMs integer(int32)

          The effective fetch wait max in milliseconds

        • effectiveMetadataMaxAgeMs integer(int32)

          The effective metadata max age in milliseconds

        • effectiveRetryBackoffMs integer(int32)

          The effective retry backoff in milliseconds

        • fetchMaxBytes integer(int32)

          Fetch max bytes. If 0 is provided, defaults to 20 MiB

        • fetchMinBytes integer(int32)

          Fetch min bytes. If 0 is provided, defaults to 5 MiB

        • fetchPartitionMaxBytes integer(int32)

          Fetch partition max bytes. If 0 is provided, defaults to 5 MiB

        • fetchWaitMaxMs integer(int32)

          Fetch request timeout. If 0 is provided, defaults to 500ms

        • metadataMaxAgeMs integer(int32)

          Max metadata age. If 0 is provided, defaults to 10 seconds

        • retryBackoffMs integer(int32)

          Retry base backoff. If 0 is provided, defaults to 100ms

        • sourceClusterId string

          If provided, this is the expected ID of the source cluster. If it does not match then the connection will be rejected. If provided, this value must match the ClusterId field returned in the Kafka Metadata response message

        • tlsSettings object

          TLS settings

          Additional properties are NOT allowed.

          Hide tlsSettings attributes Show tlsSettings attributes object

          • doNotSetSniHostname boolean

            If true, the SNI hostname will not be provided when TLS is used

          • enabled boolean

            Whether or not TLS is enabled

          • tlsFileSettings object Required

            Certificates and keys are provided as files

            Additional properties are NOT allowed.

            Hide tlsFileSettings attributes Show tlsFileSettings attributes object

            • caPath string

              Path to the CA

            • certPath string

              Path to the cert

            • keyPath string

              Key and Cert are optional but if one is provided, then both must be Path to the key

          • tlsPemSettings object Required

            Certificates and keys are provided in PEM format

            Additional properties are NOT allowed.

            Hide tlsPemSettings attributes Show tlsPemSettings attributes object

            • ca string

              The CA

            • cert string

              The cert

            • keyFingerprint string

              The SHA-256 of the key, in base64 format

      • consumerOffsetSyncOptions object

        Consumer offset sync options

        Additional properties are NOT allowed.

        Hide consumerOffsetSyncOptions attributes Show consumerOffsetSyncOptions attributes object

        • effectiveInterval string(duration)

          The effective interval for the task

        • groupFilters array[object]

          The filters

          A filter based on the name of a resource

          Hide groupFilters attributes Show groupFilters attributes object

          • filterType string

            Include or exclude

            Values are FILTER_TYPE_UNSPECIFIED, FILTER_TYPE_INCLUDE, or FILTER_TYPE_EXCLUDE.

          • name string

            The resource name, or "" Note if "", must be the only character and pattern_type must be PATTERN_TYPE_LITERAL

          • patternType string

            Literal or prefix

            Values are PATTERN_TYPE_UNSPECIFIED, PATTERN_TYPE_LITERAL, PATTERN_TYPE_PREFIX, or PATTERN_TYPE_PREFIXED.

        • interval string(duration)

          Sync interval If 0 provided, defaults to 30 seconds

        • paused boolean

          Allows user to pause the consumer offset sync task. If paused, then the task will enter the 'paused' state and not sync consumer offsets from the source cluster

      • schemaRegistrySyncOptions object

        Additional properties are NOT allowed.

        Hide schemaRegistrySyncOptions attribute Show schemaRegistrySyncOptions attribute object

        • shadowSchemaRegistryTopic object Required

          Shadow the entire source cluster's Schema Registry byte-for-byte. If set, the Shadow Link will attempt to add the _schemas topic to the list of Shadow Topics as long as:

          1. The _schemas topic exists on the source cluster
          2. The _schemas topic does not exist on the shadow cluster, or it is empty. If either of the above conditions are not met, then the _schemas topic will not be shadowed by this cluster. Unsetting this flag will not remove the _schemas topic from shadowing if it has already been added. Once made a shadow topic, the _schemas topic will be replicated byte-for-byte. To stop shadowing the _schemas topic, unset this field, then either fail-over the topic or delete it.

          Additional properties are NOT allowed.

      • securitySyncOptions object

        Security settings sync options

        Additional properties are NOT allowed.

        Hide securitySyncOptions attributes Show securitySyncOptions attributes object

        • aclFilters array[object]

          ACL filters

          A filter for ACLs

          Hide aclFilters attributes Show aclFilters attributes object

          • accessFilter object

            The access filter

            Additional properties are NOT allowed.

            Hide accessFilter attributes Show accessFilter attributes object

            • host string

              The host to match. If not set, will default to match all hosts with the specified operation and permission_type. Note that the asterisk * is literal and matches hosts that are set to *

            • operation string

              The ACL operation to match

              Values are ACL_OPERATION_UNSPECIFIED, ACL_OPERATION_ANY, ACL_OPERATION_READ, ACL_OPERATION_WRITE, ACL_OPERATION_CREATE, ACL_OPERATION_REMOVE, ACL_OPERATION_ALTER, ACL_OPERATION_DESCRIBE, ACL_OPERATION_CLUSTER_ACTION, ACL_OPERATION_DESCRIBE_CONFIGS, ACL_OPERATION_ALTER_CONFIGS, or ACL_OPERATION_IDEMPOTENT_WRITE.

            • permissionType string

              The permission type

              Values are ACL_PERMISSION_TYPE_UNSPECIFIED, ACL_PERMISSION_TYPE_ANY, ACL_PERMISSION_TYPE_ALLOW, or ACL_PERMISSION_TYPE_DENY.

            • principal string

              The name of the principal, if not set will default to match all principals with the specified operation and permission_type

          • resourceFilter object

            The resource filter

            Additional properties are NOT allowed.

            Hide resourceFilter attributes Show resourceFilter attributes object

            • name string

              Name, if not given will default to match all items in resource_type. Note that asterisk * is literal and matches resource ACLs that are named *

            • patternType string

              The pattern to apply to name

              Values are ACL_PATTERN_UNSPECIFIED, ACL_PATTERN_ANY, ACL_PATTERN_LITERAL, ACL_PATTERN_PREFIXED, ACL_PATTERN_PREFIX, or ACL_PATTERN_MATCH.

            • resourceType string

              The ACL resource type to match

              Values are ACL_RESOURCE_UNSPECIFIED, ACL_RESOURCE_ANY, ACL_RESOURCE_CLUSTER, ACL_RESOURCE_GROUP, ACL_RESOURCE_TOPIC, ACL_RESOURCE_TXN_ID, ACL_RESOURCE_SR_SUBJECT, ACL_RESOURCE_SR_REGISTRY, or ACL_RESOURCE_SR_ANY.

        • effectiveInterval string(duration)

          The effective interval for the task

        • interval string(duration)

          Sync interval If 0 provided, defaults to 30 seconds

        • paused boolean

          Allows user to pause the security settings sync task. If paused, then the task will enter the 'paused' state and will not sync security settings from the source cluster

      • topicMetadataSyncOptions object

        Topic metadata sync options

        Additional properties are NOT allowed.

        Hide topicMetadataSyncOptions attributes Show topicMetadataSyncOptions attributes object

        • autoCreateShadowTopicFilters array[object]

          List of filters that indicate which topics should be automatically created as shadow topics on the shadow cluster. This only controls automatic creation of shadow topics and does not effect the state of the mirror topic once it is created. Literal filters for _consumer_offsets, _redpanda.audit_log and _schemas will be rejected as well as prefix filters to match topics prefixed with _redpanda or __redpanda. Wildcard * is permitted only for literal filters and will _not match any topics that start with _redpanda or __redpanda. If users wish to shadow topics that start with _redpanda or __redpanda, they should provide a literal filter for those topics.

          A filter based on the name of a resource

          Hide autoCreateShadowTopicFilters attributes Show autoCreateShadowTopicFilters attributes object

          • filterType string

            Include or exclude

            Values are FILTER_TYPE_UNSPECIFIED, FILTER_TYPE_INCLUDE, or FILTER_TYPE_EXCLUDE.

          • name string

            The resource name, or "" Note if "", must be the only character and pattern_type must be PATTERN_TYPE_LITERAL

          • patternType string

            Literal or prefix

            Values are PATTERN_TYPE_UNSPECIFIED, PATTERN_TYPE_LITERAL, PATTERN_TYPE_PREFIX, or PATTERN_TYPE_PREFIXED.

        • effectiveInterval string(duration)

          The effective interval for the task

        • excludeDefault boolean

          If false, then the following topic properties will be synced by default:

          • compression.type
          • retention.bytes
          • retention.ms
          • delete.retention.ms
          • Replication Factor
          • min.compaction.lag.ms
          • max.compaction.lag.ms

          If this is true, then only the properties listed in synced_shadow_topic_properties will be synced.

        • interval string(duration)

          How often to sync metadata If 0 provided, defaults to 30 seconds

        • paused boolean

          Allows user to pause the topic sync task. If paused, then the task will enter the 'paused' state and not sync topics or their properties from the source cluster

        • syncedShadowTopicProperties array[string]

          List of topic properties that should be synced from the source topic. The following properties will always be replicated

          • Partition count
          • max.message.bytes
          • cleanup.policy
          • timestamp.type

          The following properties are not allowed to be replicated and adding them to this list will result in an error:

          • redpanda.remote.readreplica
          • redpanda.remote.recovery
          • redpanda.remote.allowgaps
          • redpanda.virtual.cluster.id
          • redpanda.leaders.preference
          • redpanda.storage.mode

          This list is a list of properties in addition to the default properties that will be synced. See exclude_default.

        • startAtEarliest object Required

          Enables data replication from the earliest offset on the source topic/partition.

          Additional properties are NOT allowed.

        • startAtLatest object Required

          Enables data replication from the latest offset on the source topic/partition.

          Additional properties are NOT allowed.

        • startAtTimestamp string(date-time) Required

          Enables data replication from the first offset on the source topic/partition where the record's timestamp is at or after the specified timestamp.

    • name string Required

      The name of the shadow link

    • status object

      Status of the shadow link

      Additional properties are NOT allowed.

      Hide status attributes Show status attributes object

      • shadowTopics array[object]

        Status of shadow topics

        A ShadowTopic resource contained by the ShadowLink

        Hide shadowTopics attributes Show shadowTopics attributes object

        • name string

          Name of the shadow topic

        • sourceTopicId string

          The topic ID of the source topic

        • sourceTopicName string

          The name of the source topic

        • status object

          The status of the shadow topic

          Additional properties are NOT allowed.

          Hide status attributes Show status attributes object

          • partitionInformation array[object]

            List of partition information for the shadow topic

            Topic partition information

            Hide partitionInformation attributes Show partitionInformation attributes object

            • highWatermark integer | string

              Shadowed partition's HWM

            • partitionId integer | string

              Partition ID

            • sourceHighWatermark integer | string

              Source partition's HWM

            • sourceLastStableOffset integer | string

              Source partition's LSO

            • sourceLastUpdatedTimestamp string(date-time)

              Timestamp of the last time the source partition information was updated

          • state string

            State of the shadow topic

            Values are SHADOW_TOPIC_STATE_UNSPECIFIED, SHADOW_TOPIC_STATE_ACTIVE, SHADOW_TOPIC_STATE_FAULTED, SHADOW_TOPIC_STATE_PAUSED, SHADOW_TOPIC_STATE_FAILING_OVER, SHADOW_TOPIC_STATE_FAILED_OVER, SHADOW_TOPIC_STATE_PROMOTING, or SHADOW_TOPIC_STATE_PROMOTED.

        • topicId string

          The topic ID of the shadow topic

      • state string

        State of the shadow link

        Values are SHADOW_LINK_STATE_UNSPECIFIED, SHADOW_LINK_STATE_ACTIVE, or SHADOW_LINK_STATE_PAUSED.

      • syncedShadowTopicProperties array[string]

        List of topic properties that are being synced

      • taskStatuses array[object]

        Statuses of the running tasks

        Status of a task

        Hide taskStatuses attributes Show taskStatuses attributes object

        • brokerId integer(int32)

          The broker the task is running on

        • name string

          Name of the task

        • reason string

          Reason for task being in state

        • shard integer(int32)

          The shard the task is running on

        • state string

          State of the task

          Values are TASK_STATE_UNSPECIFIED, TASK_STATE_ACTIVE, TASK_STATE_PAUSED, TASK_STATE_LINK_UNAVAILABLE, TASK_STATE_NOT_RUNNING, or TASK_STATE_FAULTED.

    • uid string

      The UUID of the shadow link

• default application/json

  Error

  Hide response attributes Show response attributes object

  • code string

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    Values are canceled, unknown, invalid_argument, deadline_exceeded, not_found, already_exists, permission_denied, resource_exhausted, failed_precondition, aborted, out_of_range, unimplemented, internal, unavailable, data_loss, or unauthenticated.

  • details array[object]

    A list of messages that carry the error details. There is no limit on the number of messages.

    Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.

    Hide details attributes Show details attributes object

    • debug object

      Detailed error information.

      Additional properties are allowed.

    • type string

      A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.

    • value string(binary)

      The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.

  • message string

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.