--- title: "Get Shadow Link" method: GET path: "/v1/shadow-links/{name}" tags: ["Shadow Links (Data Plane)"] --- # Get Shadow Link `GET /v1/shadow-links/{name}` Retrieve details of a specific shadow link by name. ## Path parameters - `name` string, required ## Response `200` OK - V1GetShadowLinkResponse - `shadow_link` V1ShadowLink - `configurations` ShadowLinkConfigurations - `client_options` ShadowLinkClientOptions - `authentication_configuration` AuthenticationConfiguration - `plain_configuration` PlainConfig - `password` string - `password_set` boolean - `password_set_at` string, date-time - `username` string - `scram_configuration` ScramConfig - `password` string - `password_set` boolean - `password_set_at` string, date-time - `scram_mechanism` 'SCRAM_MECHANISM_SCRAM_SHA_256' | 'SCRAM_MECHANISM_SCRAM_SHA_512' — - SCRAM_MECHANISM_SCRAM_SHA_256: SCRAM-SHA-256 - SCRAM_MECHANISM_SCRAM_SHA_512: SCRAM-SHA-512 - `username` string - `bootstrap_servers` string[], required - `client_id` string - `connection_timeout_ms` integer - `effective_connection_timeout_ms` integer - `effective_fetch_max_bytes` integer - `effective_fetch_min_bytes` integer - `effective_fetch_partition_max_bytes` integer - `effective_fetch_wait_max_ms` integer - `effective_metadata_max_age_ms` integer - `effective_retry_backoff_ms` integer - `fetch_max_bytes` integer - `fetch_min_bytes` integer - `fetch_partition_max_bytes` integer - `fetch_wait_max_ms` integer - `metadata_max_age_ms` integer - `retry_backoff_ms` integer - `source_cluster_id` string - `tls_settings` TLSSettings - `do_not_set_sni_hostname` boolean - `enabled` boolean - `tls_file_settings` TLSFileSettings - `ca_path` string - `cert_path` string - `key_path` string - `tls_pem_settings` TLSPEMSettings - `ca` string - `cert` string - `key` string - `key_fingerprint` string - `consumer_offset_sync_options` ConsumerOffsetSyncOptions - `effective_interval` string - `group_filters` NameFilter[] - `filter_type` 'FILTER_TYPE_INCLUDE' | 'FILTER_TYPE_EXCLUDE' — - FILTER_TYPE_INCLUDE: Include the items that match the filter - FILTER_TYPE_EXCLUDE: Exclude the items that match the filter - `name` string - `pattern_type` 'PATTERN_TYPE_LITERAL' | 'PATTERN_TYPE_PREFIX' | 'PATTERN_TYPE_PREFIXED' — - PATTERN_TYPE_LITERAL: Must match the filter exactly - PATTERN_TYPE_PREFIX: Will match anything that starts with filter - PATTERN_TYPE_PREFIXED: Will match anything that starts with filter - `interval` string - `paused` boolean - `role_sync_options` RoleSyncOptions - `effective_interval` string - `interval` string - `paused` boolean - `role_name_filters` NameFilter[] - `filter_type` 'FILTER_TYPE_INCLUDE' | 'FILTER_TYPE_EXCLUDE' — - FILTER_TYPE_INCLUDE: Include the items that match the filter - FILTER_TYPE_EXCLUDE: Exclude the items that match the filter - `name` string - `pattern_type` 'PATTERN_TYPE_LITERAL' | 'PATTERN_TYPE_PREFIX' | 'PATTERN_TYPE_PREFIXED' — - PATTERN_TYPE_LITERAL: Must match the filter exactly - PATTERN_TYPE_PREFIX: Will match anything that starts with filter - PATTERN_TYPE_PREFIXED: Will match anything that starts with filter - `schema_registry_sync_options` SchemaRegistrySyncOptions — Options for how the Schema Registry is synced. - `shadow_schema_registry_api` ShadowSchemaRegistryApi — Replicates selected Schema Registry subjects, configs, modes, and schema IDs over the Schema Registry HTTP API. - `auth_options` SchemaRegistryAuthOptions — Authentication settings for source Schema Registry HTTP requests. - `basic` HTTPBasicAuthOptions — HTTP Basic auth credentials. - … - `destination` SchemaRegistryContextDestination — Destination context mapping for source Schema Registry data. - `exact` SchemaRegistryExactContextMappings — Explicit source-to-destination context mappings. - … - `identity` SchemaRegistryIdentityContextMapping — Preserve source context names in the destination Schema Registry. - `effective_full_sync_interval` string — The effective interval between full scans. - `effective_max_source_requests_per_second` integer — The effective maximum request rate, in requests per second. - `effective_tail_interval` string — The effective interval between incremental polls. - `full_sync_interval` string — Interval between full scans of the selected source subjects. If unset or zero, the cluster default of 5m is used. - `max_source_requests_per_second` integer — Maximum request rate, in requests per second, for calls to the source Schema Registry. If unset or zero, a default rate limit of 30 requests/s is used. - `paused` boolean — Allows the user to pause the Schema Registry sync task. If paused, the task enters the 'paused' state and stops replicating schemas from the source, and the per-context client write protection on the contexts this link owns is lifted. - `source_filter` SchemaRegistrySourceFilter — Filter for specific Schema Registry contexts and subjects to select for replication. If unset or empty, the whole source Schema Registry is replicated. - `contexts` string[] — Source contexts to replicate in full, for example ".", ".prod", or ".staging". If both `contexts` and `subjects` are set, the effective source scope is the union of both selections. - `subjects` string[] — Exact source subjects to replicate, using Schema Registry qualified subject syntax. For example, "orders-value" selects the subject in the default context, and ":.prod:orders-value" selects the subject in context ".prod". If both `contexts` and `subjects` are set, the union of both selections is replicated. If a subject is also included by `contexts`, it is counted and replicated once. - `source_url` string — The source Schema Registry URL to use. - `tail_interval` string — Interval between incremental polls for new source subjects and subject versions. If unset or zero, the cluster default of 10s is used. - `tls_settings` TLSSettings - `do_not_set_sni_hostname` boolean - `enabled` boolean - `tls_file_settings` TLSFileSettings - … - `tls_pem_settings` TLSPEMSettings - … - `unsupported_schema_feature_policy` 'UNSUPPORTED_SCHEMA_FEATURE_POLICY_FAIL' | 'UNSUPPORTED_SCHEMA_FEATURE_POLICY_REMOVE' — Policy for handling source schema features unsupported by the destination. - UNSUPPORTED_SCHEMA_FEATURE_POLICY_FAIL: Fail the sync when an unsupported schema feature is encountered. - UNSUPPORTED_SCHEMA_FEATURE_POLICY_REMOVE: Remove unsupported schema features before writing to the destination. - `shadow_schema_registry_topic` ShadowSchemaRegistryTopic — 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. - `security_sync_options` SecuritySettingsSyncOptions - `acl_filters` ACLFilter[] - `access_filter` ACLAccessFilter - `host` string - `operation` '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' | 'ACL_OPERATION_IDEMPOTENT_WRITE' - `permission_type` 'ACL_PERMISSION_TYPE_ANY' | 'ACL_PERMISSION_TYPE_ALLOW' | 'ACL_PERMISSION_TYPE_DENY' - `principal` string - `resource_filter` ACLResourceFilter - `name` string - `pattern_type` 'ACL_PATTERN_ANY' | 'ACL_PATTERN_LITERAL' | 'ACL_PATTERN_PREFIXED' | 'ACL_PATTERN_PREFIX' | 'ACL_PATTERN_MATCH' — - ACL_PATTERN_ANY: Wildcard to match any pattern - ACL_PATTERN_LITERAL: Match a literal string - ACL_PATTERN_PREFIXED: Match a prefix - ACL_PATTERN_PREFIX: Match a prefix - ACL_PATTERN_MATCH: Match serves as a catch-all for all the names of a topic the principal is authorized to access - `resource_type` 'ACL_RESOURCE_ANY' | 'ACL_RESOURCE_CLUSTER' | 'ACL_RESOURCE_GROUP' | 'ACL_RESOURCE_TOPIC' | 'ACL_RESOURCE_TXN_ID' | 'ACL_RESOURCE_SR_SUBJECT' | 'ACL_RESOURCE_SR_REGISTRY' | 'ACL_RESOURCE_SR_ANY' — - ACL_RESOURCE_ANY: Wildcard for selecting any ACL resource - ACL_RESOURCE_CLUSTER: Cluster wide resource - ACL_RESOURCE_GROUP: Consumer group resource - ACL_RESOURCE_TOPIC: Topic resource - ACL_RESOURCE_TXN_ID: Transaction ID resource - ACL_RESOURCE_SR_SUBJECT: Schema Registry subject resource - ACL_RESOURCE_SR_REGISTRY: Schema Registry wide resource - ACL_RESOURCE_SR_ANY: Wildcard to match any SR ACL resource - `effective_interval` string - `interval` string - `paused` boolean - `topic_metadata_sync_options` TopicMetadataSyncOptions - `auto_create_shadow_topic_filters` NameFilter[] — 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. - `filter_type` 'FILTER_TYPE_INCLUDE' | 'FILTER_TYPE_EXCLUDE' — - FILTER_TYPE_INCLUDE: Include the items that match the filter - FILTER_TYPE_EXCLUDE: Exclude the items that match the filter - `name` string - `pattern_type` 'PATTERN_TYPE_LITERAL' | 'PATTERN_TYPE_PREFIX' | 'PATTERN_TYPE_PREFIXED' — - PATTERN_TYPE_LITERAL: Must match the filter exactly - PATTERN_TYPE_PREFIX: Will match anything that starts with filter - PATTERN_TYPE_PREFIXED: Will match anything that starts with filter - `effective_interval` string - `exclude_default` boolean — If this is true, then only the properties listed in `synced_shadow_topic_properties` will be synced. - `interval` string - `paused` boolean - `start_at_earliest` EarliestOffset — Start at the earliest offset in the partition. - `start_at_latest` LatestOffset — Start at the latest offset in the partition. - `start_at_timestamp` string, date-time — Enables data replication from the first offset on the source topic/partition where the record's timestamp is at or after the specified timestamp. - `synced_shadow_topic_properties` string[] — 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`. - `name` string - `state` 'SHADOW_LINK_STATE_ACTIVE' | 'SHADOW_LINK_STATE_PAUSED' — - SHADOW_LINK_STATE_ACTIVE: Shadow link is active - SHADOW_LINK_STATE_PAUSED: Shadow link was paused - `synced_shadow_topic_properties` string[] - `tasks_status` ShadowLinkTaskStatus[] - `broker_id` integer - `name` string - `reason` string - `shard` integer - `state` 'TASK_STATE_ACTIVE' | 'TASK_STATE_PAUSED' | 'TASK_STATE_LINK_UNAVAILABLE' | 'TASK_STATE_NOT_RUNNING' | 'TASK_STATE_FAULTED' — - TASK_STATE_ACTIVE: Task is active - TASK_STATE_PAUSED: Task was paused - TASK_STATE_LINK_UNAVAILABLE: Task is unable to communicate with source cluster - TASK_STATE_NOT_RUNNING: Task is not running - TASK_STATE_FAULTED: Task is faulted - `uid` string ## Other responses - `401` — Unauthenticated. - `500` — Internal Server Error. Reach out to support. - `default` — An unexpected error response. ## Changes > 51 revisions in range; 1 could not be searched. - **2026-07-06** `fe9d8a24ba80` — 2 info - added the optional property `shadow_link/configurations/role_sync_options` to the response with the `200` status - added the optional property `shadow_link/configurations/schema_registry_sync_options/shadow_schema_registry_api` to the response with the `200` status - **2026-03-18** `bcbb37a8781c` — 3 warning - added the new `ACL_PATTERN_PREFIX` enum value to the `shadow_link/configurations/security_sync_options/acl_filters/items/resource_filter/pattern_type` response property for the response status `200` - added the new `PATTERN_TYPE_PREFIXED` enum value to the `shadow_link/configurations/consumer_offset_sync_options/group_filters/items/pattern_type` response property for the response status `200` - added the new `PATTERN_TYPE_PREFIXED` enum value to the `shadow_link/configurations/topic_metadata_sync_options/auto_create_shadow_topic_filters/items/pattern_type` response property for the response status `200` - **2025-12-11** `0a5af046f9de` — 2 info - api tag `Shadow Links (Data Plane)` added - api tag `Shadow Links (Dataplane)` removed - **2025-12-11** `d6b328d69cf2` — 1 info - endpoint added - **2025-05-27** `dfa71f9d277e` — 1 breaking - api path removed without deprecation [Change history](https://skmtc.dev/redpanda-data/apis/redpanda-cloud-data-plane-api/changes/v1/shadow-links/:name/get.md) --- [API](https://skmtc.dev/redpanda-data/apis/redpanda-cloud-data-plane-api.md) · [All operations](https://skmtc.dev/redpanda-data/apis/redpanda-cloud-data-plane-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/redpanda-data/redpanda-cloud-data-plane-api/revisions/7eef0bcc42e7/schema)