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 an enterprise. Rulesets control how people can interact with repositories and code.

Create an enterprise repository ruleset

Create a repository ruleset for an enterprise.

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

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

  • "Enterprise administration" business permissions (write)

Parameters for "Create an enterprise repository ruleset"

Headers
accept string

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

Path parameters
enterprise string Required

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Body parameters
name string Required

The name of the ruleset.

target string

The target of the ruleset

Default: branch

Can be one of: branch, tag, push, repository

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 not available for the repository target.

Can be one of: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

actor_id integer or null

The ID of the actor that can bypass a ruleset. If actor_type is OrganizationAdmin, this should be 1. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

actor_type string Required

The type of actor that can bypass a ruleset

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

bypass_mode string

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type. Also, pull_request is only applicable to branch rulesets.

Default: always

Can be one of: always, pull_request

conditions object

Conditions for an enterprise ruleset. The conditions object should contain either the organization_id or organization_name property and the repository_name or repository_property property. For branch and tag rulesets, the conditions object should also contain the ref_name property.

organization_name_and_repository_name object Required

Conditions to target organizations by name and all repositories

organization_name object Required
include array of strings

Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all organizations and ~EMUS to target all enterprise managed user accounts.

exclude array of strings

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

repository_name object Required
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.

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

organization_name_and_repository_property object Required

Conditions to target organizations by name and repositories by property

organization_name object Required
include array of strings

Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all organizations and ~EMUS to target all enterprise managed user accounts.

exclude array of strings

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

repository_property object Required
include array of objects

The repository properties and values to include. All of these properties must match for the condition to pass.

name string Required

The name of the repository property to target

property_values array of strings Required

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Can be one of: custom, system

exclude array of objects

The repository properties and values to exclude. The condition will not pass if any of these properties match.

name string Required

The name of the repository property to target

property_values array of strings Required

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Can be one of: custom, system

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

organization_id_and_repository_name object Required

Conditions to target organizations by id and all repositories

organization_id object Required
organization_ids array of integers

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

repository_name object Required
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.

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

organization_id_and_repository_property object Required

Conditions to target organization by id and repositories by property

organization_id object Required
organization_ids array of integers

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

repository_property object Required
include array of objects

The repository properties and values to include. All of these properties must match for the condition to pass.

name string Required

The name of the repository property to target

property_values array of strings Required

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Can be one of: custom, system

exclude array of objects

The repository properties and values to exclude. The condition will not pass if any of these properties match.

name string Required

The name of the repository property to target

property_values array of strings Required

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Can be one of: custom, system

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

rules array of objects

An array of rules within the ruleset.

creation object Required

Only allow users with bypass permission to create matching refs.

type string Required

Value: creation

update object Required

Only allow users with bypass permission to update matching refs.

type string Required

Value: update

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

type string Required

Value: deletion

required_linear_history object Required

Prevent merge commits from being pushed to matching refs.

type string Required

Value: required_linear_history

merge_queue object Required

Merges must be performed via a merge queue.

type string Required

Value: merge_queue

parameters object
check_response_timeout_minutes integer Required

Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed

grouping_strategy string Required

When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.

Can be one of: ALLGREEN, HEADGREEN

max_entries_to_build integer Required

Limit the number of queued pull requests requesting checks and workflow runs at the same time.

max_entries_to_merge integer Required

The maximum number of PRs that will be merged together in a group.

merge_method string Required

Method to use when merging changes from queued pull requests.

Can be one of: MERGE, SQUASH, REBASE

min_entries_to_merge integer Required

The minimum number of PRs that will be merged together in a group.

min_entries_to_merge_wait_minutes integer Required

The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.

required_deployments object Required

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

type string Required

Value: required_deployments

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

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.

type string Required

Value: pull_request

parameters object
allowed_merge_methods array of strings

When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.

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.

type string Required

Value: required_status_checks

parameters object
do_not_enforce_on_create boolean

Allow repositories and branches to be created if a check would otherwise prohibit it.

required_status_checks array of objects Required

