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"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰에는 다음 권한 집합이 있어야 합니다.:

  • "Metadata" repository permissions (read)

공용 리소스만 요청되는 경우 인증 또는 앞서 언급한 권한 없이 이 엔드포인트를 사용할 수 있습니다.

"Get rules for a branch"에 대한 매개 변수

머리글
속성, 형식, 설명
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.

쿼리 매개 변수
속성, 형식, 설명
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

"Get rules for a branch"에 대한 HTTP 응답 상태 코드

상태 코드설명
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"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰에는 다음 권한 집합이 있어야 합니다.:

  • "Metadata" repository permissions (read)

공용 리소스만 요청되는 경우 인증 또는 앞서 언급한 권한 없이 이 엔드포인트를 사용할 수 있습니다.

"Get all repository rulesets"에 대한 매개 변수

머리글
속성, 형식, 설명
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."

기본값: 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

"Get all repository rulesets"에 대한 HTTP 응답 상태 코드

상태 코드설명
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"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰에는 다음 권한 집합이 있어야 합니다.:

  • "Administration" repository permissions (write)

"Create a repository ruleset"에 대한 매개 변수

머리글
속성, 형식, 설명
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

Note

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

다음 중 하나일 수 있습니다.: 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.

다음 중 하나일 수 있습니다.: 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. OrganizationAdmin is not applicable for personal repositories.

actor_type string Required

The type of actor that can bypass a ruleset.

다음 중 하나일 수 있습니다.: Integration, OrganizationAdmin, RepositoryRole, Team, DeployKey

bypass_mode string Required

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

다음 중 하나일 수 있습니다.: 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

: creation

update object Required

Only allow users with bypass permission to update matching refs.

속성, 형식, 설명
type string Required

: 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

: deletion

required_linear_history object Required

Prevent merge commits from being pushed to matching refs.

속성, 형식, 설명
type string Required

: required_linear_history

required_deployments object Required

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

속성, 형식, 설명
type string Required

: 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

: 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

: pull_request

parameters object
속성, 형식, 설명
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

: required_status_checks

parameters object
속성, 형식, 설명
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

: non_fast_forward

commit_message_pattern object Required

Parameters to be used for the commit_message_pattern rule

속성, 형식, 설명
type string Required

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

다음 중 하나일 수 있습니다.: 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

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

다음 중 하나일 수 있습니다.: 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

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

다음 중 하나일 수 있습니다.: 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

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

다음 중 하나일 수 있습니다.: 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

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

다음 중 하나일 수 있습니다.: starts_with, ends_with, contains, regex

pattern string Required

The pattern to match with.

file_path_restriction object Required

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.

속성, 형식, 설명
type string Required

: 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

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.

속성, 형식, 설명
type string Required

: 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

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.

속성, 형식, 설명
type string Required

: 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

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.

속성, 형식, 설명
type string Required

: 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

: workflows

parameters object
속성, 형식, 설명
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

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

다음 중 하나일 수 있습니다.: 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."

다음 중 하나일 수 있습니다.: none, critical, high_or_higher, medium_or_higher, all

tool string Required

The name of a code scanning tool

"Create a repository ruleset"에 대한 HTTP 응답 상태 코드

상태 코드설명
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"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰에는 다음 권한 집합이 있어야 합니다.:

  • "Metadata" repository permissions (read)

공용 리소스만 요청되는 경우 인증 또는 앞서 언급한 권한 없이 이 엔드포인트를 사용할 수 있습니다.

"Get a repository ruleset"에 대한 매개 변수

머리글
속성, 형식, 설명
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

기본값: true

"Get a repository ruleset"에 대한 HTTP 응답 상태 코드

상태 코드설명
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"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰에는 다음 권한 집합이 있어야 합니다.:

  • "Administration" repository permissions (write)

"Update a repository ruleset"에 대한 매개 변수

머리글
속성, 형식, 설명
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

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

속성, 형식, 설명
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 Required

The type of actor that can bypass a ruleset.

다음 중 하나일 수 있습니다.: Integration, OrganizationAdmin, RepositoryRole, Team, DeployKey

bypass_mode string Required

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

다음 중 하나일 수 있습니다.: 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

: creation

update object Required

Only allow users with bypass permission to update matching refs.

속성, 형식, 설명
type string Required

: 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

: deletion

required_linear_history object Required

Prevent merge commits from being pushed to matching refs.

속성, 형식, 설명
type string Required

: required_linear_history

required_deployments object Required

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

속성, 형식, 설명
type string Required

: 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

: 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

: pull_request

parameters object
속성, 형식, 설명
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

: required_status_checks

parameters object
속성, 형식, 설명
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

: non_fast_forward

commit_message_pattern object Required

Parameters to be used for the commit_message_pattern rule

속성, 형식, 설명
type string Required

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

다음 중 하나일 수 있습니다.: 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

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

다음 중 하나일 수 있습니다.: 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

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

다음 중 하나일 수 있습니다.: 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

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

다음 중 하나일 수 있습니다.: 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

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

다음 중 하나일 수 있습니다.: starts_with, ends_with, contains, regex

pattern string Required

The pattern to match with.

file_path_restriction object Required

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.

속성, 형식, 설명
type string Required

: 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

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.

속성, 형식, 설명
type string Required

: 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

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.

속성, 형식, 설명
type string Required

: 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

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.

속성, 형식, 설명
type string Required

: 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

: workflows

parameters object
속성, 형식, 설명
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

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

다음 중 하나일 수 있습니다.: 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."

다음 중 하나일 수 있습니다.: none, critical, high_or_higher, medium_or_higher, all

tool string Required

The name of a code scanning tool

"Update a repository ruleset"에 대한 HTTP 응답 상태 코드

상태 코드설명
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"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰에는 다음 권한 집합이 있어야 합니다.:

  • "Administration" repository permissions (write)

"Delete a repository ruleset"에 대한 매개 변수

머리글
속성, 형식, 설명
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.

"Delete a repository ruleset"에 대한 HTTP 응답 상태 코드

상태 코드설명
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