Run Job
rundeck.run_job
ActionBusiness appsconnection required
Calls the Rundeck API with the connection's credentials.
Start one execution of a Rundeck job and return the execution it created.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Rundeck
- Secret shape
- the API token, or {"api_token": "…"}
- Config it needs
- base_url, api_version, project
- Resolved by
- config.connection_id, else node.connection_id
Configuration
7 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
job_id The job's UUID, as rundeck.list_jobs emits it and the job's page shows it. | string | Yes | — | — | 3940e6ab-1b1c-4a0e-9e5f-0f2a1c9f0001 |
options The job's options as a map of option name to value; Rundeck takes this from API v18 onwards. | object | No | — | — | {"environment":"production"} |
arg_string The options as one command-line string; Rundeck ignores it when a map is sent as well. | string | No | — | — | -environment production |
log_level How verbosely the execution logs; Rundeck defaults to the job's own level. | string | No | — | one of "INFO", "DEBUG", "VERBOSE", "WARN", "ERROR" | — |
node_filter A Rundeck node filter string that narrows which nodes the job runs on. | string | No | — | — | tags: web |
as_user Run as this Rundeck username instead of the token's owner; needs runAs permission. | string | No | — | — | deploy-bot |
run_at_time Schedule the run for this ISO-8601 time with a timezone instead of now. | string | No | — | — | 2026-11-23T12:20:55-0800 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"arg_string": "-environment production",
"as_user": "deploy-bot",
"job_id": "3940e6ab-1b1c-4a0e-9e5f-0f2a1c9f0001",
"node_filter": "tags: web",
"options": {
"environment": "production"
},
"run_at_time": "2026-11-23T12:20:55-0800"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The execution id, which every other execution node takes. | number | — |
status Where the execution stands: running, succeeded, failed, aborted. | string | — |
project The project the execution belongs to. | string | — |
executionType How it was started: user, scheduled or user-scheduled. | string | — |
user The Rundeck user the execution ran as. | string | — |
href The API URL of this execution. | string | — |
permalink The Rundeck web URL a person can open. | string | — |
date-started When the execution started, as Rundeck reports it. | any | — |
date-ended When the execution finished; absent while it is still running. | any | — |
description Rundeck's one-line description of what ran. | string | — |
argstring The option arguments the execution was started with. | string | — |
job The job that was run. | object | — |
job.id The job's UUID. | string | — |
job.name The job's name. | string | — |
job.group The job's group path within the project. | string | — |
successfulNodes The nodes the execution succeeded on. | array | — |
failedNodes The nodes the execution failed on. | array | — |
{
"argstring": "",
"date-ended": null,
"date-started": null,
"description": "",
"executionType": "",
"failedNodes": [],
"href": "",
"id": 0,
"job": {
"group": "",
"id": "",
"name": ""
},
"permalink": "",
"project": "",
"status": "",
"successfulNodes": [],
"user": ""
}Notes
- This returns as soon as Rundeck has queued the execution; it does not wait for the job to finish.
- Poll the returned id with rundeck.get_execution to find out how it ended.
See Run Job run in a workflow.
In a technical demo we add the Rundeck connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.