hosting
POST /v1/sites/{siteId}/wordpress/staging
Copy a site's live WordPress onto staging.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão sites.view; uma chave sem ela é recusada com 403, e não 404.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/wordpress/staging \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
⛔ **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 with no vendor hosting package. `409` when another staging operation is already running for the site. Requires `sites.view` and `sites.panel_access`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
siteId (path) | Uuid | Sim | Site ID (UUIDv7). |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
permitted | boolean | Sim | 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>[] | Sim | 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 | Sim | 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 | Sim | 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[] | Sim | 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[] | Sim | The staging copies that exist. |
Erros que este endpoint pode retornar
401 · 403 · 404 · 409 · 422 · 429 · 503