Skip to content

Preview and publish

Saving, previewing and publishing are separate operations. A successful content save creates a retained revision. The website changes after a successful publication.

Method Path Permission
POST /pages/:id/preview edit
POST /pages/:id/publish edit and publish
GET /jobs/:id read

Send the exact revision you want to build and a fresh operation UUID:

{
"expectedRevision": 3,
"operationId": "22222222-2222-4222-8222-222222222222"
}

Use a newly generated UUID for each intended operation. An identical retry with the same UUID returns the saved job. Reusing the UUID for a different request returns 409.

The 202 response contains the job id. Poll /jobs/:id and retain the job ID with the content revision in your integration.

Status Meaning Next step
pending Queued for the publisher Wait and poll
running Publisher is building, checking or verifying the revision Wait and poll
succeeded Exact deployment was verified and its receipt recorded Use the returned url
failed The attempt failed and the result contains available context Read the result, fix the cause, then request a new operation
uncertain Upload or completion could not be fully confirmed Contact PulpSense before requesting another upload

Jobs are collected at minutes 17 and 47 each hour. Allow up to about 30 minutes plus queue and build time. PulpSense can dispatch the publisher immediately when operationally necessary.

The publisher builds the exact selected revision with the rest of the website, then checks content, structured data, links and performance. A failed pre-upload build leaves the served website intact.

Completion verifies the deployment’s origin, route, canonical URL, indexing policy, revision marker and artifact identity. The resulting URL identifies the verified deployment. A preview uses an immutable review-host URL with noindex; it does not advance the production revision.

Production publication requires publish permission and the managed website’s initial client-domain launch to have completed. Before launch, the API returns 409 and explains that the website must be launched first.

Article previews use POST /articles/:id/preview with the same request fields and return jobs to poll at /jobs/:id.

Article production uses POST /articles/:id/publish. Read its attempts and status at /articles/:id/publication; this uses the existing article publisher.

To restore older content, read the retained revision, save its desired content as a new current revision, and publish that revision. Completed history is kept.

On a network timeout while submitting a job, retry the same operation UUID and identical request. Check the saved job before requesting another operation. Uncertain uploads are recovered by the publisher using deployment markers; they are not blindly uploaded again.