8.4. Caching

The CLI is using the official API-Manager REST-API in order to load the Actual-API(s).

Based on the number of APIs, Applications, Organizations, this might result in a massive amount of requests and significantly reduces the performance of the CLI, especially when doing a massive export of APIs or Applications.

To avoid requesting the same entities over and over again, the CLI is using a cache, which persists the requested information to disk and it is reusing next time the CLI is called.

The CLI is delivered with a preconfigured set of entities and you can configure the caches time-to-live yourselves in the configuration file: lib/cacheConfig.xml.

If you would like to clear one, more or all caches you can provide the option: -clearCache to a command:

-clearCache ALL                        -- All caches are cleared and will be filled up with fresh data
-clearCache "*API*"                    -- All caches named with API. This is NOT case sensitive.
-clearCache "organizationCache,*API*"  -- Clears a combination of combination of caches

The get a list of all available caches, just provide an invalid to the clearCache option (-clearCache XXXX)

Also you can use the toggle: -ignoreCache to skip using the caches at all.

Caches

Cache	Cached entity	REST-Endpoint	Comment
applicationAPIAccessCache	Apps subscribed to API	/applications//apis	Since API-Mgr version 7.7 not used anymore.
organizationAPIAccessCache	Orgs access to an API	/organizations//apis	Which APIs the organization has granted access.
oauthClientProviderCache	List of OAuth-Profiles	/oauthclientprofiles	In Policy-Studio configured OAuth-Client profiles
applicationsCache	Application details	/applications/	The details of an application
applicationsSubscriptionCache	Subscribed apps for an API	/proxies//applications	Applications subscribed a specific API
applicationsQuotaCache	Application-Quotas	/applications//quota	Configured quotas for an application
applicationsCredentialCache	Application-Credentials	/applications//	Configured credentials for an application. Type might be oauth
organizationCache	Organization details	/organizations/	The details of an organization
userCache	User details	/users/	The details of a user

Please note: As of now, caches are NOT used for import actions such as API-Import or App-Import.