Generate applied policy report
Fetches the policy manifest for the project and renders it to a report document via the pdfgen service
post
https://localhost:10001/api/v1/projects/{projectId}/policies/reportbash
curl --request POST \
--url 'https://localhost:10001/api/v1/projects/{projectId}/policies/report' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{"format":"pdf","paper":"a4","policyCids":["string"]}'javascript
const response = await fetch("https://localhost:10001/api/v1/projects/{projectId}/policies/report", {
method: "POST",
headers: {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"format": "pdf",
"paper": "a4",
"policyCids": [
"string"
]
})
});
console.log(response.status);typescript
const response = await fetch("https://localhost:10001/api/v1/projects/{projectId}/policies/report", {
method: "POST",
headers: {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"format": "pdf",
"paper": "a4",
"policyCids": [
"string"
]
})
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);
console.log(response.status);python
import requests
response = requests.post(
"https://localhost:10001/api/v1/projects/{projectId}/policies/report",
headers={
"Authorization": "Bearer <token>",
"Content-Type": "application/json",
},
json={
"format": "pdf",
"paper": "a4",
"policyCids": [
"string",
],
},
)
response.raise_for_status()
print(response.status_code)go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
body := strings.NewReader(`{
"format": "pdf",
"paper": "a4",
"policyCids": [
"string"
]
}`)
req, err := http.NewRequest(http.MethodPost, "https://localhost:10001/api/v1/projects/{projectId}/policies/report", body)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <token>")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
data, err := io.ReadAll(res.Body)
if err != nil {
panic(err)
}
fmt.Println(res.Status, string(data))
}java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://localhost:10001/api/v1/projects/{projectId}/policies/report"))
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("""
{
"format": "pdf",
"paper": "a4",
"policyCids": [
"string"
]
}
"""))
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}csharp
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://localhost:10001/api/v1/projects/{projectId}/policies/report");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Content = new StringContent("""
{
"format": "pdf",
"paper": "a4",
"policyCids": [
"string"
]
}
""", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");php
<?php
$ch = curl_init('https://localhost:10001/api/v1/projects/{projectId}/policies/report');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer <token>',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"format": "pdf",
"paper": "a4",
"policyCids": [
"string"
]
}
JSON,
CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;ruby
require "net/http"
uri = URI("https://localhost:10001/api/v1/projects/{projectId}/policies/report")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
{
"format": "pdf",
"paper": "a4",
"policyCids": [
"string"
]
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"rust
// Cargo.toml dependencies: reqwest (features "json"), serde_json, tokio (features "full")
use serde_json::json;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let response = reqwest::Client::new()
.post("https://localhost:10001/api/v1/projects/{projectId}/policies/report")
.header("Authorization", "Bearer <token>")
.json(&json!({
"format": "pdf",
"paper": "a4",
"policyCids": [
"string"
]
}))
.send()
.await?;
println!("{} {}", response.status(), response.text().await?);
Ok(())
}Authorizations
BearerAuth· API key in header "Authorization" — Type "Bearer" followed by a space and JWT token.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
projectIdrequired | string | Project ID, UUID (urn:uuid optional), or slug:my-project |
Request bodyrequired
Policy report request
application/json
formatstringpdf returns a PDF, else a zip
paperstringpdfgen default when omitted
policyCidsstring[]requiredAt least one CID is required
Examplejson
{
"format": "pdf",
"paper": "a4",
"policyCids": [
"string"
]
}Responses
200Rendered policy report document
application/pdf
file
application/zip
file
400Bad request - Invalid project ID, request body, or missing policy CIDs
application/pdf
errorstring
application/zip
errorstring
401Unauthorized - Authentication required
application/pdf
errorstring
application/zip
errorstring
403Forbidden - No project access or insufficient permissions
application/pdf
errorstring
application/zip
errorstring
404Project not found
application/pdf
errorstring
application/zip
errorstring
500Internal server error
application/pdf
errorstring
application/zip
errorstring
502Bad gateway - pdfgen report generation failed
application/pdf
errorstring
application/zip
errorstring