Skip to main content
REST API теперь версия. Дополнительные сведения см. в разделе "О управлении версиями API".

Конечные точки REST API для правил

Используйте REST API для управления наборами правил для репозиториев. Наборы правил определяют, как пользователи могут взаимодействовать с выбранными ветвями и тегами в репозитории.

Get rules for a branch

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.

Подробные маркеры доступа для "Get rules for a branch

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

Маркер должен иметь следующий набор разрешений.:

  • "Metadata" repository permissions (read)

Эту конечную точку можно использовать без проверки подлинности или указанных выше упоминание разрешений, если запрашиваются только общедоступные ресурсы.

Параметры для "Get rules for a branch"

Заголовки
Имя., Тип, Description
accept string

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

Параметры пути
Имя., Тип, Description
owner string Обязательное поле

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

repo string Обязательное поле

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

branch string Обязательное поле

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

Параметры запроса
Имя., Тип, Description
per_page integer

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

По умолчанию.: 30

page integer

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

По умолчанию.: 1

Коды состояния http-ответа для "Get rules for a branch"

Код состоянияОписание
200

OK

Примеры кода для "Get rules for a branch"

Пример запроса

get/repos/{owner}/{repo}/rules/branches/{branch}
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 repository rulesets

Get all the rulesets for a repository.

Подробные маркеры доступа для "Get all repository rulesets

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

Маркер должен иметь следующий набор разрешений.:

  • "Metadata" repository permissions (read)

Эту конечную точку можно использовать без проверки подлинности или указанных выше упоминание разрешений, если запрашиваются только общедоступные ресурсы.

Параметры для "Get all repository rulesets"

Заголовки
Имя., Тип, Description
accept string

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

Параметры пути
Имя., Тип, Description
owner string Обязательное поле

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

repo string Обязательное поле

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

Параметры запроса
Имя., Тип, Description
per_page integer

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

По умолчанию.: 30

page integer

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

По умолчанию.: 1

includes_parents boolean

Include rulesets configured at higher levels that apply to this repository

По умолчанию.: true

Коды состояния http-ответа для "Get all repository rulesets"

Код состоянияОписание
200

OK

404

Resource not found

500

Internal Error

Примеры кода для "Get all repository rulesets"

Пример запроса

get/repos/{owner}/{repo}/rulesets
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/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 repository ruleset

Create a ruleset for a repository.

Подробные маркеры доступа для "Create a repository ruleset

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

Маркер должен иметь следующий набор разрешений.:

  • "Administration" repository permissions (write)

Параметры для "Create a repository ruleset"

Заголовки
Имя., Тип, Description
accept string

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

Параметры пути
Имя., Тип, Description
owner string Обязательное поле

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

repo string Обязательное поле

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

Параметры запроса
Имя., Тип, Description
name string Обязательное поле

The name of the ruleset.

target string

The target of the ruleset

Note: The push target is in beta and is subject to change.

Возможные значения: 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.

Возможные значения: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Имя., Тип, Description
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. OrganizationAdmin is not applicable for personal repositories.

actor_type string Обязательное поле

The type of actor that can bypass a ruleset.

Возможные значения: 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.

Возможные значения: always, pull_request

conditions object

Parameters for a repository ruleset ref name condition

Имя., Тип, Description
ref_name object
Имя., Тип, 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.

rules array of objects

An array of rules within the ruleset.

Имя., Тип, Description
creation object Обязательное поле

Only allow users with bypass permission to create matching refs.

Имя., Тип, Description
type string Обязательное поле

значение: creation

update object Обязательное поле

Only allow users with bypass permission to update matching refs.

Имя., Тип, Description
type string Обязательное поле

значение: update

parameters object
Имя., Тип, Description
update_allows_fetch_and_merge boolean Обязательное поле

Branch can pull changes from its upstream repository

deletion object Обязательное поле

Only allow users with bypass permissions to delete matching refs.

