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.

The product has two screens:

KVM Store list — create, edit, and delete stores (this is the sidebar page).
Manage Maps — open a store with View to add, edit, and delete maps inside that store.

Path: API Manager → Gateway Control → KVM Store

Why This Matters¶

Central store for environment-scoped key-value data used by the gateway.
Separate maps per environment for different deployment contexts.
Masked values help protect secrets in list and delete views.

Prerequisites¶

Required Access and Permissions¶

API Manager access.
Permission to manage Gateway Control features.

System / Technical Requirements¶

Valid organization context in the API Manager.
At least one gateway environment.
Unique KVM name per environment.

KVM Store list¶

Path: API Manager → Gateway Control → KVM Store

Search: Matches KVM name only.

Click Create KVM to open Create new KVM.

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

Environment appears on this list only. The entries page shows the KVM name in the header, not the environment.

KVM Entries page¶

Open this screen from the KVM Store list: click View (chevron) on a store row. There is no separate sidebar item.

How you get here: Gateway Control → KVM Store → View on a row.

Search: Matches entry key.

Click Create Maps to add an entry.

Column	Description
`Key`	Entry identifier
`Value`	Entry value (masked in the list when configured)
`Created date & time`	Entry creation time
`Edit`	Opens edit for the map
`Delete`	Opens Delete Maps

Step-by-Step Implementation¶

Manage KVM stores¶

Creating a KVM¶

Step 1: Open KVM Store¶

Go to Gateway Control → KVM Store.

Step 2: Create the store¶

Click Create KVM to open Create new KVM.
Enter KVM name, optional Description (max 500 characters), and Select Environment.
Click Create KVM.

Success

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

Editing a KVM store¶

On the KVM Store list, click Edit to open Edit KVM.
Update Description or Select Environment (KVM name is read-only).
Click Save.

Deleting a KVM store¶

On the KVM Store list, click Delete to open Delete KVM.
Review KVM Name, Environment, and No-of.Entries, then confirm.

To manage maps inside a store, use View and continue under Manage Maps.

Manage Maps¶

Viewing entries¶

Step 1: Open the entries page¶

In the KVM Store list, click View (chevron) on the target row.
The entries page opens with the KVM name in the header.

Step 2: Review entries¶

Use search to filter by entry key.
Masked values appear as asterisks in the list.

Step 3: Return to the KVM Store list¶

Use the back control next to the KVM name in the page header.

Adding a Map¶

Open the entries page with View on the KVM row.
Click Create Maps.
Enter Key and Value.
Click Create.

Key may contain only alphanumeric characters and hyphens. Value cannot be a JSON array or object.

Editing a Map¶

On the entries page, click Edit on a row to open Edit KVM - {kvmName}.
Change Value (Key is read-only).
Click Update.

Deleting a Map¶

On the entries page, click Delete on a row to open Delete Maps.
Confirm Key and masked Value, then delete.

Best Practices¶

Practice	Reason
Create environments before KVMs	Each KVM requires a gateway environment
Use a unique KVM name per environment	Duplicate names are rejected
Keep secrets in masked entries	Values stay hidden in list and delete views
Avoid KVM names that conflict with policy naming	Create can fail with a policy naming conflict

Troubleshooting¶

Issue	Possible Cause	Resolution
KVM name exists	Duplicate name in the environment	Choose a different name
Cannot edit KVM name	Name is immutable after create	Create a new KVM if rename is required
Invalid map key	Unsupported characters	Use alphanumeric characters and hyphens only
Invalid map value	Value is a JSON array or object	Use a scalar string value
No environments to select	No gateway environments	Create one in Environments

Frequently Asked Questions¶

What is the difference between the KVM Store list and the KVM Entries page?

The KVM Store list shows each store’s environment, entry count, and store-level Edit/Delete. View opens the KVM Entries page, where you manage individual key-value maps. Environment appears on the store list only.

Can I rename a KVM after create?

No. KVM name is read-only after create. Create a new KVM if you need a different name.

Are entry values always visible?

Masked values appear as asterisks in the entries list and in Delete Maps. Use Edit on the entries page to update a value.

How does this relate to Environments?

Each KVM is scoped to one gateway environment. Create the environment first, then create the KVM store on the list page.

Tip

Create Environments first, then create KVM stores on the list page and maps on the entries page for environment-specific values used by gateway policies.