---
title: "Signal workflow execution heartbeat"
method: PUT
path: "/trace/{workflowId}/heartbeat"
tags: ["trace"]
---

# Signal workflow execution heartbeat

`PUT /trace/{workflowId}/heartbeat`

Update the workflow execution trace heartbeat for the given `workflowId` to signal that execution is ongoing.

## Path parameters

- `workflowId` string, required

## Query parameters

- `workspaceId` integer

## Request body

- TraceHeartbeatRequest
  - `progress` TraceProgressData
    - `aborted` integer
    - `cached` integer
    - `failed` integer
    - `ignored` integer
    - `loadCpus` integer
    - `loadMemory` integer
    - `numSpotInterruptions` integer
    - `peakCpus` integer
    - `peakMemory` integer
    - `peakRunning` integer
    - `pending` integer
    - `processes` TraceProgressDetail[]
      - `aborted` integer
      - `cached` integer
      - `failed` integer
      - `ignored` integer
      - `index` integer
      - `loadCpus` integer
      - `loadMemory` integer
      - `name` string
      - `peakCpus` integer
      - `peakMemory` integer
      - `peakRunning` integer
      - `pending` integer
      - `retries` integer
      - `running` integer
      - `stored` integer
      - `submitted` integer
      - `succeeded` integer
      - `terminated` boolean
    - `retries` integer
    - `running` integer
    - `stored` integer
    - `submitted` integer
    - `succeeded` integer

## Response `200`

OK

- TraceHeartbeatResponse
  - `message` string

## Other responses

- `400` — Bad request
- `403` — Operation not allowed

---

[API](https://skmtc.net/seqeralabs/apis/seqera-api.md) · [All operations](https://skmtc.net/seqeralabs/apis/seqera-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/seqeralabs/seqera-api/revisions/13316c9fe5ff/schema)