hosting
PUT /v1/sites/{siteId}/moodle-auto-update
Turn automatic Moodle updates on or off and choose the window.
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 PUT https://api.zinndigital.com/v1/sites/{siteId}/moodle-auto-update \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "enabled": <boolean>, "window_hour": <integer>, "timezone": <string> }'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
Sets the quiet window (window_weekday 0 = Monday to 6 = Sunday, or null for every day; window_hour 0-23; an IANA timezone). Turning it on needs the add-on on this site (422 refusal.moodleAutoUpdate.notOnSite); a bad hour, weekday or time zone is 422. Requires sites.view and hosting.applications.manage.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
enabled | boolean | Yes | — |
window_weekday | integer | No | — |
window_hour | integer | Yes | — |
timezone | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
site_id | string | Yes | — |
offered | boolean | Yes | Whether the add-on is on sale to this organisation. |
active | boolean | Yes | Whether the add-on is on and in good standing now. |
can_buy | boolean | Yes | — |
refusal | string | Yes | Why it cannot be bought right now, or null. |
price | MoneyAmount | Yes | The yearly price in the caller's currency, or null when not on sale. |
purchase_id | string | Yes | — |
renews_on | string | Yes | — |
ends_on | string | Yes | — |
enabled | boolean | Yes | — |
window_weekday | integer | Yes | 0 = Monday … 6 = Sunday; null = every day. |
window_hour | integer | Yes | — |
timezone | string | Yes | — |
next_window_at | string | Yes | — |
last_run | MoodleUpgradeRun | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429