POST

Try POST /repos/{owner}/{repo}/rulesets — GitHub API

GitHub playground

Create a repository ruleset

Credentials

GitHub token · sent as Authorization

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.github.com; the proxy stores and logs nothing about them.

Headers

Accept · fixedX-GitHub-Api-Version · fixed

Path

owner · required · string The account owner of the repository. The name is not case sensitive. repo · required · string The name of the repository without the `.git` extension. The name is not case sensitive.

Body application/json

6 body fields

name · required · string — The name of the ruleset.
target · optional · string — The target of the ruleset
enforcement · required · string — The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).
bypass_actors · optional · object[] — The actors that can bypass the rules in this ruleset
conditions · optional · object — Parameters for a repository ruleset ref name condition
rules · optional · object[] — An array of rules within the ruleset.