Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Path Parameters

id
string
required

The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")

Response

The site's template status after the upgrade

object
enum<string>
required
Available options:
site_template
generation
string | null
required

The framework generation the site runs (vinext, tanstack-start); null for a site created before generations were recorded.

template_commit
string | null
required

The template commit the site was forked from or last upgraded to; null when it cannot be told.

latest_generation
string
required

The generation new sites are forked from.

latest_commit
string | null
required

The template commit new sites are forked from.

archive_url
string | null
required

A tarball of latest_commit, fetchable with curl.

upgrade_available
boolean
required

The site is on an older generation or template commit, or its commit cannot be told.