hosting

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

The standard backup a site's hosting package currently holds.

Alle hosting Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung sites.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

The hosting platform's **included** on-demand backup for this site — a downloadable archive of files and databases. This is a different product from `getSiteVendorSnapshots`, which is the platform's *paid* point-in-time service, and from `listSiteBackups`, which is our own archive. ⛔ **The platform deletes one of these after `retention_hours`** (12 today). That is the character of the product: it is a button, not a history, and a client must render the real age rather than presenting it as durable protection. `backup` is `null` when the platform holds none — never when we failed to ask, which is an error status. ⭐ `complete` is not `status` restated: it also requires a `download_url`, because a job reporting completion with no archive is nothing the customer can act on. `404` for a site with no vendor hosting package, or one that is not the caller's. Requires `sites.view`.

Parameter

NameTypErforderlichWas es ist
siteId (path)UuidJaSite ID (UUIDv7).

Antwort

NameTypErforderlichWas es ist
availablebooleanJaWhether this site runs on a hosting package with a standard-backup surface at all. `false` renders nothing rather than an empty list.
retention_hoursintegerJaHow 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.
backupWebsiteBackupJaThe 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.

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 422 · 429 · 503