KVM
KVM entry details.
Schema
name (required) | Name of the KVM. Valid characters include: | |||||
encrypted | Flag that specifies whether the KVM is encrypted. Defaults to | |||||
entry (required) | Name/value pairs for the KVM entry that define the data to be stored. Valid characters include: | |||||
|
Paths
The following paths use this type:
Creates a key value map (KVM) for an API proxy.
A KVM 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 KeyValueMapOperations 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 create an encrypted KVM by adding "encrypted" : "true"
to the request 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 view the KVMs defined at the API proxy scope, see List key value maps for an API proxy.
For information on retrieving KVMs, see KeyValueMapOperations policy.
Deletes a key value map (KVM) from an API proxy. KVM names are case sensitive.
Gets a key value map (KVM) in an API proxy, including the keys and values. KVM names are case sensitive.
With Apigee Edge for Public Cloud, the maximum number of KVM entries returned is 1000.
Creates a key value map (KVM) scoped to an API proxy revision.
Note: Apigee Edge for Public Cloud only.
Creates a key value map (KVM) in an environment.
A KVM 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 KeyValueMapOperations 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 create an encrypted KVM by adding "encrypted" : "true"
to the request payload. You update encrypted KVMs the same way you update non-encrypted KVMs.
KVM names are case sensitive.
Note: You can also create and manage environment-scoped KMVs in the Edge UI. For more information, see Creating and editing environment key value maps.
For information on retrieving KVMs, see KeyValueMapOperations policy.
Deletes a key value map (KVM) and all associated entries from an environment. KVM names are case sensitive.
Note: You can also create and manage environment-scoped key value maps in the Edge UI. For more information, see Creating and editing environment key value maps.
Gets a key value map (KVM) in an API proxy by name, along with the keys and values. KVM names are case sensitive.
Note: With Apigee Edge for Public Cloud, the maximum number of KVM entries returned is 1000.
You can also create and manage environment-scoped KVMs in the Edge UI. For more information, see Creating and editing environment key value maps.
Updates an existing key value map (KVM) in an environment.
This API does not override the existing map. Instead, this method updates the entries if they exist or adds them if not. It can take several minutes before the new value is visible to runtime traffic.
Notes:
- Apigee Edge for Private Cloud only. For Apigee Edge for Public Cloud use Update an entry in an environment-scoped KVM.
- You can also create and manage environment-scoped key value maps in the Edge UI. For more information, see Creating and editing environment key value maps.
Creates a key value map (KVM) in an organization.
A KVM 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 KeyValueMapOperations 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 create an encrypted KVM by adding "encrypted" : "true"
to the request payload. You update encrypted KVMs the same way you update non-encrypted KVMs.
KVM names are case sensitive.
Note: KVMs created at the organization 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 organization scope, use the List KVMs for an organization API.
For information on retrieving KVMs, see KeyValueMapOperations policy.
Deletes a key value map (KVM) and all associated entries from an organization. KVM names are case sensitive.
Gets a key value map in an organization.
Updates an existing key value map (KVM) in an environment.
This API does not override the existing map. Instead, this method updates the entries if they exist or adds them if not. It can take several minutes before the new value is visible to runtime traffic.
Note: Apigee Edge for the Private Cloud only. For Apigee Edge for the Cloud, update map entries individually instead of in bulk. See Update an entry in an organization-scoped KVM.