Update report visibility

Change a report's visibility

PATCH/v1/reports/{id}

Change a report's visibility. Owner only: a non-owner (or unauthenticated request) gets 404, never revealing the report's existence. Visibility changes carry no separate credit charge; publishing is included in the audit's base charge.

Path parameters

idstringrequired

Report id.

Request bodyrequired

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

Available options: public, unlisted, private

Responses

Updated visibility.

idstringrequired

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

Available options: public, unlisted, private

urlstring (uri)required

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

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

import requests


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

{
  "id": "<string>",
  "visibility": "public",
  "url": "<url>"
}

{
  "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