Skip to main content
The REST API is now versioned. For more information, see "About API versioning."

REST API endpoints for rules

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

Get all organization repository rulesets

Get all the repository rulesets for an organization.

Fine-grained access tokens for "Get all organization repository rulesets"

This endpoint works with the following token types:

The token must have the following permission set:

  • organization_administration:write

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.

Query parameters
Name, Type, Description
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Default: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Default: 1

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

Status codeDescription
200

OK

404

Resource not found

500

Internal Error

Code samples for "Get all organization repository rulesets"

Request example

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" \ http(s)://HOSTNAME/api/v3/orgs/ORG/rulesets

Response

Status: 200
[ { "id": 21, "name": "super cool ruleset", "source_type": "Organization", "source": "my-org", "enforcement": "enabled", "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://HOSTNAME/orgs/my-org/rulesets/21" }, "html": { "href": "https://github.com/organizations/my-org/settings/rules/21" } }, "created_at": "2023-07-15T08:43:03Z", "updated_at": "2023-08-23T16:29:47Z" }, { "id": 432, "name": "Another ruleset", "source_type": "Organization", "source": "my-org", "enforcement": "enabled", "node_id": "RRS_lACkVXNlcgQQ", "_links": { "self": { "href": "https://HOSTNAME/orgs/my-org/rulesets/432" }, "html": { "href": "https://github.com/organizations/my-org/settings/rules/432" } }, "created_at": "2023-08-15T08:43:03Z", "updated_at": "2023-09-23T16:29:47Z" } ]

Create an organization repository ruleset

Create a repository ruleset for an organization.

Fine-grained access tokens for "Create an organization repository ruleset"

This endpoint works with the following token types:

The token must have the following permission set:

  • organization_administration:write

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.

Can be one of: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Name, Type, Description
actor_id integer Required

The ID of the actor that can bypass a ruleset. If actor_type is OrganizationAdmin, this should be 1.

actor_type string Required

The type of actor that can bypass a ruleset

Can be one of: RepositoryRole, Team, Integration, OrganizationAdmin

bypass_mode string Required

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests.

Can be one of: always, pull_request

conditions object

Conditions for an organization ruleset. The conditions object should contain both repository_name and ref_name properties or both repository_id and ref_name properties.

Name, Type, Description
repository_name_and_ref_name object Required

Conditions to target repositories by name and refs by name

Name, Type, Description
ref_name object
Name, Type, Description
include array of strings

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

repository_name object Required
Name, Type, Description
include array of strings

Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.

exclude array of strings

Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

protected boolean

Whether renaming of target repositories is prevented.

repository_id_and_ref_name object Required

Conditions to target repositories by id and refs by name

Name, Type, Description
ref_name object
Name, Type, Description
include array of strings

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

repository_id object Required
Name, Type, Description
repository_ids array of integers

The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

rules array of objects

An array of rules within the ruleset.

Name, Type, Description
creation object Required

Only allow users with bypass permission to create matching refs.

Name, Type, Description
type string Required

Value: creation

update object Required

Only allow users with bypass permission to update matching refs.

Name, Type, Description
type string Required

Value: update

parameters object
Name, Type, Description
update_allows_fetch_and_merge boolean Required

Branch can pull changes from its upstream repository

deletion object Required

Only allow users with bypass permissions to delete matching refs.

Name, Type, Description
type string Required

Value: deletion

required_linear_history object Required

Prevent merge commits from being pushed to matching refs.

Name, Type, Description
type string Required

Value: required_linear_history

required_deployments object Required

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

Name, Type, Description
type string Required

Value: required_deployments

parameters object
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

Commits pushed to matching refs must have verified signatures.

Name, Type, Description
type string Required

Value: required_signatures

pull_request object Required

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

Name, Type, Description
type string Required

Value: pull_request

parameters object
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

Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.

Name, Type, Description
type string Required

Value: required_status_checks

parameters object
Name, Type, Description
required_status_checks array of objects Required

Status checks that are required.

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

Prevent users with push access from force pushing to refs.

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

Name, Type, Description
type string Required

Value: commit_message_pattern

parameters object
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

Name, Type, Description
type string Required

Value: commit_author_email_pattern

parameters object
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

Name, Type, Description
type string Required

Value: committer_email_pattern

parameters object
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

Name, Type, Description
type string Required

Value: branch_name_pattern

parameters object
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

Name, Type, Description
type string Required

Value: tag_name_pattern

parameters object
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.

workflows object Required

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

Name, Type, Description
type string Required

Value: workflows

parameters object
Name, Type, Description
workflows array of objects Required

Workflows that must pass for this rule to pass.

Name, Type, Description
path string Required

The path to the workflow file

ref string

The ref (branch or tag) of the workflow file to use

repository_id integer Required

The ID of the repository where the workflow is defined

sha string

The commit SHA of the workflow file to use

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

Status codeDescription
201

Created

404

Resource not found

500

Internal Error

Code samples for "Create an organization repository ruleset"

Request example

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" \ http(s)://HOSTNAME/api/v3/orgs/ORG/rulesets \ -d '{"name":"super cool ruleset","target":"branch","enforcement":"active","bypass_actors":[{"actor_id":234,"actor_type":"Team","bypass_mode":"always"}],"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"}}]}'

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", "bypass_mode": "always" } ], "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" } } ], "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://HOSTNAME/orgs/my-org/rulesets/21" }, "html": { "href": "https://github.com/organizations/my-org/settings/rules/21" } }, "created_at": "2023-08-15T08:43:03Z", "updated_at": "2023-09-23T16:29:47Z" }

