> ## 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. # Start a device link > Unauthenticated bootstrap. The CLI keeps a verifier locally and sends only its SHA-256 hash. The response carries an opaque public request id and a browser approval URL — never a bearer credential. Link requests live 10 minutes. The device name, client version, OS family, and architecture are sanitized server-side before storage. ## OpenAPI ````yaml /api-reference/openapi.json post /api/v1/device-links 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/device-links: post: tags: - Device linking summary: Start a device link description: >- Unauthenticated bootstrap. The CLI keeps a verifier locally and sends only its SHA-256 hash. The response carries an opaque public request id and a browser approval URL — never a bearer credential. Link requests live 10 minutes. The device name, client version, OS family, and architecture are sanitized server-side before storage. operationId: createDeviceLink requestBody: required: true content: application/json: schema: type: object required: - verifierHash properties: verifierHash: type: string minLength: 32 description: SHA-256 of the CLI-held verifier. At least 32 characters. deviceName: type: string description: Defaults to "Unnamed device". clientVersion: type: string description: Defaults to "unknown". osFamily: type: string description: Defaults to "unknown". arch: type: string description: Defaults to "unknown". example: verifierHash: aGFzaC1vZi10aGUtdmVyaWZpZXItYmFzZTY0dXJs deviceName: work-laptop clientVersion: 0.1.0 osFamily: darwin arch: arm64 responses: '201': description: Link request created. content: application/json: schema: type: object required: - publicRequestId - approvalUrl - expiresAt - pollIntervalMs properties: publicRequestId: type: string approvalUrl: type: string format: uri expiresAt: type: string format: date-time pollIntervalMs: type: integer example: 1500 '400': $ref: '#/components/responses/BadRequest' '429': $ref: '#/components/responses/RateLimited' security: [] components: 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' RateLimited: description: '`RATE_LIMITED` — a throttle was exceeded.' content: application/json: schema: $ref: '#/components/schemas/ApiError' schemas: 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' 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 ````