tenant.md

Tenant

Module suite_cloud.api.tenant. The conventions are in the overview.

ping

GET tenant.ping

Confirms the credentials and returns the tenant profile, including where its mail lives.

{
  "tenant": "0199e1a2-3b4c-7d5e-8f60-123456789abc",
  "cluster": "c1.frappemail.com",
  "status": "Active",
  "title": "Acme",
  "contact_email": "it@acme.example",
  "enabled": true,
  "allowed_ips": ["203.0.113.10/32"],
  "jmap_url": "https://c1.frappemail.com",
  "mail_hostname": "c1.frappemail.com",
  "limits": {
    "max_domains": 5,
    "max_accounts": 100,
    "max_groups": 20,
    "max_mailing_lists": 20,
    "max_disk_gb": 500,
    "default_daily_send_limit": 2000,
    "default_monthly_send_limit": 10000,
    "custom_send_limits": false
  },
  "usage": {
    "domains": 2,
    "accounts": 41,
    "groups": 3,
    "mailing_lists": 1,
    "used_disk_bytes": 734003200,
    "emails_sent": 182
  }
}

status is Active, Suspended or Archived. cluster, jmap_url and mail_hostname are null until an operator sets the tenant up for Mail; until then every mail call answers a 422 MailNotConfiguredError, while the tenant calls on this page keep working. A limit of null means no limit. max_disk_gb is the disk the tenant's plan includes; it does not cap the quotas of the tenant's accounts and groups. default_daily_send_limit and default_monthly_send_limit are the send limits a new account starts at, and custom_send_limits says whether the tenant may set an account's limits itself. used_disk_bytes is the figure get_disk_usage answers, or null when the mail server cannot answer. emails_sent counts the emails the tenant's sites sent through Suite Cloud this calendar month, by when each was sent; see Email.

get_disk_usage

GET tenant.get_disk_usage

Parameter	Type	Default	Meaning
fresh	boolean	false	Asks the mail server now instead of answering from the cache

Answers the disk the tenant's accounts and groups use together, as the mail server reports it:

{
  "used_disk_bytes": 734003200,
  "fetched_at": "2026-03-04T05:06:07Z"
}

Suite Cloud asks the mail server for every account and group of the tenant in as few calls as the server allows, then keeps the sum for 5 minutes. A call inside that time answers the kept figure and fetched_at says when it was read. fresh reads the mail server again and replaces the kept figure. When the mail server cannot answer, the call fails with a 503 and nothing is kept, so a partial sum is never served.

update_tenant_profile

PATCH tenant.update_tenant_profile

Parameter	Type	Meaning
title	string	The tenant's workspace name, shown to operators. It cannot be empty.
contact_email	string	Where Suite Cloud sends tenant-specific notices. An empty string puts it back to the owner's email.

Only the fields passed change. Returns the tenant profile as ping does. The Suite app sends both fields whenever its settings change.