API Platform Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Resource Path: /keyvaluemaps
Persistence resources that enable storing arbitrary data

The KeyValueMaps resource provides an API that enables client applications to interact with the Apigee Edge key/value store.

Key/ValueMaps provide an API for storing arbitrary name/value pairs that can be access at runtime by custom policies, or for other custom runtime requirements such as protocol support.

Each key/value map consists of one or more 'entries'. Each entry in a map defines a name/value pair that can be fetched, updated, deleted via the API.

API proxies can also interact with the Key/value store at runtime using policies.

See Persist data using KeyValueMap.

Create key/value map Detail
/keyvaluemaps
Verb: POST
Description: Creates a KeyValueMap
Media types:
application/json
text/xml
Auth: Basic Auth
Delete a key/value map Detail
/keyvaluemaps/{map_name}
Verb: DELETE
Description: Deletes a KeyValueMap and all associated entries.
Auth: Basic Auth
Delete an entry from a key/value map Detail
/keyvaluemaps/{map_name}/entries/{entry_name}
Verb: DELETE
Description: Deletes a single entry by name
Media types:
application/json
text/xml
Auth: Basic Auth
Get key/value map Detail
/keyvaluemaps/{map_name}
Verb: GET
Description: Gets a KeyValueMap by name, along with associated entries
Media types:
application/json
text/xml
Auth: Basic Auth
List key/value maps Detail
/keyvaluemaps
Verb: GET
Description: List all KeyValueMaps by name
Media types:
application/json
text/xml
Auth: Basic Auth
Update key/value map Detail
/keyvaluemaps/{map_name}
Verb: PUT
Description: Updates an existing KeyValueMap
Media types:
application/json
text/xml
Auth: Basic Auth

 

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)