Give one person, by email, access to a private page (or its whole site with --site)
curl --request POST \
--url http://localhost:3000/api/v1/pages/share \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"console": "<string>",
"execute": true,
"expires": "<string>",
"reason": "<string>",
"site": true,
"with": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/pages/share"
payload = {
"url": "<string>",
"console": "<string>",
"execute": True,
"expires": "<string>",
"reason": "<string>",
"site": True,
"with": "<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({
url: '<string>',
console: '<string>',
execute: true,
expires: '<string>',
reason: '<string>',
site: true,
with: '<string>'
})
};
fetch('http://localhost:3000/api/v1/pages/share', 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/share",
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([
'url' => '<string>',
'console' => '<string>',
'execute' => true,
'expires' => '<string>',
'reason' => '<string>',
'site' => true,
'with' => '<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/share"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"console\": \"<string>\",\n \"execute\": true,\n \"expires\": \"<string>\",\n \"reason\": \"<string>\",\n \"site\": true,\n \"with\": \"<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/share")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"console\": \"<string>\",\n \"execute\": true,\n \"expires\": \"<string>\",\n \"reason\": \"<string>\",\n \"site\": true,\n \"with\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/pages/share")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"console\": \"<string>\",\n \"execute\": true,\n \"expires\": \"<string>\",\n \"reason\": \"<string>\",\n \"site\": true,\n \"with\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"actedBy": {
"kind": "operator"
},
"consoleUrl": "<string>",
"created": true,
"grant": {
"createdAt": "<string>",
"createdBy": "<string>",
"email": "<string>",
"expiresAt": "<string>",
"id": "<string>",
"name": "<string>",
"routeId": "<string>",
"routePath": "<string>",
"scope": "route",
"url": "<string>",
"userId": "<string>"
},
"success": true,
"userCreated": true
}pages
Give one person, by email, access to a private page (or its whole site with --site)
POST
/
api
/
v1
/
pages
/
share
Give one person, by email, access to a private page (or its whole site with --site)
curl --request POST \
--url http://localhost:3000/api/v1/pages/share \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"console": "<string>",
"execute": true,
"expires": "<string>",
"reason": "<string>",
"site": true,
"with": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/pages/share"
payload = {
"url": "<string>",
"console": "<string>",
"execute": True,
"expires": "<string>",
"reason": "<string>",
"site": True,
"with": "<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({
url: '<string>',
console: '<string>',
execute: true,
expires: '<string>',
reason: '<string>',
site: true,
with: '<string>'
})
};
fetch('http://localhost:3000/api/v1/pages/share', 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/share",
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([
'url' => '<string>',
'console' => '<string>',
'execute' => true,
'expires' => '<string>',
'reason' => '<string>',
'site' => true,
'with' => '<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/share"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"console\": \"<string>\",\n \"execute\": true,\n \"expires\": \"<string>\",\n \"reason\": \"<string>\",\n \"site\": true,\n \"with\": \"<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/share")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"console\": \"<string>\",\n \"execute\": true,\n \"expires\": \"<string>\",\n \"reason\": \"<string>\",\n \"site\": true,\n \"with\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/pages/share")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"console\": \"<string>\",\n \"execute\": true,\n \"expires\": \"<string>\",\n \"reason\": \"<string>\",\n \"site\": true,\n \"with\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"actedBy": {
"kind": "operator"
},
"consoleUrl": "<string>",
"created": true,
"grant": {
"createdAt": "<string>",
"createdBy": "<string>",
"email": "<string>",
"expiresAt": "<string>",
"id": "<string>",
"name": "<string>",
"routeId": "<string>",
"routePath": "<string>",
"scope": "route",
"url": "<string>",
"userId": "<string>"
},
"success": true,
"userCreated": true
}Body
application/json
Ravi Page URL, such as https://acme.ravi.page/report
Console base URL
Give the access. Without it, share prints the plan and exits 3
End of access: 30d, 12h, 2w, or an ISO date (max 365 days)
Why this person gets access (kept on the grant, max 500)
Share every private route of the page's site, not only this route
Email of the person who gets access