GitHub API (unofficial showcase)
GET/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}

Get a repository rule suite

Gets information about a suite of rule evaluations from within a repository. For more information, see "Managing rulesets for a repository."

4 parameters
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.
rule_suite_idintegerrequired
The unique identifier of the rule suite result. To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) for organizations.
include_metadatabooleanoptional
When set to `true`, the response will include additional metadata for pull request and required status check rule evaluation. Results are capped at 50 entries.
Default:false

3 status codes
200Response
idintegeroptional
The unique identifier of the rule insight.
actor_idintegeroptional
The number that identifies the user.
actor_namestringoptional
The handle for the GitHub user account.
before_shastringoptional
The previous commit SHA of the ref.
after_shastringoptional
The new commit SHA of the ref.
refstringoptional
The ref name that the evaluation ran on.
repository_idintegeroptional
The ID of the repository associated with the rule evaluation.
repository_namestringoptional
The name of the repository without the `.git` extension.
pushed_atstringoptional
resultstringoptional
The result of the rule evaluations for rules with the `active` enforcement status.
Allowed:passfailbypass
evaluation_resultstringoptional
The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run.
Allowed:passfailbypass
rule_evaluationsarray<object>optional
Details on the evaluated rules.
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
500Internal Error
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 404 is returned: Resource not found. A 500 is returned: Internal Error.