Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.github.com/en/rest/repos/rules below:

REST API endpoints for rules

Use the REST API to manage rulesets for repositories. Rulesets control how people can interact with selected branches and tags in a repository.

Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" enforcement statuses are not returned.

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

• GitHub App user access tokens
• GitHub App installation access tokens
• Fine-grained personal access tokens

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

• "Metadata" repository permissions (read)

This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.

accept string

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

owner string Required

The account owner of the repository. The name is not case sensitive.

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

branch string Required

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

OK

get/repos/{owner}/{repo}/rules/branches/{branch}

Copy to clipboard curl request example

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/repos/OWNER/REPO/rules/branches/BRANCH

Response

Status: 200

[ { "type": "commit_message_pattern", "ruleset_source_type": "Repository", "ruleset_source": "monalisa/my-repo", "ruleset_id": 42, "parameters": { "operator": "starts_with", "pattern": "issue" } }, { "type": "commit_author_email_pattern", "ruleset_source_type": "Organization", "ruleset_source": "my-org", "ruleset_id": 73, "parameters": { "operator": "contains", "pattern": "github" } } ]

Get all the rulesets for a repository.

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

• GitHub App user access tokens
• GitHub App installation access tokens
• Fine-grained personal access tokens

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

• "Metadata" repository permissions (read)

This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.

accept string

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

owner string Required

The account owner of the repository. The name is not case sensitive.

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

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

includes_parents boolean

Include rulesets configured at higher levels that apply to this repository

Default: true

targets string

A comma-separated list of rule targets to filter by. If provided, only rulesets that apply to the specified targets will be returned. For example, branch,tag,push.

OK

Resource not found

Internal Error

get/repos/{owner}/{repo}/rulesets

Copy to clipboard curl request example

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/repos/OWNER/REPO/rulesets

Response

Status: 200

[ { "id": 42, "name": "super cool ruleset", "source_type": "Repository", "source": "monalisa/my-repo", "enforcement": "enabled", "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42" }, "html": { "href": "https://github.com/monalisa/my-repo/rules/42" } }, "created_at": "2023-07-15T08:43:03Z", "updated_at": "2023-08-23T16:29:47Z" }, { "id": 314, "name": "Another ruleset", "source_type": "Repository", "source": "monalisa/my-repo", "enforcement": "enabled", "node_id": "RRS_lACkVXNlcgQQ", "_links": { "self": { "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/314" }, "html": { "href": "https://github.com/monalisa/my-repo/rules/314" } }, "created_at": "2023-08-15T08:43:03Z", "updated_at": "2023-09-23T16:29:47Z" } ]

Create a ruleset for a repository.

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

• GitHub App user access tokens
• GitHub App installation access tokens
• Fine-grained personal access tokens

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

• "Administration" repository permissions (write)

accept string

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

owner string Required

The account owner of the repository. The name is not case sensitive.

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

name string Required

The name of the ruleset.

target string

The target of the ruleset

Default: branch

Can be one of: branch, tag, push

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

actor_id integer or null

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, this should be 1. If actor_type is DeployKey, this should be null. OrganizationAdmin is 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

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

Parameters for a repository ruleset ref name condition

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

Array of allowed merge methods. Allowed values include merge, squash, and rebase. At least one option must be enabled. Supported values are: merge, squash, rebase

automatic_copilot_code_review_enabled boolean

Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.

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 and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.

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 the 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 with individual files that exceed the specified limit from being pushed to the commit graph.

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

Created

Resource not found

Internal Error

post/repos/{owner}/{repo}/rulesets

Copy to clipboard curl request example

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/repos/OWNER/REPO/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*"]}},"rules":[{"type":"commit_author_email_pattern","parameters":{"operator":"contains","pattern":"github"}}]}'

Response

Status: 201

{ "id": 42, "name": "super cool ruleset", "target": "branch", "source_type": "Repository", "source": "monalisa/my-repo", "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*" ] } }, "rules": [ { "type": "commit_author_email_pattern", "parameters": { "operator": "contains", "pattern": "github" } } ], "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42" }, "html": { "href": "https://github.com/monalisa/my-repo/rules/42" } }, "created_at": "2023-07-15T08:43:03Z", "updated_at": "2023-08-23T16:29:47Z" }

