# Using the Karapace REST Proxy

###### [Documentation](https://instaclustr.husldigital.com/support/documentation/)



 

 

 

###### [Documentation](https://instaclustr.husldigital.com/support/documentation/)

- [ Announcements+ ](#section-announcements)
    - [ General ](#section-announcements-general)
        - [ Announcement: RIYOA is now BYOC, and RICMI is now On-Premises ](https://instaclustr.husldigital.com/support/documentation/announcements/general/announcement-riyoa-is-now-byoc-and-ricmi-is-now-on-premises/)
        - [ Self-Service Tag Management feature is now available on the NetApp Instaclustr Managed Platform ](https://instaclustr.husldigital.com/support/documentation/announcements/general/self-service-tag-management-feature-is-now-available-on-the-netapp-instaclustr-managed-platform/)
        - [ NetApp releases Public Preview of Zero Inbound Access on the NetApp Instaclustr Managed Platform ](https://instaclustr.husldigital.com/support/documentation/announcements/general/instaclustr-releases-zero-inbound-access-public-preview/)
        - [ Instaclustr enables Default Encryption for new AWS EBS Volumes ](https://instaclustr.husldigital.com/support/documentation/announcements/general/instaclustr-enables-default-encryption-for-new-aws-ebs-volumes/)
        - [ Instaclustr API Rate Limits ](https://instaclustr.husldigital.com/support/documentation/announcements/general/instaclustr-api-rate-limits/)
        - [ Instaclustr disables GCP Soft-Delete on Cloud Storage Buckets ](https://instaclustr.husldigital.com/support/documentation/announcements/general/instaclustr-disables-gcp-soft-delete-on-cloud-storage-buckets/)
    - [ Apache Cassandra ](#section-announcements-apache-cassandra)
        - [ Announcement: Addressing Assertion Errors and Quorum Failures in Cassandra 5.x Versions ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-cassandra/announcement-addressing-assertion-errors-and-quorum-failures-in-cassandra-5-x-versions/)
        - [ Addressing Mutation Thread Stalls in Cassandra 4.1.8 ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-cassandra/addressing-mutation-thread-stalls-in-cassandra-4-1-8/)
        - [ Important Announcement Regarding Cassandra 3.x End-of-Life Support ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-cassandra/cassandra-3-eol/)
        - [ Updates to Cipher Suites for Cassandra version 4 and above Clusters ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-cassandra/updates-to-cipher-suites-for-cassandra-version-4-and-above-clusters/)
        - [ Important Update: Apache Spark™ Add-On Will Reach End of Life on Instaclustr Platform on 10 Aug 2025 ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-cassandra/important-update-apache-spark-add-on-will-reach-end-of-life-on-instaclustr-platform-on-10-aug-2025/)
        - [ Past Announcements ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-cassandra/past-announcements/)
    - [ Apache Kafka and Kafka Connect ](#section-announcements-apache-kafka-and-kafka-connect)
        - [ How to monitor Kafka consumer group lag with Client Telemetry ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-kafka-and-kafka-connect/how-to-monitor-kafka-consumer-group-lag-with-client-telemetry/)
        - [ Identifying when a Kafka share group is falling behind ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-kafka-and-kafka-connect/identifying-when-a-kafka-share-group-is-falling-behind/)
        - [ Kafka client fleet visibility and per-producer latency with Client Telemetry ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-kafka-and-kafka-connect/kafka-client-fleet-visibility-and-per-producer-latency-with-client-telemetry/)
        - [ Instaclustr for Apache Kafka® and Kafka® Connect 4.3.1 are now generally available ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-kafka-and-kafka-connect/instaclustr-for-apache-kafka-and-kafka-connect-4-3-1-are-now-generally-available/)
        - [ Instaclustr for Apache Kafka® and Kafka® Connect 4.2.1 are now generally available ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-kafka-and-kafka-connect/instaclustr-for-apache-kafka-and-kafka-connect-4-2-1-are-now-generally-available/)
        - [ Instaclustr for Apache Kafka® and Apache Kafka® Connect 4.1.2 Are Generally Available ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-kafka-and-kafka-connect/instaclustr-for-apache-kafka-and-apache-kafka-connect-4-1-2-are-generally-available/)
        - [ Instaclustr for Apache Kafka® and Apache Kafka® Connect 3.9.2 are Generally Available ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-kafka-and-kafka-connect/instaclustr-for-apache-kafka-and-apache-kafka-connect-3-9-2-are-generally-available/)
        - [ Kafka “Diskless” – Proposals, Status &amp; Insights ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-kafka-and-kafka-connect/kafka-diskless-proposals-status-insights/)
        - [ Past Announcements ](#section-announcements-apache-kafka-and-kafka-connect-past-announcements)
            - [ Instaclustr for Apache Kafka® and Kafka ® Connect 4.1.1 are generally available ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-kafka-and-kafka-connect/past-announcements/instaclustr-for-apache-kafka-and-kafka-connect-4-1-1-are-generally-available/)
            - [ NetApp Instaclustr Security Advisory – Multiple Kafka CVEs (June 2025) ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-kafka-and-kafka-connect/past-announcements/netapp-instaclustr-security-advisory-multiple-kafka-cves-june-2025/)
            - [ Instaclustr for Apache Kafka® and Kafka ® Connect 3.9.1 are generally available ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-kafka-and-kafka-connect/past-announcements/instaclustr-for-apache-kafka-and-kafka-connect-3-9-1-are-generally-available/)
            - [ Instaclustr for Apache Kafka® and Apache Kafka® Connect 3.9.0 Are Generally Available ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-kafka-and-kafka-connect/past-announcements/instaclustr-for-apache-kafka-and-kafka-connect-3-9-0-are-generally-available/)
            - [ Instaclustr for Apache Kafka® 3.8.1 and Kafka Tiered Storage Are Now Generally Available ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-kafka-and-kafka-connect/past-announcements/instaclustr-for-apache-kafka-3-8-1-and-kafka-tiered-storage-are-now-generally-available/)
            - [ Instaclustr for Apache Kafka® and Apache Kafka® Connect 3.7.1 Are Now Generally Available ](https://instaclustr.husldigital.com/support/documentation/announcements/apache-kafka-and-kafka-connect/past-announcements/instaclustr-for-apache-kafka-and-apache-kafka-connect-3-7-1-are-now-generally-available/)
    - [ Cadence ](#section-announcements-cadence)
        - [ Instaclustr NetApp Announces AWS Graviton Node Types for Managed Cadence® Workflow ](https://instaclustr.husldigital.com/support/documentation/announcements/cadence/instaclustr-netapp-announces-aws-graviton-node-types-for-managed-cadence-workflow/)
        - [ NetApp Announces General Availability of Cadence Web 4.0 and Cadence version 1.3.2 on the NetApp Instaclustr Managed Platform ](https://instaclustr.husldigital.com/support/documentation/announcements/cadence/netapp-announces-general-availability-of-cadence-web-4-0-and-cadence-version-1-3-2-on-the-netapp-instaclustr-managed-platform/)
        - [ Past Announcements ](https://instaclustr.husldigital.com/support/documentation/announcements/cadence/past-announcements/)
    - [ ClickHouse ](#section-announcements-clickhouse)
        - [ Simpler, secure peering with AWS PrivateLink with NetApp Instaclustr for ClickHouse on the NetApp Instaclustr managed platform ](https://instaclustr.husldigital.com/support/documentation/announcements/clickhouse/aws-privatelink-clickhouse/)
    - [ OpenSearch ](#section-announcements-opensearch)
        - [ OpenSearch 3.5 Is Now Generally Available on the NetApp Instaclustr Platform ](https://instaclustr.husldigital.com/support/documentation/announcements/opensearch/opensearch-3-5-generally-available-netapp-instaclustr-platform/)
        - [ Observability Plugin Is Now Available for OpenSearch on the NetApp Instaclustr Managed Platform ](https://instaclustr.husldigital.com/support/documentation/announcements/opensearch/observability-plugin-available-for-opensearch-on-the-netapp-instaclustr-managed-platform/)
        - [ Announcing OpenSearch 2.18 on the Instaclustr Managed Platform ](https://instaclustr.husldigital.com/support/documentation/announcements/opensearch/announcing-opensearch-2-18-on-the-instaclustr-managed-platform/)
        - [ OpenSearch® Sink Connector for Apache Kafka® is now Available on the Instaclustr Managed Platform ](https://instaclustr.husldigital.com/support/documentation/announcements/opensearch/opensearch-sink-connector-for-apache-kafka-is-now-available-on-the-instaclustr-managed-platform/)
        - [ Past Announcements ](https://instaclustr.husldigital.com/support/documentation/announcements/opensearch/past-announcements/)
    - [ PostgreSQL ](#section-announcements-postgresql-2)
        - [ Past Announcements ](https://instaclustr.husldigital.com/support/documentation/announcements/postgresql-2/past-announcements/)
    - [ Release Log ](https://instaclustr.husldigital.com/support/documentation/announcements/release-log/)
    - [ Archive ](#section-announcements-archive)
        - [ Apache ZooKeeper ](#section-announcements-archive-apache-zookeeper)
            - [ Past Announcements ](https://instaclustr.husldigital.com/support/documentation/announcements/archive/apache-zookeeper/past-announcements-2/)
        - [ Redis ](#section-announcements-archive-redis)
            - [ Past Announcements ](https://instaclustr.husldigital.com/support/documentation/announcements/archive/redis/past-announcements/)
        - [ Valkey ](#section-announcements-archive-valkey)
            - [ Past Announcements ](https://instaclustr.husldigital.com/support/documentation/announcements/archive/valkey/past-announcements/)
- [ Getting Started+ ](#section-getting-started)
    - [ Signing Up ](https://instaclustr.husldigital.com/support/documentation/getting-started/signing-up/)
    - [ AWS Marketplace ](https://instaclustr.husldigital.com/support/documentation/getting-started/aws-marketplace/)
    - [ Azure Marketplace ](https://instaclustr.husldigital.com/support/documentation/getting-started/azure-marketplace/)
    - [ GCP Marketplace ](https://instaclustr.husldigital.com/support/documentation/getting-started/gcp-marketplace/)
    - [ Set Up BYOC - AWS ](https://instaclustr.husldigital.com/support/documentation/getting-started/set-up-byoc-aws/)
    - [ Setting Up a BYOC Provider Account Using Terraform ](https://instaclustr.husldigital.com/support/documentation/getting-started/setting-up-a-byoc-provider-account-using-terraform/)
- [ Instaclustr Account and User Management+ ](#section-instaclustr-account-and-user-management)
    - [ Updating User Details ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/updating-user-details/)
    - [ Migrating to Social SSO ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/migrating-to-social-sso/)
    - [ Change a User's Sign In Option ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/change-a-users-sign-in-option/)
    - [ User Security Settings ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/user-security-settings/)
    - [ Enable 2-Factor Authentication on Your User ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/enable-2-factor-authentication/)
    - [ Managing Account Details and Access ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/managing-account-details-and-access/)
    - [ Restructuring Accounts and Clusters via Instaclustr Organizations ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/restructuring-accounts-and-clusters-via-instaclustr-organizations/)
    - [ Types of Instaclustr Support Contacts ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/types-of-support-contact/)
    - [ Setting Account Preferences for Maintenance Event Notifications ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/setting-account-preferences-for-maintenance-event-notifications/)
    - [ Maintenance Event Webhook Notifications ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/maintenance-event-webhook-notifications/)
    - [ Account Security Options ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/account-security-options/)
    - [ Single Sign On (SSO) with SAML 2.0 Authentication ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/single-sign-on/)
    - [ Add New User to Your Account ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/add-new-user-account/)
    - [ User Roles ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/user-roles/)
    - [ Service Users ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/service-users/)
    - [ Organization Management ](#section-instaclustr-account-and-user-management-organization-management)
        - [ Create a New Organization ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/organization-management/create-a-new-organization/)
        - [ Migrate Clusters to another Account within an Organization ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/organization-management/migrate-clusters-to-another-account-within-an-organization/)
        - [ Enrol and Remove Accounts from an Organization ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/organization-management/enrol-and-remove-accounts-from-an-organization/)
        - [ Manage Organization Owners ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/organization-management/manage-organization-owners/)
        - [ Manage Organization Details ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/organization-management/manage-organization-details/)
        - [ Manage Billing Through the Organization ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/organization-management/manage-billing-through-the-organization/)
        - [ Manage Multiple Account SSO through the Organization ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/organization-management/manage-multiple-account-sso-through-the-organization/)
        - [ Organization Account Controls ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/organization-management/account-controls/)
        - [ Sharing BYOC Provider Accounts ](https://instaclustr.husldigital.com/support/documentation/instaclustr-account-and-user-management/organization-management/sharing-byoc-provider-accounts/)
- [ Console Features+ ](#section-console-features)
    - [ Using Service Control Policies with Instaclustr BYOC (previously RIYOA) ](https://instaclustr.husldigital.com/support/documentation/console-features/using-service-control-policies-with-instaclustr-byoc/)
    - [ The Monitoring Page ](https://instaclustr.husldigital.com/support/documentation/console-features/the-monitoring-page/)
    - [ Search in Instaclustr Console ](https://instaclustr.husldigital.com/support/documentation/console-features/search-clusters-and-accounts/)
    - [ API Keys ](https://instaclustr.husldigital.com/support/documentation/console-features/api-keys/)
    - [ Adding Tags to Clusters ](https://instaclustr.husldigital.com/support/documentation/console-features/adding-tags-to-clusters/)
    - [ Deleting a Cluster ](https://instaclustr.husldigital.com/support/documentation/console-features/deleting-a-cluster/)
    - [ Two-Factor Delete ](https://instaclustr.husldigital.com/support/documentation/console-features/two-factor-delete/)
    - [ Maintenance Scheduling Features ](#section-console-features-maintenance-scheduling-features)
        - [ Maintenance Events ](https://instaclustr.husldigital.com/support/documentation/console-features/maintenance-scheduling-features/maintenance-events/)
        - [ Exclusion Times ](https://instaclustr.husldigital.com/support/documentation/console-features/maintenance-scheduling-features/exclusion-times/)
    - [ Instaclustr Application Logs ](#section-console-features-application-logs)
        - [ Viewing Application Logs ](https://instaclustr.husldigital.com/support/documentation/console-features/application-logs/viewing-logs/)
        - [ Storing Application Logs in S3 ](https://instaclustr.husldigital.com/support/documentation/console-features/application-logs/storing-application-logs-in-s3/)
        - [ Sending Application Logs to Apache Kafka® ](https://instaclustr.husldigital.com/support/documentation/console-features/application-logs/sending-application-logs-to-apache-kafka/)
    - [ Management Units Usage ](https://instaclustr.husldigital.com/support/documentation/console-features/management-units-usage/)
- [ Useful Information+ ](#section-useful-information)
    - [ Maximizing Availability During Maintenance on the NetApp Instaclustr Platform ](https://instaclustr.husldigital.com/support/documentation/useful-information/maximizing-availability-during-maintenance-on-the-netapp-instaclustr-platform/)
    - [ Self-Service Tag Management ](https://instaclustr.husldigital.com/support/documentation/useful-information/self-service-tag-management/)
    - [ Single CA ](https://instaclustr.husldigital.com/support/documentation/useful-information/single-ca/)
    - [ Zero Inbound Access ](https://instaclustr.husldigital.com/support/documentation/useful-information/zero-inbound-access/)
    - [ Cluster DNS ](https://instaclustr.husldigital.com/support/documentation/useful-information/cluster-dns/)
    - [ Lifecycle Policy ](https://instaclustr.husldigital.com/support/documentation/useful-information/lifecycle-policy/)
    - [ Lifecycle Status of Application Versions ](https://instaclustr.husldigital.com/support/documentation/useful-information/lifecycle-status-of-application-versions/)
    - [ Private Link ](#section-useful-information-private-link)
        - [ Azure Private Link ](https://instaclustr.husldigital.com/support/documentation/useful-information/private-link/azure-private-link/)
        - [ GCP Private Service Connect ](https://instaclustr.husldigital.com/support/documentation/useful-information/private-link/gcp-private-service-connect/)
        - [ AWS PrivateLink ](https://instaclustr.husldigital.com/support/documentation/useful-information/private-link/aws-privatelink/)
    - [ Subject Alternative Names ](https://instaclustr.husldigital.com/support/documentation/useful-information/subject-alternative-names/)
    - [ PCI Compliance ](https://instaclustr.husldigital.com/support/documentation/useful-information/pci-compliance/)
    - [ Regions Not Included in the Cloud Provider Compliance Report ](https://instaclustr.husldigital.com/support/documentation/useful-information/regions-not-in-cloud-provider-compliance-report/)
    - [ Private Network Clusters ](https://instaclustr.husldigital.com/support/documentation/useful-information/private-network-clusters/)
    - [ Unsupported Firewall Rules ](https://instaclustr.husldigital.com/support/documentation/useful-information/unsupported-firewall-rules/)
    - [ What Are Virtual Racks? ](https://instaclustr.husldigital.com/support/documentation/useful-information/what-are-virtual-racks/)
    - [ AWS EBS Encryption and KMS Keys ](#section-useful-information-aws-ebs-encryption-and-kms-keys)
        - [ Creating an AWS Data Centre with EBS Encryption ](https://instaclustr.husldigital.com/support/documentation/useful-information/aws-ebs-encryption-and-kms-keys/creating-an-aws-data-centre-with-ebs-encryption/)
        - [ Adding a KMS Key for Use on the Instaclustr Platform using Run in Instaclustr’s Account (RIIA) Provisioning ](https://instaclustr.husldigital.com/support/documentation/useful-information/aws-ebs-encryption-and-kms-keys/adding-a-kms-key-riia/)
        - [ Adding a KMS Key for use on the Instaclustr Platform using AWS Bring Your Own Cloud (BYOC - previously RIYOA) Provisioning ](https://instaclustr.husldigital.com/support/documentation/useful-information/aws-ebs-encryption-and-kms-keys/adding-a-kms-key-byoc/)
    - [ Network Address Allocation ](https://instaclustr.husldigital.com/support/documentation/useful-information/network-address-allocation/)
    - [ SLA Tier ](https://instaclustr.husldigital.com/support/documentation/useful-information/sla-tier/)
    - [ The Provisioning Life Cycle ](https://instaclustr.husldigital.com/support/documentation/useful-information/provisioning-lifecycle/)
    - [ Bundled Use Only Cluster Deployments ](https://instaclustr.husldigital.com/support/documentation/useful-information/bundled-use-only-cluster-deployments/)
    - [ Understanding Encryption on your ANF Cluster ](https://instaclustr.husldigital.com/support/documentation/useful-information/understanding-encryption-on-your-anf-cluster/)
    - [ BYOC Template Technical Reference ](https://instaclustr.husldigital.com/support/documentation/useful-information/byoc-template-technical-reference/)
    - [ Instaclustr Open Source Project Status ](https://instaclustr.husldigital.com/support/documentation/useful-information/instaclustr-open-source-project-status/)
- [ Security+ ](#section-security)
    - [ NetApp Instaclustr Security Overview ](https://instaclustr.husldigital.com/support/documentation/security/instaclustr-security-overview/)
    - [ Infrastructure &amp; Network Security ](https://instaclustr.husldigital.com/support/documentation/security/infrastructure-network-security/)
    - [ Data Protection ](https://instaclustr.husldigital.com/support/documentation/security/data-protection/)
    - [ Application Security ](https://instaclustr.husldigital.com/support/documentation/security/application-security/)
    - [ Trust and Access ](https://instaclustr.husldigital.com/support/documentation/security/trust-and-access/)
    - [ Resilience ](https://instaclustr.husldigital.com/support/documentation/security/resilience/)
    - [ AI Cluster Health Security Overview ](https://instaclustr.husldigital.com/support/documentation/security/ai-cluster-health-security-overview/)
    - [ Security Advisories ](#section-security-security-advisories)
        - [ Instaclustr Platform ](#section-security-security-advisories-instaclustr-platform)
            - [ Security Advisory: Linux kernel vulnerabilities that allow a local user to gain root through page-cache changes ](https://instaclustr.husldigital.com/support/documentation/security/security-advisories/instaclustr-platform/security-advisory-linux-kernel-vulnerabilities-that-allow-a-local-user-to-gain-root-through-page-cache-changes/)
            - [ NetApp Instaclustr Security Advisory - CVE-2024-48990 ](https://instaclustr.husldigital.com/support/documentation/security/security-advisories/instaclustr-platform/netapp-instaclustr-security-advisory-cve-2024-48990/)
        - [ Apache Cassandra ](#section-security-security-advisories-apache-cassandra)
            - [ Security Advisory – Cassandra Lucene Index – CVE-2025-26511 ](https://instaclustr.husldigital.com/support/documentation/security/security-advisories/apache-cassandra/security-advisory-cassandra-lucene-index-cve-2025-26511/)
            - [ Security Advisory for Apache Cassandra Vulnerabilities - CVE-2025-23015, CVE-2025-24860, and CVE-2024-27137 ](https://instaclustr.husldigital.com/support/documentation/security/security-advisories/apache-cassandra/security-advisory-for-apache-cassandra-vulnerabilities-cve-2025-23015-cve-2025-24860-and-cve-2024-27137/)
        - [ Apache Kafka and Kafka Connect ](#section-security-security-advisories-apache-kafka-and-kafka-connect)
            - [ NetApp Instaclustr Security Advisory – Multiple Kafka CVEs (June 2025) ](https://instaclustr.husldigital.com/support/documentation/security/security-advisories/apache-kafka-and-kafka-connect/netapp-instaclustr-security-advisory-multiple-kafka-cves-june-2025/)
        - [ PostgreSQL ](#section-security-security-advisories-postgresql)
            - [ NetApp Instaclustr Security Advisory – Multiple PostgreSQL CVEs (September 2026) ](https://instaclustr.husldigital.com/support/documentation/security/security-advisories/postgresql/netapp-instaclustr-security-advisory-multiple-postgresql-cves-september-2026/)
            - [ Security Advisory for PostgreSQL Vulnerability CVE 2024-7348 ](https://instaclustr.husldigital.com/support/documentation/security/security-advisories/postgresql/security-advisory-for-postgresql-vulnerability-cve-2024-7348/)
- [ Apache Cassandra+ ](#section-cassandra)
    - [ Getting Started with Apache Cassandra ](#section-cassandra-getting-started-with-cassandra)
        - [ Creating an Apache Cassandra Cluster ](https://instaclustr.husldigital.com/support/documentation/cassandra/getting-started-with-cassandra/creating-a-cluster/)
        - [ Creating a PCI Compliant Cassandra Cluster ](https://instaclustr.husldigital.com/support/documentation/cassandra/getting-started-with-cassandra/documentation-cassandra-getting-started-with-cassandra-creating-a-pci-compliant-cluster/)
        - [ Creating an AWS PrivateLink enabled Apache Cassandra Cluster on the Instaclustr Platform ](https://instaclustr.husldigital.com/support/documentation/cassandra/getting-started-with-cassandra/creating-a-privatelink-cassandra-cluster/)
        - [ Creating an Apache Cassandra Cluster in a Custom VPC ](https://instaclustr.husldigital.com/support/documentation/cassandra/getting-started-with-cassandra/custom-vpc/)
    - [ Using Apache Cassandra ](#section-cassandra-using-cassandra)
        - [ Apache Cassandra Support Caveats ](https://instaclustr.husldigital.com/support/documentation/cassandra/using-cassandra/apache-cassandra-support-caveats/)
        - [ Changing the Apache Cassandra default user password ](https://instaclustr.husldigital.com/support/documentation/cassandra/using-cassandra/changing-the-cassandra-default-user-password/)
        - [ Connect to an Apache Cassandra Cluster ](https://instaclustr.husldigital.com/support/documentation/cassandra/using-cassandra/connect-to-a-cluster/)
        - [ Connect to Apache Cassandra with Cqlsh ](https://instaclustr.husldigital.com/support/documentation/cassandra/using-cassandra/connect-to-cassandra-with-cqlsh/)
        - [ Connect to Apache Cassandra with C# ](https://instaclustr.husldigital.com/support/documentation/cassandra/using-cassandra/connect-to-cassandra-with-c-sharp/)
        - [ Connect to Apache Cassandra with Golang ](https://instaclustr.husldigital.com/support/documentation/cassandra/using-cassandra/connect-to-cassandra-with-golang/)
        - [ Connect to Apache Cassandra with Node.js ](https://instaclustr.husldigital.com/support/documentation/cassandra/using-cassandra/connect-to-cassandra-with-node-js/)
        - [ Connect to an AWS PrivateLink enabled Apache Cassandra Cluster on the Instaclustr Platform ](https://instaclustr.husldigital.com/support/documentation/cassandra/using-cassandra/connect-to-an-aws-privatelink-enabled-apache-cassandra-cluster-on-the-instaclustr-platform/)
        - [ Avoiding range slice issues in Cassandra ](https://instaclustr.husldigital.com/support/documentation/cassandra/using-cassandra/avoiding-range-slice-issues-in-cassandra/)
        - [ Managing Tombstones in Apache Cassandra ](https://instaclustr.husldigital.com/support/documentation/cassandra/using-cassandra/managing-tombstones-in-cassandra/)
        - [ Use VPC Peering (AWS) to Connect to Apache Cassandra | Instaclustr ](https://instaclustr.husldigital.com/support/documentation/cassandra/using-cassandra/connect-to-cassandra-cluster-vpc-peering-aws/)
        - [ Use VPC Network Peering (GCP) to Connect to Apache Cassandra ](https://instaclustr.husldigital.com/support/documentation/cassandra/using-cassandra/use-vpc-network-peering-gcp-to-connect-to-cassandra/)
        - [ Use VNet Peering (Azure AZ) to Connect to Apache Cassandra ](https://instaclustr.husldigital.com/support/documentation/cassandra/using-cassandra/use-vnet-peering-azure-az-to-connect-to-apache-cassandra/)
        - [ Cluster data centre (CDC) &amp; private addressing (GCP) connection ](https://instaclustr.husldigital.com/support/documentation/cassandra/using-cassandra/connecting-to-a-cluster-data-center-cdc-with-private-addressing-gcp/)
        - [ Data Modelling Recommended Practices ](https://instaclustr.husldigital.com/support/documentation/cassandra/using-cassandra/data-modelling-recommended-practices/)
        - [ ic-tools for Apache Cassandra SSTables ](https://instaclustr.husldigital.com/support/documentation/cassandra/using-cassandra/ic-tools-for-cassandra-sstables/)
    - [ Apache Cassandra Cluster Operations ](#section-cassandra-cassandra-cluster-operations)
        - [ Expanding Your Cluster ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-cluster-operations/expanding-your-cluster/)
        - [ Setting Up a Multi-Datacentre Cluster with Instaclustr ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-cluster-operations/setting-up-a-multi-datacentre-cluster-with-instaclustr/)
        - [ Cluster Data Backups ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-cluster-operations/cluster-data-backups/)
        - [ Restoring a Cluster ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-cluster-operations/restoring-a-cluster/)
        - [ Apache Cassandra version upgrades ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-cluster-operations/cassandra-version-upgrades/)
        - [ In-place Data Centre Resizing ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-cluster-operations/in-place-data-centre-resizing/)
    - [ Apache Cassandra Monitoring Metrics Documentation ](#section-cassandra-cassandra-monitoring)
        - [ Monitoring API Metrics Troubleshooting ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/monitoring-api-metrics-troubleshooting/)
        - [ Accessing Monitoring Tools ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/accessing-monitoring-tools/)
        - [ Tombstones Per Read ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/tombstones-per-read/)
        - [ SSTables Per Read ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/sstables-per-read/)
        - [ Client Reads and Writes Latency ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/read-and-write-latency/)
        - [ Reads and Writes Per Second ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/reads-and-writes-per-second/)
        - [ Thread Pool Metrics ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/thread-pool-metrics/)
        - [ Pending Compactions ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/pending-compactions/)
        - [ Range Slice ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/range-slice/)
        - [ Synthetic Transactions ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/synthetic-transactions/)
        - [ OS Load - Apache Cassandra ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/os-load/)
        - [ Total Hint Metrics ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/total-hints/)
        - [ Partition Size ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/partition-size/)
        - [ Cluster Health Check ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/cluster-health-check/)
        - [ Request Latency ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/request-latency/)
        - [ Cassandra CPU Usage ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/cpu-usage/)
        - [ Disk Usage ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/disk-usage/)
        - [ Network ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/network/)
        - [ Additional CPU ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/additional-cpu/)
        - [ Memory ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/memory/)
        - [ Memory (Heap) ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/heap-memory/)
        - [ Memory (Off-Heap) ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/off-heap-memory/)
        - [ Client Connections ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/client-connections/)
        - [ Garbage Collection (ParNew) ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/garbage-collection-parnew/)
        - [ Active Schema Versions ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/active-schema-versions/)
        - [ CAS Reads and CAS Writes ](https://instaclustr.husldigital.com/support/documentation/cassandra/cassandra-monitoring/cas-read-and-cas-write/)
- [ Apache Cassandra Add-Ons+ ](#section-cassandra-add-ons)
    - [ Apache Spark Add-On for Apache Cassandra ](#section-cassandra-add-ons-apache-spark)
        - [ Getting Started with the Apache Spark Add-On for Apache Cassandra ](https://instaclustr.husldigital.com/support/documentation/cassandra-add-ons/apache-spark/getting-started-with-instaclustr-spark-cassandra/)
        - [ Getting started with Spark Jobserver and Instaclustr ](https://instaclustr.husldigital.com/support/documentation/cassandra-add-ons/apache-spark/getting-started-with-spark-jobserver-and-instaclustr/)
        - [ Connecting to Spark via JDBC/ODBC Thrift Server ](https://instaclustr.husldigital.com/support/documentation/cassandra-add-ons/apache-spark/connecting-spark-via-jdbc-odbc-thrift-server/)
        - [ Instaclustr Spark with SSL configured Apache Cassandra Cluster ](https://instaclustr.husldigital.com/support/documentation/cassandra-add-ons/apache-spark/instaclustr-spark-with-ssl-configured-cassandra-cluster/)
        - [ Apache Spark Streaming, Apache Kafka and Apache Cassandra Tutorial ](https://instaclustr.husldigital.com/support/documentation/cassandra-add-ons/apache-spark/spark-streaming-kafka-and-cassandra-tutorial/)
        - [ Spark MLlib Linear Regression Example ](https://instaclustr.husldigital.com/support/documentation/cassandra-add-ons/apache-spark/spark-mllib-linear-regression-example/)
        - [ Enable Logging for Completed Applications ](https://instaclustr.husldigital.com/support/documentation/cassandra-add-ons/apache-spark/enable-logging-completed-applications/)
        - [ Useful Apache Spark References ](https://instaclustr.husldigital.com/support/documentation/cassandra-add-ons/apache-spark/useful-apache-spark-references/)
    - [ Apache Lucene ](https://instaclustr.husldigital.com/support/documentation/cassandra-add-ons/lucene/)
    - [ Continuous Backup ](https://instaclustr.husldigital.com/support/documentation/cassandra-add-ons/continuous-backup/)
    - [ Private Network Cluster ](https://instaclustr.husldigital.com/support/documentation/cassandra-add-ons/private-network-cluster/)
    - [ Apache Cassandra PCI ](https://instaclustr.husldigital.com/support/documentation/cassandra-add-ons/pci/)
    - [ Creating a Cassandra Cluster with Debezium Connector ](https://instaclustr.husldigital.com/support/documentation/cassandra-add-ons/creating-a-cassandra-cluster-with-debezium-connector/)
- [ Apache Kafka+ ](#section-kafka)
    - [ Useful Concepts ](#section-kafka-useful-concepts)
        - [ Apache Kafka Client ⇄ Broker Encryption &amp; Mutual Authentication (mTLS) ](https://instaclustr.husldigital.com/support/documentation/kafka/useful-concepts/mtls/)
        - [ Apache Kafka Client Telemetry ](https://instaclustr.husldigital.com/support/documentation/kafka/useful-concepts/apache-kafka-client-telemetry/)
        - [ Apache Kafka KRaft ](https://instaclustr.husldigital.com/support/documentation/kafka/useful-concepts/apache-kafka-kraft-useful-information/)
        - [ Apache Kafka Tiered Storage ](https://instaclustr.husldigital.com/support/documentation/kafka/useful-concepts/kafka-tiered-storage/)
        - [ Partition Reassignment ](https://instaclustr.husldigital.com/support/documentation/kafka/useful-concepts/partition-reassignment/)
        - [ Zookeeper to KRaft Migration Process ](https://instaclustr.husldigital.com/support/documentation/kafka/useful-concepts/zookeeper-to-kraft-migration-process/)
    - [ Getting Started with Apache Kafka ](#section-kafka-getting-started-with-kafka)
        - [ Creating an Apache Kafka Cluster ](https://instaclustr.husldigital.com/support/documentation/kafka/getting-started-with-kafka/creating-a-kafka-cluster/)
        - [ Creating an Apache Kafka® Cluster With Client ⇄ Broker Encryption &amp; Mutual Authentication (mTLS) Enabled ](https://instaclustr.husldigital.com/support/documentation/kafka/getting-started-with-kafka/connecting-to-a-kafka-mtls-cluster/)
        - [ Creating a PCI Compliant Apache Kafka Cluster ](https://instaclustr.husldigital.com/support/documentation/kafka/getting-started-with-kafka/creating-a-pci-compliant-cluster/)
        - [ Creating a PrivateLink Apache Kafka Cluster ](https://instaclustr.husldigital.com/support/documentation/kafka/getting-started-with-kafka/creating-a-privatelink-kafka-cluster/)
        - [ Creating a Private Service Connect Apache Kafka Cluster ](https://instaclustr.husldigital.com/support/documentation/kafka/getting-started-with-kafka/creating-a-private-service-connect-apache-kafka-cluster/)
        - [ Creating an Apache Kafka Cluster in a Custom VPC ](https://instaclustr.husldigital.com/support/documentation/kafka/getting-started-with-kafka/custom-vpc/)
        - [ Creating an Apache Kafka cluster with dedicated KRaft Controller nodes ](https://instaclustr.husldigital.com/support/documentation/kafka/getting-started-with-kafka/creating-an-apache-kafka-cluster-with-dedicated-kraft-controller-nodes/)
        - [ Creating a Apache Kafka cluster with dedicated Zookeeper nodes ](https://instaclustr.husldigital.com/support/documentation/kafka/getting-started-with-kafka/creating-a-kafka-cluster-with-dedicated-zookeeper-nodes/)
    - [ Using Apache Kafka ](#section-kafka-using-kafka)
        - [ Configuring the Keystore to Use Client ⇄ Broker Encryption &amp; Mutual Authentication (mTLS) For Apache Kafka Client ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/configure-keystore-to-use-mtls-authentication-with-clients/)
        - [ Converting Keystore (JKS) to PEM file ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/converting-jks-to-pem-file/)
        - [ Managing Certificates on a Client ⇄ Broker Encryption &amp; Mutual Authentication (mTLS) Enabled Apache Kafka Cluster ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/managing-certificates-with-mtls/)
        - [ Using Apache Kafka Share Groups / Queues ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/using-apache-kafka-share-groups-queues/)
        - [ Using Kafka Client Telemetry ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/using-kafka-client-telemetry/)
        - [ Connect to an Apache Kafka Cluster ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/connect-to-a-kafka-cluster/)
        - [ Connect to a Private Service Connect Apache Kafka cluster ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/connecting-to-a-private-service-connect-apache-kafka-cluster/)
        - [ Connect to a PrivateLink Apache Kafka Cluster ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/connect-to-a-privatelink-kafka-cluster/)
        - [ Connect to a PrivateLink Apache Kafka cluster with AWS CloudFormation ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/connect-to-a-privatelink-kafka-cluster-with-aws-cloudformation/)
        - [ Managing Principal ARNs of an Apache Kafka Cluster with AWS PrivateLink ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/managing-principal-arns-of-a-privatelink-kafka-cluster/)
        - [ Use Apache Kafka with the Command Line ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/use-kafka-with-the-command-line/)
        - [ Use Apache Kafka with Java ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/use-kafka-with-java/)
        - [ Use Apache Kafka with Python ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/use-kafka-with-python/)
        - [ Use Apache Kafka with Ruby ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/use-kafka-with-ruby/)
        - [ Use Apache Kafka with C# ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/use-kafka-with-c-sharp/)
        - [ Working with Apache Kafka Streams API ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/working-with-kafka-streams-api/)
        - [ Connect to Apache Kafka and Kafka Connect Using VPC Peering (AWS) ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/connect-to-kafka-cluster-vpc-peering-aws/)
        - [ Using Certificates with Apache Kafka Clients ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/how-to-use-certificates-with-kafka-clients/)
        - [ Managing Apache Kafka Topics ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/topic-management/)
        - [ Managing Apache Kafka Users ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/kafka-user-management-2/)
        - [ Managing Apache Kafka ACLs ](https://instaclustr.husldigital.com/support/documentation/kafka/using-kafka/kafka-acl-management/)
    - [ Apache Kafka Cluster Operations ](#section-kafka-kafka-cluster-operations)
        - [ Scaling your cluster horizontally ](https://instaclustr.husldigital.com/support/documentation/kafka/kafka-cluster-operations/scaling-your-cluster-horizontally/)
        - [ Scaling your cluster vertically ](https://instaclustr.husldigital.com/support/documentation/kafka/kafka-cluster-operations/scaling-your-cluster-vertically/)
        - [ Setting up Mirror Maker ](https://instaclustr.husldigital.com/support/documentation/kafka/kafka-cluster-operations/setting-up-mirror-maker/)
        - [ Modifiable Broker Settings ](https://instaclustr.husldigital.com/support/documentation/kafka/kafka-cluster-operations/modifiable-broker-settings/)
        - [ Cluster Config Backup ](https://instaclustr.husldigital.com/support/documentation/kafka/kafka-cluster-operations/cluster-config-backup/)
    - [ Apache Kafka Monitoring Metrics Documentation ](#section-kafka-monitoring-information)
        - [ Accessing Monitoring Information ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/accessing-monitoring-information/)
        - [ Apache Kafka Schema Registry Metrics ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/kafka-schema-registry-metrics/)
        - [ Consumer Group Metrics ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/kafka-consumer-group/)
        - [ Consumer Group States ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/consumer-group-states/)
        - [ Broker Topic Metrics ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/broker-topic-metrics/)
        - [ Leader Election Rate and Time Ms ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/leader-election-rate-time-ms/)
        - [ Message Conversions ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/message-conversions/)
        - [ Network and Request Handler Capacity ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/network-and-request-handler-capacity/)
        - [ Fetcher Lag Metrics ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/fetcher-lag-metrics/)
        - [ Partition Metrics ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/partition-metrics/)
        - [ Fetcher Manager Metrics ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/fetcher-manager-metrics/)
        - [ Per-Topic Metrics ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/per-topic-metrics/)
        - [ Replicas ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/replicas/)
        - [ Request Metrics ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/request-metrics/)
        - [ Synthetic Transactions | Kafka Documentation ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/synthetic-transactions/)
        - [ Disk Usage | Kafka Documentation ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/disk-usage/)
        - [ Delayed Operations ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/delayed-operations/)
        - [ Garbage Collection ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/garbage-collection/)
        - [ Network | Apache Kafka Documentation ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/network/)
        - [ Memory | Kafka Documentation ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/memory/)
        - [ CPU Usage | Kafka Documentation ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/cpu-usage/)
        - [ Additional CPU - Kafka ](https://instaclustr.husldigital.com/support/documentation/kafka/monitoring-information/additional-cpu/)
- [ Apache Kafka Add-Ons+ ](#section-kafka-add-ons)
    - [ Apache Kafka REST Proxy ](https://instaclustr.husldigital.com/support/documentation/kafka-add-ons/kafka-rest-proxy/)
    - [ Using the Apache Kafka Schema Registry ](https://instaclustr.husldigital.com/support/documentation/kafka-add-ons/using-the-kafka-schema-registry/)
    - [ Enabling PCI ](https://instaclustr.husldigital.com/support/documentation/kafka-add-ons/pci/)
    - [ Using the Karapace Schema Registry ](https://instaclustr.husldigital.com/support/documentation/kafka-add-ons/using-the-karapace-schema-registry/)
    - [ Using the Karapace REST Proxy ](https://instaclustr.husldigital.com/support/documentation/kafka-add-ons/using-the-karapace-rest-proxy/)
    - [ Using Kafka Tiered Storage ](https://instaclustr.husldigital.com/support/documentation/kafka-add-ons/using-kafka-tiered-storage/)
- [ Apache Kafka Connect+ ](#section-kafka-connect)
    - [ Getting Started With Apache Kafka Connect ](#section-kafka-connect-getting-started-with-kafka-connect)
        - [ Creating an Apache Kafka Connect Cluster ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/getting-started-with-kafka-connect/creating-a-kafka-connect-cluster/)
        - [ Custom Kafka Connect Connectors ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/getting-started-with-kafka-connect/custom-kafka-connect-connectors/)
        - [ Use IAM roles and policies to provide the Kafka Connect cluster with access to AWS S3 bucket ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/getting-started-with-kafka-connect/use-iam-roles-and-policies-to-provide-the-kafka-connect-cluster-with-access-to-aws-s3-bucket/)
        - [ Using non-Instaclustr Kafka Clusters ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/getting-started-with-kafka-connect/using-non-instaclustr-kafka-clusters/)
    - [ Using Apache Kafka Connect ](#section-kafka-connect-using-kafka-connect)
        - [ Interacting with Apache Kafka Connect ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/using-kafka-connect/interacting-with-kafka-connect/)
        - [ Connect to Instaclustr Managed Clusters ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/using-kafka-connect/connect-kafka-connect-to-other-clusters/)
        - [ Updating custom connectors ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/using-kafka-connect/updating-custom-connectors/)
        - [ Starting a connector ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/using-kafka-connect/starting-a-connector/)
        - [ Troubleshooting your Kafka connectors ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/using-kafka-connect/troubleshooting-your-kafka-connectors/)
        - [ Tutorial: Using Kafka with Amazon S3 ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/using-kafka-connect/store-kafka-data-amazon-s3/)
        - [ Tutorial: Using Kafka with MQTT ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/using-kafka-connect/using-kafka-mqtt/)
    - [ Bundled Connectors ](#section-kafka-connect-bundled-kafka-connect-plugins)
        - [ Apache Cassandra Sink Connector ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/bundled-kafka-connect-plugins/cassandra-connector/)
        - [ AWS S3 Source and Sink Connector ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/bundled-kafka-connect-plugins/instaclustr-aws-s3-kafka-connect-plugins/)
        - [ ClickHouse Sink Connector ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/bundled-kafka-connect-plugins/clickhouse-kafka-connect-sink/)
        - [ Elasticsearch Sink Connector ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/bundled-kafka-connect-plugins/elasticsearch-connector/)
        - [ JDBC Source and Sink Connector ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/bundled-kafka-connect-plugins/jdbc-source-and-sink-connectors-for-apache-kafka/)
        - [ OpenSearch Sink Connector ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/bundled-kafka-connect-plugins/opensearch-sink-connector/)
        - [ SLA Sink Connector ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/bundled-kafka-connect-plugins/instaclustr-kafka-connect-sla-sink-plugin/)
    - [ Kafka Mirroring with Kafka Connect ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/kafka-mirroring-with-kafka-connect/)
    - [ Kafka Connect Monitoring Metrics Documentation ](#section-kafka-connect-monitoring-information)
        - [ Worker Metrics ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/monitoring-information/worker-metrics/)
        - [ Worker Rebalance Metrics ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/monitoring-information/worker-rebalance-metrics/)
        - [ Availability Metrics ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/monitoring-information/availability-metrics/)
        - [ Source Connector Metrics ](https://instaclustr.husldigital.com/support/documentation/kafka-connect/monitoring-information/source-connector-metrics/)
- [ OpenSearch+ ](#section-opensearch)
    - [ Getting started with OpenSearch ](#section-opensearch-getting-started-with-opensearch)
        - [ Creating a PCI Compliant OpenSearch Cluster ](https://instaclustr.husldigital.com/support/documentation/opensearch/getting-started-with-opensearch/creating-a-pci-compliant-opensearch-cluster/)
        - [ Creating an OpenSearch Cluster ](https://instaclustr.husldigital.com/support/documentation/opensearch/getting-started-with-opensearch/creating-an-opensearch-cluster/)
        - [ Creating an OpenSearch Cluster using Terraform ](https://instaclustr.husldigital.com/support/documentation/opensearch/getting-started-with-opensearch/creating-an-opensearch-cluster-using-terraform/)
        - [ Creating an OpenSearch Cluster with Cross-cluster Replication ](https://instaclustr.husldigital.com/support/documentation/opensearch/getting-started-with-opensearch/creating-an-opensearch-cluster-with-cross-cluster-replication/)
        - [ Creating an OpenSearch Cluster with Dedicated Cluster Manager ](https://instaclustr.husldigital.com/support/documentation/opensearch/getting-started-with-opensearch/creating-an-opensearch-cluster-with-dedicated-cluster-manager/)
        - [ Creating an OpenSearch Cluster with Dedicated Ingest Nodes ](https://instaclustr.husldigital.com/support/documentation/opensearch/getting-started-with-opensearch/creating-an-opensearch-cluster-with-dedicated-ingest-nodes/)
        - [ Creating an OpenSearch Cluster with OpenSearch Dashboards ](https://instaclustr.husldigital.com/support/documentation/opensearch/getting-started-with-opensearch/creating-an-opensearch-cluster-with-opensearch-dashboards/)
        - [ Creating a PrivateLink OpenSearch Cluster ](https://instaclustr.husldigital.com/support/documentation/opensearch/getting-started-with-opensearch/creating-a-privatelink-opensearch-cluster/)
    - [ Using OpenSearch ](#section-opensearch-using-opensearch)
        - [ Connect to an OpenSearch Cluster ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch/connect-to-an-opensearch-cluster/)
        - [ Security Access Control ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch/security-access-control/)
        - [ Connect to OpenSearch Using cURL ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch/connect-to-opensearch-using-curl/)
        - [ Connect to OpenSearch with Java ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch/connect-to-opensearch-with-java/)
        - [ Connect to OpenSearch with Python ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch/connect-to-opensearch-with-python/)
        - [ Connect to OpenSearch with C# ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch/connect-to-opensearch-with-c-sharp/)
        - [ Connect to a PrivateLink OpenSearch Cluster ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch/connect-to-a-privatelink-opensearch-cluster/)
        - [ Use VPC Peering (AWS) to Connect to OpenSearch ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch/use-vpc-peering-aws-to-connect-to-opensearch/)
        - [ Connect Logstash to OpenSearch ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch/connect-logstash-to-opensearch/)
        - [ How to perform a snapshot migration from Amazon OpenSearch Service ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch/aws-opensearch-service-snapshot-migration-guide/)
    - [ Using OpenSearch Dashboards ](#section-opensearch-using-opensearch-dashboards)
        - [ Configuring OpenSearch Dashboards ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch-dashboards/configuring-opensearch-dashboards/)
        - [ Connect to OpenSearch Dashboards ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch-dashboards/connect-to-opensearch-dashboards/)
        - [ Connect an OpenID Connect (OIDC) Provider - OpenSearch ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch-dashboards/connect-an-openid-connect-oidc-provider/)
    - [ Using OpenSearch Plugins ](#section-opensearch-using-opensearch-plugins)
        - [ List of Available OpenSearch Plugins ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch-plugins/list-of-available-opensearch-plugins/)
        - [ AI Search Plugin ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch-plugins/ai-search-plugin/)
        - [ k-NN Plugin ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch-plugins/knn-plugin/)
        - [ Alerting and Notifications Plugins ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch-plugins/alerting-and-notifications-plugins/)
        - [ Anomaly Detection Plugin ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch-plugins/anomaly-detection-plugin/)
        - [ Asynchronous Search Plugin ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch-plugins/asynchronous-search/)
        - [ SQL Plugin ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch-plugins/sql/)
        - [ Observability Plugin ](https://instaclustr.husldigital.com/support/documentation/opensearch/using-opensearch-plugins/observability-plugin/)
    - [ OpenSearch Cluster Operations ](#section-opensearch-opensearch-cluster-operations)
        - [ Expanding Your Cluster ](https://instaclustr.husldigital.com/support/documentation/opensearch/opensearch-cluster-operations/expanding-your-cluster/)
        - [ OpenSearch Cluster Indices Backup ](https://instaclustr.husldigital.com/support/documentation/opensearch/opensearch-cluster-operations/cluster-indices-backup/)
        - [ Cluster Indices Restore - OpenSearch ](https://instaclustr.husldigital.com/support/documentation/opensearch/opensearch-cluster-operations/cluster-indices-restore/)
        - [ In-place Resizing for OpenSearch ](https://instaclustr.husldigital.com/support/documentation/opensearch/opensearch-cluster-operations/in-place-resizing-for-opensearch/)
        - [ Managing Principal ARNs of a PrivateLink OpenSearch Cluster ](https://instaclustr.husldigital.com/support/documentation/opensearch/opensearch-cluster-operations/managing-principal-arns-of-a-privatelink-opensearch-cluster/)
    - [ OpenSearch Monitoring Metrics Documentation ](#section-opensearch-opensearch-monitoring-metrics-documentation)
        - [ Accessing OpenSearch Monitoring Tools ](https://instaclustr.husldigital.com/support/documentation/opensearch/opensearch-monitoring-metrics-documentation/accessing-opensearch-monitoring-tools/)
        - [ OpenSearch Document ](https://instaclustr.husldigital.com/support/documentation/opensearch/opensearch-monitoring-metrics-documentation/document/)
        - [ Index ](https://instaclustr.husldigital.com/support/documentation/opensearch/opensearch-monitoring-metrics-documentation/index/)
        - [ Query ](https://instaclustr.husldigital.com/support/documentation/opensearch/opensearch-monitoring-metrics-documentation/query/)
        - [ OpenSearch JVM ](https://instaclustr.husldigital.com/support/documentation/opensearch/opensearch-monitoring-metrics-documentation/jvm/)
        - [ Monitoring CPU Usage OpenSearch ](https://instaclustr.husldigital.com/support/documentation/opensearch/opensearch-monitoring-metrics-documentation/monitoring-cpu-usage/)
        - [ OS Load - OpenSearch ](https://instaclustr.husldigital.com/support/documentation/opensearch/opensearch-monitoring-metrics-documentation/os-load/)
        - [ OpenSearch Disk Usage ](https://instaclustr.husldigital.com/support/documentation/opensearch/opensearch-monitoring-metrics-documentation/opensearch-disk-usage/)
        - [ OpenSearch Network ](https://instaclustr.husldigital.com/support/documentation/opensearch/opensearch-monitoring-metrics-documentation/opensearch-network/)
        - [ OpenSearch Memory ](https://instaclustr.husldigital.com/support/documentation/opensearch/opensearch-monitoring-metrics-documentation/opensearch-memory/)
- [ OpenSearch Add-Ons+ ](#section-opensearch-add-ons)
    - [ OpenSearch Searchable Snapshots ](https://instaclustr.husldigital.com/support/documentation/opensearch-add-ons/opensearch-searchable-snapshots/)
    - [ OpenSearch Load Balancer ](https://instaclustr.husldigital.com/support/documentation/opensearch-add-ons/opensearch-load-balancer/)
- [ PostgreSQL+ ](#section-postgresql)
    - [ Getting Started with PostgreSQL ](#section-postgresql-getting-started-with-postgresql)
        - [ Creating a PostgreSQL Cluster ](https://instaclustr.husldigital.com/support/documentation/postgresql/getting-started-with-postgresql/getting-started-with-postgres-creating-a-postgres-cluster/)
        - [ Creating a PostgreSQL Cluster with AWS PrivateLink ](https://instaclustr.husldigital.com/support/documentation/postgresql/getting-started-with-postgresql/creating-a-postgresql-cluster-with-aws-privatelink/)
        - [ Creating a PostgreSQL Cluster with Azure Private Link ](https://instaclustr.husldigital.com/support/documentation/postgresql/getting-started-with-postgresql/creating-a-postgresql-cluster-with-azure-private-link/)
        - [ Creating a PostgreSQL Cluster in a Custom VPC/VNet ](https://instaclustr.husldigital.com/support/documentation/postgresql/getting-started-with-postgresql/creating-a-postgresql-cluster-in-a-custom-vpc-vnet/)
        - [ Creating a PostgreSQL Cluster with Azure NetApp Files ](https://instaclustr.husldigital.com/support/documentation/postgresql/getting-started-with-postgresql/creating-a-postgresql-cluster-with-azure-netapp-files/)
        - [ Creating a PostgreSQL Multi-Region Replication (MRR) Cluster with Instaclustr ](https://instaclustr.husldigital.com/support/documentation/postgresql/getting-started-with-postgresql/creating-a-postgresql-multi-region-replication-mrr-cluster-with-instaclustr/)
        - [ Creating a PCI Compliant PostgreSQL Cluster ](https://instaclustr.husldigital.com/support/documentation/postgresql/getting-started-with-postgresql/creating-a-pci-compliant-postgresql-cluster/)
    - [ Using PostgreSQL ](#section-postgresql-using-postgresql)
        - [ Available Extensions ](https://instaclustr.husldigital.com/support/documentation/postgresql/using-postgresql/available-extensions/)
        - [ Change PostgreSQL Default User Password ](https://instaclustr.husldigital.com/support/documentation/postgresql/using-postgresql/change-postgresql-default-user-password/)
        - [ Connect to a PostgreSQL Cluster ](https://instaclustr.husldigital.com/support/documentation/postgresql/using-postgresql/connect-to-a-postgresql-cluster/)
        - [ Connect to an AWS PrivateLink enabled PostgreSQL Cluster ](https://instaclustr.husldigital.com/support/documentation/postgresql/using-postgresql/connect-to-an-aws-privatelink-enabled-postgresql-cluster/)
        - [ Connect to an Azure Private Link enabled PostgreSQL Cluster ](https://instaclustr.husldigital.com/support/documentation/postgresql/using-postgresql/connect-to-an-azure-private-link-enabled-postgresql-cluster/)
        - [ Connect to PostgreSQL with C++ ](https://instaclustr.husldigital.com/support/documentation/postgresql/using-postgresql/connect-to-postgresql-with-c-plus-plus/)
        - [ Connect to PostgreSQL with Java ](https://instaclustr.husldigital.com/support/documentation/postgresql/using-postgresql/connect-to-postgresql-with-java/)
        - [ Connect to PostgreSQL with Python ](https://instaclustr.husldigital.com/support/documentation/postgresql/using-postgresql/connect-to-postgresql-with-python/)
        - [ Customer Administration Role ](https://instaclustr.husldigital.com/support/documentation/postgresql/using-postgresql/customer-administration-role/)
        - [ Enable or disable a PostgreSQL extension ](https://instaclustr.husldigital.com/support/documentation/postgresql/using-postgresql/enable-or-disable-a-postgresql-extension/)
        - [ Extensions that require additional Instantiation steps ](https://instaclustr.husldigital.com/support/documentation/postgresql/using-postgresql/extensions-that-require-additional-instantiation-steps/)
        - [ How Clients Connect to a PostgreSQL Cluster Using Azure Private Link connection ](https://instaclustr.husldigital.com/support/documentation/postgresql/using-postgresql/how-clients-connect-to-a-postgresql-cluster-using-azure-private-link-connection/)
        - [ Managing Principal ARNs of a PostgreSQL Cluster with AWS PrivateLink ](https://instaclustr.husldigital.com/support/documentation/postgresql/using-postgresql/managing-principal-arns-of-a-postgresql-cluster-with-aws-privatelink/)
    - [ PostgreSQL Cluster Operations ](#section-postgresql-postgresql-cluster-operations)
        - [ Backup ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-cluster-operations/backup/)
        - [ Restore ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-cluster-operations/restore/)
        - [ Reloading a Node ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-cluster-operations/reloading-a-node/)
        - [ Modifying Configuration ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-cluster-operations/modifying-configuration/)
        - [ Replication and High Availability ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-cluster-operations/replication-and-high-availability/)
        - [ In-place Resizing for PostgreSQL ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-cluster-operations/in-place-resizing-for-postgresql/)
        - [ Azure NetApp Files Fast Forking ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-cluster-operations/azure-netapp-files-fast-forking/)
    - [ PostgreSQL Monitoring Documentation ](#section-postgresql-postgresql-monitoring-documentation)
        - [ Miscellaneous Metrics ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-monitoring-documentation/misc-metrics/)
        - [ Transaction Metrics ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-monitoring-documentation/transaction-metrics/)
        - [ Replication and Replication Slot Metrics ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-monitoring-documentation/replication-and-replication-slot-metrics/)
        - [ Table Metrics ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-monitoring-documentation/table-metrics/)
        - [ Database Metrics ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-monitoring-documentation/database-metrics/)
        - [ Synthetic Transaction Metrics ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-monitoring-documentation/synthetic-transactions/)
        - [ CPU Metrics ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-monitoring-documentation/cpu-metrics/)
        - [ CPU Detailed Metrics ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-monitoring-documentation/cpu-detailed-metrics/)
        - [ Disk Metrics ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-monitoring-documentation/disk-metrics/)
        - [ Memory Metrics ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-monitoring-documentation/memory-metrics/)
        - [ Network Metrics ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-monitoring-documentation/network-metrics/)
    - [ Cluster Creation Options ](#section-postgresql-options)
        - [ Replication Mode ](https://instaclustr.husldigital.com/support/documentation/postgresql/options/replication-mode/)
        - [ Synchronous Mode Strict ](https://instaclustr.husldigital.com/support/documentation/postgresql/options/synchronous-mode-strict/)
    - [ PostgreSQL with AWS FSx for NetApp ONTAP ](#section-postgresql-postgresql-with-aws-fsx-for-netapp-ontap)
        - [ Creating a PostgreSQL Cluster with AWS FSx for NetApp ONTAP ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-with-aws-fsx-for-netapp-ontap/creating-a-postgresql-cluster-with-aws-fsx-for-netapp-ontap/)
        - [ AWS FSx for NetApp ONTAP Snapshotting ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-with-aws-fsx-for-netapp-ontap/aws-fsx-for-netapp-ontap-snapshotting/)
        - [ AWS FSx for NetApp ONTAP Fast Forking ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-with-aws-fsx-for-netapp-ontap/aws-fsx-for-netapp-ontap-fast-forking/)
        - [ Creating a PostgreSQL Cluster in the Same VPC as an Existing FSx for NetApp ONTAP ](https://instaclustr.husldigital.com/support/documentation/postgresql/postgresql-with-aws-fsx-for-netapp-ontap/creating-a-postgresql-cluster-in-the-same-vpc-as-an-existing-fsx-for-netapp-ontap/)
- [ PostgreSQL Add-Ons+ ](#section-postgresql-add-ons)
    - [ Getting Started with PgBouncer ](https://instaclustr.husldigital.com/support/documentation/postgresql-add-ons/getting-started-with-pgbouncer/)
    - [ Using AWS Load Balancer ](https://instaclustr.husldigital.com/support/documentation/postgresql-add-ons/using-aws-load-balancer/)
    - [ Using PgBouncer ](https://instaclustr.husldigital.com/support/documentation/postgresql-add-ons/using-pgbouncer/)
    - [ PgBouncer Monitoring Metrics ](https://instaclustr.husldigital.com/support/documentation/postgresql-add-ons/pgbouncer-monitoring-metrics/)
- [ Cadence+ ](#section-cadence)
    - [ Getting Started with Cadence ](#section-cadence-getting-started-with-cadence)
        - [ Creating a Cadence Cluster ](https://instaclustr.husldigital.com/support/documentation/cadence/getting-started-with-cadence/creating-a-cadence-cluster/)
        - [ Creating an Advanced Visibility Cadence Cluster ](https://instaclustr.husldigital.com/support/documentation/cadence/getting-started-with-cadence/creating-an-advanced-visibility-cadence-cluster/)
        - [ Load Balancer Support ](https://instaclustr.husldigital.com/support/documentation/cadence/getting-started-with-cadence/load-balancer-support/)
        - [ Create a Multi-Region Cadence Cluster ](https://instaclustr.husldigital.com/support/documentation/cadence/getting-started-with-cadence/create-a-multi-region-cadence-cluster/)
        - [ Creating a PCI Compliant Cadence Cluster ](https://instaclustr.husldigital.com/support/documentation/cadence/getting-started-with-cadence/creating-a-pci-compliant-cadence-cluster/)
        - [ Configuring the Cadence VPC ](https://instaclustr.husldigital.com/support/documentation/cadence/getting-started-with-cadence/configuring-the-cadence-vpc/)
        - [ Cadence Advanced Visibility ](https://instaclustr.husldigital.com/support/documentation/cadence/getting-started-with-cadence/cadence-advanced-visibility/)
        - [ Configuring your Cluster to Use Cadence Archival ](https://instaclustr.husldigital.com/support/documentation/cadence/getting-started-with-cadence/configuring-your-cluster-to-use-cadence-archival/)
        - [ Cadence HTTP API ](https://instaclustr.husldigital.com/support/documentation/cadence/getting-started-with-cadence/cadence-http-api/)
        - [ Creating a Cadence Cluster with HTTP API ](https://instaclustr.husldigital.com/support/documentation/cadence/getting-started-with-cadence/creating-a-cadence-cluster-with-http-api/)
        - [ Creating a PrivateLink Cadence Cluster ](https://instaclustr.husldigital.com/support/documentation/cadence/getting-started-with-cadence/creating-a-privatelink-cadence-cluster/)
    - [ Using Cadence ](#section-cadence-using-cadence)
        - [ Securing Cadence Web Using NGINX ](https://instaclustr.husldigital.com/support/documentation/cadence/using-cadence/securing-cadence-web-using-nginx/)
        - [ Connect to a PrivateLink Cadence Cluster ](https://instaclustr.husldigital.com/support/documentation/cadence/using-cadence/connect-to-a-privatelink-cadence-cluster/)
        - [ Managing Principal ARNs of a PrivateLink Cadence Cluster ](https://instaclustr.husldigital.com/support/documentation/cadence/using-cadence/managing-principal-arns-of-a-privatelink-cadence-cluster/)
    - [ Cadence Cluster Operations ](#section-cadence-cadence-cluster-operations)
        - [ In-place Scaling for Cadence ](https://instaclustr.husldigital.com/support/documentation/cadence/cadence-cluster-operations/cadence-scaling/)
    - [ Cadence Monitoring Metrics Documentation ](#section-cadence-monitoring-information)
        - [ Accessing Monitoring Information ](https://instaclustr.husldigital.com/support/documentation/cadence/monitoring-information/accessing-monitoring-information/)
        - [ Cadence Node CPU Usage ](https://instaclustr.husldigital.com/support/documentation/cadence/monitoring-information/node-cpu-usage/)
        - [ Node Disk Usage ](https://instaclustr.husldigital.com/support/documentation/cadence/monitoring-information/node-disk-usage/)
        - [ Node Memory Usage ](https://instaclustr.husldigital.com/support/documentation/cadence/monitoring-information/node-memory/)
        - [ Node Network Usage ](https://instaclustr.husldigital.com/support/documentation/cadence/monitoring-information/node-network-usage/)
        - [ Cadence Synthetic Workflows ](https://instaclustr.husldigital.com/support/documentation/cadence/monitoring-information/cadence-synthetic-workflows/)
        - [ Cadence Global Metrics ](https://instaclustr.husldigital.com/support/documentation/cadence/monitoring-information/cadence-frontend-metrics/)
        - [ Cadence Persistence Metrics ](https://instaclustr.husldigital.com/support/documentation/cadence/monitoring-information/cadence-persistence-metrics/)
        - [ Cadence General Metrics ](https://instaclustr.husldigital.com/support/documentation/cadence/monitoring-information/cadence-metrics/)
        - [ Cadence Matching Metrics ](https://instaclustr.husldigital.com/support/documentation/cadence/monitoring-information/cadence-matching-metrics/)
        - [ Cadence History Metrics ](https://instaclustr.husldigital.com/support/documentation/cadence/monitoring-information/cadence-history-metrics-2/)
        - [ Cadence Workflow (tag-level) Metrics ](https://instaclustr.husldigital.com/support/documentation/cadence/monitoring-information/cadence-workflow-tag-level-metrics/)
        - [ Multi-Region Cadence Replication Metrics ](https://instaclustr.husldigital.com/support/documentation/cadence/monitoring-information/multi-region-cadence-replication-metrics/)
- [ ClickHouse+ ](#section-clickhouse)
    - [ Getting Started with ClickHouse ](#section-clickhouse-getting-started-with-clickhouse)
        - [ Creating a ClickHouse Cluster ](https://instaclustr.husldigital.com/support/documentation/clickhouse/getting-started-with-clickhouse/creating-a-clickhouse-cluster/)
        - [ Creating a ClickHouse Cluster in the Same VPC as an Existing FSx ONTAP ](https://instaclustr.husldigital.com/support/documentation/clickhouse/getting-started-with-clickhouse/creating-a-clickhouse-cluster-in-the-same-vpc-as-an-existing-fsx-ontap/)
        - [ Configure a ClickHouse Cluster for Tiered Storage ](https://instaclustr.husldigital.com/support/documentation/clickhouse/getting-started-with-clickhouse/configure-a-clickhouse-cluster-for-tiered-storage/)
        - [ Creating an AWS PrivateLink ClickHouse Cluster ](https://instaclustr.husldigital.com/support/documentation/clickhouse/getting-started-with-clickhouse/creating-an-aws-privatelink-clickhouse-cluster/)
    - [ Using a ClickHouse Cluster ](#section-clickhouse-using-a-clickhouse-cluster)
        - [ ClickHouse Cluster Macros ](https://instaclustr.husldigital.com/support/documentation/clickhouse/using-a-clickhouse-cluster/documentation-clickhouse-using-a-clickhouse-cluster-clickhouse-cluster-macros/)
        - [ Cluster Managing Principal ARNs of a PrivateLink ClickHouse Cluster ](https://instaclustr.husldigital.com/support/documentation/clickhouse/using-a-clickhouse-cluster/cluster-managing-principal-arns-of-a-privatelink-clickhouse-cluster/)
        - [ Connecting to a ClickHouse Cluster ](https://instaclustr.husldigital.com/support/documentation/clickhouse/using-a-clickhouse-cluster/connecting-to-a-clickhouse-cluster/)
        - [ Connecting to an AWS PrivateLink ClickHouse Cluster ](https://instaclustr.husldigital.com/support/documentation/clickhouse/using-a-clickhouse-cluster/connecting-to-an-aws-privatelink-clickhouse-cluster/)
        - [ Use VPC Peering (AWS) to Connect to NetApp Instaclustr-Managed ClickHouse ](https://instaclustr.husldigital.com/support/documentation/clickhouse/using-a-clickhouse-cluster/use-aws-vpc-peering-to-connect-to-clickhouse/)
        - [ Connecting to ClickHouse with ClickHouse Client ](https://instaclustr.husldigital.com/support/documentation/clickhouse/using-a-clickhouse-cluster/connecting-to-clickhouse-with-clickhouse-client/)
        - [ Connecting to ClickHouse with Java ](https://instaclustr.husldigital.com/support/documentation/clickhouse/using-a-clickhouse-cluster/connecting-to-clickhouse-with-java/)
        - [ Connecting to ClickHouse with Go ](https://instaclustr.husldigital.com/support/documentation/clickhouse/using-a-clickhouse-cluster/connecting-to-clickhouse-with-go/)
        - [ Connecting to ClickHouse with Python ](https://instaclustr.husldigital.com/support/documentation/clickhouse/using-a-clickhouse-cluster/connecting-to-clickhouse-with-python/)
        - [ Connecting to ClickHouse from Apache Superset™ ](https://instaclustr.husldigital.com/support/documentation/clickhouse/using-a-clickhouse-cluster/connecting-to-clickhouse-from-apache-superset/)
        - [ ClickHouse Cluster Backup and Restore ](https://instaclustr.husldigital.com/support/documentation/clickhouse/using-a-clickhouse-cluster/clickhouse-cluster-backup-and-restore/)
        - [ ClickHouse Cluster Resizing ](https://instaclustr.husldigital.com/support/documentation/clickhouse/using-a-clickhouse-cluster/documentation-clickhouse-using-a-clickhouse-cluster-scaling-a-clickhouse-cluster/)
        - [ Configuring ClickHouse Parameters ](https://instaclustr.husldigital.com/support/documentation/clickhouse/using-a-clickhouse-cluster/configuration/)
    - [ ClickHouse Integrations ](#section-clickhouse-integrations)
        - [ AWS S3 Region Integration ](https://instaclustr.husldigital.com/support/documentation/clickhouse/integrations/aws-s3-integration/)
        - [ AWS Private S3 Bucket Integration ](https://instaclustr.husldigital.com/support/documentation/clickhouse/integrations/private-s3/)
        - [ AWS FSx for NetApp ONTAP Integration ](#section-clickhouse-integrations-s3-fsx-for-ontap)
            - [ AWS FSx for NetApp ONTAP Integration: Instaclustr-Managed FSx ](https://instaclustr.husldigital.com/support/documentation/clickhouse/integrations/s3-fsx-for-ontap/instaclustr-managed-fsx/)
            - [ AWS FSx for NetApp ONTAP Integration: Self-Managed FSx ](https://instaclustr.husldigital.com/support/documentation/clickhouse/integrations/s3-fsx-for-ontap/self-managed-fsx/)
        - [ Domain Integration ](https://instaclustr.husldigital.com/support/documentation/clickhouse/integrations/domain-integration/)
        - [ Kafka Integration ](https://instaclustr.husldigital.com/support/documentation/clickhouse/integrations/kafka/)
        - [ Open Table Format Integration ](https://instaclustr.husldigital.com/support/documentation/clickhouse/integrations/open-table-format/)
    - [ Useful Concepts ](#section-clickhouse-useful-concepts)
        - [ Dedicated ClickHouse Keeper for ClickHouse Clusters ](https://instaclustr.husldigital.com/support/documentation/clickhouse/useful-concepts/dedicated-clickhouse-keeper/)
        - [ Load Balancer for ClickHouse Clusters ](https://instaclustr.husldigital.com/support/documentation/clickhouse/useful-concepts/clickhouse-load-balancer/)
        - [ Tiered Storage for ClickHouse Clusters ](https://instaclustr.husldigital.com/support/documentation/clickhouse/useful-concepts/creating-a-clickhouse-cluster-with-tiered-storage/)
    - [ Visualising ClickHouse Data ](#section-clickhouse-visualising-clickhouse-data)
        - [ Connecting to ClickHouse from Grafana ](https://instaclustr.husldigital.com/support/documentation/clickhouse/visualising-clickhouse-data/connecting-to-clickhouse-from-grafana/)
    - [ ClickHouse Monitoring Metrics Documentation ](#section-clickhouse-monitoring-information)
        - [ Accessing Monitoring Information ](https://instaclustr.husldigital.com/support/documentation/clickhouse/monitoring-information/accessing-monitoring-information/)
        - [ CPU Usage ](https://instaclustr.husldigital.com/support/documentation/clickhouse/monitoring-information/cpu-usage/)
        - [ Disk Usage ](https://instaclustr.husldigital.com/support/documentation/clickhouse/monitoring-information/disk-usage/)
        - [ Memory Usage ](https://instaclustr.husldigital.com/support/documentation/clickhouse/monitoring-information/memory-usage/)
        - [ Network Usage ](https://instaclustr.husldigital.com/support/documentation/clickhouse/monitoring-information/network-usage/)
        - [ Availability Metrics ](https://instaclustr.husldigital.com/support/documentation/clickhouse/monitoring-information/availability-metrics/)
        - [ Active Queries ](https://instaclustr.husldigital.com/support/documentation/clickhouse/monitoring-information/active-queries/)
        - [ Internal Replication Tasks ](https://instaclustr.husldigital.com/support/documentation/clickhouse/monitoring-information/internal-replication-tasks/)
        - [ Read and Write ](https://instaclustr.husldigital.com/support/documentation/clickhouse/monitoring-information/read-and-write/)
        - [ Mark Cache ](https://instaclustr.husldigital.com/support/documentation/clickhouse/monitoring-information/mark-cache/)
        - [ Query Cache ](https://instaclustr.husldigital.com/support/documentation/clickhouse/monitoring-information/query-cache/)
        - [ Uncompressed Cache ](https://instaclustr.husldigital.com/support/documentation/clickhouse/monitoring-information/uncompressed-cache/)
        - [ Remote Storage ](https://instaclustr.husldigital.com/support/documentation/clickhouse/monitoring-information/remote-storage/)
- [ MCP Gateway+ ](#section-mcp-gateway)
    - [ Getting Started with MCP Gateway ](#section-mcp-gateway-getting-started-with-mcp-gateway)
        - [ Creating an MCP Gateway Cluster ](https://instaclustr.husldigital.com/support/documentation/mcp-gateway/getting-started-with-mcp-gateway/creating-an-mcp-gateway-cluster/)
    - [ Using MCP Gateway ](#section-mcp-gateway-using-mcp-gateway)
        - [ MCP Gateway Concepts ](https://instaclustr.husldigital.com/support/documentation/mcp-gateway/using-mcp-gateway/mcp-gateway-concepts/)
        - [ Configure MCP Virtual Server ](https://instaclustr.husldigital.com/support/documentation/mcp-gateway/using-mcp-gateway/configure-mcp-virtual-server/)
        - [ Connecting to an MCP Gateway Virtual Server ](https://instaclustr.husldigital.com/support/documentation/mcp-gateway/using-mcp-gateway/connecting-to-an-mcp-gateway-virtual-server/)
        - [ Configure Cassandra MCP Backend and Tools ](https://instaclustr.husldigital.com/support/documentation/mcp-gateway/using-mcp-gateway/configure-cassandra-mcp-backend-and-tools/)
        - [ Configure Kafka MCP Backend and Tools ](https://instaclustr.husldigital.com/support/documentation/mcp-gateway/using-mcp-gateway/configure-kafka-mcp-backend-and-tools/)
        - [ Configure OpenSearch MCP Backend and Tools ](https://instaclustr.husldigital.com/support/documentation/mcp-gateway/using-mcp-gateway/configure-opensearch-mcp-backend-and-tools-duplicate/)
        - [ Configure HTTP Server MCP Backend and Tools ](https://instaclustr.husldigital.com/support/documentation/mcp-gateway/using-mcp-gateway/configure-http-server-mcp-backend-and-tools/)
        - [ Configure Instaclustr API Server MCP Backend and Tools ](https://instaclustr.husldigital.com/support/documentation/mcp-gateway/using-mcp-gateway/configure-instaclustr-api-server-mcp-backend-and-tools/)
        - [ Configure MCP Tool Access ](https://instaclustr.husldigital.com/support/documentation/mcp-gateway/using-mcp-gateway/configure-mcp-tool-access/)
    - [ MCP Gateway Cluster Operations ](#section-mcp-gateway-mcp-gateway-cluster-operations)
        - [ Scale Your Cluster ](https://instaclustr.husldigital.com/support/documentation/mcp-gateway/mcp-gateway-cluster-operations/expanding-your-cluster/)
        - [ Backup and Restore Your Cluster ](https://instaclustr.husldigital.com/support/documentation/mcp-gateway/mcp-gateway-cluster-operations/backup-and-restore-your-mcp-gateway-cluster/)
    - [ Identity Provider example configurations ](#section-mcp-gateway-mcp-gateway-identity-providers)
        - [ Auth0 example configuration ](https://instaclustr.husldigital.com/support/documentation/mcp-gateway/mcp-gateway-identity-providers/mcp-gateway-auth0-example-configuration/)
        - [ Okta example configuration ](https://instaclustr.husldigital.com/support/documentation/mcp-gateway/mcp-gateway-identity-providers/mcp-gateway-okta-example-configuration/)
        - [ Entra ID example configuration ](https://instaclustr.husldigital.com/support/documentation/mcp-gateway/mcp-gateway-identity-providers/entra-id-example-configuration/)
        - [ Keycloak example configuration ](https://instaclustr.husldigital.com/support/documentation/mcp-gateway/mcp-gateway-identity-providers/mcp-gateway-keycloak-example-configuration/)
- [ MCP Gateway Add-Ons+ ](#section-mcp-gateway-add-ons)
    - [ MCP Gateway Load Balancer ](https://instaclustr.husldigital.com/support/documentation/mcp-gateway-add-ons/mcp-gateway-load-balancer/)
 
  

 ###### [API &amp; Integrations](https://instaclustr.husldigital.com/support/api-integrations/)

###### [API &amp; Integrations](https://instaclustr.husldigital.com/support/api-integrations/)

- [ API Reference+ ](#section-api-reference)
    - [ Cluster Management API ](https://instaclustr.husldigital.com/support/api-integrations/api-reference/cluster-management-api/)
    - [ Monitoring API ](https://instaclustr.husldigital.com/support/api-integrations/api-reference/monitoring-api/)
    - [ Rate Limits ](#section-api-reference-rate-limits)
        - [ Instaclustr API Rate Limits ](https://instaclustr.husldigital.com/support/api-integrations/api-reference/rate-limits/instaclustr-api-rate-limits/)
    - [ Set Up a BYOC Provider Account Using the API ](https://instaclustr.husldigital.com/support/api-integrations/api-reference/set-up-a-byoc-provider-account-using-the-api/)
- [ Integrations+ ](#section-integrations)
    - [ Instaclustr Monitoring with Prometheus ](https://instaclustr.husldigital.com/support/api-integrations/integrations/instaclustr-monitoring-with-prometheus/)
    - [ Terraform Code Generation ](https://instaclustr.husldigital.com/support/api-integrations/integrations/terraform-code-generation/)
    - [ Using the Instaclustr Monitoring API with Datadog ](https://instaclustr.husldigital.com/support/api-integrations/integrations/using-the-instaclustr-monitoring-api-with-datadog/)
    - [ Using the Instaclustr Terraform Provider v2 ](https://instaclustr.husldigital.com/support/api-integrations/integrations/using-the-instaclustr-terraform-provider/)
    - [ Using Instaclustr with Kong ](https://instaclustr.husldigital.com/support/api-integrations/integrations/using-instaclustr-with-kong/)
    - [ Sending Instaclustr Metrics to New Relic via Prometheus ](https://instaclustr.husldigital.com/support/api-integrations/integrations/sending-instaclustr-metrics-to-new-relic-via-prometheus/)
    - [ Using Instaclustr from Heroku ](https://instaclustr.husldigital.com/support/api-integrations/integrations/using-instaclustr-from-heroku/)
 
  

 

Back to full documentation



 

 

 

 

 

Using the Karapace REST Proxy
=============================

The Karapace Rest Proxy is an add-on which can be enabled when creating an Instaclustr Managed Apache Kafka cluster. Note that enabling any Enterprise Add-On or Enterprise Feature adds 20% to standard costs. If you would like to add the Karapace Rest Proxy to an existing cluster, please contact support.

The Karapace Rest Proxy enables you to integrate an [**Instaclustr Managed Kafka**](https://instaclustr.husldigital.com/platform/managed-apache-kafka/) cluster with any system that can communicate with a simple HTTPS RESTful API.

To create a new Kafka cluster with the Karapace REST Proxy add-on, make sure to enable Karapace REST Proxy under the *Enterprise Add-Ons* subsection on the Kafka setup page. Please note that the Karapace add-ons on the console show up with the following naming:

- Karapace Schema Registry is displayed simply as *Schema Registry, and*
- Karapace REST Proxy is displayed as *REST Proxy*.

![](https://instaclustr.husldigital.com/wp-content/uploads/Screenshot-2024-07-03-at-3.00.55%E2%80%AFPM-300x261.png)

**Note: Karapace REST Proxy and Karapace Schema Registry cannot be used together with either Kafka Schema Registry (Old) or Kafka REST Proxy (Old). This is enforced through the console as well our API, and Terraform Provider. For example, on the console, enabling Karapace causes Kafka Schema Registry (Old) as well as Kafka REST Proxy (Old) to be disabled, and vice-versa. If you would like to use schema registry, you do have the option of doing so by enabling Schema Registry add-on.**

Instaclustr offers a fixed number of 3 Karapace Rest Proxy nodes when creating a Kafka cluster by selecting Karapace Rest Proxy, and this number remains the same regardless of the size of the Kafka cluster.

You can also create a local Karapace Schema Registry on the cluster and choose to integrate the Karapace REST Proxy with the local one. The checkbox will be visible when both the Karapace Schema Registry and Karapace REST Proxy are selected.

![](https://instaclustr.husldigital.com/wp-content/uploads/Screenshot-2024-07-03-at-3.01.23%E2%80%AFPM-300x271.png)

Configuring the Karapace Rest Proxy
-----------------------------------

To start using the Karapace Rest Proxy, you must first open the firewall to your client application IP address. Once your cluster is up and running, go to *Firewall Rules* and add your IP address to the *KARAPACE REST PROXY ALLOWED ADDRESSES*.

[![](https://instaclustr.husldigital.com/wp-content/uploads/2022/07/Screen-Shot-2022-07-21-at-3.08.43-pm-2048x1093.png)](https://instaclustr.husldigital.com/wp-content/uploads/2022/07/Screen-Shot-2022-07-21-at-3.08.43-pm.png)

Connecting to the Karapace Rest Proxy
-------------------------------------

The Karapace Rest Proxy is hosted in our Instaclustr hosted zone, cnodes.io. You can access the Karapace Rest Proxy by using the subdomain we have created.

Connection information can be retrieved on the *Connection Info* page for the cluster running the Karapace REST Proxy. This page also includes the username and automatically generated password, plus code samples for testing connectivity to your Karapace REST Proxy servers.

[![](https://instaclustr.husldigital.com/wp-content/uploads/2022/07/Screen-Shot-2022-07-21-at-3.16.15-pm-2048x1260.png)](https://instaclustr.husldigital.com/wp-content/uploads/2022/07/Screen-Shot-2022-07-21-at-3.16.15-pm.png)

Karapace Rest Proxy access
--------------------------

Up until the introduction of ic\_addon\_rest\_proxy Kafka user, we did not offer the ability to restrict access via ACLs for Karapace Rest Proxy clients. For clusters provisioned prior to this user being available, the Karapace Rest Proxy service connects to your Apache Kafka cluster and has access to all topics stored in the cluster.

After the introduction of the ic\_addon\_rest\_proxy Kafka user, only Kafka clusters that provision or enable Karapace Rest Proxy starting that point onwards will have this user present in Kafka. Clusters that upgrade the bundle or have it already enabled, will not have this user present in the Kafka. For such clusters, contacting support to have the Karapace REST Proxy disabled and re-enabled on their clusters would add in this new user.

This user allows you to manage the ACLs specific for ic\_addon\_rest\_proxy. The presence of this user can be verified by checking the Users list for Kafka.

Using the Karapace Rest Proxy
-----------------------------

The Karapace Rest Proxy operates as a RESTful web API, any application that can send and receive HTTPS messages can be configured to operate with the application.

Special attention should be paid to the Content Type headers sent with each request. The same Content Type headers must be sent when setting up and configuring consumer instances and producing Kafka topics, otherwise, the requests may fail or return 404 NOT FOUND.

For more information about what content types are supported, refer to the following documentation:

<https://github.com/aiven/karapace/blob/3.2.0/README.rst>

Example:

- The following examples will illustrate a few basic commands using the CURL command on a Unix based client machine.
- The consumer instance will be named “my\_consumer\_instance”
- The Content Type header used will be application/vnd.kafka.json.v2+json

1. Listing the topics in a Kafka cluster  
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Request curl -XGET -u ickarapacerest:&lt;restPassword&gt; https://karapace-proxy.149d286a4168457da1705e4f7016faa7.cnodes.io:8083/topics
    
       1
    
    2
    
    3
    
    
    
      Request
    
    curl -XGET -u ickarapacerest:&lt;restPassword&gt;
    
    https://karapace-proxy.149d286a4168457da1705e4f7016faa7.cnodes.io:8083/topics
    
    
    
       
    
     
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Response 200 OK \["instaclustr-sla"\]
    
       1
    
    2
    
    3
    
    
    
      Response
    
    200 OK
    
    \["instaclustr-sla"\]
2. Create a consumer instance in the consumer group named ‘consumer1’  
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Request curl -XPOST -u ickarapacerest:&lt;restPassword&gt; https://karapace-proxy.149d286a4168457da1705e4f7016faa7.cnodes.io:8083/consumers/consumer1 --data '{"name": "my\_consumer\_instance", "format": "json", "auto.offset.reset": "earliest"}' --header "Content-Type: application/vnd.kafka.json.v2+json"
    
       1
    
    2
    
    3
    
    
    
      Request
    
    curl -XPOST -u ickarapacerest:&lt;restPassword&gt;
    
    https://karapace-proxy.149d286a4168457da1705e4f7016faa7.cnodes.io:8083/consumers/consumer1 --data '{"name": "my\_consumer\_instance", "format": "json", "auto.offset.reset": "earliest"}' --header "Content-Type: application/vnd.kafka.json.v2+json"
    
    
    
       
    
     
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Response 200 OK {"instance\_id":"my\_consumer\_instance","base\_uri":"https://34.239.232.248:8083/consumers/consumer1/instances/my\_consumer\_instance"}
    
       1
    
    2
    
    3
    
    
    
      Response
    
    200 OK
    
    {"instance\_id":"my\_consumer\_instance","base\_uri":"https://34.239.232.248:8083/consumers/consumer1/instances/my\_consumer\_instance"}

\*Note: Although Instaclustr provides 3 Karapace Rest Proxy nodes, when creating a consumer instance you will be returned a URL for a specific node IP address, which is decided by Karapace. And then a consumer is created in this particular node, you can only consume messages from this particular node.

This is expected and necessary behaviour, as the consumer instances are stateful and each instance maintains the state independently. Subsequent requests for that consumer instance must be made to the same IP address.

1. Subscribe consumer instance to the topic “test”  
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Request curl -XPOST -u ickarapacerest:&lt;restPassword&gt; https://34.239.232.248:8083/consumers/consumer1/instances/my\_consumer\_instance/subscription --data '{"topics": \["test"\]}' --header "Content-Type: application/vnd.kafka.json.v2+json"
    
       1
    
    2
    
    
    
      Request
    
    curl -XPOST -u ickarapacerest:&lt;restPassword&gt; https://34.239.232.248:8083/consumers/consumer1/instances/my\_consumer\_instance/subscription --data '{"topics": \["test"\]}' --header "Content-Type: application/vnd.kafka.json.v2+json"
    
    
    
       
    
     
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Response 204 NO CONTENT
    
       1
    
    2
    
    
    
      Response
    
    204 NO CONTENT
2. Produce a message to the topic “test”  
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Request curl -XPOST -u ickarapacerest:&lt;restPassword&gt; https://karapace-proxy.149d286a4168457da1705e4f7016faa7.cnodes.io:8083/topics/test --data '{"records": \[{"key": "hello","value": "world"}\]}' --header "Content-Type: application/vnd.kafka.json.v2+json"
    
       1
    
    2
    
    
    
      Request
    
    curl -XPOST -u ickarapacerest:&lt;restPassword&gt; https://karapace-proxy.149d286a4168457da1705e4f7016faa7.cnodes.io:8083/topics/test --data '{"records": \[{"key": "hello","value": "world"}\]}' --header "Content-Type: application/vnd.kafka.json.v2+json"
    
    
    
       
    
     
    
        
    Note: producing can be done to any Karapace Rest Proxy node  
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Response 200 OK {"offsets":\[{"partition":2,"offset":0,"error\_code":null,"error":null},{"partition":1,"offset":0,"error\_code":null,"error":null},{"partition":2,"offset":1,"error\_code":null,"error":null}\],"key\_schema\_id":null,"value\_schema\_id":null}
    
       1
    
    2
    
    3
    
    
    
      Response
    
    200 OK
    
    {"offsets":\[{"partition":2,"offset":0,"error\_code":null,"error":null},{"partition":1,"offset":0,"error\_code":null,"error":null},{"partition":2,"offset":1,"error\_code":null,"error":null}\],"key\_schema\_id":null,"value\_schema\_id":null}
3. Consume the produced message  
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Request curl -XGET -u ickarapacerest:&lt;restPassword&gt; https://34.239.232.248:8083/consumers/consumer1/instances/my\_consumer\_instance/records --header "Accept: application/vnd.kafka.json.v2+json"
    
       1
    
    2
    
    
    
      Request
    
    curl -XGET -u ickarapacerest:&lt;restPassword&gt; https://34.239.232.248:8083/consumers/consumer1/instances/my\_consumer\_instance/records --header "Accept: application/vnd.kafka.json.v2+json"
    
    
    
       
    
     
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Response 200 OK \[{"topic":"test","key":"hello","value":"world","partition":0,"offset":1}\]
    
       1
    
    2
    
    3
    
    
    
      Response
    
    200 OK
    
    \[{"topic":"test","key":"hello","value":"world","partition":0,"offset":1}\]


Troubleshooting
---------------

### Consume Issue

The most common issue for new users is that you receive a **404 NOT FOUND** when attempting to consume from your consumer instance.

There can be a few reasons this may occur

#### Mismatched “Content-Type” headers

Check your Content-Type headers are consistent for each request made to create and configure your consumer instance. Any mismatch on datatype or API version will cause requests to fail.

#### The consumer instance exists on another Karapace Rest Proxy server

Ensure you are communicating with the correct server. Instaclustr offers 3 Karapace Rest Proxy nodes to produce and consume from, however, a single consumer instance only exists on the server it was created on.

To use this consumer instance, you must keep connecting to the same server by its IP address. To facilitate this pattern, in addition to the ID of the consumer instance, the Karapace Rest Proxy will also return the fully qualified URL your application should use.

#### The Karapace Rest Proxy application was restarted

While Instaclustr does everything it can to avoid restarting your applications, they may get restarted during general maintenance (this is only performed after coordinating with you) or troubleshooting operations.

To account for both scenarios, you can ensure your client code is robust by attempting to use the existing consumer instance, and if you receive a 404 response, creating a new consumer instance and using that one.

### Seek Consumer Offset Failure

Another issue you may encounter is that you get the error message: **{“error\_code”:40403,”message”:”Unknown topic or partition”}**, when trying to seek beginning/end consumer offsets from your consumer instance with following endpoint































consumers/&lt;consumer-group&gt;/instances/&lt;consumer-name&gt;/positions/beginning

   1



  consumers/&lt;consumer-group&gt;/instances/&lt;consumer-name&gt;/positions/beginning



   

 

 You can try to replace calling following endpoint using request body **{“topics”: \[“your topic”\]}**































consumers/&lt;consumer-group&gt;/instances/&lt;consumer-name&gt;/subscription

   1



  consumers/&lt;consumer-group&gt;/instances/&lt;consumer-name&gt;/subscription



   

 

 with the endpoint using request body **{“partitions”: \[{“topic”: “your topic”, “partition”: your-partition}\]}** as below































consumers/&lt;consumer-group&gt;/instances/&lt;consumer-name&gt;/assignments

   1



  consumers/&lt;consumer-group&gt;/instances/&lt;consumer-name&gt;/assignments



   

 

 Further reading
---------------

The example above is a simple illustration of a basic produce/consume workflow.

Instaclustr provides and supports all the available features and operations provided by the Karapace Rest Proxy.

Please consult this [GitHub repo](https://github.com/aiven/karapace) for a comprehensive guide to these features.

 

 [ Previous ](https://instaclustr.husldigital.com/support/documentation/kafka-add-ons/using-the-karapace-schema-registry/)Using the Karapace Schema Registry

 

 

 [ Next ](https://instaclustr.husldigital.com/support/documentation/kafka-add-ons/using-kafka-tiered-storage/)Using Kafka Tiered Storage

 

 

 

 

 

 



 

 Need support?

 [Learn more](https://support.instaclustr.com/hc/en-us/requests/new) 

 

Experiencing difficulties on the website or console?

 [See the status page](https://status.instaclustr.com/?_gl=1*qj87gm*_gcl_au*MTYxNTg3NTY5Ny4xNzM1NTI0ODMzLjE4OTQyMjAxNTYuMTc0MTAxMTI5My4xNzQxMDExMjkz*_ga*MTgxNTY5OTk0NS4xNzEwOTYxMzE1*_ga_4NBQSJMP6D*MTc0MjIyMjAyOC4yNDUuMS4xNzQyMjIzMDUyLjIwLjAuMA..&_ga=2.12354995.628574599.1742218211-1815699945.1710961315) 

 

Already have an account?

 [Log in to the Console](https://console2.instaclustr.com/?_gl=1*qj87gm*_gcl_au*MTYxNTg3NTY5Ny4xNzM1NTI0ODMzLjE4OTQyMjAxNTYuMTc0MTAxMTI5My4xNzQxMDExMjkz*_ga*MTgxNTY5OTk0NS4xNzEwOTYxMzE1*_ga_4NBQSJMP6D*MTc0MjIyMjAyOC4yNDUuMS4xNzQyMjIzMDUyLjIwLjAuMA..&_ga=2.12354995.628574599.1742218211-1815699945.1710961315) 

 

### Need help withyour Cluster?

 [Contact support](https://support.instaclustr.com/hc/en-us/requests/new) 

 

 

  



  Learn about our  
Managed platform
----------------------------------

Schedule your 1:1 session with one of our open source experts

 

 [ Schedule a demo ](/schedule-a-demo/)
