Search documentation

Find pages, sections, and snippets across the Clog docs.

Report a broken link (404)

POST
/external/link-health

Reports a 404 from a consumer site. Low-friction — requires only a valid API key bound to the workspace (no per-route permission). Idempotent: the service upserts on (workspaceId, path), bumping hitCount on repeat reports.

Authorization

ApiKeyAuth
X-API-Key<token>

Workspace-scoped API key, e.g. clog_live_AbCdEfGh.... Passed in the X-API-Key header on every request.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/external/link-health" \  -H "Content-Type: application/json" \  -d '{    "path": "string"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
  "path": "string",
  "referrer": "string",
  "hitCount": 0,
  "firstSeenAt": "2019-08-24T14:15:22Z",
  "lastSeenAt": "2019-08-24T14:15:22Z",
  "resolvedAt": "2019-08-24T14:15:22Z",
  "resolvedBy": "string"
}
{
  "code": "BAD_REQUEST",
  "message": "string",
  "details": null
}
{
  "code": "BAD_REQUEST",
  "message": "string",
  "details": null
}
{
  "code": "BAD_REQUEST",
  "message": "string",
  "details": null
}