Имя., Тип, Description
type string Обязательное поле

значение: deletion

required_linear_history object Обязательное поле

Prevent merge commits from being pushed to matching refs.

Имя., Тип, Description
type string Обязательное поле

значение: required_linear_history

required_deployments object Обязательное поле

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

Имя., Тип, Description
type string Обязательное поле

значение: required_deployments

parameters object
Имя., Тип, Description
required_deployment_environments array of strings Обязательное поле

The environments that must be successfully deployed to before branches can be merged.

required_signatures object Обязательное поле

Commits pushed to matching refs must have verified signatures.

Имя., Тип, Description
type string Обязательное поле

значение: required_signatures

pull_request object Обязательное поле

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

Имя., Тип, Description
type string Обязательное поле

значение: pull_request

parameters object
Имя., Тип, Description
dismiss_stale_reviews_on_push boolean Обязательное поле

New, reviewable commits pushed will dismiss previous pull request review approvals.

require_code_owner_review boolean Обязательное поле

Require an approving review in pull requests that modify files that have a designated code owner.

require_last_push_approval boolean Обязательное поле

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

required_approving_review_count integer Обязательное поле

The number of approving reviews that are required before a pull request can be merged.

required_review_thread_resolution boolean Обязательное поле

All conversations on code must be resolved before a pull request can be merged.

required_status_checks object Обязательное поле

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.

Имя., Тип, Description
type string Обязательное поле

значение: required_status_checks

parameters object
Имя., Тип, Description
required_status_checks array of objects Обязательное поле

Status checks that are required.

Имя., Тип, Description
context string Обязательное поле

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 Обязательное поле

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 Обязательное поле

Prevent users with push access from force pushing to refs.

Имя., Тип, Description
type string Обязательное поле

значение: non_fast_forward

commit_message_pattern object Обязательное поле

Parameters to be used for the commit_message_pattern rule

Имя., Тип, Description
type string Обязательное поле

значение: commit_message_pattern

parameters object
Имя., Тип, Description
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Обязательное поле

The operator to use for matching.

Возможные значения: starts_with, ends_with, contains, regex

pattern string Обязательное поле

The pattern to match with.

commit_author_email_pattern object Обязательное поле

Parameters to be used for the commit_author_email_pattern rule

Имя., Тип, Description
type string Обязательное поле

значение: commit_author_email_pattern

parameters object
Имя., Тип, Description
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Обязательное поле

The operator to use for matching.

Возможные значения: starts_with, ends_with, contains, regex

pattern string Обязательное поле

The pattern to match with.

committer_email_pattern object Обязательное поле

Parameters to be used for the committer_email_pattern rule

Имя., Тип, Description
type string Обязательное поле

значение: committer_email_pattern

parameters object
Имя., Тип, Description
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Обязательное поле

The operator to use for matching.

Возможные значения: starts_with, ends_with, contains, regex

pattern string Обязательное поле

The pattern to match with.

branch_name_pattern object Обязательное поле

Parameters to be used for the branch_name_pattern rule

Имя., Тип, Description
type string Обязательное поле

значение: branch_name_pattern

parameters object
Имя., Тип, Description
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Обязательное поле

The operator to use for matching.

Возможные значения: starts_with, ends_with, contains, regex

pattern string Обязательное поле

The pattern to match with.

tag_name_pattern object Обязательное поле

Parameters to be used for the tag_name_pattern rule

Имя., Тип, Description
type string Обязательное поле

значение: tag_name_pattern

parameters object
Имя., Тип, Description
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Обязательное поле

The operator to use for matching.

Возможные значения: starts_with, ends_with, contains, regex

pattern string Обязательное поле

The pattern to match with.

file_path_restriction object Обязательное поле

Note: file_path_restriction is in beta and subject to change.

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

Имя., Тип, Description
type string Обязательное поле

значение: file_path_restriction

