Rules

Use the rulesets API to manage rulesets for repositories. Organization rulesets control how people can interact with selected branches and tags in repositories in an organization.

Note: Rulesets are in public beta and subject to change.

Get all organization repository rulesets

Works with GitHub Apps

Get all the repository rulesets for an organization.

Parameters for "Get all organization repository rulesets"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`org` string Required The organization name. The name is not case sensitive.

HTTP response status codes for "Get all organization repository rulesets"

Status code	Description
`200`	OK
`404`	Resource not found
`500`	Internal Error

Code samples for "Get all organization repository rulesets"

get/orgs/{org}/rulesets

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/rulesets

Response

Status: 200

[
  {
    "id": 21,
    "name": "super cool ruleset",
    "source_type": "Organization",
    "source": "my-org",
    "enforcement": "enabled"
  },
  {
    "id": 432,
    "name": "Another ruleset",
    "source_type": "Organization",
    "source": "my-org",
    "enforcement": "enabled"
  }
]

Create an organization repository ruleset

Works with GitHub Apps

Create a repository ruleset for an organization.

Parameters for "Create an organization repository ruleset"

Headers

Name, Type, Description

accept string

Setting to application/vnd.github+json is recommended.

Path parameters

Name, Type, Description

org string Required

The organization name. The name is not case sensitive.

Body parameters

Name, Type, Description

name string Required

The name of the ruleset.

target string

The target of the ruleset.

Can be one of: branch, tag

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

Can be one of: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Properties of bypass_actors

Name, Type, Description
`actor_id` integer The ID of the actor that can bypass a ruleset
`actor_type` string The type of actor that can bypass a ruleset Can be one of: `Team`, `Integration`

conditions object

Conditions for a organization ruleset

rules array of objects

An array of rules within the ruleset.

Can be one of these objects:

Name, Type, Description

creation object Required

Parameters to be used for the creation rule

Properties of creation

Name, Type, Description
`type` string Required Value: `creation`

update object Required

Parameters to be used for the update rule

Properties of update

Name, Type, Description

type string Required

Value: update

parameters object

Properties of parameters

Name, Type, Description
`update_allows_fetch_and_merge` boolean Required Branch can pull changes from its upstream repository

deletion object Required

Parameters to be used for the deletion rule

Properties of deletion

Name, Type, Description
`type` string Required Value: `deletion`

required_linear_history object Required

Parameters to be used for the required_linear_history rule

Properties of required_linear_history

Name, Type, Description
`type` string Required Value: `required_linear_history`

required_deployments object Required

Parameters to be used for the required_deployments rule

Properties of required_deployments

Name, Type, Description

type string Required

Value: required_deployments

parameters object

Properties of parameters

Name, Type, Description
`required_deployment_environments` array of strings Required The environments that must be successfully deployed to before branches can be merged.

required_signatures object Required

Parameters to be used for the required_signatures rule

Properties of required_signatures

Name, Type, Description
`type` string Required Value: `required_signatures`

pull_request object Required

Parameters to be used for the pull_request rule

Properties of pull_request

Name, Type, Description

type string Required

Value: pull_request

parameters object

Properties of parameters

Name, Type, Description
`dismiss_stale_reviews_on_push` boolean Required New, reviewable commits pushed will dismiss previous pull request review approvals.
`require_code_owner_review` boolean Required Require an approving review in pull requests that modify files that have a designated code owner.
`require_last_push_approval` boolean Required Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
`required_approving_review_count` integer Required The number of approving reviews that are required before a pull request can be merged.
`required_review_thread_resolution` boolean Required All conversations on code must be resolved before a pull request can be merged.

required_status_checks object Required

Parameters to be used for the required_status_checks rule

Properties of required_status_checks

Name, Type, Description

type string Required

Value: required_status_checks

parameters object

Properties of parameters

Name, Type, Description

required_status_checks array of objects Required

Status checks that are required.

Properties of required_status_checks

Name, Type, Description
`context` string Required The status check context name that must be present on the commit.
`integration_id` integer The optional integration ID that this status check must originate from.

strict_required_status_checks_policy boolean Required

Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.

non_fast_forward object Required

Parameters to be used for the non_fast_forward rule

Properties of non_fast_forward

Name, Type, Description
`type` string Required Value: `non_fast_forward`

commit_message_pattern object Required

Parameters to be used for the commit_message_pattern rule

Properties of commit_message_pattern

Name, Type, Description

type string Required

Value: commit_message_pattern

parameters object

Properties of parameters

Name, Type, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Required The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Required The pattern to match with.

commit_author_email_pattern object Required

Parameters to be used for the commit_author_email_pattern rule

Properties of commit_author_email_pattern

Name, Type, Description

type string Required

Value: commit_author_email_pattern

parameters object

Properties of parameters

Name, Type, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Required The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Required The pattern to match with.

committer_email_pattern object Required

Parameters to be used for the committer_email_pattern rule

Properties of committer_email_pattern

Name, Type, Description

type string Required

Value: committer_email_pattern

parameters object

Properties of parameters

Name, Type, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Required The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Required The pattern to match with.

