Scanner API Reference
| Field | Value |
|---|---|
| Source spec | scanner/openapi/scan-completed-stream.v1.json |
| OpenAPI version | 3.1.1 |
| API version | 1.0.0 |
| Operations | 2 |
| Path filter | All paths |
Operations
POST /api/v1/scans/completed/consumers/{consumerId}
Register or report a scanner completion consumer cursor
Registers/resets a remote consumer or reports its exact durable tenant cursor for the Scanner-owned retention floor.
| Property | Value |
|---|---|
| Operation ID | scanner.scans.completed.consumer |
| Tags | Scans |
| Auth | Required |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
consumerId | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
400 | Bad Request | application/json |
401 | Unauthorized | - |
403 | Forbidden | - |
409 | Conflict | application/json |
GET /api/v1/scans/completed/events
Retained scanner.scan.completed event feed
Returns the authenticated tenant’s ordered P6 scanner.scans envelopes after a durable tenant cursor with explicit epoch, head, retention-horizon and bootstrap signals.
| Property | Value |
|---|---|
| Operation ID | scanner.scans.completed.stream |
| Tags | Scans |
| Auth | Required |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
afterSeq | query | no | |
limit | query | no | |
maxBytes | query | no | |
streamEpoch | query | no |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
400 | Bad Request | application/json |
401 | Unauthorized | - |
403 | Forbidden | - |