Skip to main content
POST
/
api
/
v1
/
workers
/
janitor
/
scan
curl -X POST https://alfred.black/api/v1/workers/janitor/scan \
  -H "Authorization: Bearer alf_your_key_here" \
  -H "Content-Type: application/json"

{
  "files_scanned": 423,
  "issues_found": 12
}
Runs a one-time structural health scan of your vault. The Janitor checks for broken links, invalid frontmatter, orphaned records, and other structural issues. This is a read-only operation that reports problems without modifying any files.
This is a scan-only operation. To scan and fix issues automatically, use the fix endpoint instead.
curl -X POST https://alfred.black/api/v1/workers/janitor/scan \
  -H "Authorization: Bearer alf_your_key_here" \
  -H "Content-Type: application/json"

{
  "files_scanned": 423,
  "issues_found": 12
}
If the response contains structured JSON, it is returned directly. Otherwise, the output is returned in a raw field.
​
raw
string
Human-readable output when structured JSON is not available.