API Management versions 7.5.X and 7.6.X have reached end of support in November 2020.
Check out the latest version of the documentation.

Install an Apache Cassandra database

Apache Cassandra is required to store data for API Manager (for example, API catalog, quotas, and client registry) or API Gateway client registry (API key and OAuth). In addition, Cassandra is optional to store data for the following API Gateway components:

  • Custom KPS table definitions and data
  • OAuth token stores
Note   You must ensure that Cassandra is installed and running to use API Manager or API Gateway client registry.

Supported Cassandra versions

API Gateway supports Apache Cassandra version 2.2.12. For more details on Apache Cassandra, see http://cassandra.apache.org/.

For details on upgrading your Cassandra version, see Upgrade Apache Cassandra in the API Gateway Upgrade Guide.

Upgrade from earlier API Gateway versions

API Gateway version 7.5.3 and later include the Datastax Cassandra client, which uses a default port of 9042 to communicate with Cassandra over the Cassandra native protocol. Earlier API Gateway versions included the Hector Cassandra client, which used a default port of 9160 to communicate with Cassandra over the Apache Thrift protocol.

In API Gateway version 7.5.1 or later, Cassandra runs externally to the API Gateway process. In earlier API Gateway versions, Cassandra was embedded in the API Gateway process.

For details on upgrading from an earlier API Gateway version, see the API Gateway Upgrade Guide.

Cassandra prerequisites

This section describes Cassandra-specific prerequisites in addition to the general API Gateway Prerequisites.

Production environment requirements

API Gateway supports the following in production:

  • Operating systems:
  • Cassandra:
    • Cassandra version 2.2.12
    • 64-bit Oracle JRE version 8 (OpenJDK is not supported)

For details on requirements for high availability, see Configure a Cassandra HA cluster in the API Gateway Apache Cassandra Administrator Guide.

JRE requirements and recommendations

The default API Gateway installation includes a 64-bit Oracle JRE (apigateway/Linux.x86_64/jre/bin). You can configure Cassandra to use the API Gateway JRE (for example, in a demo environment), but it is recommended that you install a separate Oracle JRE for use with Cassandra. When using a separate JRE, use the same version (or at least the same major version) as the API Gateway uses.

JCE policies for Cassandra TLS/SSL

If client TLS/SSL will be enabled for Cassandra, you must install the Java Cryptographic Extension (JCE) policies for your Oracle JRE. For example, you can download the Oracle Java 8 JCE policies from:


Install Apache Cassandra

Note   Apache Cassandra 2.2.12 is installed by default in an API Gateway Standard or Complete setup. For more details, see Installation options.

Install Cassandra in GUI mode

In GUI mode, to install Apache Cassandra only, use the steps described in Installation options with the following selections:

  • Setup Type: Select Custom.
  • Select Components: Select Cassandra.
  • Cassandra configuration: Enter your Cassandra Installation Directory and your JRE Location. For more details, see Cassandra configuration.

Install Cassandra in unattended mode

To install Apache Cassandra using the API Gateway installer in unattended mode, follow the steps described in Unattended installation.

The following command is an example of how to install Apache Cassandra in unattended mode on Linux:

./APIGateway_7.6.2_Install_linux-x86-32_BN<n>.run --mode unattended 
--setup_type advanced 
--enable-components cassandra
--disable-components apigateway,qstart,policystudio,analytics,
--cassandraInstalldir /opt/db/cassandra
--cassandraJDK /opt/jre
--startCassandra 0

Keep Cassandra installation after API Gateway is uninstalled

To keep your Cassandra installation after API Gateway is uninstalled, you must ensure that you first install Cassandra only. For example, perform the following steps:

  1. Run the API Gateway installer, and select Cassandra only.
  2. Run the API Gateway installer, and select API Gateway components to install.

If API Gateway is uninstalled, Cassandra remains installed.

For more details on Apache Cassandra, see the following:

Related Links