Publish a report

Publish an audit report

POST / v1 / reports

Publish an audit report. The report payload is the full `AuditReport` produced by the CLI/engine. Visibility defaults to `private`. **Publishing is included in the audit's base charge**; no visibility carries a separate credit charge. `unlisted` and `private` publishes always create a new report (no idempotency). Org-scoped `public` publishes are keyed on the publisher + a content hash: republishing the identical payload is an idempotent replay, returning the original report with `200` if the prior response was cached, or `409` otherwise (still in flight / not cached).

Request body required

reportobjectrequired

The full audit report payload produced by the squirrelscan engine. Only the high-signal top-level fields are documented here; the complete schema is validated server-side (see `apps/api/src/schemas/audit-report.ts`). Extra top-level fields are accepted but ignored (the server-side schema strips unknown keys rather than rejecting them) — hence `additionalProperties: true`. The documented fields below are still validated and must conform.

visibilityanydefault: private

Responses

Idempotent replay of an identical org-scoped `public` publish whose original response was cached — returns the originally published report.

id string required

url string (uri) required

visibility "public" | "unlisted" | "private" required

Available options: public, unlisted, private

createdAt string (date-time) required

curl --request POST \
  --url "https://api.squirrelscan.com/v1/reports"

const res = await fetch("https://api.squirrelscan.com/v1/reports", {
  method: "POST",
});
const data = await res.json();

import requests


r = requests.post("https://api.squirrelscan.com/v1/reports")
r.raise_for_status()
data = r.json()

{
  "id": "<string>",
  "url": "<url>",
  "visibility": "public",
  "createdAt": "2023-11-07T05:31:56Z"
}

{
  "id": "<string>",
  "url": "<url>",
  "visibility": "public",
  "createdAt": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

Edit this page