v68

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,21696712.3 MB

repos

List repository rule suites

Lists suites of rule evaluations at the repository level. For more information, see "Managing rulesets for a repository."

get/repos/{owner}/{repo}/rulesets/rule-suites

Path parameters

ownerstring required

The account owner of the repository. The name is not case sensitive.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

Query parameters

refstring

The name of the ref. Cannot contain wildcard characters. Optionally prefix with refs/heads/ to limit to branches or refs/tags/ to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.

time_period'hour' | 'day' | 'week' | 'month'

The time period to filter by.

For example, day will filter for rule suites that occurred in the past 24 hours, and week will filter for rule suites that occurred in the past 7 days (168 hours).

actor_namestring

The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.

rule_suite_result'pass' | 'fail' | 'bypass' | 'all'

The rule suite results to filter on. When specified, only suites with this result will be returned.

evaluate_status'all' | 'active' | 'evaluate'

The evaluate status to filter on. When specified, only rule suites resulting from rulesets with the specified evaluate status will be returned.

all - all rule suites will be returned.
active - only rule suites resulting from rulesets in active (non-evaluate) mode will be returned.
evaluate - only rule suites resulting from rulesets in evaluate mode will be returned.

per_pageinteger

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

pageinteger

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Response

idinteger

The unique identifier of the rule insight.

actor_idinteger

The number that identifies the user.

actor_namestring

The handle for the GitHub user account.

before_shastring

The first commit sha before the push evaluation.

after_shastring

The last commit sha in the push evaluation.

refstring

The ref name that the evaluation ran on.

repository_idinteger

The ID of the repository associated with the rule evaluation.

repository_namestring

The name of the repository without the .git extension.

pushed_atstring date-time

result'pass' | 'fail' | 'bypass'

The result of the rule evaluations for rules with the active enforcement status.

evaluation_result'pass' | 'fail' | 'bypass'

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.

Example response

[
  {
    "pushed_at": "2011-01-26T19:06:43Z"
  }
]