> ## Documentation Index
> Fetch the complete documentation index at: https://ancplua.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Post apiv1workspacescurrentheartbeat

> Register workspace heartbeat



## OpenAPI

````yaml /api-reference/openapi.yaml post /api/v1/workspaces/current/heartbeat
openapi: 3.0.0
info:
  title: QYL Observability API
  version: '2026-01-26'
servers:
  - url: https://api.staging.qyl.dev
    description: QYL Staging API
    variables: {}
  - url: https://api.qyl.dev
    description: QYL Production API
    variables: {}
security: []
tags:
  - name: Streaming
  - name: Traces
  - name: Logs
  - name: Metrics
  - name: Sessions
  - name: Errors
  - name: Deployments
  - name: Services
  - name: Health
  - name: Workspaces
  - name: Onboarding
  - name: Configurator
  - name: Issues
  - name: Workflows
  - name: Search
  - name: Alerts
paths:
  /api/v1/workspaces/current/heartbeat:
    post:
      tags:
        - Workspaces
      description: Register workspace heartbeat
      operationId: WorkspacesApi_heartbeat
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Qyl.Domains.Workspace.WorkspaceEnvelopeEntity
        '404':
          description: Resource not found (404)
          headers:
            X-Trace-Id:
              required: false
              description: Trace ID for correlation
              schema:
                type: string
            X-Request-Id:
              required: false
              description: Request ID for support
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Qyl.Common.Errors.NotFoundError'
        '500':
          description: Internal server error (500)
          headers:
            X-Trace-Id:
              required: false
              description: Trace ID for correlation
              schema:
                type: string
            X-Request-Id:
              required: false
              description: Request ID for support
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Qyl.Common.Errors.InternalServerError'
components:
  schemas:
    Qyl.Domains.Workspace.WorkspaceEnvelopeEntity:
      type: object
      required:
        - id
        - project_id
        - environment_id
        - node_id
        - name
        - root_path
        - heartbeat_interval_seconds
        - status
        - created_at
        - updated_at
      properties:
        id:
          type: string
          description: Workspace ID
        project_id:
          type: string
          description: Owning project
        environment_id:
          type: string
          description: Environment
        node_id:
          type: string
          description: Host node
        name:
          type: string
          description: Workspace name
        root_path:
          type: string
          description: Local filesystem root path
        heartbeat_at:
          type: string
          format: date-time
          description: Last heartbeat timestamp
        heartbeat_interval_seconds:
          type: integer
          format: int32
          description: Heartbeat interval in seconds
        status:
          allOf:
            - $ref: '#/components/schemas/Qyl.Domains.Workspace.WorkspaceStatus'
          description: Workspace status
        config_json:
          type: string
          description: Workspace-level configuration overrides
          x-duckdb-type: JSON
        created_at:
          type: string
          format: date-time
          description: Creation timestamp
        updated_at:
          type: string
          format: date-time
          description: Last update timestamp
      description: 'Workspace envelope: the local-first workspace unit'
      x-csharp-type: WorkspaceEnvelopeEntity
      x-duckdb-table: workspace_envelopes
    Qyl.Common.Errors.NotFoundError:
      type: object
      required:
        - title
      properties:
        title:
          type: string
          enum:
            - Not Found
        resource_type:
          type: string
          description: The type of resource that was not found
        resource_id:
          type: string
          description: The identifier that was not found
      allOf:
        - $ref: '#/components/schemas/Qyl.Common.Errors.ProblemDetails'
      description: Resource not found (404)
    Qyl.Common.Errors.InternalServerError:
      type: object
      required:
        - title
      properties:
        title:
          type: string
          enum:
            - Internal Server Error
        error_code:
          type: string
          description: Error code for support reference
      allOf:
        - $ref: '#/components/schemas/Qyl.Common.Errors.ProblemDetails'
      description: Internal server error (500)
    Qyl.Domains.Workspace.WorkspaceStatus:
      type: string
      enum:
        - active
        - suspended
        - archived
      description: Workspace lifecycle status
    Qyl.Common.Errors.ProblemDetails:
      type: object
      required:
        - type
        - title
        - status
      properties:
        type:
          type: string
          format: uri
          description: A URI reference identifying the problem type
          default: about:blank
        title:
          type: string
          description: A short, human-readable summary of the problem type
        status:
          type: integer
          format: int32
          description: >-
            The HTTP status code (informational only, actual code set by
            subtype)
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence
        instance:
          type: string
          format: uri
          description: A URI reference identifying the specific occurrence
        timestamp:
          type: string
          format: date-time
          description: Timestamp of the error
      description: RFC 7807 Problem Details for HTTP APIs

````