Skip to content

WSO2 API Manager: Database Guide

This guide explains what WSO2 API Manager (APIM) stores in its database, and why. It covers what each table is for and how the tables connect. It also shows which rows get written when someone creates an API, subscribes to it, generates keys or calls it.

For the exact columns, see the table reference.

  • APIM 4.x series

    Documented from WSO2 API Manager 4.7.0. Covers revisions, gateway environments, organizations, operation policies, governance and AI APIs.

    Start with 4.x

  • APIM 3.x series

    Documented from WSO2 API Manager 3.2.0. Covers the classic model, where APIs are published to gateway labels and the API's identity lives in the registry.

    Start with 3.x

  • 3.x vs 4.x

    What changed between the two series, table by table and flow by flow. Useful when you're migrating.

    Compare

  • New here?

    Learn how to read the diagrams, and look up APIM terms such as subscription, key manager or revision.

    How to read this guide

How to use this guide

  1. Get the big picture. Read the series Overview and The databases pages.
  2. Follow a flow. The Core flows pages tell the story of APIM step by step, e.g. "a developer subscribes to an API", and show exactly which tables are touched.
  3. Go deep on a domain. The Domains pages explain groups of related tables, such as applications and subscriptions, or keys and tokens.
  4. Look up a table. The Table reference lists every table and column.

Supported databases

APIM uses the same logical schema on every supported database (MySQL, PostgreSQL, Oracle, Microsoft SQL Server, DB2 and H2). Column types and key syntax vary slightly between vendors. The table and column names are the same.