About this guide

This guide describes how to configure and manage the API Gateway Key Property Store (KPS). The KPS enables you to manage API Gateway data referenced from policies running on the API Gateway.

Who should read this guide

The intended audience for this guide is KPS administrators and policy developers. For more details on API Gateway user roles, see the API Gateway Concepts Guide. This guide assumes that you are familiar with the following:

  • Database concepts such as tables, rows, and keys
  • API Gateway configuration and deployment
  • API Gateway selectors
  • Using command line tools
  • Database configuration where database storage is required

For more details on API Gateway configuration and selectors, see the API Gateway Policy Developer Guide.

How to use this guide

This guide should be used with the other guides in the API Gateway documentation set. Before you begin, review this guide thoroughly. The following is a brief description of the contents of each chapter:

Introduction to KPS provides an overview of the KPS architecture and features.

Get started with KPS explains how to develop an example KPS table for managing simple user information.

Configure KPS in Policy Studio provides more detail on how to define general KPS configuration using the Policy Studio graphical tool.

Access KPS data using selectors explains how to access data in policies on the API Gateway at runtime.

Manage KPS using the kpsadmin tool explains how to manage a KPS, independent of data source.

Configure Apache Cassandra KPS storage explains how to store KPS data in an external Apache Cassandra database.

Configure database KPS storage explains how to store KPS data in a relational database (for example, Oracle, MySQL, IBM DB2, or Microsoft SQL Server).

Configure file-based KPS storage explains how to store KPS data in a directory on the file system.

Related topics

Related documentation

Related Links