Skip to main content
POST
Start a site publish

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Replo-Api-Version
enum<string>
required

The public API version to use for this request.

Available options:
2026-11-10

Path Parameters

siteId
string<uuid>
required

Body

application/json
sha
string
required

The full 40-character sha of the commit to publish. Push it to the site's repository first; uncommitted work never ships.

Pattern: ^[0-9a-f]{40}$
promoteRoutes
string[]

Routes whose unpublished edits go live in this publish — pages and content entries alike, e.g. ["/", "/about", "/blog/my-post"] (a content entry's route is //). Omit to publish every page and entry with changes. Pass [] to publish only site-wide changes and leave every page and entry draft as it is.

Maximum array length: 200
Required string length: 1 - 500
Pattern: ^\/[^\s\x00-\x1f\x7f]*$

Response

Start a site publish

PublicSitePublish

object
enum<string>
required
Available options:
site_publish
id
string<uuid>
required
siteId
string<uuid>
required
status
enum<string>
required
Available options:
queued,
running,
succeeded,
failed
sha
string | null
required

The commit this publish was asked to build.

fault
enum<string> | null
required

Whose problem a failure is. site means the site's code must change before publishing again; the others clear on their own or are ours to fix.

Available options:
site,
platform,
provider,
request,
null
code
string | null
required

A stable name for why the publish failed, such as build.type_error.

message
string | null
required

What failed, in words an agent can act on.

logTail
string | null
required

The end of the failed stage's log.

createdAt
string<date-time>
required
startedAt
string<date-time> | null
required
finishedAt
string<date-time> | null
required