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. For cross-site search, click Search all in the search results.

Key/Value Maps management API

The KeyValueMaps resource provides an API for managing the Apigee Edge key/value store for longer-term data persistence. Key/Value maps are collections of arbitrary name/value pairs ("entries") that can be accessed at runtime by API proxies, or for other custom runtime requirements. The API lets you perform CRUD operations on the key/value store.

You can create and manage key/value maps at multiple scopes:

  • API proxy: Key/value maps at the API proxy scope can be accessed only by the API proxy or a specific revision of the proxy.
  • Environment: Key/value maps at the environment scope can be accessed by any API proxy in the environment (such as test or prod). In the management UI (APIs > Environment Configuration), key/value maps are at the environment scope.
  • Organization: Key/value maps at the organization scope can be accessed by all API proxies in all environments.

API proxies interact with the key/value store at runtime using policies. See Key Value Map Operations policy.

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?)