Skip to main content
POST
One-shot: publish a route on the project default Pages host

Body

application/json
args
string[]

[project] [slug]; project defaults to Console scope. A slug is a legacy extra host. Omit it to use the project default host

body
string

HTML body fragment wrapped in a simple HTML5 document

console
string

Console base URL

dir
string

Directory with an entrypoint (default index.html)

entrypoint
string

Package entrypoint path (default: index.html)

execute
boolean

Accepted and ignored for compatibility. pages ship always publishes

html
string

Path to an HTML file to publish

membersBestEffort
boolean

Ship ravi.bases.* uses on a public route anyway. Only org members already signed in get live data

project
string

Console project id or slug; overrides saved Console scope

route
string

Pages route path to mount content at (default: /)

theme
string

Theme for this ship: a theme ref, or none. Default: the project theme, else the org theme

title
string

Page title. Does not create a host slug

uses
string[]

Capability ids to declare on the publish, such as ravi.identity.assertion. Repeat or comma-separate. Does not embed a JWT

visibility
string

Pages visibility: private|protected_link|public (default: private)

Response

Success — body conforms to the @Returns schema.

artifactId
string | null
required
commentFollow
object
required
kit
object
required
presentation
object | null
required
route
string
required
site
object
required
slug
string
required
success
boolean
required
url
string | null
required
visibility
string
required
uses
string[]
warnings
string[]