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

Reset system API cache

Drops the cached answers of a system API whose settings have enableCaching, for example get table meta or get secret.
Method POST
URL /api/system-api/admin/reset-redis-cache-system-apis : admin is the user path of your account
Body { name, tenantUsername? } or an array of them
Answer data : the number of cache entries removed
From code g.sys.cache.resetCacheSystemApis

The call

Body
{ "name": "Get table meta data" }
Body : several, one for a tenant
[ { "name": "Get table meta data" }, { "name": "Get secret key-keys", "tenantUsername": "acme" } ]
Answer
{ "success": true, "statusCode": 200, "data": 1 }
  • name is the name shown on the System API page : Encrypt data, Decrypt data, Hash data, Get token, Call external API, Execute plain query, Get secret key-keys, Get redis key-keys, Set redis key-keys, Remove redis key-keys, Reset database cache, Reset third party API cache, Reset custom apis cache, Reset system apis cache, Get table meta data, Create indexes, Drop indexes, Get indexes, Emit event, Emit event WS, Is valid data for table, Is valid data for custom API, Is valid data for third party API, Multi tenant instance updated, Is valid connection string. An unknown name gives -1 and a 404 in errors.

From code

await g.sys.cache.resetCacheSystemApis('Get table meta data');

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.