Creating and editing environment key value maps

You're viewing Apigee Edge documentation.
Go to the Apigee X documentation. info

This topic shows you how to create and edit key value maps (KVMs) in the UI. The KVMs you create in the UI are environment scoped. For more information about KVMs and scope, see Working with key value maps.

Managing your environment key value maps

Manage your KVMs, as described below. KVMs are defined at the environment scope. For example, if you create a KVM in the 'test' environment, API proxies running in the 'prod' environment won't have access to the KVM.

Edge

To manage KVMs using the Edge UI:

  1. Sign in to apigee.com/edge.
  2. Select Admin > Environments > Key Value Maps in the left navigation bar.
  3. To create a KVM:
    1. Click + Key value map.
    2. Enter property values for the new KVM. The following table describes the settings.
      Property Name Description
      Name Name of the KVM. Must be unique in the environment. Reference this name from policies that interact with the KVM.
      EncryptedFlag that specifies whether the KVM is encrypted. In the UI, encrypted values will appear as asterisks (*****). Encryption is set on the entire map. You cannot set encryption entry by entry.
      Note: You can only encrypt KVMs when you create them. You can't encrypt or decrypt a key value map after it's been created.
    3. Click Add.
  4. To add an entry to a KVM:
    1. Click the name of the KMV in the list to display the current entries.
    2. Click +.
    3. Enter property values for the new KVM entry, as described below.
      Property Name Description
      Key

      Key name that you'll use to access the data value in your API proxies.

      With Apigee Edge for Public Cloud, key names cannot be larger than 2 KB.

      In the Edge UI, names cannot contain "/".
      Value

      Value of the key. Enter any combination of numbers, letters, or special characters.

      Note: The total size of a KVM cannot be larger than 15 MB.
    4. Click Add.
  5. To manage the key entries in a KVM:
    1. Click the name of the KVM in the list to display the current entries.
    2. Position your cursor over the KVM entry to display the actions menu and perform one of the following tasks:
      • To copy the value of an entry, click .
      • To edit an entry, click . Then, edit the entry and click Update.
      • To delete an entry, click . Then, click Delete to confirm the operation.

New Edge UI (Private Cloud)

To manage KVMs using the New Edge UI:

  1. Sign in to the New Edge UI at http://host:3001/edge, where host is the IP address or DNS name of the host running the New Edge UI.
  2. Select Admin > Environments > Key Value Maps in the left navigation bar.
  3. Select the environment for which you want to configure KVMs, such as test or prod.
  4. To create a KVM:
    1. Click + Key value map.
    2. Enter property values for the new KVM. The following table describes the settings.
      Property Name Description
      Name Name of the KVM. Must be unique in the environment. Reference this name from policies that interact with the KVM.
      Encrypted Flag that specifies whether the KVM is encrypted. In the UI, encrypted values will appear as asterisks (*****). Encryption is set on the entire map. You cannot set encryption entry by entry.
      Note: You can only encrypt KVMs when you create them. You can't encrypt or decrypt a key value map after it's been created.
    3. Click Add.
  5. To add an entry to a KVM:
    1. Click the name of the KVM in the list to display the current entries.
    2. Click +.
    3. Enter property values for the new KVM entry, as described below.
      Property Name Description
      Key

      Key name that you'll use to access the data value in your API proxies.

      In the New Edge UI, names cannot contain "/".
      Value

      Value of the key. Enter any combination of numbers, letters, or special characters.

      Note: The total size of a KVM cannot be larger than 15 MB.
    4. Click Add.
  6. To manage the key entries in a KVM:
    1. Click the name of the KVM in the list to display the current entries.
    2. Position your cursor over the KVM entry to display the actions menu and perform one of the following tasks:
      • To copy the value of an entry, click Copy key icon.
      • To edit an entry, click Edit icon. Then, edit the entry and click Update.
      • To delete an entry, click Delete icon. Then, click Delete to confirm the operation.