Get an organization repository ruleset

Get a repository ruleset for an organization.

Fine-grained access tokens for "Get an organization repository ruleset"

This endpoint works with the following token types:

The token must have the following permission set:

  • organization_administration:write

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 codeDescription
200

OK

404

Resource not found

500

Internal Error

Code samples for "Get an organization repository ruleset"

Request example

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" \ http(s)://HOSTNAME/api/v3/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", "bypass_mode": "always" } ], "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" } } ], "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://HOSTNAME/orgs/my-org/rulesets/21" }, "html": { "href": "https://github.com/organizations/my-org/settings/rules/21" } }, "created_at": "2023-08-15T08:43:03Z", "updated_at": "2023-09-23T16:29:47Z" }

Update an organization repository ruleset

Update a ruleset for an organization.

Fine-grained access tokens for "Update an organization repository ruleset"

This endpoint works with the following token types:

The token must have the following permission set:

  • organization_administration:write

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.

Can be one of: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Name, Type, Description
actor_id integer Required

The ID of the actor that can bypass a ruleset. If actor_type is OrganizationAdmin, this should be 1.

actor_type string Required

The type of actor that can bypass a ruleset

Can be one of: RepositoryRole, Team, Integration, OrganizationAdmin

bypass_mode string Required

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests.

Can be one of: always, pull_request

conditions object

Conditions for an organization ruleset. The conditions object should contain both repository_name and ref_name properties or both repository_id and ref_name properties.

Name, Type, Description
repository_name_and_ref_name object Required

Conditions to target repositories by name and refs by name

Name, Type, Description
ref_name object
Name, Type, Description
include array of strings

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

repository_name object Required
Name, Type, Description
include array of strings

Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.

exclude array of strings

Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

protected boolean

Whether renaming of target repositories is prevented.

repository_id_and_ref_name object Required

Conditions to target repositories by id and refs by name

Name, Type, Description
ref_name object
Name, Type, Description
include array of strings

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

repository_id object Required
Name, Type, Description
repository_ids array of integers

The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

rules array of objects

An array of rules within the ruleset.

Name, Type, Description
creation object Required

Only allow users with bypass permission to create matching refs.

Name, Type, Description
type string Required

Value: creation

update object Required

Only allow users with bypass permission to update matching refs.

Name, Type, Description
type string Required

Value: update

parameters object
Name, Type, Description
update_allows_fetch_and_merge boolean Required

Branch can pull changes from its upstream repository

deletion object Required

Only allow users with bypass permissions to delete matching refs.

Name, Type, Description
type string Required

Value: deletion

required_linear_history object Required

Prevent merge commits from being pushed to matching refs.

Name, Type, Description
type string Required

Value: required_linear_history

required_deployments object Required

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

Name, Type, Description
type string Required

Value: required_deployments

parameters object
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

Commits pushed to matching refs must have verified signatures.

Name, Type, Description
type string Required

Value: required_signatures

pull_request object Required

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

Name, Type, Description
type string Required

Value: pull_request

parameters object
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

Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.

Name, Type, Description
type string Required

Value: required_status_checks

parameters object
Name, Type, Description
required_status_checks array of objects Required

Status checks that are required.

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

Prevent users with push access from force pushing to refs.

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

Name, Type, Description
type string Required

Value: commit_message_pattern

parameters object
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

Name, Type, Description
type string Required

Value: commit_author_email_pattern

parameters object
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

Name, Type, Description
type string Required

Value: committer_email_pattern

parameters object
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

Name, Type, Description
type string Required

Value: branch_name_pattern

parameters object
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

Name, Type, Description
type string Required

Value: tag_name_pattern

parameters object
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.

workflows object Required

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

Name, Type, Description
type string Required

Value: workflows

parameters object
Name, Type, Description
workflows array of objects Required

Workflows that must pass for this rule to pass.

Name, Type, Description
path string Required

The path to the workflow file

ref string

The ref (branch or tag) of the workflow file to use

repository_id integer Required

The ID of the repository where the workflow is defined

sha string

The commit SHA of the workflow file to use

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

Status codeDescription
200

OK

404

Resource not found

500

Internal Error

Code samples for "Update an organization repository ruleset"

Request example

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" \ http(s)://HOSTNAME/api/v3/orgs/ORG/rulesets/RULESET_ID \ -d '{"name":"super cool ruleset","target":"branch","enforcement":"active","bypass_actors":[{"actor_id":234,"actor_type":"Team","bypass_mode":"always"}],"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"}}]}'

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", "bypass_mode": "always" } ], "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" } } ], "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://HOSTNAME/orgs/my-org/rulesets/21" }, "html": { "href": "https://github.com/organizations/my-org/settings/rules/21" } }, "created_at": "2023-08-15T08:43:03Z", "updated_at": "2023-09-23T16:29:47Z" }

Delete an organization repository ruleset

Delete a ruleset for an organization.

Fine-grained access tokens for "Delete an organization repository ruleset"

This endpoint works with the following token types:

The token must have the following permission set:

  • organization_administration:write

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 codeDescription
204

No Content

404

Resource not found

500

Internal Error

Code samples for "Delete an organization repository ruleset"

Request example

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" \ http(s)://HOSTNAME/api/v3/orgs/ORG/rulesets/RULESET_ID

Response

Status: 204