hosting

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

Install a one-click application onto a live site.

Аутентификация

Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

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> }'

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

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.

Параметры

Имя	Тип	Обязательно	Что это
`siteId (path)`	`Uuid`	Да	Site ID (UUIDv7).

Тело запроса

Имя	Тип	Обязательно	Что это
`application`	`string`	Да	The `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.
`locale`	`string`	Нет	The 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…

Ответ

Имя	Тип	Обязательно	Что это
`id`	`string`	Да	—
`application_key`	`string`	Да	—
`application_name`	`string`	Да	The display name captured at the moment of installing — a snapshot, so history still reads correctly after the platform renames or retires an application.
`status`	`string<queued, installing, installed, failed>`	Да	—
`message`	`string`	Да	Customer-facing English. Only meaningful when `failed`.
`requested_by`	`string`	Нет	The actor who asked for it, for the audit trail.
`started_at`	`string`	Нет	—
`finished_at`	`string`	Нет	—
`created_at`	`string`	Да	—

Ошибки, которые может возвращать этот эндпоинт

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

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