Skip to content

[RUN-4518] Document nodeFilter URL parameter for job linking #1827

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ltamaster wants to merge 2 commits into
base: 6.1.0
Choose a base branch
from
Open

[RUN-4518] Document nodeFilter URL parameter for job linking #1827

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99d7fb7
RUN-4518: Document nodeFilter URL parameter for job linking
ltamaster Jun 25, 2026
62fcedb
RUN-4518: Expand URL encoding note to cover nodeFilter
ltamaster Jun 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions docs/manual/jobs/job-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -800,9 +800,10 @@ In this case, the option will be allowed to use a text field to set the value.

You can create a URL to link to a specific Job, and pre-fill some of the option values by adding URL query parameters to the Job's URL.

Query Parameters format for options:
Supported query parameters:

- `opt.NAME`: provide a value for an option named `NAME`
- `nodeFilter`: pre-populate the node filter field with the given filter expression. This parameter is only applied when the Job has **Node Filter** set to **Editable** (`nodeFilterEditable: true`); it is ignored otherwise.

For example, if the URL for the Job is:

Expand All @@ -816,4 +817,8 @@ The result would be:

http://rundeck:4440/project/MyProject/job/show/ab698597-9753-4e98-bdab-90ebf395b0d0?opt.myopt1=some+value&opt.myotheropt=another+value

Note: be sure to properly escape the strings for option values, and if necessary for the option names as well.
To also pre-populate the node filter, combine `nodeFilter` with option parameters:

http://rundeck:4440/project/MyProject/job/show/ab698597-9753-4e98-bdab-90ebf395b0d0?opt.myopt1=some+value&nodeFilter=name%3A+web-server-01

Note: be sure to properly URL-encode all parameter values. This applies to option values, option names, and `nodeFilter` expressions — filter syntax characters such as spaces and `:` must be encoded (e.g., `name: web-01` becomes `name%3A+web-01`).
Loading