—Rate this article—
 

Beta Release of SmartDocs

1. In the Resource URL, replace any values enclosed in "{}", such as your organization name.
2. Set the Basic Authentication credentials. These are your Edge credentials (user must be in the Org Admin role).
3. Tweak the Request Body as needed (if a body is needed).
4. Send the live request to Edge and view the response! You can also view Request data.

Create a cache in an environment

Resource Summary

Auth Type

BASICAUTH,

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

300 seconds

No

maxElementsInMemory

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 Maximum number of entries kept on disk. Upon reaching the max limit the entries are evicted using the LRU algorithm. 1000 No

inMemorySizeInKB

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

0

No

compression

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 Enables cache entries to be persistent across restarts. 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

Basic Auth

OAuth 2

Custom Token

Reset

Make a request and see the response.

Make a request and see the response.

Working...

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