hosting
POST /v1/sites/{siteId}/wordpress/staging
Copy a site's live WordPress onto staging.
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}/wordpress/staging \
-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
⛔ This copies live onto staging and can do nothing else. It takes no body, so there is no field a caller could set to make it publish over the live site — that is publishSiteWordPressStaging, a different path with its own refusal. the platform itself distinguishes the two directions with one string in one field, which is precisely why they must not share an endpoint. An existing staging copy is overwritten by the live site: that is what "refresh my staging" means, and it is the safe direction. ⛔⛔ 202 means accepted, never finished, and a client that treats it as finished will be wrong every time. Copying a document root and a database takes far longer than any HTTP request may — ~30 s for an empty WordPress on the Zinn® fleet, and it scales with the site — so the copy runs on the platform's queue. The body carries the new entry in operations: poll getSiteWordPressStaging until it leaves queued and running, and read message if it ends failed. ⭐ Refusals still arrive here, immediately: a site whose platform cannot stage is a 422 from this call, not a failed operation a minute later. 404 for a site whose platform has no WordPress to manage. 409 when another staging operation is already running for the site. Requires sites.view and sites.panel_access.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
permitted | boolean | Yes | Whether this site may use WordPress staging at all — on the resold range the package type's own flag, and on our own fleet the plan's staging entitlement. |
publish_modes | string<files, db, both>[] | Yes | Which publish scopes this site's platform can actually perform, for publishSiteWordPressStaging. A client offers exactly these and no more. ⛔⛔… |
publishable | boolean | Yes | Whether the plan also carries publish to live, which is a separate permission from creating a staging copy. ⛔ Not folded into permitted, because the catalogue sells the two… |
reinstallable | boolean | Yes | Whether the plan carries reinstalling the platform software over the staging copy. A fifth question for the same reason as publishable: the catalogue sells it separately, so… |
idle_removal_days | integer | Yes | After how many days with no change a staging copy is removed automatically, or null when nothing ever removes it. ⛔⛔… |
idle_notice_days | integer | Yes | How many days' warning the customer is emailed before that removal, or null when idle_removal_days is null. |
operations | SiteWordPressStagingOperation[] | Yes | The site's recent staging operations, newest first — the client's window onto work that runs after the request returns. ⛔⛔… |
data | SiteWordPressStagingClone[] | Yes | The staging copies that exist. |
Errors this endpoint can return
401 · 403 · 404 · 409 · 422 · 429 · 503