You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com.

Create KeyValueMap in an API proxy

Resource Summary

Security

Content Type

application/json

Category

KeyValueMaps,

createAPIKVMaps

POST

Create KeyValueMap in an API proxy

Creates a key value map (KVM) for a single API proxy.

A key value map is a simple structure for persistently storing name/value pairs as entries in a named map. The entries in a KVM can be retrieved at runtime by the Key Value Map Operations policy or code running on Apigee Edge. Use KVMs for use cases such as profile-based access control, storing environment-specific data, to control application-specific behavior, and so on.

 

You can created an encrypted KVM by adding "encrypted" : "true" to the payload. You update encrypted KVMs the same way you update non-encrypted KVMs.

 

KVM names are case sensitive.

 

Note: KVMs created at the API proxy scope do not appear in the Edge UI. Only KVMs created at the environment scope apear in the Edge UI. To see the KVMs defined at the API proxy scope, use the List KeyValueMaps for an API proxy API.

 

For information on retrieving KVMs, see:

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}/apis/{api_name}/keyvaluemaps

Header Parameters

Name Values Description
Content-Type
(required)

Specify the Content Type as application/json.

Request Body

Name Description Default Required?
name The name of the map to be created. Characters you can use in the name are restricted to: A-Z0-9._\-$ %. N/A Yes
encrypted true to create an encrypted KVM. false No
entry The name/value pairs for the entry that defines the data to be stored. Characters you can use in the entry are restricted to: A-Z0-9._\-$ %. N/A Yes

org_name Mention the organization name true

env_name Mention the API proxy name true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)