curl --request POST \
--url http://localhost:3000/api/v1/pages/ship \
--header 'Content-Type: application/json' \
--data '
{
"args": [
"<string>"
],
"body": "<string>",
"console": "<string>",
"dir": "<string>",
"entrypoint": "<string>",
"execute": true,
"html": "<string>",
"membersBestEffort": true,
"project": "<string>",
"route": "<string>",
"theme": "<string>",
"title": "<string>",
"uses": [
"<string>"
],
"visibility": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/pages/ship"
payload = {
"args": ["<string>"],
"body": "<string>",
"console": "<string>",
"dir": "<string>",
"entrypoint": "<string>",
"execute": True,
"html": "<string>",
"membersBestEffort": True,
"project": "<string>",
"route": "<string>",
"theme": "<string>",
"title": "<string>",
"uses": ["<string>"],
"visibility": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
args: ['<string>'],
body: JSON.stringify('<string>'),
console: '<string>',
dir: '<string>',
entrypoint: '<string>',
execute: true,
html: '<string>',
membersBestEffort: true,
project: '<string>',
route: '<string>',
theme: '<string>',
title: '<string>',
uses: ['<string>'],
visibility: '<string>'
})
};
fetch('http://localhost:3000/api/v1/pages/ship', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/pages/ship",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'args' => [
'<string>'
],
'body' => '<string>',
'console' => '<string>',
'dir' => '<string>',
'entrypoint' => '<string>',
'execute' => true,
'html' => '<string>',
'membersBestEffort' => true,
'project' => '<string>',
'route' => '<string>',
'theme' => '<string>',
'title' => '<string>',
'uses' => [
'<string>'
],
'visibility' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/v1/pages/ship"
payload := strings.NewReader("{\n \"args\": [\n \"<string>\"\n ],\n \"body\": \"<string>\",\n \"console\": \"<string>\",\n \"dir\": \"<string>\",\n \"entrypoint\": \"<string>\",\n \"execute\": true,\n \"html\": \"<string>\",\n \"membersBestEffort\": true,\n \"project\": \"<string>\",\n \"route\": \"<string>\",\n \"theme\": \"<string>\",\n \"title\": \"<string>\",\n \"uses\": [\n \"<string>\"\n ],\n \"visibility\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/v1/pages/ship")
.header("Content-Type", "application/json")
.body("{\n \"args\": [\n \"<string>\"\n ],\n \"body\": \"<string>\",\n \"console\": \"<string>\",\n \"dir\": \"<string>\",\n \"entrypoint\": \"<string>\",\n \"execute\": true,\n \"html\": \"<string>\",\n \"membersBestEffort\": true,\n \"project\": \"<string>\",\n \"route\": \"<string>\",\n \"theme\": \"<string>\",\n \"title\": \"<string>\",\n \"uses\": [\n \"<string>\"\n ],\n \"visibility\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/pages/ship")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"args\": [\n \"<string>\"\n ],\n \"body\": \"<string>\",\n \"console\": \"<string>\",\n \"dir\": \"<string>\",\n \"entrypoint\": \"<string>\",\n \"execute\": true,\n \"html\": \"<string>\",\n \"membersBestEffort\": true,\n \"project\": \"<string>\",\n \"route\": \"<string>\",\n \"theme\": \"<string>\",\n \"title\": \"<string>\",\n \"uses\": [\n \"<string>\"\n ],\n \"visibility\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"artifactId": "<string>",
"commentFollow": {
"ok": true,
"session": "main",
"topic": "<string>",
"agentId": "<string>",
"filter": "<string>",
"orgId": "<string>",
"pageId": "<string>",
"projectId": "<string>",
"rebound": true,
"replacedTriggerId": "<string>",
"replySession": "<string>",
"reused": true,
"routePath": "<string>",
"skipped": "missing_page",
"triggerId": "<string>",
"warning": "<string>"
},
"kit": {
"changedFiles": [
"<string>"
],
"status": "applied",
"theme": {},
"warnings": [
"<string>"
],
"widgets": [
{}
]
},
"presentation": {},
"route": "<string>",
"site": {},
"slug": "<string>",
"success": true,
"url": "<string>",
"visibility": "<string>",
"uses": [
"<string>"
],
"warnings": [
"<string>"
]
}One-shot: publish a route on the project default Pages host
curl --request POST \
--url http://localhost:3000/api/v1/pages/ship \
--header 'Content-Type: application/json' \
--data '
{
"args": [
"<string>"
],
"body": "<string>",
"console": "<string>",
"dir": "<string>",
"entrypoint": "<string>",
"execute": true,
"html": "<string>",
"membersBestEffort": true,
"project": "<string>",
"route": "<string>",
"theme": "<string>",
"title": "<string>",
"uses": [
"<string>"
],
"visibility": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/pages/ship"
payload = {
"args": ["<string>"],
"body": "<string>",
"console": "<string>",
"dir": "<string>",
"entrypoint": "<string>",
"execute": True,
"html": "<string>",
"membersBestEffort": True,
"project": "<string>",
"route": "<string>",
"theme": "<string>",
"title": "<string>",
"uses": ["<string>"],
"visibility": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
args: ['<string>'],
body: JSON.stringify('<string>'),
console: '<string>',
dir: '<string>',
entrypoint: '<string>',
execute: true,
html: '<string>',
membersBestEffort: true,
project: '<string>',
route: '<string>',
theme: '<string>',
title: '<string>',
uses: ['<string>'],
visibility: '<string>'
})
};
fetch('http://localhost:3000/api/v1/pages/ship', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/pages/ship",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'args' => [
'<string>'
],
'body' => '<string>',
'console' => '<string>',
'dir' => '<string>',
'entrypoint' => '<string>',
'execute' => true,
'html' => '<string>',
'membersBestEffort' => true,
'project' => '<string>',
'route' => '<string>',
'theme' => '<string>',
'title' => '<string>',
'uses' => [
'<string>'
],
'visibility' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/v1/pages/ship"
payload := strings.NewReader("{\n \"args\": [\n \"<string>\"\n ],\n \"body\": \"<string>\",\n \"console\": \"<string>\",\n \"dir\": \"<string>\",\n \"entrypoint\": \"<string>\",\n \"execute\": true,\n \"html\": \"<string>\",\n \"membersBestEffort\": true,\n \"project\": \"<string>\",\n \"route\": \"<string>\",\n \"theme\": \"<string>\",\n \"title\": \"<string>\",\n \"uses\": [\n \"<string>\"\n ],\n \"visibility\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/v1/pages/ship")
.header("Content-Type", "application/json")
.body("{\n \"args\": [\n \"<string>\"\n ],\n \"body\": \"<string>\",\n \"console\": \"<string>\",\n \"dir\": \"<string>\",\n \"entrypoint\": \"<string>\",\n \"execute\": true,\n \"html\": \"<string>\",\n \"membersBestEffort\": true,\n \"project\": \"<string>\",\n \"route\": \"<string>\",\n \"theme\": \"<string>\",\n \"title\": \"<string>\",\n \"uses\": [\n \"<string>\"\n ],\n \"visibility\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/pages/ship")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"args\": [\n \"<string>\"\n ],\n \"body\": \"<string>\",\n \"console\": \"<string>\",\n \"dir\": \"<string>\",\n \"entrypoint\": \"<string>\",\n \"execute\": true,\n \"html\": \"<string>\",\n \"membersBestEffort\": true,\n \"project\": \"<string>\",\n \"route\": \"<string>\",\n \"theme\": \"<string>\",\n \"title\": \"<string>\",\n \"uses\": [\n \"<string>\"\n ],\n \"visibility\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"artifactId": "<string>",
"commentFollow": {
"ok": true,
"session": "main",
"topic": "<string>",
"agentId": "<string>",
"filter": "<string>",
"orgId": "<string>",
"pageId": "<string>",
"projectId": "<string>",
"rebound": true,
"replacedTriggerId": "<string>",
"replySession": "<string>",
"reused": true,
"routePath": "<string>",
"skipped": "missing_page",
"triggerId": "<string>",
"warning": "<string>"
},
"kit": {
"changedFiles": [
"<string>"
],
"status": "applied",
"theme": {},
"warnings": [
"<string>"
],
"widgets": [
{}
]
},
"presentation": {},
"route": "<string>",
"site": {},
"slug": "<string>",
"success": true,
"url": "<string>",
"visibility": "<string>",
"uses": [
"<string>"
],
"warnings": [
"<string>"
]
}Body
[project] [slug]; project defaults to Console scope. A slug is a legacy extra host. Omit it to use the project default host
HTML body fragment wrapped in a simple HTML5 document
Console base URL
Directory with an entrypoint (default index.html)
Package entrypoint path (default: index.html)
Accepted and ignored for compatibility. pages ship always publishes
Path to an HTML file to publish
Ship ravi.bases.* uses on a public route anyway. Only org members already signed in get live data
Console project id or slug; overrides saved Console scope
Pages route path to mount content at (default: /)
Theme for this ship: a theme ref, or none. Default: the project theme, else the org theme
Page title. Does not create a host slug
Capability ids to declare on the publish, such as ravi.identity.assertion. Repeat or comma-separate. Does not embed a JWT
Pages visibility: private|protected_link|public (default: private)
Response
Success — body conforms to the @Returns schema.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes