v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1438212159.2 KB

Begins a run of a specified workflow.

put/v1/spaces/{spaceName}/projects/{projectName}/workflowRuns#workflowId

Path parameters

spaceNamestring required

The name of the space.

projectNamestring required

The name of the project in the space.

Query parameters

workflowIdstring required

The system-generated unique ID of the workflow. To retrieve a list of workflow IDs, use <a>ListWorkflows</a>.

Request body

clientTokenstring

A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

Response

Success

spaceNamestring required

The name of the space.

projectNamestring required

The name of the project in the space.

idstring required

The system-generated unique ID of the workflow run.

workflowIdstring required

The system-generated unique ID of the workflow.