Status checks that are required.

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.

type string Required

Value: non_fast_forward

commit_message_pattern object Required

Parameters to be used for the commit_message_pattern rule

type string Required

Value: commit_message_pattern

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

type string Required

Value: commit_author_email_pattern

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

type string Required

Value: committer_email_pattern

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

type string Required

Value: branch_name_pattern

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

type string Required

Value: tag_name_pattern

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

file_path_restriction object Required

Prevent commits that include changes in specified file paths from being pushed to the commit graph.

type string Required

Value: file_path_restriction

parameters object
restricted_file_paths array of strings Required

The file paths that are restricted from being pushed to the commit graph.

max_file_path_length object Required

Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.

type string Required

Value: max_file_path_length

parameters object
max_file_path_length integer Required

The maximum amount of characters allowed in file paths

file_extension_restriction object Required

Prevent commits that include files with specified file extensions from being pushed to the commit graph.

type string Required

Value: file_extension_restriction

parameters object
restricted_file_extensions array of strings Required

The file extensions that are restricted from being pushed to the commit graph.

max_file_size object Required

Prevent commits that exceed a specified file size limit from being pushed to the commit.

type string Required

Value: max_file_size

parameters object
max_file_size integer Required

The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).

workflows object Required

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

type string Required

Value: workflows

parameters object
do_not_enforce_on_create boolean

Allow repositories and branches to be created if a check would otherwise prohibit it.

workflows array of objects Required

Workflows that must pass for this rule to pass.

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

code_scanning object Required

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

type string Required

Value: code_scanning

parameters object
code_scanning_tools array of objects Required

Tools that must provide code scanning results for this rule to pass.

alerts_threshold string Required

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "About code scanning alerts."

Can be one of: none, errors, errors_and_warnings, all

security_alerts_threshold string Required

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "About code scanning alerts."

Can be one of: none, critical, high_or_higher, medium_or_higher, all

tool string Required

The name of a code scanning tool

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

Status codeDescription
201

Created

404

Resource not found

500

Internal Error

Code samples for "Create an enterprise repository ruleset"

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

Request example

post/enterprises/{enterprise}/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/enterprises/ENTERPRISE/rulesets \ -d '{"name":"super cool ruleset","target":"repository","enforcement":"active","bypass_actors":[{"actor_id":234,"actor_type":"Team","bypass_mode":"always"}],"conditions":{"org_name":{"include":["important_org"],"exclude":["unimportant_org"]}},"rules":[{"type":"repository_delete"}]}'

Response

