hosting
GET /v1/sites/{siteId}/resource-usage
Get the vendor's own counts of what a package is using.
Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/resource-usage \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
How many cron jobs, FTP accounts, databases, database users, aliases and SSH keys the package currently holds, counted by the vendor rather than by us. This is the honest denominator behind every *"3 of 5"* caption on the hosting tab: a count we derived from our own list would disagree with the package the moment anything was created outside this platform. ⛔ A count the vendor sent in a form we could not read is **named in `unreadable`** and reported as `0`, never silently folded into the number. A caption built on a zero that means "we could not tell" is worse than no caption. Requires `sites.view` — the same class of fact as the disk and bandwidth figures beside it. `404` for a site with no managed hosting package.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
cron_jobs | integer | Yes | Scheduled tasks on the package. |
ftp_accounts | integer | Yes | FTP accounts on the package, including its primary one. |
mysql_databases | integer | Yes | MySQL databases on the package. |
mysql_users | integer | Yes | MySQL users on the package. |
server_aliases | integer | Yes | Domain aliases pointed at the package. |
ssh_public_keys | integer | Yes | SSH public keys installed on the package. |
unreadable | string[] | Yes | ⛔ Counts the vendor sent in a form we could not read. They are **named here and reported as 0** above, never silently folded into the number — a caption built on a zero that mea… |
Errors this endpoint can return
401 · 403 · 404 · 429 · 503