hosting

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

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

Alle hosting-eindpunten

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie sites.view beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

curl -X POST https://api.zinndigital.com/v1/site-blueprints/{siteBlueprintId}/screenshot \
  -H "Authorization: Bearer zdk_live_…"

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

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`.

Parameters

NaamTypeVerplichtWat dit is
siteBlueprintId (path)UuidJaA 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…

Reactie

NaamTypeVerplichtWat dit is
urlstringJa⛔ A **bearer credential** for the picture until it expires — never log it, never store it, hand it straight to the browser.
expires_atstringJa

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 422 · 429