parameters object
Имя., Тип, Description
restricted_file_paths array of strings Обязательное поле

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

max_file_path_length object Обязательное поле

Note: max_file_path_length is in beta and subject to change.

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

Имя., Тип, Description
type string Обязательное поле

значение: max_file_path_length

parameters object
Имя., Тип, Description
max_file_path_length integer Обязательное поле

The maximum amount of characters allowed in file paths

file_extension_restriction object Обязательное поле

Note: file_extension_restriction is in beta and subject to change.

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

Имя., Тип, Description
type string Обязательное поле

значение: file_extension_restriction

parameters object
Имя., Тип, Description
restricted_file_extensions array of strings Обязательное поле

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

max_file_size object Обязательное поле

Note: max_file_size is in beta and subject to change.

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

Имя., Тип, Description
type string Обязательное поле

значение: max_file_size

parameters object
Имя., Тип, Description
max_file_size integer Обязательное поле

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

workflows object Обязательное поле

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

Имя., Тип, Description
type string Обязательное поле

значение: workflows

parameters object
Имя., Тип, Description
workflows array of objects Обязательное поле

Workflows that must pass for this rule to pass.

Имя., Тип, Description
path string Обязательное поле

The path to the workflow file

ref string

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

repository_id integer Обязательное поле

The ID of the repository where the workflow is defined

sha string

The commit SHA of the workflow file to use

code_scanning object Обязательное поле

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.

Имя., Тип, Description
type string Обязательное поле

значение: code_scanning

parameters object
Имя., Тип, Description
code_scanning_tools array of objects Обязательное поле

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

Имя., Тип, Description
alerts_threshold string Обязательное поле

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

Возможные значения: none, errors, errors_and_warnings, all

security_alerts_threshold string Обязательное поле

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

Возможные значения: none, critical, high_or_higher, medium_or_higher, all

tool string Обязательное поле

The name of a code scanning tool

Коды состояния http-ответа для "Create a repository ruleset"

Код состоянияОписание
201

Created

404

Resource not found

500

Internal Error

Примеры кода для "Create a repository ruleset"

Пример запроса

post/repos/{owner}/{repo}/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/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 repository ruleset

Get a ruleset for a repository.

Подробные маркеры доступа для "Get a repository ruleset

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

Маркер должен иметь следующий набор разрешений.:

  • "Metadata" repository permissions (read)

Эту конечную точку можно использовать без проверки подлинности или указанных выше упоминание разрешений, если запрашиваются только общедоступные ресурсы.

Параметры для "Get a repository ruleset"

Заголовки
Имя., Тип, Description
accept string

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

Параметры пути
Имя., Тип, Description
owner string Обязательное поле

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

repo string Обязательное поле

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

ruleset_id integer Обязательное поле

The ID of the ruleset.

Параметры запроса
Имя., Тип, Description
includes_parents boolean

Include rulesets configured at higher levels that apply to this repository

По умолчанию.: true

Коды состояния http-ответа для "Get a repository ruleset"

Код состоянияОписание
200

OK

404

Resource not found

500

Internal Error

Примеры кода для "Get a repository ruleset"

Пример запроса

get/repos/{owner}/{repo}/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/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 repository ruleset

Update a ruleset for a repository.

Подробные маркеры доступа для "Update a repository ruleset

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

Маркер должен иметь следующий набор разрешений.:

  • "Administration" repository permissions (write)

Параметры для "Update a repository ruleset"

Заголовки
Имя., Тип, Description
accept string

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

Параметры пути
Имя., Тип, Description
owner string Обязательное поле

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

repo string Обязательное поле

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

ruleset_id integer Обязательное поле

The ID of the ruleset.

Параметры запроса
Имя., Тип, Description
name string

The name of the ruleset.

target string

The target of the ruleset

Note: The push target is in beta and is subject to change.

Возможные значения: 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.

