> ## 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.

# Liveness

> Dependency-free and cheap: it answers "is this process still able to serve a request", nothing more. Gate container restarts on this, never traffic — a database outage would otherwise put every replica into a restart loop. Answers on any hostname.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/health
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/health:
    get:
      tags:
        - Health
      summary: Liveness
      description: >-
        Dependency-free and cheap: it answers "is this process still able to
        serve a request", nothing more. Gate container restarts on this, never
        traffic — a database outage would otherwise put every replica into a
        restart loop. Answers on any hostname.
      operationId: getHealth
      responses:
        '200':
          description: The process is alive.
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - uptimeSeconds
                properties:
                  status:
                    type: string
                    const: ok
                  uptimeSeconds:
                    type: integer
              example:
                status: ok
                uptimeSeconds: 4210
      security: []

````