Skip to content

Reset Cache APIs

Get redis key/keys

title: Get Redis Key Example description: Example of accessing and managing Redis keys for caching with API Maker.

Get redis keys

Get redis key using global object 'g'.

  • Get single redis key value.
1
await g.sys.cache.getKey("REDIS_KEY_NAME");
  • Get multiple redis keys values.
1
await g.sys.cache.getKey(["REDIS_KEY_NAME", "ANOTHER_REDIS_KEY_NAME"]);

Set redis key/keys

title: Set Redis Key Example description: Demonstrates setting Redis keys for caching or session management in API Maker.

Set redis keys

Set redis key using global object 'g'.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
await g.sys.cache.setKey([
    {
        key: "redis_key_name",
        value: "redis_key_value",
        ttl: 1500  // This key will be available till next 1500 seconds.
    },
    {
        key: "redis_key_name",
        value: "redis_key_value"
    }
]);

Remove redis key/keys

title: Remove Redis Key Example description: Example showing how to remove Redis keys to manage cache effectively.

Remove redis keys

Remove redis key and its value using global object 'g'. 

1
await g.sys.cache.removeKey("REDIS_KEY_NAME");

Remove multiple redis keys. 

1
await g.sys.cache.removeKey(["REDIS_KEY_NAME", "ANOTHER_REDIS_KEY_NAME"]);

Reset cache of custom APIs

title: Reset Custom API Cache Example description: Example showing how to clear cache for custom APIs using API Maker.

Reset cache custom API

Reset cache of the custom API using global object 'g'. 

1
await g.sys.cache.resetCacheCustomApis("CUSTOM_API_NAME");

Reset cache of system APIs

title: Reset System APIs Cache Example description: Demonstrates resetting cache for system APIs with API Maker system examples.

Reset cache of system API

Reset cache of system API using global object 'g'. 

1
await g.sys.cache.resetCacheSystemApis("SYSTEM_API_NAME");

Reset cache of third party APIs

title: Reset Third Party API Cache Example description: See how to reset caches for integrated third-party APIs with API Maker examples.

Reset cache of Third party APIs

Reset Third party API cache using global object 'g'.

1
2
3
4
await g.sys.cache.resetCacheThirdPartyApis({
    "apiBundleName": "bundle_name",
    "apiVersionName": "api_version_name"
});

Reset cache of database table/collection

title: Reset Database Cache Example description: Example demonstrating how to clear and reset database cache using API Maker.

Database cache reset

Reset cache of database table/collection using global object 'g'. 

1
2
3
await g.sys.cache.resetCacheDB({
    instance: "INSTANCE_NAME", database: 'DB_NAME', collection: "COLLECTION_NAME",
});