Возможные значения: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Имя., Тип, Description
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. OrganizationAdmin is not applicable for personal repositories.

actor_type string Обязательное поле

The type of actor that can bypass a ruleset.

Возможные значения: 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.

Возможные значения: always, pull_request

conditions object

Parameters for a repository ruleset ref name condition

Имя., Тип, Description
ref_name object
Имя., Тип, 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.

rules array of objects

An array of rules within the ruleset.

Имя., Тип, Description
creation object Обязательное поле

Only allow users with bypass permission to create matching refs.

Имя., Тип, Description
type string Обязательное поле

значение: creation

update object Обязательное поле

Only allow users with bypass permission to update matching refs.

Имя., Тип, Description
type string Обязательное поле

значение: update

parameters object
Имя., Тип, Description
update_allows_fetch_and_merge boolean Обязательное поле

Branch can pull changes from its upstream repository

deletion object Обязательное поле

Only allow users with bypass permissions to delete matching refs.

Имя., Тип, Description
type string Обязательное поле

значение: deletion

required_linear_history object Обязательное поле

Prevent merge commits from being pushed to matching refs.

Имя., Тип, Description
type string Обязательное поле

значение: required_linear_history

required_deployments object Обязательное поле

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

Имя., Тип, Description
type string Обязательное поле

значение: required_deployments

parameters object
Имя., Тип, Description
required_deployment_environments array of strings Обязательное поле

The environments that must be successfully deployed to before branches can be merged.

required_signatures object Обязательное поле

Commits pushed to matching refs must have verified signatures.

Имя., Тип, Description
type string Обязательное поле

значение: required_signatures

pull_request object Обязательное поле

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

Имя., Тип, Description
type string Обязательное поле

значение: pull_request

parameters object
Имя., Тип, Description
dismiss_stale_reviews_on_push boolean Обязательное поле

New, reviewable commits pushed will dismiss previous pull request review approvals.

require_code_owner_review boolean Обязательное поле

Require an approving review in pull requests that modify files that have a designated code owner.

require_last_push_approval boolean Обязательное поле

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

required_approving_review_count integer Обязательное поле

The number of approving reviews that are required before a pull request can be merged.

required_review_thread_resolution boolean Обязательное поле

All conversations on code must be resolved before a pull request can be merged.

required_status_checks object Обязательное поле

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.

Имя., Тип, Description
type string Обязательное поле

значение: required_status_checks

parameters object
Имя., Тип, Description
required_status_checks array of objects Обязательное поле

Status checks that are required.

Имя., Тип, Description
context string Обязательное поле

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 Обязательное поле

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 Обязательное поле

Prevent users with push access from force pushing to refs.

Имя., Тип, Description
type string Обязательное поле

значение: non_fast_forward

commit_message_pattern object Обязательное поле

Parameters to be used for the commit_message_pattern rule

Имя., Тип, Description
type string Обязательное поле

значение: commit_message_pattern

parameters object
Имя., Тип, Description
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Обязательное поле

The operator to use for matching.

Возможные значения: starts_with, ends_with, contains, regex

pattern string Обязательное поле

The pattern to match with.

commit_author_email_pattern object Обязательное поле

Parameters to be used for the commit_author_email_pattern rule

Имя., Тип, Description
type string Обязательное поле

значение: commit_author_email_pattern

parameters object
Имя., Тип, Description
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Обязательное поле

The operator to use for matching.

Возможные значения: starts_with, ends_with, contains, regex

pattern string Обязательное поле

The pattern to match with.

committer_email_pattern object Обязательное поле

Parameters to be used for the committer_email_pattern rule

Имя., Тип, Description
type string Обязательное поле

значение: committer_email_pattern

parameters object
Имя., Тип, Description
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Обязательное поле

The operator to use for matching.

Возможные значения: starts_with, ends_with, contains, regex

pattern string Обязательное поле

The pattern to match with.

branch_name_pattern object Обязательное поле

