hosting

POST /v1/sites/{siteId}/hosting/applications

Install a one-click application onto a live site.

Všechny koncové body hosting

Všechny dokumenty pro vývojáře

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/hosting/applications \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "application": <string> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

Installs application onto the site's hosting package. The submit is instant and the work runs as a durable workflow (§2.16), so this answers 202 with the install row — poll GET on this path and read current for its state. ⛔ This is destructive: a one-click install unpacks a whole application over the site's document root and creates a database, so it is gated on hosting.applications.manage rather than on hosting.deploy.manage, and only one install may run per site at a time (409 otherwise). 404 for a site whose platform has no application catalogue at all — a site on our own fleet simply does not have this resource, and naming the platform it is not on would disclose which vendor a site runs on. 422 when the catalogue exists but that application is not offered: either the product line does not sell it, or the vendor no longer carries it. The application list is per product line — the footprint-free line deliberately offers a narrower set than mainstream — and it is read live, so a page left open can offer something that has since gone.

Parametry

NázevTypPožadovánoCo to je
siteId (path)UuidAnoSite ID (UUIDv7).

Tělo požadavku

NázevTypPožadovánoCo to je
applicationstringAnoThe key of an application from this site's own list. Validated against the live catalogue rather than a fixed enum, because the range changes without a release on our side.
localestringNeThe language to install the site in, as a platform language code (de, pt-BR). Applies to wordpress only, and is saved to the site so a later reinstall keeps it. Omit to use…

Odpověď

NázevTypPožadovánoCo to je
idstringAno
application_keystringAno
application_namestringAnoThe display name captured at the moment of installing — a snapshot, so history still reads correctly after the platform renames or retires an application.
statusstring<queued, installing, installed, failed>Ano
messagestringAnoCustomer-facing English. Only meaningful when failed.
requested_bystringNeThe actor who asked for it, for the audit trail.
started_atstringNe
finished_atstringNe
created_atstringAno

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 409 · 422 · 429 · 503