Get a ruleset for a repository.

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.

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

• GitHub App user access tokens
• GitHub App installation access tokens
• Fine-grained personal access tokens

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

• "Metadata" repository permissions (read)

This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.

accept string

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

owner string Required

The account owner of the repository. The name is not case sensitive.

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

ruleset_id integer Required

The ID of the ruleset.

includes_parents boolean

Include rulesets configured at higher levels that apply to this repository

Default: true

OK

Resource not found

Internal Error

get/repos/{owner}/{repo}/rulesets/{ruleset_id}

Copy to clipboard curl request example

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/repos/OWNER/REPO/rulesets/RULESET_ID

Response

Status: 200

{ "id": 42, "name": "super cool ruleset", "target": "branch", "source_type": "Repository", "source": "monalisa/my-repo", "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*" ] } }, "rules": [ { "type": "commit_author_email_pattern", "parameters": { "operator": "contains", "pattern": "github" } } ], "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42" }, "html": { "href": "https://github.com/monalisa/my-repo/rules/42" } }, "created_at": "2023-07-15T08:43:03Z", "updated_at": "2023-08-23T16:29:47Z" }

Update a ruleset for a repository.

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

• GitHub App user access tokens
• GitHub App installation access tokens
• Fine-grained personal access tokens

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

• "Administration" repository permissions (write)

accept string

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

owner string Required

The account owner of the repository. The name is not case sensitive.

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

ruleset_id integer Required

The ID of the ruleset.

name string

The name of the ruleset.

target string

The target of the ruleset

Can be one of: branch, tag, push

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

actor_id integer or null

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, this should be 1. If actor_type is DeployKey, this should be null. OrganizationAdmin is 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

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

Parameters for a repository ruleset ref name condition

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

Array of allowed merge methods. Allowed values include merge, squash, and rebase. At least one option must be enabled. Supported values are: merge, squash, rebase

automatic_copilot_code_review_enabled boolean

Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.

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 and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.

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 the 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 with individual files that exceed the specified limit from being pushed to the commit graph.

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

OK

Resource not found

Internal Error

put/repos/{owner}/{repo}/rulesets/{ruleset_id}

Copy to clipboard curl request example

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/repos/OWNER/REPO/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*"]}},"rules":[{"type":"commit_author_email_pattern","parameters":{"operator":"contains","pattern":"github"}}]}'

Response

Status: 200

{ "id": 42, "name": "super cool ruleset", "target": "branch", "source_type": "Repository", "source": "monalisa/my-repo", "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*" ] } }, "rules": [ { "type": "commit_author_email_pattern", "parameters": { "operator": "contains", "pattern": "github" } } ], "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42" }, "html": { "href": "https://github.com/monalisa/my-repo/rules/42" } }, "created_at": "2023-07-15T08:43:03Z", "updated_at": "2023-08-23T16:29:47Z" }

delete/repos/{owner}/{repo}/rulesets/{ruleset_id}

Copy to clipboard curl request example

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/repos/OWNER/REPO/rulesets/RULESET_ID

Response

get/repos/{owner}/{repo}/rulesets/{ruleset_id}/history

Copy to clipboard curl request example

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/repos/OWNER/REPO/rulesets/RULESET_ID/history

Response

Status: 200

[ { "version_id": 3, "actor": { "id": 1, "type": "User" }, "updated_at": "2024-010-23T16:29:47Z" }, { "version_id": 2, "actor": { "id": 2, "type": "User" }, "updated_at": "2024-09-23T16:29:47Z" }, { "version_id": 1, "actor": { "id": 1, "type": "User" }, "updated_at": "2024-08-23T16:29:47Z" } ]

get/repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id}

Copy to clipboard curl request example

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/repos/OWNER/REPO/rulesets/RULESET_ID/history/VERSION_ID

Response

Status: 200

[ { "version_id": 3, "actor": { "id": 1, "type": "User" }, "updated_at": "2024-010-23T16:29:47Z", "state": { "id": 42, "name": "super cool ruleset", "target": "branch", "source_type": "Repository", "source": "monalisa/my-repo", "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*" ] } }, "rules": [ { "type": "commit_author_email_pattern", "parameters": { "operator": "contains", "pattern": "github" } } ] } } ]

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4