Skip to main content
REST API はバージョン管理になりました。 詳細については、「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:read

このエンドポイントは、パブリック リソースのみが要求される場合は、認証または前述メンションアクセス許可なしで使用できます。

"Get rules for a branch" のパラメーター

ヘッダー
名前, Type, 説明
accept string

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

パス パラメーター
名前, Type, 説明
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.

クエリ パラメーター
名前, Type, 説明
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

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

このエンドポイントは、パブリック リソースのみが要求される場合は、認証または前述メンションアクセス許可なしで使用できます。

"Get all repository rulesets" のパラメーター

ヘッダー
名前, Type, 説明
accept string

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

パス パラメーター
名前, Type, 説明
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.

クエリ パラメーター
名前, Type, 説明
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

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

"Create a repository ruleset" のパラメーター

ヘッダー
名前, Type, 説明
accept string

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

パス パラメーター
名前, Type, 説明
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.

本文のパラメーター
名前, Type, 説明
name string 必須

The name of the ruleset.

target string

The target of the ruleset.

次のいずれかにできます: branch, tag

enforcement string 必須

The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (evaluate is only available with GitHub Enterprise).

次のいずれかにできます: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

名前, Type, 説明
actor_id integer 必須

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

actor_type string 必須

The type of actor that can bypass a ruleset

次のいずれかにできます: RepositoryRole, Team, Integration, OrganizationAdmin

bypass_mode string 必須

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

次のいずれかにできます: always, pull_request

conditions object

Parameters for a repository ruleset ref name condition

名前, Type, 説明
ref_name object
名前, Type, 説明
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.

名前, Type, 説明
creation object 必須

Only allow users with bypass permission to create matching refs.

名前, Type, 説明
type string 必須

Value: creation

update object 必須

Only allow users with bypass permission to update matching refs.

名前, Type, 説明
type string 必須

Value: update

parameters object
名前, Type, 説明
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.

名前, Type, 説明
type string 必須

Value: deletion

required_linear_history object 必須

Prevent merge commits from being pushed to matching refs.

名前, Type, 説明
type string 必須

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

名前, Type, 説明
type string 必須

Value: required_deployments

parameters object
名前, Type, 説明
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.

名前, Type, 説明
type string 必須

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

名前, Type, 説明
type string 必須

Value: pull_request

parameters object
名前, Type, 説明
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.

名前, Type, 説明
type string 必須

Value: required_status_checks

parameters object
名前, Type, 説明
required_status_checks array of objects 必須

Status checks that are required.

名前, Type, 説明
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.

名前, Type, 説明
type string 必須

Value: non_fast_forward

commit_message_pattern object 必須

Parameters to be used for the commit_message_pattern rule

名前, Type, 説明
type string 必須

Value: commit_message_pattern

parameters object
名前, Type, 説明
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

名前, Type, 説明
type string 必須

Value: commit_author_email_pattern

parameters object
名前, Type, 説明
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

名前, Type, 説明
type string 必須

Value: committer_email_pattern

parameters object
名前, Type, 説明
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

名前, Type, 説明
type string 必須

Value: branch_name_pattern

parameters object
名前, Type, 説明
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

名前, Type, 説明
type string 必須

Value: tag_name_pattern

parameters object
名前, Type, 説明
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.

workflows object 必須

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

名前, Type, 説明
type string 必須

Value: workflows

parameters object
名前, Type, 説明
workflows array of objects 必須

Workflows that must pass for this rule to pass.

名前, Type, 説明
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

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

このエンドポイントは、パブリック リソースのみが要求される場合は、認証または前述メンションアクセス許可なしで使用できます。

"Get a repository ruleset" のパラメーター

ヘッダー
名前, Type, 説明
accept string

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

パス パラメーター
名前, Type, 説明
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.

クエリ パラメーター
名前, Type, 説明
includes_parents boolean

Include rulesets configured at higher levels that apply to this repository

Default: 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:write

"Update a repository ruleset" のパラメーター

ヘッダー
名前, Type, 説明
accept string

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

パス パラメーター
名前, Type, 説明
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.

本文のパラメーター
名前, Type, 説明
name string

The name of the ruleset.

target string

The target of the ruleset.

次のいずれかにできます: branch, tag

enforcement string

The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (evaluate is only available with GitHub Enterprise).

次のいずれかにできます: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

名前, Type, 説明
actor_id integer 必須

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

actor_type string 必須

The type of actor that can bypass a ruleset

次のいずれかにできます: RepositoryRole, Team, Integration, OrganizationAdmin

bypass_mode string 必須

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

次のいずれかにできます: always, pull_request

conditions object

Parameters for a repository ruleset ref name condition

名前, Type, 説明
ref_name object
名前, Type, 説明
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.

名前, Type, 説明
creation object 必須

Only allow users with bypass permission to create matching refs.

名前, Type, 説明
type string 必須

Value: creation

update object 必須

Only allow users with bypass permission to update matching refs.

名前, Type, 説明
type string 必須

Value: update

parameters object
名前, Type, 説明
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.

名前, Type, 説明
type string 必須

Value: deletion

required_linear_history object 必須

Prevent merge commits from being pushed to matching refs.

名前, Type, 説明
type string 必須

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

名前, Type, 説明
type string 必須

Value: required_deployments

parameters object
名前, Type, 説明
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.

名前, Type, 説明
type string 必須

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

名前, Type, 説明
type string 必須

Value: pull_request

parameters object
名前, Type, 説明
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.

名前, Type, 説明
type string 必須

Value: required_status_checks

parameters object
名前, Type, 説明
required_status_checks array of objects 必須

Status checks that are required.

名前, Type, 説明
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.

名前, Type, 説明
type string 必須

Value: non_fast_forward

commit_message_pattern object 必須

Parameters to be used for the commit_message_pattern rule

名前, Type, 説明
type string 必須

Value: commit_message_pattern

parameters object
名前, Type, 説明
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

名前, Type, 説明
type string 必須

Value: commit_author_email_pattern

parameters object
名前, Type, 説明
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

名前, Type, 説明
type string 必須

Value: committer_email_pattern

parameters object
名前, Type, 説明
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

名前, Type, 説明
type string 必須

Value: branch_name_pattern

parameters object
名前, Type, 説明
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

名前, Type, 説明
type string 必須

Value: tag_name_pattern

parameters object
名前, Type, 説明
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.

workflows object 必須

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

名前, Type, 説明
type string 必須

Value: workflows

parameters object
名前, Type, 説明
workflows array of objects 必須

Workflows that must pass for this rule to pass.

名前, Type, 説明
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

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

"Delete a repository ruleset" のパラメーター

ヘッダー
名前, Type, 説明
accept string

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

パス パラメーター
名前, Type, 説明
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.

"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