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

# Signal workflow execution start

`PUT /trace/{workflowId}/begin`

Updates the workflow execution trace for the given `workflowId`.

## Path parameters

- `workflowId` string, required

## Query parameters

- `workspaceId` integer

## Request body

- TraceBeginRequest
  - `launchId` string
  - `processNames` string[]
  - `towerLaunch` boolean
  - `workflow` Workflow
    - `attributes` WorkflowExtAttributes
      - `cost` number
      - `costCurrency` string
      - `costRetries` integer
      - `empty` boolean
      - `instancesProvisioned` integer
      - `schedRunId` string
    - `commandLine` string, required
    - `commitId` string
    - `complete` string, date-time
    - `configFiles` string[]
    - `configText` string
    - `container` string
    - `containerEngine` string
    - `dateCreated` string, date-time, nullable
    - `deleted` boolean
    - `duration` integer
    - `errorMessage` string
    - `errorReport` string
    - `exitStatus` integer
    - `fusion` WfFusionMeta
      - `enabled` boolean
      - `version` string
    - `homeDir` string
    - `id` string
    - `lastUpdated` string, date-time, nullable
    - `launchDir` string
    - `launchId` string
    - `logFile` string
    - `manifest` WfManifest
      - `author` string
      - `defaultBranch` string
      - `description` string
      - `gitmodules` string
      - `homePage` string
      - `icon` string
      - `mainScript` string
      - `name` string
      - `nextflowVersion` string
      - `version` string
    - `nextflow` WfNextflow
      - `build` string
      - `timestamp` string, date-time
      - `version` string
    - `operationId` string
    - `outFile` string
    - `ownerId` integer
    - `params` object
    - `profile` string
    - `projectDir` string
    - `projectName` string, required
    - `repository` string
    - `requiresAttention` boolean
    - `resume` boolean
    - `revision` string
    - `runName` string, required
    - `sched` WfSched
      - `enabled` boolean
    - `scriptFile` string
    - `scriptId` string
    - `scriptName` string
    - `sessionId` string, required
    - `start` string, date-time
    - `stats` WfStats
      - `cachedCount` integer
      - `cachedCountFmt` string
      - `cachedDuration` integer
      - `cachedPct` number, float
      - `computeTimeFmt` string
      - `failedCount` integer
      - `failedCountFmt` string
      - `failedDuration` integer
      - `failedPct` number, float
      - `ignoredCount` integer
      - `ignoredCountFmt` string
      - `ignoredPct` number, float
      - `succeedCount` integer
      - `succeedCountFmt` string
      - `succeedDuration` integer
      - `succeedPct` number, float
    - `status` 'SUBMITTED' | 'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'CANCELLED' | 'UNKNOWN'
    - `submit` string, date-time, required
    - `success` boolean
    - `userName` string, required
    - `wave` WfWaveMeta
      - `enabled` boolean
    - `workDir` string, required

## Response `200`

OK

- TraceBeginResponse
  - `status` 'OK' | 'KO'
  - `watchUrl` string
  - `workflowId` 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)