Skip to main content
POST
Start static export job
Static export requires an Enterprise plan.

Authorizations

Authorization
string
header
required

Admin API key. Generate one on the API keys page in your dashboard.

Body

application/json
domain
string
required

The domain of the deployment to export, for example docs.example.com.

Example:

"docs.example.com"

version
string

An optional version label to tag this export. Defaults to the latest published version.

Example:

"2024-06-01"

paths
string[]

An optional list of page paths to include. When omitted, every published page is exported.

Example:

Response

The export job was accepted and queued.

jobId
string
required

Unique identifier for the static export job.

Example:

"se_3f9a2c1b8e7d4a06"

status
enum<string>
required

The current state of the job.

Available options:
queued,
running,
completed,
failed
Example:

"running"

progress
number
required

Completion percentage from 0 to 100.

Required range: 0 <= x <= 100
Example:

42

pageCount
integer
required

The number of pages exported so far.

Example:

128

createdAt
string<date-time>
required

When the job was created.

updatedAt
string<date-time>
required

When the job was last updated.

error
string | null

A human-readable error message. Present only when status is failed.