hosting
GET /v1/sites/{siteId}/exam-boost
Read a Moodle site's Exam Boost offer, its booking and its history.
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}/exam-boost \
-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
Exam Boost (docs/1160 §8): seven days at double CPU, memory, I/O and entry processes, then the site goes back to its plan by itself. The first boost in any twelve months is free for the site; after that each costs the moodle_exam_boost price (USD 9.99) in the caller's currency. Returns whether it is offered for this site (a Moodle site on our own servers), the free allowance, the price, the plan limits and the doubled limits, the current or scheduled boost and the last five finished ones. 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 | — |
free_available | boolean | Yes | — |
next_free_on | string | Yes | — |
price | ExamBoostMoney | Yes | — |
duration_days | integer | Yes | — |
multiplier | integer | Yes | — |
max_lead_days | integer | Yes | — |
plan_limits | ExamBoostLimits | Yes | — |
boosted_limits | ExamBoostLimits | Yes | — |
current | ExamBoostBooking | Yes | — |
history | ExamBoostBooking[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429