Parameters to be used for the branch_name_pattern rule

Имя., Тип, Description
type string Обязательное поле

значение: branch_name_pattern

parameters object
Имя., Тип, Description
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Обязательное поле

The operator to use for matching.

Возможные значения: starts_with, ends_with, contains, regex

pattern string Обязательное поле

The pattern to match with.

tag_name_pattern object Обязательное поле

Parameters to be used for the tag_name_pattern rule

Имя., Тип, Description
type string Обязательное поле

значение: tag_name_pattern

parameters object
Имя., Тип, Description
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Обязательное поле

The operator to use for matching.

Возможные значения: starts_with, ends_with, contains, regex

pattern string Обязательное поле

The pattern to match with.

file_path_restriction object Обязательное поле

Note: file_path_restriction is in beta and subject to change.

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

Имя., Тип, Description
type string Обязательное поле

значение: file_path_restriction

parameters object
Имя., Тип, Description
restricted_file_paths array of strings Обязательное поле

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

max_file_path_length object Обязательное поле

Note: max_file_path_length is in beta and subject to change.

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

Имя., Тип, Description
type string Обязательное поле

значение: max_file_path_length

parameters object
Имя., Тип, Description
max_file_path_length integer Обязательное поле

The maximum amount of characters allowed in file paths

file_extension_restriction object Обязательное поле

Note: file_extension_restriction is in beta and subject to change.

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

Имя., Тип, Description
type string Обязательное поле

значение: file_extension_restriction

parameters object
Имя., Тип, Description
restricted_file_extensions array of strings Обязательное поле

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

max_file_size object Обязательное поле

Note: max_file_size is in beta and subject to change.

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

Имя., Тип, Description
type string Обязательное поле

значение: max_file_size

parameters object
Имя., Тип, Description
max_file_size integer Обязательное поле

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

workflows object Обязательное поле

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

Имя., Тип, Description
type string Обязательное поле

значение: workflows

parameters object
Имя., Тип, Description
workflows array of objects Обязательное поле

Workflows that must pass for this rule to pass.

Имя., Тип, Description
path string Обязательное поле

The path to the workflow file

ref string

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

repository_id integer Обязательное поле

The ID of the repository where the workflow is defined

sha string

The commit SHA of the workflow file to use

code_scanning object Обязательное поле

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.

Имя., Тип, Description
type string Обязательное поле

значение: code_scanning

parameters object
Имя., Тип, Description
code_scanning_tools array of objects Обязательное поле

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

Имя., Тип, Description
alerts_threshold string Обязательное поле

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

Возможные значения: none, errors, errors_and_warnings, all

security_alerts_threshold string Обязательное поле

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

Возможные значения: none, critical, high_or_higher, medium_or_higher, all

tool string Обязательное поле

The name of a code scanning tool

Коды состояния http-ответа для "Update a repository ruleset"

Код состоянияОписание
200

OK

404

Resource not found

500

Internal Error

Примеры кода для "Update a repository ruleset"

Пример запроса

put/repos/{owner}/{repo}/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/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 a repository ruleset

Delete a ruleset for a repository.

Подробные маркеры доступа для "Delete a repository ruleset

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

Маркер должен иметь следующий набор разрешений.:

  • "Administration" repository permissions (write)

Параметры для "Delete a repository ruleset"

Заголовки
Имя., Тип, Description
accept string

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

Параметры пути
Имя., Тип, Description
owner string Обязательное поле

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

repo string Обязательное поле

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

ruleset_id integer Обязательное поле

The ID of the ruleset.

Коды состояния http-ответа для "Delete a repository ruleset"

Код состоянияОписание
204

No Content

404

Resource not found

500

Internal Error

Примеры кода для "Delete a repository ruleset"

Пример запроса

delete/repos/{owner}/{repo}/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/repos/OWNER/REPO/rulesets/RULESET_ID

Response

Status: 204