Skip to main content
POST
Upload a local artifact/file/directory to Console and optionally release it to Ravi Pages

Body

application/json
target
string
required

Local artifact id, file, or directory; use a directory with index.html for Pages

artifactVersion
string

Local artifact version number (default: latest)

assetBase
string

Package asset base intent

basePath
string

Package base path intent

console
string

Console base URL

description
string

Published artifact description

entrypoint
string

Package entrypoint path

execute
boolean

Actually upload/release to Console; default is a dry-run that only shows the plan (exit 3)

idempotencyKey
string

Idempotency key for Console retries

name
string

Published artifact name

noActivate
boolean
default:false

Create publish records without activating a site release

project
string

Console project id or slug

reason
string

Release reason sent to Console

replaceRelease
boolean

Replace the full active route map instead of merging

route
string

Site route path to mount the artifact at

site
string

Console site id or slug to release to

slug
string

Published artifact slug

uploadSession
string

Use an existing Console upload session

visibility
string

Requested visibility: private|protected_link|public

Response

Success — body conforms to the @Returns schema.

artifact
required
artifactVersion
required
authenticated
boolean
required
consoleUrl
string
required
localSync
object
required
publish
required
release
required
routes
object[]
required
site
required
success
boolean
required
upload
object
required
uploadSession
object | null
required
url
string | null
required