NotAShelf
9e5eb41d39
Signed-off-by: NotAShelf <raf@notashelf.dev> Change-Id: I4806c58aa0a17f504c9312723ad770166a6a6964
41 lines
709 B
Markdown
Vendored
41 lines
709 B
Markdown
Vendored
# 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 |
|
|
|
|
---
|