hosting

POST /v1/sites/{siteId}/website-backups

Take a standard backup of a site's files and databases.

Все эндпоинты hosting

Вся документация для разработчиков

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

Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение hosting.backup.manage; ключ без него отклоняется с кодом 403, а не 404.

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

Попробовать

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

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/website-backups \
  -H "Authorization: Bearer zdk_live_…"

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

Подробнее

Asks the hosting platform to build a fresh archive of this site's files and databases. 202, because the platform runs the job afterwards and a 200 would claim an instant we never observed. ⛔ The response is the new state of the surface, never a bare acknowledgement — the client writes it straight into its cache, so an empty body would leave the button un-flipped and the poll never started. There is deliberately no restore verb on this resource: the platform restores this product from an archive the customer uploads by hand, so a Restore control here could only ever fail. 404 for a site with no vendor hosting package, or one that is not the caller's. Requires hosting.backup.manage.

Параметры

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

Ответ

ИмяТипОбязательноЧто это
availablebooleanДаWhether this site runs on a hosting package with a standard-backup surface at all. false renders nothing rather than an empty list.
retention_hoursintegerДаHow long the platform keeps one. Sent rather than hardcoded in the client so the screen can show a real expiry, and so it cannot drift if the platform changes it.
backupWebsiteBackupДаThe current backup, or null when the platform holds none. ⛔ null never means we failed to ask — that is an error status, not an empty surface.

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

401 · 403 · 404 · 422 · 429 · 503