hosting
GET /v1/sites/{siteId}/moodle-upgrade
Read a Moodle site's installed release, the offered upgrade and recent runs.
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}/moodle-upgrade \
-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
The one-click Moodle upgrade (s1014, docs/1160), free on every Moodle plan. installed is the release the last check found; available is the highest release THIS server can run that is newer (any branch, so a major upgrade is the same click); blocked lists newer releases it cannot run, each with the reason (database or PHP too old, a plugin that does not support it, requirements unknown). refusal says why the button is off (refusal.moodleUpgrade.*), or null when can_upgrade is true. current_run is the upgrade in flight; runs the newest ten. A pure database read. 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 | — |
is_moodle | boolean | Yes | — |
installed | MoodleRelease | Yes | — |
available | MoodleRelease | Yes | The highest release this server can run that is newer than installed. |
blocked | MoodleBlockedRelease[] | Yes | — |
can_upgrade | boolean | Yes | — |
refusal | MoodleRefusal | Yes | — |
checked_at | string | Yes | — |
check_pending | boolean | Yes | — |
current_run | MoodleUpgradeRun | Yes | — |
runs | MoodleUpgradeRun[] | Yes | Newest first, at most ten. |
Errors this endpoint can return
401 · 403 · 404 · 429