branch_name_pattern object Required

Parameters to be used for the branch_name_pattern rule

Properties of branch_name_pattern

Name, Type, Description

type string Required

Value: branch_name_pattern

parameters object

Properties of parameters

Name, Type, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Required The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Required The pattern to match with.

tag_name_pattern object Required

Parameters to be used for the tag_name_pattern rule

Properties of tag_name_pattern

Name, Type, Description

type string Required

Value: tag_name_pattern

parameters object

Properties of parameters

Name, Type, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Required The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Required The pattern to match with.

HTTP response status codes for "Create an organization repository ruleset"

Status code	Description
`201`	Created
`404`	Resource not found
`500`	Internal Error

Code samples for "Create an organization repository ruleset"

post/orgs/{org}/rulesets

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/rulesets \
  -d '{"name":"super cool ruleset","target":"branch","enforcement":"active","bypass_actors":[{"actor_id":234,"actor_type":"Team"}],"conditions":{"ref_name":{"include":["refs/heads/main","refs/heads/master"],"exclude":["refs/heads/dev*"]}},"rules":[{"type":"commit_author_email_pattern","parameters":{"operator":"contains","pattern":"github"}}]}'

Response

Status: 201

{
  "id": 21,
  "name": "super cool ruleset",
  "target": "branch",
  "source_type": "Organization",
  "source": "my-org",
  "enforcement": "active",
  "bypass_actors": [
    {
      "actor_id": 234,
      "actor_type": "Team"
    }
  ],
  "conditions": {
    "ref_name": {
      "include": [
        "refs/heads/main",
        "refs/heads/master"
      ],
      "exclude": [
        "refs/heads/dev*"
      ]
    },
    "repository_name": {
      "include": [
        "important_repository",
        "another_important_repository"
      ],
      "exclude": [
        "unimportant_repository"
      ],
      "protected": true
    }
  },
  "rules": [
    {
      "type": "commit_author_email_pattern",
      "parameters": {
        "operator": "contains",
        "pattern": "github"
      }
    }
  ]
}

Get an organization repository ruleset

Works with GitHub Apps

Get a repository ruleset for an organization.

Parameters for "Get an organization repository ruleset"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`org` string Required The organization name. The name is not case sensitive.
`ruleset_id` integer Required The ID of the ruleset.

HTTP response status codes for "Get an organization repository ruleset"

Status code	Description
`200`	OK
`404`	Resource not found
`500`	Internal Error

Code samples for "Get an organization repository ruleset"

