Post apiv1workspacescurrentheartbeat

Register workspace heartbeat

POST /api/v1/workspaces/current/heartbeat

cURL

cURL

curl --request POST \
  --url https://api.staging.qyl.dev/api/v1/workspaces/current/heartbeat

200

{
  "id": "<string>",
  "project_id": "<string>",
  "environment_id": "<string>",
  "node_id": "<string>",
  "name": "<string>",
  "root_path": "<string>",
  "heartbeat_interval_seconds": 123,
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "heartbeat_at": "2023-11-07T05:31:56Z",
  "config_json": "<string>"
}

Response

200

application/json

The request has succeeded.

Workspace envelope: the local-first workspace unit

id · string · required

Workspace ID

project_id · string · required

Owning project

environment_id · string · required

Environment

node_id · string · required

Host node

name · string · required

Workspace name

root_path · string · required

Local filesystem root path

heartbeat_interval_seconds · integer<int32> · required

Heartbeat interval in seconds

status · enum<string> · required

Workspace status

Available options: active, suspended, archived

created_at · string<date-time> · required

Creation timestamp

updated_at · string<date-time> · required

Last update timestamp

heartbeat_at · string<date-time>

Last heartbeat timestamp

config_json · string

Workspace-level configuration overrides