pinakes/docs/api/scan.md
NotAShelf 934691c0f9
docs: auto-generate API route documentation
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: Id0d1f9769b7ccdbf83d5fa78adef62e46a6a6964
2026-03-22 22:04:52 +03:00

645 B

Scan

Directory scanning

Endpoints

POST /api/v1/scan

Trigger a scan as a background job. Returns the job ID immediately.

Authentication: Required (Bearer JWT)

Request Body

Content-Type: application/json

See docs/api/openapi.json for the full schema.

Responses

Status Description
200 Scan job submitted
401 Unauthorized
403 Forbidden
500 Internal server error

GET /api/v1/scan/status

Authentication: Required (Bearer JWT)

Responses

Status Description
200 Scan status
401 Unauthorized