get/orgs/{org}/rulesets/{ruleset_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/rulesets/RULESET_ID

Response

Status: 200

{
  "id": 21,
  "name": "super cool ruleset",
  "target": "branch",
  "source_type": "Organization",
  "source": "my-org",
  "enforcement": "active",
  "bypass_actors": [
    {
      "actor_id": 234,
      "actor_type": "Team"
    }
  ],
  "conditions": {
    "ref_name": {
      "include": [
        "refs/heads/main",
        "refs/heads/master"
      ],
      "exclude": [
        "refs/heads/dev*"
      ]
    },
    "repository_name": {
      "include": [
        "important_repository",
        "another_important_repository"
      ],
      "exclude": [
        "unimportant_repository"
      ],
      "protected": true
    }
  },
  "rules": [
    {
      "type": "commit_author_email_pattern",
      "parameters": {
        "operator": "contains",
        "pattern": "github"
      }
    }
  ]
}

Update an organization repository ruleset

Works with GitHub Apps

Update a ruleset for an organization.

Parameters for "Update an organization repository ruleset"

Headers

Name, Type, Description

accept string

Setting to application/vnd.github+json is recommended.

Path parameters

Name, Type, Description

org string Required

The organization name. The name is not case sensitive.

ruleset_id integer Required

The ID of the ruleset.

Body parameters

Name, Type, Description

name string

The name of the ruleset.

target string

The target of the ruleset.

Can be one of: branch, tag

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

Can be one of: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Properties of bypass_actors

Name, Type, Description
`actor_id` integer The ID of the actor that can bypass a ruleset
`actor_type` string The type of actor that can bypass a ruleset Can be one of: `Team`, `Integration`

conditions object

Conditions for a organization ruleset

rules array of objects

An array of rules within the ruleset.

Can be one of these objects:

Name, Type, Description

creation object Required

Parameters to be used for the creation rule

Properties of creation

Name, Type, Description
`type` string Required Value: `creation`

update object Required

Parameters to be used for the update rule

Properties of update

Name, Type, Description

type string Required

Value: update

parameters object

Properties of parameters

Name, Type, Description
`update_allows_fetch_and_merge` boolean Required Branch can pull changes from its upstream repository

deletion object Required

Parameters to be used for the deletion rule

Properties of deletion

Name, Type, Description
`type` string Required Value: `deletion`

required_linear_history object Required

Parameters to be used for the required_linear_history rule

Properties of required_linear_history

Name, Type, Description
`type` string Required Value: `required_linear_history`

required_deployments object Required

Parameters to be used for the required_deployments rule

Properties of required_deployments

Name, Type, Description

type string Required

Value: required_deployments

parameters object

Properties of parameters

Name, Type, Description
`required_deployment_environments` array of strings Required The environments that must be successfully deployed to before branches can be merged.

required_signatures object Required

Parameters to be used for the required_signatures rule

Properties of required_signatures

Name, Type, Description
`type` string Required Value: `required_signatures`

pull_request object Required

Parameters to be used for the pull_request rule

Properties of pull_request

Name, Type, Description

type string Required

Value: pull_request

parameters object

Properties of parameters

Name, Type, Description
`dismiss_stale_reviews_on_push` boolean Required New, reviewable commits pushed will dismiss previous pull request review approvals.
`require_code_owner_review` boolean Required Require an approving review in pull requests that modify files that have a designated code owner.
`require_last_push_approval` boolean Required Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
`required_approving_review_count` integer Required The number of approving reviews that are required before a pull request can be merged.
`required_review_thread_resolution` boolean Required All conversations on code must be resolved before a pull request can be merged.

required_status_checks object Required

Parameters to be used for the required_status_checks rule

Properties of required_status_checks

Name, Type, Description

type string Required

Value: required_status_checks

parameters object

Properties of parameters

Name, Type, Description

required_status_checks array of objects Required

Status checks that are required.

Properties of required_status_checks

Name, Type, Description
`context` string Required The status check context name that must be present on the commit.
`integration_id` integer The optional integration ID that this status check must originate from.

strict_required_status_checks_policy boolean Required

Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.

non_fast_forward object Required

Parameters to be used for the non_fast_forward rule

Properties of non_fast_forward

Name, Type, Description
`type` string Required Value: `non_fast_forward`

commit_message_pattern object Required

Parameters to be used for the commit_message_pattern rule

Properties of commit_message_pattern

Name, Type, Description

type string Required

Value: commit_message_pattern

parameters object

Properties of parameters

Name, Type, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Required The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Required The pattern to match with.

commit_author_email_pattern object Required

Parameters to be used for the commit_author_email_pattern rule

Properties of commit_author_email_pattern

Name, Type, Description

type string Required

Value: commit_author_email_pattern

parameters object

Properties of parameters

Name, Type, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Required The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Required The pattern to match with.

committer_email_pattern object Required

Parameters to be used for the committer_email_pattern rule

Properties of committer_email_pattern

Name, Type, Description

type string Required

Value: committer_email_pattern

parameters object

Properties of parameters

Name, Type, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Required The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Required The pattern to match with.

branch_name_pattern object Required

Parameters to be used for the branch_name_pattern rule

Properties of branch_name_pattern

Name, Type, Description

type string Required

Value: branch_name_pattern

parameters object

Properties of parameters

Name, Type, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Required The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Required The pattern to match with.

tag_name_pattern object Required

Parameters to be used for the tag_name_pattern rule

Properties of tag_name_pattern

Name, Type, Description

type string Required

Value: tag_name_pattern

parameters object

Properties of parameters

Name, Type, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Required The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Required The pattern to match with.

HTTP response status codes for "Update an organization repository ruleset"

Status code	Description
`200`	OK
`404`	Resource not found
`500`	Internal Error

Code samples for "Update an organization repository ruleset"

put/orgs/{org}/rulesets/{ruleset_id}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/rulesets/RULESET_ID \
  -d '{"name":"super cool ruleset","target":"branch","enforcement":"active","bypass_actors":[{"actor_id":234,"actor_type":"Team"}],"conditions":{"ref_name":{"include":["refs/heads/main","refs/heads/master"],"exclude":["refs/heads/dev*"]}},"rules":[{"type":"commit_author_email_pattern","parameters":{"operator":"contains","pattern":"github"}}]}'

Response

Status: 200

{
  "id": 21,
  "name": "super cool ruleset",
  "target": "branch",
  "source_type": "Organization",
  "source": "my-org",
  "enforcement": "active",
  "bypass_actors": [
    {
      "actor_id": 234,
      "actor_type": "Team"
    }
  ],
  "conditions": {
    "ref_name": {
      "include": [
        "refs/heads/main",
        "refs/heads/master"
      ],
      "exclude": [
        "refs/heads/dev*"
      ]
    },
    "repository_name": {
      "include": [
        "important_repository",
        "another_important_repository"
      ],
      "exclude": [
        "unimportant_repository"
      ],
      "protected": true
    }
  },
  "rules": [
    {
      "type": "commit_author_email_pattern",
      "parameters": {
        "operator": "contains",
        "pattern": "github"
      }
    }
  ]
}

Delete an organization repository ruleset

Works with GitHub Apps

Delete a ruleset for an organization.

Parameters for "Delete an organization repository ruleset"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`org` string Required The organization name. The name is not case sensitive.
`ruleset_id` integer Required The ID of the ruleset.

HTTP response status codes for "Delete an organization repository ruleset"

Status code	Description
`204`	No Content
`404`	Resource not found
`500`	Internal Error

Code samples for "Delete an organization repository ruleset"

delete/orgs/{org}/rulesets/{ruleset_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/rulesets/RULESET_ID

Response

Status: 204