hosting
GET /v1/sites/{siteId}/storage
Read a site's storage, its extra storage packs and what it can buy.
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}/storage \
-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
Extra storage for one website (s1014 STORAGE, docs/157 §S): the site's disk and file usage against its ceiling (base from its plan, packs added by extra storage), the packs it holds (each removable only while the site fits without it), and the three packs on sale — 10 GB, 50 GB and 100 GB a month, each adding 10,000 files per GB — priced in the caller's currency, with today's prorated first charge (first_charge_minor, to the plan's renewal day renews_on). can_buy is the purchase door's own answer; when the site's server cannot back the pack and another server in its pool can, refusal_code is box_full and move_available is true (see moveSiteForStorage). plan_suggestion names a plan upgrade that gives the same space for the pack's price or less, when one exists. lapse is set while a pack that ended is still in use (the site keeps its space for a grace period, then only new growth stops). Buy a pack through purchaseExtra (POST /v1/extras/extra_storage_10gb/purchase with site_id). Requires sites.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
site_id | string | Yes | — |
offered | boolean | Yes | Whether extra storage is on sale to this organisation. |
disk | SiteStorageUsage | Yes | One resource of a site (disk in MB, or files), in stored units. limit is base + packs (plus any staff grant); -1 is unlimited and null is not provisioned. |
inodes | SiteStorageUsage | Yes | One resource of a site (disk in MB, or files), in stored units. limit is base + packs (plus any staff grant); -1 is unlimited and null is not provisioned. |
packs | SiteStoragePack[] | Yes | — |
offers | SiteStorageOffer[] | Yes | — |
lapse | object | Yes | Set while a pack that ended is still in use: the site keeps its space until deadline, after which only new growth stops. Files are never deleted. |
move | object | Yes | The latest "move and add" request for this site. |
Errors this endpoint can return
401 · 403 · 404 · 429