Skip to content

Key Management System

Overview

The Key Management System (Key Management Service in the UI) lets you generate or upload cryptographic key pairs for API authentication, signing, and Encryption and Decryption policies.

Open Manage APIs → Key Management System in the API Manager sidebar.

Why This Matters

  • Central lifecycle management for RSA and ECDSA keys.
  • Supports system-generated and user-uploaded keys.
  • Links keys to gateway policies with visibility before delete.

Scope

  • Generate keys with algorithm and validity period.
  • Upload private, public, or combined key pairs.
  • View, edit metadata, filter, and delete keys (when not policy-linked).

Outcome

  • Named key pairs ready for Encryption & Decryption and related policies.
  • Validity tracking (Active, Expiring Soon, Expired).

Prerequisites

Required Access and Permissions

  • API Manager access.
  • Permission to manage API metadata and keys.

System / Technical Requirements

  • Supported algorithms: RSA-2048, RSA-4096, ECDSA-P256.
  • PEM-format keys for upload flows.

Features

  • Key grid with search and filters (Type, Validity).
  • Generate Key — create system-generated key pairs.
  • Upload Key — import existing keys.
  • Policy linkage — view policies attached to a key.
  • View mode — inspect private and public key material.

List Filters

Filter Options
Type All, User Uploaded, System Generated
Validity All, Active, Expiring Soon, Expired

List Columns

Column Description
Key Name Identifier for the key pair
Type System Generated or User Uploaded
Algorithm e.g. RSA-2048, RSA-4096, ECDSA-P256
Created On Creation date
Validity Active / days remaining / Expired badge
Linked to Policy Policy count link or -

Generate Key

Field Required Description
Key Name Yes Unique key identifier
Description No Optional notes
Algorithm Yes RSA-2048, RSA-4096, or ECDSA-P256
Validity Yes Duration in Days, Months, or Years

Info banner: Enter name, select algorithm, click Generate Key; view keys via View on the main page.

View mode: Shows Private key and Public key blocks.

Upload Key

Same metadata fields as generate; Algorithm shows Detected by system (read-only).

Upload Key Type Options
Key material Private Key, Public Key, or Private and Public Key

Upload via file or paste per key type.

Delete Key

  • Blocked when the key is linked to policies.
  • Modal shows Key Name, Algorithm, Validity, and Attached To policy list.
  • Delete disabled until policies are detached.

Policy attached modal: Lists policy names with View details → Gateway Policies.

Step-by-Step Implementation

You can add keys in two ways: Generate Key (system creates the pair) or Upload Key (you provide existing PEM material).

Generating a Key

Step 1: Open Key Management System

  • Go to Manage APIs → Key Management System.

Step 2: Open Generate

  • Click Generate Key.

Step 3: Enter Key Details

  • Enter Key Name, optional Description, Algorithm, and Validity.
  • Click Generate Key.

The new system-generated key appears in the keys list. Use View later to inspect the private and public key material.

Uploading a Key

Step 1: Open Key Management System

  • Go to Manage APIs → Key Management System.

Step 2: Open Upload

  • Click Upload Key.

Step 3: Enter Key Details

  • Enter Key Name, optional Description, and Validity.
  • Algorithm shows Detected by system (read-only); the platform detects it from the key material.

Step 4: Provide Key Material

  • In Upload Key Type, select Private Key, Public Key, or Private and Public Key.
  • Upload a PEM file or paste the key content for each selected type.

Step 5: Submit

  • Click Upload Key.

The new user-uploaded key appears in the keys list with Type User Uploaded.

Viewing a Key

Step 1: Open View

  • In the keys list, click View (eye icon) on the target row.

Step 2: Review Key Material

  • For a system-generated key, the dialog title is View Generated Key.
  • For an uploaded key, the dialog title is View Uploaded Key.
  • Review Private key and Public key (and other fields) in read-only mode.
  • Click Close when finished.

Step 3: Review Policy Linkages (optional)

  • In the Linked to Policy column, click the policies link (for example, 2 Policies) to see which Encryption & Decryption policies use the key.
  • If the column shows -, the key is not linked to any policy.
  • From the linked-policies dialog, use View details to open Gateway Policies, or click Close.

Editing a Key

Step 1: Open Edit

  • In the keys list, click Edit on the target row.
  • The dialog title is Edit Generated Key or Edit Uploaded Key, depending on key type.

Step 2: Update Fields

  • Update allowed fields such as Description and Validity.
  • Algorithm stays read-only after create.
  • For uploaded keys, you can replace key material by uploading or pasting again when the form allows it.

Step 3: Save

  • Click the primary save action to apply changes.
  • If nothing changed, the form asks you to modify values before updating.

Deleting a Key

Step 1: Open Delete Confirmation

  • In the keys list, click Delete (trash icon) on the target row.

Step 2: Review Summary

The Delete Key dialog shows:

  • Key Name
  • Algorithm
  • Validity
  • Attached To (policy count, or -)

Step 3: Confirm Delete

  • If the key is linked to policies, Delete is disabled. Detach the key from those policies first (use the Linked to Policy column or the Attached To list).
  • If the key is not linked, click Delete to remove it.

Tip

Keep key names clear and track validity regularly so active keys stay easy to find when you attach them to Encryption & Decryption policies.