Create a share link
curl --request POST \
--url http://localhost:3000/api/v1/reports/{id}/shares \
--header 'Content-Type: application/json' \
--cookie myrqen_session= \
--data '
{
"defaultPolicy": {
"version": 1,
"sections": {
"ids": []
},
"findings": {
"ids": [
"<string>"
]
},
"fields": {
"evidence": true,
"code": true,
"reproduction": true,
"remediation": true,
"metadata": true
},
"anonymize": true
},
"password": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"anonymousAllowed": true,
"principals": [
{
"policy": {
"version": 1,
"sections": {
"ids": []
},
"findings": {
"ids": [
"<string>"
]
},
"fields": {
"evidence": true,
"code": true,
"reproduction": true,
"remediation": true,
"metadata": true
},
"anonymize": true
},
"principalValue": "<string>",
"label": "<string>"
}
]
}
'import requests
url = "http://localhost:3000/api/v1/reports/{id}/shares"
payload = {
"defaultPolicy": {
"version": 1,
"sections": { "ids": [] },
"findings": { "ids": ["<string>"] },
"fields": {
"evidence": True,
"code": True,
"reproduction": True,
"remediation": True,
"metadata": True
},
"anonymize": True
},
"password": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"anonymousAllowed": True,
"principals": [
{
"policy": {
"version": 1,
"sections": { "ids": [] },
"findings": { "ids": ["<string>"] },
"fields": {
"evidence": True,
"code": True,
"reproduction": True,
"remediation": True,
"metadata": True
},
"anonymize": True
},
"principalValue": "<string>",
"label": "<string>"
}
]
}
headers = {
"cookie": "myrqen_session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'myrqen_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
defaultPolicy: {
version: 1,
sections: {ids: []},
findings: {ids: ['<string>']},
fields: {
evidence: true,
code: true,
reproduction: true,
remediation: true,
metadata: true
},
anonymize: true
},
password: '<string>',
expiresAt: '2023-11-07T05:31:56Z',
anonymousAllowed: true,
principals: [
{
policy: {
version: 1,
sections: {ids: []},
findings: {ids: ['<string>']},
fields: {
evidence: true,
code: true,
reproduction: true,
remediation: true,
metadata: true
},
anonymize: true
},
principalValue: '<string>',
label: '<string>'
}
]
})
};
fetch('http://localhost:3000/api/v1/reports/{id}/shares', 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/reports/{id}/shares",
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([
'defaultPolicy' => [
'version' => 1,
'sections' => [
'ids' => [
]
],
'findings' => [
'ids' => [
'<string>'
]
],
'fields' => [
'evidence' => true,
'code' => true,
'reproduction' => true,
'remediation' => true,
'metadata' => true
],
'anonymize' => true
],
'password' => '<string>',
'expiresAt' => '2023-11-07T05:31:56Z',
'anonymousAllowed' => true,
'principals' => [
[
'policy' => [
'version' => 1,
'sections' => [
'ids' => [
]
],
'findings' => [
'ids' => [
'<string>'
]
],
'fields' => [
'evidence' => true,
'code' => true,
'reproduction' => true,
'remediation' => true,
'metadata' => true
],
'anonymize' => true
],
'principalValue' => '<string>',
'label' => '<string>'
]
]
]),
CURLOPT_COOKIE => "myrqen_session=",
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/reports/{id}/shares"
payload := strings.NewReader("{\n \"defaultPolicy\": {\n \"version\": 1,\n \"sections\": {\n \"ids\": []\n },\n \"findings\": {\n \"ids\": [\n \"<string>\"\n ]\n },\n \"fields\": {\n \"evidence\": true,\n \"code\": true,\n \"reproduction\": true,\n \"remediation\": true,\n \"metadata\": true\n },\n \"anonymize\": true\n },\n \"password\": \"<string>\",\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"anonymousAllowed\": true,\n \"principals\": [\n {\n \"policy\": {\n \"version\": 1,\n \"sections\": {\n \"ids\": []\n },\n \"findings\": {\n \"ids\": [\n \"<string>\"\n ]\n },\n \"fields\": {\n \"evidence\": true,\n \"code\": true,\n \"reproduction\": true,\n \"remediation\": true,\n \"metadata\": true\n },\n \"anonymize\": true\n },\n \"principalValue\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "myrqen_session=")
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/reports/{id}/shares")
.header("cookie", "myrqen_session=")
.header("Content-Type", "application/json")
.body("{\n \"defaultPolicy\": {\n \"version\": 1,\n \"sections\": {\n \"ids\": []\n },\n \"findings\": {\n \"ids\": [\n \"<string>\"\n ]\n },\n \"fields\": {\n \"evidence\": true,\n \"code\": true,\n \"reproduction\": true,\n \"remediation\": true,\n \"metadata\": true\n },\n \"anonymize\": true\n },\n \"password\": \"<string>\",\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"anonymousAllowed\": true,\n \"principals\": [\n {\n \"policy\": {\n \"version\": 1,\n \"sections\": {\n \"ids\": []\n },\n \"findings\": {\n \"ids\": [\n \"<string>\"\n ]\n },\n \"fields\": {\n \"evidence\": true,\n \"code\": true,\n \"reproduction\": true,\n \"remediation\": true,\n \"metadata\": true\n },\n \"anonymize\": true\n },\n \"principalValue\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/reports/{id}/shares")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["cookie"] = 'myrqen_session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"defaultPolicy\": {\n \"version\": 1,\n \"sections\": {\n \"ids\": []\n },\n \"findings\": {\n \"ids\": [\n \"<string>\"\n ]\n },\n \"fields\": {\n \"evidence\": true,\n \"code\": true,\n \"reproduction\": true,\n \"remediation\": true,\n \"metadata\": true\n },\n \"anonymize\": true\n },\n \"password\": \"<string>\",\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"anonymousAllowed\": true,\n \"principals\": [\n {\n \"policy\": {\n \"version\": 1,\n \"sections\": {\n \"ids\": []\n },\n \"findings\": {\n \"ids\": [\n \"<string>\"\n ]\n },\n \"fields\": {\n \"evidence\": true,\n \"code\": true,\n \"reproduction\": true,\n \"remediation\": true,\n \"metadata\": true\n },\n \"anonymize\": true\n },\n \"principalValue\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"shareId": "<string>",
"slug": "<string>",
"url": "<string>"
}{
"error": {
"code": "SYNC_WEEKLY_LIMIT_REACHED",
"message": "Cloud report limit reached. This scan stays local.",
"requestId": "8f14e45f-ceea-467a-9f8b-2b6b2b6a1f2c",
"details": {
"weekly": {
"used": 15,
"limit": 15,
"resetsAt": "2026-08-24T06:00:00.000Z"
}
}
}
}{
"error": {
"code": "SYNC_WEEKLY_LIMIT_REACHED",
"message": "Cloud report limit reached. This scan stays local.",
"requestId": "8f14e45f-ceea-467a-9f8b-2b6b2b6a1f2c",
"details": {
"weekly": {
"used": 15,
"limit": 15,
"resetsAt": "2026-08-24T06:00:00.000Z"
}
}
}
}{
"error": {
"code": "SYNC_WEEKLY_LIMIT_REACHED",
"message": "Cloud report limit reached. This scan stays local.",
"requestId": "8f14e45f-ceea-467a-9f8b-2b6b2b6a1f2c",
"details": {
"weekly": {
"used": 15,
"limit": 15,
"resetsAt": "2026-08-24T06:00:00.000Z"
}
}
}
}{
"error": {
"code": "SYNC_WEEKLY_LIMIT_REACHED",
"message": "Cloud report limit reached. This scan stays local.",
"requestId": "8f14e45f-ceea-467a-9f8b-2b6b2b6a1f2c",
"details": {
"weekly": {
"used": 15,
"limit": 15,
"resetsAt": "2026-08-24T06:00:00.000Z"
}
}
}
}Sharing
Create a share link
Only the report owner may create a share, and the slug is returned exactly once. Anonymous access is honoured only when the mode is anyone_with_link.
Active shares per report are capped by plan: 5 on free, 25 on pro, 100 on team, 1000 on enterprise.
POST
/
api
/
v1
/
reports
/
{id}
/
shares
Create a share link
curl --request POST \
--url http://localhost:3000/api/v1/reports/{id}/shares \
--header 'Content-Type: application/json' \
--cookie myrqen_session= \
--data '
{
"defaultPolicy": {
"version": 1,
"sections": {
"ids": []
},
"findings": {
"ids": [
"<string>"
]
},
"fields": {
"evidence": true,
"code": true,
"reproduction": true,
"remediation": true,
"metadata": true
},
"anonymize": true
},
"password": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"anonymousAllowed": true,
"principals": [
{
"policy": {
"version": 1,
"sections": {
"ids": []
},
"findings": {
"ids": [
"<string>"
]
},
"fields": {
"evidence": true,
"code": true,
"reproduction": true,
"remediation": true,
"metadata": true
},
"anonymize": true
},
"principalValue": "<string>",
"label": "<string>"
}
]
}
'import requests
url = "http://localhost:3000/api/v1/reports/{id}/shares"
payload = {
"defaultPolicy": {
"version": 1,
"sections": { "ids": [] },
"findings": { "ids": ["<string>"] },
"fields": {
"evidence": True,
"code": True,
"reproduction": True,
"remediation": True,
"metadata": True
},
"anonymize": True
},
"password": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"anonymousAllowed": True,
"principals": [
{
"policy": {
"version": 1,
"sections": { "ids": [] },
"findings": { "ids": ["<string>"] },
"fields": {
"evidence": True,
"code": True,
"reproduction": True,
"remediation": True,
"metadata": True
},
"anonymize": True
},
"principalValue": "<string>",
"label": "<string>"
}
]
}
headers = {
"cookie": "myrqen_session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'myrqen_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
defaultPolicy: {
version: 1,
sections: {ids: []},
findings: {ids: ['<string>']},
fields: {
evidence: true,
code: true,
reproduction: true,
remediation: true,
metadata: true
},
anonymize: true
},
password: '<string>',
expiresAt: '2023-11-07T05:31:56Z',
anonymousAllowed: true,
principals: [
{
policy: {
version: 1,
sections: {ids: []},
findings: {ids: ['<string>']},
fields: {
evidence: true,
code: true,
reproduction: true,
remediation: true,
metadata: true
},
anonymize: true
},
principalValue: '<string>',
label: '<string>'
}
]
})
};
fetch('http://localhost:3000/api/v1/reports/{id}/shares', 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/reports/{id}/shares",
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([
'defaultPolicy' => [
'version' => 1,
'sections' => [
'ids' => [
]
],
'findings' => [
'ids' => [
'<string>'
]
],
'fields' => [
'evidence' => true,
'code' => true,
'reproduction' => true,
'remediation' => true,
'metadata' => true
],
'anonymize' => true
],
'password' => '<string>',
'expiresAt' => '2023-11-07T05:31:56Z',
'anonymousAllowed' => true,
'principals' => [
[
'policy' => [
'version' => 1,
'sections' => [
'ids' => [
]
],
'findings' => [
'ids' => [
'<string>'
]
],
'fields' => [
'evidence' => true,
'code' => true,
'reproduction' => true,
'remediation' => true,
'metadata' => true
],
'anonymize' => true
],
'principalValue' => '<string>',
'label' => '<string>'
]
]
]),
CURLOPT_COOKIE => "myrqen_session=",
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/reports/{id}/shares"
payload := strings.NewReader("{\n \"defaultPolicy\": {\n \"version\": 1,\n \"sections\": {\n \"ids\": []\n },\n \"findings\": {\n \"ids\": [\n \"<string>\"\n ]\n },\n \"fields\": {\n \"evidence\": true,\n \"code\": true,\n \"reproduction\": true,\n \"remediation\": true,\n \"metadata\": true\n },\n \"anonymize\": true\n },\n \"password\": \"<string>\",\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"anonymousAllowed\": true,\n \"principals\": [\n {\n \"policy\": {\n \"version\": 1,\n \"sections\": {\n \"ids\": []\n },\n \"findings\": {\n \"ids\": [\n \"<string>\"\n ]\n },\n \"fields\": {\n \"evidence\": true,\n \"code\": true,\n \"reproduction\": true,\n \"remediation\": true,\n \"metadata\": true\n },\n \"anonymize\": true\n },\n \"principalValue\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "myrqen_session=")
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/reports/{id}/shares")
.header("cookie", "myrqen_session=")
.header("Content-Type", "application/json")
.body("{\n \"defaultPolicy\": {\n \"version\": 1,\n \"sections\": {\n \"ids\": []\n },\n \"findings\": {\n \"ids\": [\n \"<string>\"\n ]\n },\n \"fields\": {\n \"evidence\": true,\n \"code\": true,\n \"reproduction\": true,\n \"remediation\": true,\n \"metadata\": true\n },\n \"anonymize\": true\n },\n \"password\": \"<string>\",\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"anonymousAllowed\": true,\n \"principals\": [\n {\n \"policy\": {\n \"version\": 1,\n \"sections\": {\n \"ids\": []\n },\n \"findings\": {\n \"ids\": [\n \"<string>\"\n ]\n },\n \"fields\": {\n \"evidence\": true,\n \"code\": true,\n \"reproduction\": true,\n \"remediation\": true,\n \"metadata\": true\n },\n \"anonymize\": true\n },\n \"principalValue\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/reports/{id}/shares")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["cookie"] = 'myrqen_session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"defaultPolicy\": {\n \"version\": 1,\n \"sections\": {\n \"ids\": []\n },\n \"findings\": {\n \"ids\": [\n \"<string>\"\n ]\n },\n \"fields\": {\n \"evidence\": true,\n \"code\": true,\n \"reproduction\": true,\n \"remediation\": true,\n \"metadata\": true\n },\n \"anonymize\": true\n },\n \"password\": \"<string>\",\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"anonymousAllowed\": true,\n \"principals\": [\n {\n \"policy\": {\n \"version\": 1,\n \"sections\": {\n \"ids\": []\n },\n \"findings\": {\n \"ids\": [\n \"<string>\"\n ]\n },\n \"fields\": {\n \"evidence\": true,\n \"code\": true,\n \"reproduction\": true,\n \"remediation\": true,\n \"metadata\": true\n },\n \"anonymize\": true\n },\n \"principalValue\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"shareId": "<string>",
"slug": "<string>",
"url": "<string>"
}{
"error": {
"code": "SYNC_WEEKLY_LIMIT_REACHED",
"message": "Cloud report limit reached. This scan stays local.",
"requestId": "8f14e45f-ceea-467a-9f8b-2b6b2b6a1f2c",
"details": {
"weekly": {
"used": 15,
"limit": 15,
"resetsAt": "2026-08-24T06:00:00.000Z"
}
}
}
}{
"error": {
"code": "SYNC_WEEKLY_LIMIT_REACHED",
"message": "Cloud report limit reached. This scan stays local.",
"requestId": "8f14e45f-ceea-467a-9f8b-2b6b2b6a1f2c",
"details": {
"weekly": {
"used": 15,
"limit": 15,
"resetsAt": "2026-08-24T06:00:00.000Z"
}
}
}
}{
"error": {
"code": "SYNC_WEEKLY_LIMIT_REACHED",
"message": "Cloud report limit reached. This scan stays local.",
"requestId": "8f14e45f-ceea-467a-9f8b-2b6b2b6a1f2c",
"details": {
"weekly": {
"used": 15,
"limit": 15,
"resetsAt": "2026-08-24T06:00:00.000Z"
}
}
}
}{
"error": {
"code": "SYNC_WEEKLY_LIMIT_REACHED",
"message": "Cloud report limit reached. This scan stays local.",
"requestId": "8f14e45f-ceea-467a-9f8b-2b6b2b6a1f2c",
"details": {
"weekly": {
"used": 15,
"limit": 15,
"resetsAt": "2026-08-24T06:00:00.000Z"
}
}
}
}Authorizations
Browser session cookie: httpOnly, sameSite=lax, Secure when APP_BASE_URL is https, 30-day lifetime. Deliberately separate from CLI device credentials.
Path Parameters
The cloud report id.
Body
application/json
Available options:
private, workspace, account_allowlist, unlisted, anyone_with_link A typed, testable projection rule set. Deliberately not a programmable policy language.
Show child attributes
Show child attributes
Honoured only when mode is anyone_with_link.
Show child attributes
Show child attributes
⌘I