start_workflow

Start a configured workflow against one or more target assets.

start_workflow

Start a configured workflow against one or more target assets.

Start a configured workflow over confined target assets.

Safety class: C · API type: admin · Min version: —

📘
Confinement
Class C: a workflow can have GLOBAL side effects. Only target confined assets (under your run-root), and only reference a workflow you own. Non-prod only.

Signatures

def start_workflow(sdk, action_arguments, target_ids):
    """Start a workflow (action_arguments) against target_ids; return the run dict or None."""
    return sdk.start_workflow(action_arguments, target_ids)

export async function startWorkflow(sdk, actionArguments, targetIds) {
    // Start a configured workflow over confined target assets.
    return await sdk.startWorkflow(actionArguments, targetIds);
}

Parameters

Parameter (Python)	Parameter (JS)	Type	Required	Notes
`sdk`	`sdk`	Nomad_SDK	yes
`action_arguments`	`actionArguments`	dict	yes	e.g. `{"workflowId": "<workflow-uuid>"}`
`target_ids`	`targetIds`	list[str]	yes	e.g. `["<asset-uuid>"]`

Returns

dict | None — the started workflow run; None on failure.

Errors

401 unauthenticated
InvalidAPITypeException on a non-admin session
400 unknown workflowId