Status: 201
{ "id": 21, "name": "super cool ruleset", "target": "repository", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", "conditions": { "organization_name": { "include": [ "important_organization" ] }, "repository_name": { "include": [ "~ALL" ] } }, "rules": [ { "type": "repository_delete" } ], "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://api.github.com/enterprises/my-enterprise/rulesets/21" }, "html": { "href": "https://github.com/enterprise/my-enterprise/settings/policies/repositories/21" } }, "created_at": "2024-08-15T08:43:03Z", "updated_at": "2024-09-23T16:29:47Z" }

Get an enterprise repository ruleset

Get a repository ruleset for an enterprise.

Note: To prevent leaking sensitive information, the bypass_actors property is only returned if the user making the API request has write access to the ruleset.

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

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

  • "Enterprise administration" business permissions (write)

Parameters for "Get an enterprise repository ruleset"

Headers
accept string

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

Path parameters
enterprise string Required

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

ruleset_id integer Required

The ID of the ruleset.

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

Status codeDescription
200

OK

404

Resource not found

500

Internal Error

Code samples for "Get an enterprise repository ruleset"

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

Request example

get/enterprises/{enterprise}/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/enterprises/ENTERPRISE/rulesets/RULESET_ID

Response

Status: 200
{ "id": 21, "name": "super cool ruleset", "target": "repository", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", "conditions": { "organization_name": { "include": [ "important_organization" ] }, "repository_name": { "include": [ "~ALL" ] } }, "rules": [ { "type": "repository_delete" } ], "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://api.github.com/enterprises/my-enterprise/rulesets/21" }, "html": { "href": "https://github.com/enterprise/my-enterprise/settings/policies/repositories/21" } }, "created_at": "2024-08-15T08:43:03Z", "updated_at": "2024-09-23T16:29:47Z" }

Update an enterprise repository ruleset

Update a ruleset for an enterprise.

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

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

  • "Enterprise administration" business permissions (write)

Parameters for "Update an enterprise repository ruleset"

Headers
accept string

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

Path parameters
enterprise string Required

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

ruleset_id integer Required

The ID of the ruleset.

Body parameters
name string

The name of the ruleset.

target string

The target of the ruleset

Can be one of: branch, tag, push, repository

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 not available for the repository target.

Can be one of: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

actor_id integer or null

The ID of the actor that can bypass a ruleset. If actor_type is OrganizationAdmin, this should be 1. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

actor_type string Required

The type of actor that can bypass a ruleset

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

bypass_mode string

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type. Also, pull_request is only applicable to branch rulesets.

Default: always

Can be one of: always, pull_request

conditions object

Conditions for an enterprise ruleset. The conditions object should contain either the organization_id or organization_name property and the repository_name or repository_property property. For branch and tag rulesets, the conditions object should also contain the ref_name property.

organization_name_and_repository_name object Required

Conditions to target organizations by name and all repositories

organization_name object Required
include array of strings

Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all organizations and ~EMUS to target all enterprise managed user accounts.

exclude array of strings

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

repository_name object Required
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.

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

organization_name_and_repository_property object Required

Conditions to target organizations by name and repositories by property

organization_name object Required
include array of strings

Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all organizations and ~EMUS to target all enterprise managed user accounts.

exclude array of strings

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

repository_property object Required
include array of objects

The repository properties and values to include. All of these properties must match for the condition to pass.

name string Required

The name of the repository property to target

property_values array of strings Required

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Can be one of: custom, system

exclude array of objects

The repository properties and values to exclude. The condition will not pass if any of these properties match.

name string Required

The name of the repository property to target

property_values array of strings Required

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Can be one of: custom, system

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

organization_id_and_repository_name object Required

Conditions to target organizations by id and all repositories

organization_id object Required
organization_ids array of integers

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

repository_name object Required
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.

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

organization_id_and_repository_property object Required

Conditions to target organization by id and repositories by property

organization_id object Required
organization_ids array of integers

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

repository_property object Required
include array of objects

The repository properties and values to include. All of these properties must match for the condition to pass.

name string Required

The name of the repository property to target

property_values array of strings Required

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Can be one of: custom, system

exclude array of objects

The repository properties and values to exclude. The condition will not pass if any of these properties match.

name string Required

The name of the repository property to target

property_values array of strings Required

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Can be one of: custom, system

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

rules array of objects

An array of rules within the ruleset.

creation object Required

Only allow users with bypass permission to create matching refs.

type string Required

Value: creation

update object Required

Only allow users with bypass permission to update matching refs.

type string Required

Value: update

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

type string Required

Value: deletion

required_linear_history object Required

Prevent merge commits from being pushed to matching refs.

type string Required

Value: required_linear_history

merge_queue object Required

Merges must be performed via a merge queue.

type string Required

Value: merge_queue

parameters object
check_response_timeout_minutes integer Required

Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed

grouping_strategy string Required

When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.

Can be one of: ALLGREEN, HEADGREEN

max_entries_to_build integer Required

Limit the number of queued pull requests requesting checks and workflow runs at the same time.

max_entries_to_merge integer Required

The maximum number of PRs that will be merged together in a group.

merge_method string Required

Method to use when merging changes from queued pull requests.

Can be one of: MERGE, SQUASH, REBASE

min_entries_to_merge integer Required

The minimum number of PRs that will be merged together in a group.

min_entries_to_merge_wait_minutes integer Required

The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.

required_deployments object Required

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

type string Required

Value: required_deployments

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

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.

type string Required

Value: pull_request

parameters object
allowed_merge_methods array of strings

When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.

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.

type string Required

Value: required_status_checks

parameters object
do_not_enforce_on_create boolean

Allow repositories and branches to be created if a check would otherwise prohibit it.

required_status_checks array of objects Required

Status checks that are required.

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.

type string Required

Value: non_fast_forward

commit_message_pattern object Required

Parameters to be used for the commit_message_pattern rule

type string Required

Value: commit_message_pattern

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

type string Required

Value: commit_author_email_pattern

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

type string Required

Value: committer_email_pattern

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

type string Required

Value: branch_name_pattern

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

type string Required

Value: tag_name_pattern

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

file_path_restriction object Required

Prevent commits that include changes in specified file paths from being pushed to the commit graph.

type string Required

Value: file_path_restriction

parameters object
restricted_file_paths array of strings Required

The file paths that are restricted from being pushed to the commit graph.

max_file_path_length object Required

Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.

type string Required

Value: max_file_path_length

parameters object
max_file_path_length integer Required

The maximum amount of characters allowed in file paths

file_extension_restriction object Required

Prevent commits that include files with specified file extensions from being pushed to the commit graph.

type string Required

Value: file_extension_restriction

parameters object
restricted_file_extensions array of strings Required

The file extensions that are restricted from being pushed to the commit graph.

max_file_size object Required

Prevent commits that exceed a specified file size limit from being pushed to the commit.

type string Required

Value: max_file_size

parameters object
max_file_size integer Required

The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).

workflows object Required

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

type string Required

Value: workflows

parameters object
do_not_enforce_on_create boolean

Allow repositories and branches to be created if a check would otherwise prohibit it.

workflows array of objects Required

Workflows that must pass for this rule to pass.

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

code_scanning object Required

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

type string Required

Value: code_scanning

parameters object
code_scanning_tools array of objects Required

Tools that must provide code scanning results for this rule to pass.

alerts_threshold string Required

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "About code scanning alerts."

Can be one of: none, errors, errors_and_warnings, all

security_alerts_threshold string Required

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "About code scanning alerts."

Can be one of: none, critical, high_or_higher, medium_or_higher, all

tool string Required

The name of a code scanning tool

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

Status codeDescription
200

OK

404

Resource not found

500

Internal Error

Code samples for "Update an enterprise repository ruleset"

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

Request example

put/enterprises/{enterprise}/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/enterprises/ENTERPRISE/rulesets/RULESET_ID \ -d '{"name":"super cool ruleset","target":"repository","enforcement":"active","bypass_actors":[{"actor_id":234,"actor_type":"Team","bypass_mode":"always"}],"conditions":{"org_name":{"include":["important_org"],"exclude":["unimportant_org"]}},"rules":[{"type":"repository_delete"}]}'

Response

Status: 200
{ "id": 21, "name": "super cool ruleset", "target": "repository", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", "conditions": { "organization_name": { "include": [ "important_organization" ] }, "repository_name": { "include": [ "~ALL" ] } }, "rules": [ { "type": "repository_delete" } ], "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://api.github.com/enterprises/my-enterprise/rulesets/21" }, "html": { "href": "https://github.com/enterprise/my-enterprise/settings/policies/repositories/21" } }, "created_at": "2024-08-15T08:43:03Z", "updated_at": "2024-09-23T16:29:47Z" }

Delete an enterprise repository ruleset

Delete a ruleset for an enterprise.

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

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

  • "Enterprise administration" business permissions (write)

Parameters for "Delete an enterprise repository ruleset"

Headers
accept string

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

Path parameters
enterprise string Required

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

ruleset_id integer Required

The ID of the ruleset.

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

Status codeDescription
204

No Content

404

Resource not found

500

Internal Error

Code samples for "Delete an enterprise repository ruleset"

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

Request example

delete/enterprises/{enterprise}/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/enterprises/ENTERPRISE/rulesets/RULESET_ID

Response

Status: 204