provider repos POST /orgs/{org}/rulesets
@utdk/github /orgs/{org}/rulesets
Create an organization repository ruleset
Create a repository ruleset for an organization.
org path required
The organization name. The name is not case sensitive.
string

Try it

Authentication
Configure credentials for GitHub v3 REST API
repos.createOrgRuleset
POST/orgs/{org}/rulesets
Create a repository ruleset for an organization.

Parameters

required

The organization name. The name is not case sensitive.

Input

required

The name of the ruleset.

The target of the ruleset

required

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

The actors that can bypass the rules in this ruleset

Conditions for an organization ruleset. The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. The push rulesets conditions object does not require the `ref_name` property. For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.

An array of rules within the ruleset.

Configure credentials above to enable sending.

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

TypeScript

import github from '@utdk/github';

await github.repos.createOrgRuleset({
  "target": "branch"
})