provider repos GET /repos/{owner}/{repo}/rulesets/{ruleset_id}
@utdk/github /repos/{owner}/{repo}/rulesets/{ruleset_id}
Get a repository ruleset
Get a ruleset for a repository. **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user making the API request has write access to the ruleset.
owner path required
The account owner of the repository. The name is not case sensitive.
string
repo path required
The name of the repository without the `.git` extension. The name is not case sensitive.
string
ruleset_id path required
The ID of the ruleset.
integer
includes_parents query
Include rulesets configured at higher levels that apply to this repository
boolean

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.getRepoRuleset
GET/repos/{owner}/{repo}/rulesets/{ruleset_id}
Get a ruleset for a repository. **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user making the API request has write access to the ruleset.

Parameters

required

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

required

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

required

The ID of the ruleset.

Include rulesets configured at higher levels that apply to this repository

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.getRepoRuleset({
  "includes_parents": true
})