> ## Documentation Index > Fetch the complete documentation index at: https://docs.myrqen.cc/llms.txt > Use this file to discover all available pages before exploring further. # Append live progress events > Privacy-safe progress only. The payload schema is **closed**, so the scanner cannot deliver source, prose, evidence, or secrets through this path even by accident — anything that fails the schema is rejected with `UNSAFE_PAYLOAD_REJECTED`. At most 25 events per request. Every event's `reportId` must match the path. Throttled at 600 events per minute per device and report. ## OpenAPI ````yaml /api-reference/openapi.json post /api/v1/reports/{id}/progress openapi: 3.1.0 info: title: Myrqen API version: 1.0.0 description: >- The JSON API served by `apps/web` under `/api/v1`. Derived from the route handlers in `apps/web/app/api/v1` and the shared types in `packages/contracts`. This reference documents the surface a developer and the Myrqen CLI actually use. Platform-administration and billing endpoints exist in the application but are operator-only and are deliberately not published here. The hosted service at `https://api.myrqen.cc` is not deployed yet. Run your own deployment and use its origin. license: name: Myrqen Source-Available Licence 1.0 url: https://github.com/stijnswapped/Myrqen/blob/main/LICENSE servers: - url: http://localhost:3000 description: >- A deployment you run yourself. Use this while the hosted service is unavailable. - url: https://api.myrqen.cc description: >- The hosted API. This is the CLI's shipped default, but the hosted service is NOT deployed yet, so requests to it do not resolve today. security: [] tags: - name: Health description: >- Liveness and readiness probes. Unauthenticated, and answered on any hostname. - name: Authentication description: Browser sessions. Password plus recovery codes; no email is ever sent. - name: Device linking description: Binding a machine's CLI to an account, via browser approval. - name: Workspaces and projects description: Where a scanned repository belongs. - name: Sync and quota description: Creating, feeding, and finalizing a cloud report. - name: Reports description: Reading and exporting a synced report. - name: Sharing description: Share links and the server-side projections they resolve to. - name: Analytics description: Allowlisted product-event ingest. - name: Updates description: The signed release manifest. paths: /api/v1/reports/{id}/progress: post: tags: - Sync and quota summary: Append live progress events description: >- Privacy-safe progress only. The payload schema is **closed**, so the scanner cannot deliver source, prose, evidence, or secrets through this path even by accident — anything that fails the schema is rejected with `UNSAFE_PAYLOAD_REJECTED`. At most 25 events per request. Every event's `reportId` must match the path. Throttled at 600 events per minute per device and report. operationId: appendProgress parameters: - $ref: '#/components/parameters/ReportId' requestBody: required: true content: application/json: schema: type: object required: - events properties: events: type: array minItems: 1 maxItems: 25 items: $ref: '#/components/schemas/SafeScanEvent' example: events: - eventId: evt_1 reportId: rep_… type: phase_started occurredAt: '2026-08-20T10:00:00.000Z' phase: discovery safeCode: PHASE_STARTED responses: '200': description: Accepted. content: application/json: schema: type: object required: - accepted - rejected properties: accepted: type: integer rejected: type: integer example: accepted: 1 rejected: 0 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '404': $ref: '#/components/responses/NotFound' '410': $ref: '#/components/responses/Gone' '422': description: >- `UNSAFE_PAYLOAD_REJECTED` — an event did not match the closed safe-event schema. content: application/json: schema: $ref: '#/components/schemas/ApiError' '429': $ref: '#/components/responses/RateLimited' security: - deviceToken: [] components: parameters: ReportId: name: id in: path required: true schema: type: string description: The cloud report id. schemas: SafeScanEvent: type: object required: - eventId - reportId - type - occurredAt description: >- The closed live-progress payload. `schemas/scan-event.schema.json` is the contract; anything outside it is rejected with `UNSAFE_PAYLOAD_REJECTED`. properties: eventId: type: string reportId: type: string type: type: string enum: - report_created - phase_started - phase_completed - aggregate_updated - warning_safe - scan_completed - scan_failed occurredAt: type: string format: date-time phase: $ref: '#/components/schemas/ScanPhase' safeCode: type: string description: A stable machine-readable code. message: type: string durationMs: type: integer aggregate: type: object description: Counts only. properties: candidateCount: type: integer validatedCount: type: integer critical: type: integer high: type: integer medium: type: integer low: type: integer info: type: integer ApiError: type: object required: - error properties: error: type: object required: - code - message - requestId properties: code: $ref: '#/components/schemas/ApiErrorCode' message: type: string description: Human-readable. May change; branch on `code`. requestId: type: string description: A fresh UUID per response, for correlating with server logs. details: type: object additionalProperties: true example: error: code: SYNC_WEEKLY_LIMIT_REACHED message: Cloud report limit reached. This scan stays local. requestId: 8f14e45f-ceea-467a-9f8b-2b6b2b6a1f2c details: weekly: used: 15 limit: 15 resetsAt: '2026-08-24T06:00:00.000Z' ScanPhase: type: string enum: - preflight - scope - discovery - source_review - runtime_validation - access_control - validation - reporting ApiErrorCode: type: string enum: - BAD_REQUEST - VALIDATION_FAILED - UNAUTHENTICATED - FORBIDDEN - NOT_FOUND - CONFLICT - RATE_LIMITED - INTERNAL - DEVICE_LINK_EXPIRED - DEVICE_LINK_ALREADY_CONSUMED - DEVICE_LINK_NOT_APPROVED - DEVICE_REVOKED - SYNC_DAILY_LIMIT_REACHED - SYNC_WEEKLY_LIMIT_REACHED - REPORT_EXPIRED - REPORT_SCHEMA_UNSUPPORTED - UNSAFE_PAYLOAD_REJECTED - SHARE_PASSWORD_REQUIRED - SHARE_NOT_AVAILABLE - CLIENT_VERSION_REVOKED - CLIENT_VERSION_TOO_OLD - SUPPORT_GRANT_REQUIRED responses: BadRequest: description: >- `BAD_REQUEST`. Also returned with HTTP 413 when a body exceeds the endpoint's byte limit. content: application/json: schema: $ref: '#/components/schemas/ApiError' Unauthenticated: description: >- `UNAUTHENTICATED` — no credential, a malformed credential, or one that did not match. `DEVICE_REVOKED` also uses 401. content: application/json: schema: $ref: '#/components/schemas/ApiError' NotFound: description: >- `NOT_FOUND` — the resource does not exist, or exists and you may not know that. content: application/json: schema: $ref: '#/components/schemas/ApiError' Gone: description: >- `REPORT_EXPIRED` or `DEVICE_LINK_EXPIRED` — the resource passed its window and its contents were deleted. content: application/json: schema: $ref: '#/components/schemas/ApiError' RateLimited: description: '`RATE_LIMITED` — a throttle was exceeded.' content: application/json: schema: $ref: '#/components/schemas/ApiError' securitySchemes: deviceToken: type: http scheme: bearer description: >- The CLI's device credential, obtained once from the device-link exchange and stored in the OS keystore. Sent as `Authorization: Bearer myrq_dev_…`. The server never trusts a CLI-supplied user id — identity comes from the credential row. ````