Skip to content

KVM Store

Overview

The KVM Store (Key-Value Map Store) lets you create and manage key-value maps scoped to a gateway environment. Use KVM entries in gateway policies and related workflows that need environment-specific configuration values.

Open Gateway Control → KVM Store in the API Manager sidebar.

Why This Matters

  • Central store for environment-scoped key-value data used by the gateway.
  • Separate maps per environment for dev, staging, and production contexts.
  • Masked values protect secrets in the UI.

Scope

  • Create, view, edit, and delete KVM stores.
  • Add, edit, and delete entries (maps) within each KVM.
  • Search KVMs by name and entries by key.

Outcome

  • Named KVM stores linked to gateway environments.
  • Key-value entries ready for policy and routing configuration.

Prerequisites

Required Access and Permissions

  • API Manager access.
  • Permission to manage gateway environments and KVM stores.
  • Feature: Gateway Policies metadata enabled.

System / Technical Requirements

Features

  • KVM list — list stores with environment, entry count, and timestamps.
  • Search — filter by KVM name.
  • Create KVM — add a new store with name, description, and environment.
  • View — open the entries page for a KVM (chevron icon on the list row).
  • Masked values — sensitive entry values hidden in list and delete views.

KVM List Fields

Column Description
KVM Name Display name of the key-value map
Environment Linked gateway environment
No.of.Entries Count of keys in the store
Created date & time When the KVM was created
Edit Open Edit KVM for the store (description and environment)
Delete Remove the KVM store
View Open the KVM entries page (chevron icon)

Create KVM

Field Required Description
KVM name Yes Unique name for the store (read-only after create)
Description No Optional notes (max 500 characters)
Select Environment Yes Gateway environment for this KVM

KVM Entries page

Click View (chevron icon) on a KVM row in the main list to open that store's entries page. This is where you manage individual key-value maps inside the KVM — not a read-only summary dialog.

UI area What you see
Page header KVM name (for example, KVM - 2) and a back control to return to the KVM list
Entry list All key-value maps in this KVM
Toolbar Search by Entry name and Create Maps
Row actions Edit and Delete per entry

KVM list vs entries page

The KVM Store list shows each store's Environment alongside name and entry count. View opens the entries page, which shows the KVM name in the header but does not repeat the environment — use the main list to see which environment a KVM belongs to. To update the KVM itself (description or environment), use Edit on the main list; to remove the whole store, use Delete on the main list.

Entry list columns

Column Description
Key Entry identifier
Value Entry value (masked when configured)
Created date & time Entry creation time

Create / Edit Map

Field Required Notes
Key Yes Read-only on edit
Value Yes Masked as password field when entry is masked

Delete Map

Confirmation shows Key and masked Value before delete.

Step-by-Step: Create a KVM and Add Entries

Step 1: Open KVM Store

  • Go to Gateway Control → KVM Store.

Step 2: Create KVM

  • Click Create KVM.
  • Enter KVM name, optional Description, and Select Environment.
  • Click Create KVM.

The new KVM appears in the main list with No.of.Entries set to 0 until you add maps.

Viewing and managing KVM entries

Step 1: Open the entries page

  • In the KVM list, click View (chevron icon) on the target row.
  • The entries page opens with the KVM name in the page header. The list shows existing maps (Key, Value, Created date & time), or is empty if none exist yet.

Step 2: Review entries

  • Use Search by Entry name to filter by key.
  • Masked values appear as asterisks in the list; use Edit on a row to update a value.

Step 3: Add an entry

  • Click Create Maps.
  • Enter Key and Value.
  • Click Create.
  • The new entry appears in the entries list and No.of.Entries updates on the main KVM list when you return.

Step 4: Edit or delete an entry

  • On the entries page, click Edit on a row to change the Value (Key is read-only).
  • Click Delete on a row to remove a map; confirm Key and masked Value in the dialog.

Step 5: Return to the KVM list

  • Click the back control next to the KVM name in the page header to return to the KVM Store list.
  • On the main list, use Edit or Delete on a KVM row for store-level changes (not individual entries).

Troubleshooting

Issue Possible Cause Resolution
KVM name exists Duplicate name in environment Choose a different name
Policy conflict Name conflicts with policy rules Rename or check gateway policy naming
Cannot edit KVM name Name is immutable after create Create a new KVM if rename is required