hosting

POST `/v1/site-blueprints/{siteBlueprintId}/screenshot`

Mint a time-limited URL for a blueprint's screenshot.

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 POST https://api.zinndigital.com/v1/site-blueprints/{siteBlueprintId}/screenshot \
  -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

Returns a presigned URL the browser fetches directly from object storage. ⛔ **`POST`, despite reading nothing** — the same rule `downloadSiteBackup` follows: the response body is a signed credential for customer content (a picture of their site, which can show unlaunched branding or a page behind a login), so a `GET` would invite it into browser history, proxy logs and shared caches. The grant expires in ten minutes; take a new one rather than storing it. A blueprint with no screenshot is a `422`, not a `404` — the blueprint exists, the picture does not. Requires `sites.view`.

Parameter

Name	Typ	Erforderlich	Was es ist
`siteBlueprintId (path)`	`Uuid`	Ja	A SITE blueprint's id (UUIDv7) — one of the customer's own captured sites. ⛔ Not a `blueprintId`: that names a published stack recipe, and the two are different resources that u…

Antwort

Name	Typ	Erforderlich	Was es ist
`url`	`string`	Ja	⛔ A bearer credential for the picture until it expires — never log it, never store it, hand it straight to the browser.
`expires_at`	`string`	Ja	—

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 422 · 429

POST /v1/site-blueprints/{siteBlueprintId}/screenshot