GET /repos/{owner}/{repo}/rulesets/rule-suites
Lists suites of rule evaluations at the repository level. For more information, see "Managing rulesets for a repository."
Servers
- https://api.github.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
repo |
String | Yes |
The name of the repository without the |
owner |
String | Yes |
The account owner of the repository. The name is not case sensitive. |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
page |
Integer | No |
The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default value: 1 |
time_period |
String | No |
The time period to filter by. For example, Possible values:
Default value: "day" |
rule_suite_result |
String | No |
The rule results to filter on. When specified, only suites with this result will be returned. Possible values:
Default value: "all" |
per_page |
Integer | No |
The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default value: 30 |
actor_name |
String | No |
The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. |
ref |
String | No |
The name of the ref. Cannot contain wildcard characters. Optionally prefix with |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.