provider repos GET /orgs/{org}/rulesets/rule-suites
@utdk/github /orgs/{org}/rulesets/rule-suites
List organization rule suites
Lists suites of rule evaluations at the organization level. For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)."
org path required
The organization name. The name is not case sensitive.
string
ref query
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.
string
repository_name query
The name of the repository to filter on.
string
time_period query
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).
enum: hour, day, week, month
actor_name query
The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.
string
rule_suite_result query
The rule suite results to filter on. When specified, only suites with this result will be returned.
enum: pass, fail, bypass, all
per_page query
The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integer
page query
The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integer

Try it

Authentication
Configure credentials for GitHub v3 REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

repos.getOrgRuleSuites
GET/orgs/{org}/rulesets/rule-suites
Lists suites of rule evaluations at the organization level. For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)."

Parameters

required

The organization name. The name is not case sensitive.

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.

The name of the repository to filter on.

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).

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

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

The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."

The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import github from '@utdk/github';

await github.repos.getOrgRuleSuites({
  "time_period": "day",
  "rule_suite_result": "all",
  "per_page": 30,
  "page": 1
})