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

Multi tenant instance updated

Call it when the connection string of a tenant of a multi-tenant instance changes in the tenants table : every server drops the connection pools of that tenant and the cached answers of the instance and of the tenants table, so the next request of the tenant reads its row again and connects to the new database.
Method POST
URL /api/system-api/admin/multi-tenant-instance-updated : admin is the user path of your account
Body { instanceName, username } or an array of them
Answer data : one answer per item, { success, data }
From code g.sys.system.multiTenantInstanceUpdated

The call

Body : one tenant of one instance
{ "instanceName": "crm", "username": "acme" }
Body : several
[ { "instanceName": "crm", "username": "acme" }, { "instanceName": "billing", "username": "acme" } ]
Answer
{
    "success": true,
    "statusCode": 200,
    "data": [
        { "success": true, "data": true },
        { "success": false, "data": false, "error": { "code": 400, "message": "Instance 'billing' is not a multi tenant structure instance." } }
    ]
}
  • Each item is answered on its own : an unknown instance (404) or an instance which is not multi-tenant (400) does not stop the other items.
  • Both fields are required.
  • Until this API is called, the servers keep using the pools they have. For PostgreSQL, the pools of every database of the tenant are dropped.

From code

await g.sys.system.multiTenantInstanceUpdated({ instanceName: 'crm', username: 'acme' });

await g.sys.system.multi_tenant_instance_updated('crm', 'acme')

$g->sys->system->multiTenantInstanceUpdated('crm', 'acme');

await g.Sys.System.MultiTenantInstanceUpdated(new MultiTenantInstanceUpdated("crm", "acme"));

if _, err := g.Sys.System.MultiTenantInstanceUpdated(am.MultiTenantInstanceUpdated{InstanceName: "crm", Username: "acme"}); err != nil {
    return nil, err
}

g.sys.system.multi_tenant_instance_updated(MultiTenantInstanceUpdated::new("crm", "acme"))?;

g.sys.system.multiTenantInstanceUpdated(new MultiTenantInstanceUpdated("crm", "acme"));

g.sys.system.multiTenantInstanceUpdated(MultiTenantInstanceUpdated("crm", "acme"))

Several instances at once

Several instances or tenants at once, each item answered on its own:

1
2
3
4
5
const output = await g.sys.system.multiTenantInstanceUpdated([
    { instanceName: 'crm', username: 'acme' },
    { instanceName: 'billing', username: 'acme' },
]);
// [{ success: true, data: true }, { success: false, data: false, error: { code: 404, message: "..." } }]

1
2
3
4
5
output = await g.sys.system.multi_tenant_instances_updated([
    MultiTenantInstanceUpdated('crm', 'acme'),
    MultiTenantInstanceUpdated('billing', 'acme'),
])
# [{ success: true, data: true }, { success: false, data: false, error: { code: 404, message: "..." } }]

1
2
3
4
5
$output = $g->sys->system->multiTenantInstancesUpdated([
    new MultiTenantInstanceUpdated('crm', 'acme'),
    new MultiTenantInstanceUpdated('billing', 'acme'),
]);
// [{ success: true, data: true }, { success: false, data: false, error: { code: 404, message: "..." } }]

1
2
3
4
5
var output = await g.Sys.System.MultiTenantInstancesUpdated([
    new MultiTenantInstanceUpdated("crm", "acme"),
    new MultiTenantInstanceUpdated("billing", "acme"),
]);
// [{ success: true, data: true }, { success: false, data: false, error: { code: 404, message: "..." } }]

1
2
3
4
5
6
7
8
output, err := g.Sys.System.MultiTenantInstancesUpdated([]am.MultiTenantInstanceUpdated{
    am.MultiTenantInstanceUpdated{InstanceName: "crm", Username: "acme"},
    am.MultiTenantInstanceUpdated{InstanceName: "billing", Username: "acme"},
})
if err != nil {
    return nil, err
}
// [{ success: true, data: true }, { success: false, data: false, error: { code: 404, message: "..." } }]

1
2
3
4
5
let output = g.sys.system.multi_tenant_instances_updated(vec![
    MultiTenantInstanceUpdated::new("crm", "acme"),
    MultiTenantInstanceUpdated::new("billing", "acme"),
])?;
// [{ success: true, data: true }, { success: false, data: false, error: { code: 404, message: "..." } }]

1
2
3
4
5
var output = g.sys.system.multiTenantInstancesUpdated(List.of(
    new MultiTenantInstanceUpdated("crm", "acme"),
    new MultiTenantInstanceUpdated("billing", "acme")
));
// [{ success: true, data: true }, { success: false, data: false, error: { code: 404, message: "..." } }]

1
2
3
4
5
val output = g.sys.system.multiTenantInstancesUpdated(listOf(
    MultiTenantInstanceUpdated("crm", "acme"),
    MultiTenantInstanceUpdated("billing", "acme"),
))
// [{ success: true, data: true }, { success: false, data: false, error: { code: 404, message: "..." } }]

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.