Never-ending Pumpkin Mulch


    1.0.4 • Public • Published

    IBM API Connect Micro Gateway Data Store

    What is it?

    The data store is a loopback application for the data model of all API Connect artifacts needed by the Micro Gateway at runtime. The data store is essential for proper API enforcement by the Micro Gateway, as the Micro Gateway queries the data store with each received request to determine the proper behavior where the desired behavior is defined by the content of the artifacts.

    How does it work?

    The artifacts consumed by the data store are created in one of the following ways:

    • In a laptop scenario by using the API Connect CLI.
    • In an on-premises scenario by downloading from the API Connect management server.

    Once created, the data store loads these artifacts into an in-memory database on startup. In the on-premises scenario, the in-memory database is periodically updated at run time (every 15 minutes by default). Once the raw data is populated into the in-memory database, a specific view of the information is generated that is optimized for performant runtime lookup of the appropriate behavior for a specific request to the Micro Gateway. The data store exposes information to the Micro Gateway using a REST interface.

    The configuration files

    In the end-to-end (or the laptop) scenario, the default application default / SECRET and plan 100/hour will be created into the datastore. If developers want to configure their own applications, plans, or TLS profiles, they can take advantage of the two configuration files, apic.json and apic-tls-profiles.json, which should be created in the project folder, for example, the apiconnect-demo.

    Here's an example of apic.json to configure applications and plans. Two clients foo and bar, and two plans plan-a and plan-b are added to the datastore. The foo subscribes the plan-a, which includes APIs stock-quote and weather while the bar subscribes the plan-b, which includes only bank-account. Each plan stores an independent rate-limit setting. (Please note that, in the case of apiconnect-demo, there is only one api named apiconnect-demo.)

        "applications": {
            "foo": {
                "client-secret": "fooSecret",
                "oauth-redirection-uri": "",
                "subscription": "plan-b"
            "bar": { "client-secret": "barSecret",
                "oauth-redirection-uri": "",
                "subscription": "plan-a"
        "plans": {
            "plan-a": {
                "apis": [
                "hard-limit": false,
                "rate-limit": "100/minute"
            "plan-b": {
                "apis": [
                "hard-limit": true,
                "rate-limit": "1/second"

    Here's an example of apic-tls-profiles.json which is used to configure TLS profiles. Developers may specify the key, certificate, and other options to create a TLS profile. A TLS profile is used in the secure connections. For example, the created TLS profile can be used in an invoke policy.

        "theTlsProfile-bob: {
            "ca": [
            "cert": "bob.crt",
            "key": "bob.key",
            "rejectUnauthorized": true,
            "secureProtocols": [

    Do I need to start it explicitly?

    In most cases, no. By default, each Micro Gateway starts its own instance of the data store. The data store can either be started within the same process space as the Micro Gateway or as its own process. It makes sense to start the data store explicitly in certain scenarios where differing numbers of Micro Gateways and data stores are needed for optimal scaling of a solution.

    So why do I need to know about the data store?

    The data store could contain sensitive information 'in the clear' so access to the data store should be restricted. Also, the data store loads information on start up and periodically (on-premises only). If the source information is updated, it might be necessary to restart the data store to pick up the latest information quicker than happens by default.

    Environment Variables

    • APIMANAGER : Host of the API Connect management server you need to connect to. (on-premises only)
    • APIMANAGER_CATALOG : Catalog that the Micro Gateway is responsible for servicing. (on-premises only)
    • APIMANAGER_PORT : Port to connect to the API Connect management server on. (on-premises only)
    • APIMANAGER_REFRESH_INTERVAL : Interval in milliseconds (defaults to 15 minutes) on how long to wait before fetching updated artifacts from the API Connect management server (on-premises only)
    • CONFIG_DIR : Directory of Swagger to load. (On-premises, this is used for initial load. On-premises loads into ./config for subsequent loads.)
    • DATASTORE_PORT : Port for the data store to listen for requests on. By default, the data store binds to port 0, causing an ephemeral port listen If set before startup, the data store listens on that port
    • LAPTOP_RATELIMIT : Rate limit (defaults to 100/hour) to apply for all requests (laptop only)


    npm i microgateway-datastore

    DownloadsWeekly Downloads





    Apache 2.0

    Unpacked Size

    172 kB

    Total Files


    Last publish


    • jisoolee
    • dhmlau
    • ritch
    • johnbellessa
    • chrisdudley
    • redlanne
    • scheu
    • sanchit.chadha