Workflow start request

Endpoint

PUT /api/workflow/start/

Auth

Authorization: Bearer ${token}

Query Parameters

link assigns a link to every step declaring one under link in the definition, while the license carries any. Left out, the start runs the steps with their declared links idle. The response entity lists what the workflow holds under links, each entry carrying step, port, name and host.

Body

Optional. A JSON object of override values written to the workflow's workflow.ini before it starts. Keys are <category>.<step>.<key>, scoped to a step by its name: volume.<step>.<volume-name> and port.<step>.<port-name> (host side), env.<step>.<VAR>, and resource.<step>.<cpu|memory|gpu>. When omitted, the existing workflow.ini (if any) is used unchanged. Overrides are applied only at launch and never modify the definition; an unknown step / volume / port name, or an invalid cpu/memory/gpu value, fails the start.

{
    "override": {
        "volume.step-name.data": "/mnt/host/data",
        "env.step-name.KEY": "value",
        "resource.step-name.cpu": "8"
    }
}

Response

[
    {
        "kind": "status",
        "payload": {
            "code": 0,
            "message": ""
        }
    },
    {
        "kind": "",
        "payload": ""
    },
    {
        "kind": "entity",
        "payload": {
            "created_at": 0,
            "identity": "",
            "links": [
                {
                    "host": "",
                    "name": "",
                    "port": "",
                    "step": ""
                }
            ],
            "name": "",
            "status": "",
            "tags": [
                ""
            ]
        }
    }
]

Notes

• Workflow Permission Required