Skip to content
This page View Markdown Open in ChatGPT Open in Claude

Reset third party API cache

Drops the cached answers of the APIs of a version of an installed third party bundle (deprecated feature).
Method POST
URL /api/system-api/admin/reset-redis-cache-third-party-apis : admin is the user path of your account
Body { apiBundleName, apiVersionName?, tenantUsername? }
Answer data : the number of cache entries removed
From code g.sys.cache.resetCacheThirdPartyApis

The call

Body
{ "apiBundleName": "bundle_name", "apiVersionName": "api_version_name" }
Body : one tenant
{ "apiBundleName": "bundle_name", "apiVersionName": "api_version_name", "tenantUsername": "acme" }
Answer
{ "success": true, "statusCode": 200, "data": 2 }

From code

await g.sys.cache.resetCacheThirdPartyApis({ apiBundleName: 'bundle_name', apiVersionName: 'api_version_name' });

Access and settings

  • Over HTTP, a system API answers once its settings give it apiAccessType: TOKEN_ACCESS (the token of an API user whose group grants this system API, in x-am-authorization) or IS_PUBLIC. Without settings it is NO_ACCESS : your code calls it through g.sys, the admin panel tests it, and an HTTP call is refused.
  • The settings can also cache the answer or require person tokens (authProviders) ; pre and post hooks run around it like around any API.
  • The request headers apply : x-am-response-case, x-am-content-type-response, x-am-internationalization, x-am-tenant-username…

Errors

Code When
400 The body is wrong : the message names the missing or invalid key.
401 No valid API user token, or the API is NO_ACCESS : You are not authorized to access this API.
403 No group grants this system API.