hosting
POST /v1/sites/{siteId}/moodle-upgrade/check
Check a Moodle site for a newer release now.
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 POST https://api.zinndigital.com/v1/sites/{siteId}/moodle-upgrade/check \
-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
Queues an inspect of the site (installed release, plugins, database and PHP versions) against Moodle's update feed. Returns at once with check_pending true; poll getSiteMoodleUpgrade until it is false. Sites are also checked daily. 409 MOODLE_UPGRADE_REFUSED for a site that is not on our servers or not live. 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 · 409 · 429 · 503