Send Docs Feedback

Making management API calls from this page

  1. In the URL, replace any values indicated by "{ }", such as your organization name.
  2. Set the Basic Authentication credentials: Edge email and password (user must be in the Org Admin role).
    If you don't have an Apigee account,
    go here.
  3. Tweak the parameters and request body as needed.
  4. Send the live request to Edge!

Create a cache in an environment

Resource Summary

Security

Content Type

application/json, text/xml

Category

Caches,

cacheCreate

POST

Create a cache in an environment

Creates a cache in an environment.

Caches are created per environment. For data segregation, a cache created in 'test', for example, cannot be accessed by API proxies deployed in 'prod'.

The JSON object in the request body can be empty, or the <Cache/> tag in XML can be empty, to create a cache with the default settings.

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}/environments/{env_name}/caches

Query Parameters

Name Values Description
name
(required)

Enter the name of the cache to create. Characters you can use in the name are restricted to: A-Z0-9._\-$ %.

Header Parameters

Name Values Description
Content-Type
(required)

Specify the content type as application/json or text/xml.

Request Body

Name

Description

Default

Required?

description

A description of the cache resource.

N/A

No

diskSizeInMB Deprecated -- will be removed in the future. Specifies the disk space used for the cache, in megabytes. 0 No

expirySettings

Enables different expiration mechanisms to be applied to entries in the cache. Cache entries can be expired a certain number of seconds after creation, at a specific time of day each day, or on a specific date.

Options include:

  • timeoutInSec
  • timeOfDay (hh:mm:ss)
  • expiryDate (mm-dd-yyyy)

The Populate Cache policy also lets you set expiry settings. The valuesNull property controls which expiry settings are applied for each entry.

  • If valuesNull is false (default), expiry settings in the Populate Cache policy are used.
  • If valuesNull = true, expiry settings in the policy are ignored.

300 seconds

No

maxElementsInMemory

Deprecated -- will be removed in the future. Maximum number of entries the cache keeps in memory. Upon reaching the max limit the entries are evicted using the LRU algorithm.

100

No

maxElementsOnDisk Deprecated -- will be removed in the future. Maximum number of entries kept on disk. Upon reaching the max limit the entries are evicted using the LRU algorithm. 1000 No

inMemorySizeInKB

Deprecated -- will be removed in the future. All entries larger than the configured setting size, in kilobytes, will be compressed before being cached.

0

No

compression

Deprecated -- will be removed in the future. If specified, enables you to configure the size threshold above which cache entries will be compressed. If not specified, compression is disabled.

Options include:

  • minimumSizeInKB: All entries larger than the configured setting size, in kilobytes, will be compressed before being cached.

false

No

overflowToDisk Specifies to overflow the in-memory cache to disk. false No
persistent Deprecated. Use ExpirySettings. false No

skipCacheIfElementSizeInKBExceeds

If specified, enables you to configure the maximum size of data to be cached. Specify the size limit, in kilobytes, for cache entries. Data larger than the limit you set will not be cached.

disabled

No

org_name Mention the organization name true

env_name Mention the environment 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?