Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Rundeck API documentation to describe the project-scoped authorization rules enforced by the Execution Metrics endpoints, including how the project and jobIdListFilter inputs affect access and results.
Changes:
- Documented required
readpermission on theeventresource type for execution metrics queries. - Clarified authorization behavior for project-scoped, job-filtered, and global (no project) metrics queries, including when
403responses occur.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
fdevans
approved these changes
Aug 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the API documentation to clarify the authorization requirements for accessing execution metrics. The new section explains in detail how access is determined based on the project and query parameters.
Documentation update:
readaccess for theeventresource type is required to obtain execution metrics, with clear rules for project-specific, job-filtered, and global queries, and how authorization affects the results and error responses.OSS PR related: https://github.com/rundeck/rundeck/pull/10419