hosting
GET /v1/sites/{siteId}/app-auto-update
Read a site's automatic app updates add-on and its window.
Authentication
Send an API key as a bearer token. The endpoint checks sites.view; 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}/app-auto-update \
-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 paid automatic-updates add-on for the app the site runs (wordpress_auto_updates, woocommerce_auto_updates, joomla_auto_updates, drupal_auto_updates, mediawiki_auto_updates, phpbb_auto_updates, matomo_auto_updates, typo3_auto_updates, concretecms_auto_updates, strapi_auto_updates, payload_auto_updates, dolibarr_auto_updates, silverstripe_auto_updates, craft_auto_updates, osticket_auto_updates, piwigo_auto_updates, modx_auto_updates, suitecrm_auto_updates, zenphoto_auto_updates or mautic_auto_updates, USD 29 a year per site; nextcloud_auto_updates, owncloud_auto_updates, prestashop_auto_updates, magento_auto_updates, oscommerce_auto_updates, opencart_auto_updates or abantecart_auto_updates, USD 50 a year per site; s1014 row 41): whether it is on sale and on, its price in the caller's currency, the renewal, the quiet window and the last run. Each run takes a safety backup first and rolls back to it when the homepage breaks. WordPress: core, plugins and themes (a held plugin version is never applied). Joomla!: the core only, through Joomla's own console; extensions and templates are not updated. Nextcloud: the server through its own updater, then every app with an update. Drupal: the core only (the newest release of the installed major version, then its database updates); contributed modules and themes are not updated. MediaWiki: the newest stable release with its bundled extensions and skins, then its own update script; extensions the customer added are not updated. phpBB: the newest release of the installed branch with its bundled style, language and extension, then its own db:migrate; styles, language packs and extensions the customer added are not updated. ownCloud: the newest release of the installed major version (the complete build, with its bundled apps), then its own occ upgrade; apps from the ownCloud marketplace are not updated. PrestaShop: the newest stable release of the installed major version through PrestaShop's own Update Assistant (files, database and native modules); modules the customer added are kept, never uninstalled, and are not updated. Magento: the newest security patch of the installed 2.x.y line (the source release's code, its Composer lock and setup:upgrade); modules and themes the customer added are kept and not updated, and a store that added Composer packages is refused with nothing changed. Strapi and Payload: the newest release of the installed major from npm (every package of the app's own family on the core's version moves together), then the app's own build (strapi build; for Payload a schema migration when the release needs one, payload migrate and next build) and a process restart; other npm packages the customer added are kept and not updated. osCommerce: the vendor's newest osCommerce 4 build (its code over the store's, then its own database migrations and cache rebuild); the store's configuration, images and uploads are kept, and extensions and themes the customer added are kept and not updated. Dolibarr: the newest release of the installed major version (the tag's htdocs), then its own CLI upgrade (install/upgrade.php, upgrade2.php, step5.php) until the database records the new version; modules the customer added in custom/ are kept and not updated. Buy it through purchaseExtra with site_id. Requires Silverstripe CMS: Composer moves the site to the newest release of the installed major (the newest silverstripe/installer constraints for the packages the site already requires), then its own sake db:build --flush; packages the customer added move only within their own constraints. Craft CMS: Composer moves craftcms/cms and every plugin to the newest release the project's own composer.json allows (the installed major), then its own craft up (migrations and project config) and clear-caches/all; done only when both the code and the database report the new version. osTicket: the newest release of the installed version line (1.17 or 1.18; its upload/ folder, the desk's include/ost-config.php kept), then its own manage.php upgrade until no upgrade is pending; plugins and language packs the customer added are kept and not updated. Piwigo: the newest release of the installed major (the gallery's local/ settings and every photo kept), then its own database upgrades (upgrade_feed.php) until none is left; plugins and themes the customer added are kept and not updated. MODX: the newest release of the installed major (core/config and installed Extras kept), then its own setup in upgrade mode (setup/ removed after every run) until the database records the new version; Extras the customer installed are kept and not updated. SuiteCRM: the newest release of the installed major through SuiteCRM 8's own console upgrader (suitecrm:app:upgrade, then upgrade-finalize -m keep, customisations kept) until suitecrm:version reports the new version; modules the customer added are kept and not updated. Zenphoto: the newest release of the installed major swapped in (zp-data, albums, uploaded and the caches kept; plugins and themes merged), then Zenphoto's own setup driven over loopback signed in as the site's administrator (setup's blind autorun stops on LiteSpeed), setup protected again on every exit, until the database's install signature records the new version; a run whose setup failed after its swap is finished by the next run. OpenCart: the newest patch release of the installed major.minor (its upload/ folder; config.php, admin/config.php and the store's storage kept; extensions merged), then OpenCart's own upgrade steps (install/controller/upgrade/upgrade_1 onwards) run on the command line through its own framework with the installer kept outside the web root, both config files restored byte for byte on every exit; a run whose steps failed after its swap is finished by the next run; extensions the customer added are kept and not updated. AbanteCart: every newer release of the installed major, one release at a time up to the newest (its public_html code over the store's, system/config.php kept, the installer never lands), then each release's own database upgrade (upgrade.sql run through AbanteCart's own database layer with the version row written last, then its upgrade.php trigger) until the database records the new version; a run that failed after its swap is finished by the next run; extensions the customer added are kept and not updated. Mautic: the newest stable release of the installed major, through Mautic's own updater (mautic:update:apply with the release's own update package, refused when the package's minimum Mautic or PHP range does not fit, then --finish for its database migrations); config/local.php, media and plugins the customer added are kept and not updated. 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 | — |
app_key | object | Yes | The app the add-on serves on this site, or null when none is sold for it. |
code | string | Yes | The catalogue code to buy (<app_key>_auto_updates). |
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 to 6 = Sunday; null = every day. |
window_hour | integer | Yes | — |
timezone | string | Yes | — |
next_window_at | string | Yes | — |
last_run_at | string | Yes | — |
last_outcome | object | Yes | — |
last_detail | string | Yes | What the last run changed, or why it was rolled back. |
Errors this endpoint can return
401 · 403 · 404 · 429