Skip to content

Get a single ruleset's detail

Read one ruleset by id, including who or what can bypass it.

You need the ruleset’s numeric id. Get it from list-repo-rulesets.md first.

get_repo_ruleset { "owner": "<owner>", "repo": "<repo>", "rulesetId": 12345 }
{
"id": 12345,
"name": "main-protection",
"target": "branch",
"enforcement": "active",
"bypassActors": [
{ "actorId": 1, "actorType": "Team", "bypassMode": "always" }
]
}

bypassActors is an empty array if the ruleset defines no bypass — i.e., it applies to everyone with push access, no exceptions.

Read-only in this plugin. Check bypassActors before assuming a ruleset fully blocks a given action for a given actor — an admin or bot identity present here bypasses the rule entirely.