hosting
POST /v1/sites/{siteId}/wordpress/staging/publish
Publish a site's staging WordPress over the live site.
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/publish \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'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 most destructive operation on the managed hosting line**: the live site's files and database are replaced by the staging clone's. Its own path, so no request aimed at any other staging operation can reach it. ⛔⛤ **The one optional field, `mode`, selects SCOPE and never DIRECTION.** This path exists separately from `createSiteWordPressStaging` precisely so that no field can flip which way the copy runs — on managed shared hosting both directions are driven from a single value, and one passthrough endpoint would let a request reading as *"refresh my staging copy"* publish a stale clone over a live shop. Every value of `mode` copies staging onto live; it says only how much travels. A field that could change the direction must never be added here. ⛔ **A scope the site's platform cannot honour is refused `422`.** Read `publish_modes` on `SiteWordPressStaging` first and offer only what it lists: the Zinn® autoscaling platform performs `files`, `db` and `both`, and managed shared hosting performs `both` only, because its staging operation takes no scope at all. That is a property of the platform, not of the customer's plan — a larger package does not add a database-only publish. Refused `422` when the site has **no staging clone** — the platform does not check, and would happily publish an empty staging environment over a live shop. The client is required to take a typed confirmation naming the site. `202` because the publish continues at the vendor after the acknowledgement. `404` for a site with no vendor hosting package. Requires `sites.view` and `sites.panel_access`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
mode | string<files, db, both> | No | `files` copies the document root and leaves the live database alone; `db` copies the database and search-replaces the staging URL back to the live one, leaving the live files al… |
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. ⛔⛔ **This is not a permission a… |
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 tw… |
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,… |
operations | SiteWordPressStagingOperation[] | Yes | The site's recent staging operations, newest first — the client's window onto work that runs **after** the request returns. ⛔⛔ **Creating, publishing, deleting and reinstalling… |
data | SiteWordPressStagingClone[] | Yes | The staging copies that exist. |
Errors this endpoint can return
401 · 403 · 404 · 409 · 422 · 429 · 503