ルールの REST API エンドポイント - GitHub Enterprise Cloud Docs

Create an enterprise repository ruleset

Create a repository ruleset for an enterprise.

"Create an enterprise repository ruleset" のきめ細かいアクセストークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

"Enterprise administration" enterprise permissions (write)

"Create an enterprise repository ruleset" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`enterprise` string 必須 The slug version of the enterprise name.

名前, タイプ, 説明

name string 必須

The name of the ruleset.

target string

The target of the ruleset

Default: branch

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

enforcement string 必須

The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. evaluate is not available for the repository target.

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

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Properties of bypass_actors

名前, タイプ, 説明
`actor_id` integer or null The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories.
`actor_type` string 必須 The type of actor that can bypass a ruleset 次のいずれかにできます: `Integration`, `OrganizationAdmin`, `RepositoryRole`, `Team`, `DeployKey`, `EnterpriseOwner`
`bypass_mode` string When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created. Default: `always` 次のいずれかにできます: `always`, `pull_request`, `exempt`

conditions object

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

Can be one of these objects:

名前, タイプ, 説明

organization_name_and_repository_name object

Conditions to target organizations by name and all repositories

Properties of organization_name_and_repository_name

名前, タイプ, 説明

organization_name object 必須

Properties of organization_name

名前, タイプ, 説明
`include` array of strings Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.
`exclude` array of strings Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.

repository_name object 必須

Properties of repository_name

名前, タイプ, 説明
`include` array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.
`exclude` array of strings Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
`protected` boolean Whether renaming of target repositories is prevented.

ref_name object

Properties of ref_name

名前, タイプ, 説明
`include` array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.
`exclude` array of strings Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_name_and_repository_property object

Conditions to target organizations by name and repositories by property

Properties of organization_name_and_repository_property

名前, タイプ, 説明

organization_name object 必須

Properties of organization_name

名前, タイプ, 説明
`include` array of strings Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.
`exclude` array of strings Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.

repository_property object 必須

Properties of repository_property

名前, タイプ, 説明

include array of objects

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

Properties of include

名前, タイプ, 説明
`name` string 必須 The name of the repository property to target
`property_values` array of strings 必須 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 次のいずれかにできます: `custom`, `system`

exclude array of objects

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

Properties of exclude

名前, タイプ, 説明
`name` string 必須 The name of the repository property to target
`property_values` array of strings 必須 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 次のいずれかにできます: `custom`, `system`

ref_name object

Properties of ref_name

名前, タイプ, 説明
`include` array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.
`exclude` array of strings Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_id_and_repository_name object

Conditions to target organizations by id and all repositories

Properties of organization_id_and_repository_name

名前, タイプ, 説明

organization_id object 必須

Properties of organization_id

名前, タイプ, 説明
`organization_ids` array of integers The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

repository_name object 必須

Properties of repository_name

名前, タイプ, 説明
`include` array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.
`exclude` array of strings Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
`protected` boolean Whether renaming of target repositories is prevented.

ref_name object

Properties of ref_name

名前, タイプ, 説明
`include` array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.
`exclude` array of strings Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_id_and_repository_property object

Conditions to target organization by id and repositories by property

Properties of organization_id_and_repository_property

名前, タイプ, 説明

organization_id object 必須

Properties of organization_id

名前, タイプ, 説明
`organization_ids` array of integers The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

repository_property object 必須

Properties of repository_property

名前, タイプ, 説明

include array of objects

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

Properties of include

名前, タイプ, 説明
`name` string 必須 The name of the repository property to target
`property_values` array of strings 必須 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 次のいずれかにできます: `custom`, `system`

exclude array of objects

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

Properties of exclude

名前, タイプ, 説明
`name` string 必須 The name of the repository property to target
`property_values` array of strings 必須 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 次のいずれかにできます: `custom`, `system`

ref_name object

Properties of ref_name

名前, タイプ, 説明
`include` array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.
`exclude` array of strings Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_property_and_repository_name object

Conditions to target organizations by property and all repositories

Properties of organization_property_and_repository_name

名前, タイプ, 説明

organization_property object 必須

Properties of organization_property

名前, タイプ, 説明

include array of objects

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

Properties of include

名前, タイプ, 説明
`name` string 必須 The name of the organization property to target
`property_values` array of strings 必須 The values to match for the organization property

exclude array of objects

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

Properties of exclude

名前, タイプ, 説明
`name` string 必須 The name of the organization property to target
`property_values` array of strings 必須 The values to match for the organization property

repository_name object 必須

Properties of repository_name

名前, タイプ, 説明
`include` array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.
`exclude` array of strings Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
`protected` boolean Whether renaming of target repositories is prevented.

ref_name object

Properties of ref_name

名前, タイプ, 説明
`include` array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.
`exclude` array of strings Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_property_and_repository_property object

Conditions to target organizations by property and repositories by property

Properties of organization_property_and_repository_property

名前, タイプ, 説明

organization_property object 必須

Properties of organization_property

名前, タイプ, 説明

include array of objects

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

Properties of include

名前, タイプ, 説明
`name` string 必須 The name of the organization property to target
`property_values` array of strings 必須 The values to match for the organization property

exclude array of objects

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

Properties of exclude

名前, タイプ, 説明
`name` string 必須 The name of the organization property to target
`property_values` array of strings 必須 The values to match for the organization property

repository_property object 必須

Properties of repository_property

名前, タイプ, 説明

include array of objects

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

Properties of include

名前, タイプ, 説明
`name` string 必須 The name of the repository property to target
`property_values` array of strings 必須 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 次のいずれかにできます: `custom`, `system`

exclude array of objects

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

Properties of exclude

名前, タイプ, 説明
`name` string 必須 The name of the repository property to target
`property_values` array of strings 必須 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 次のいずれかにできます: `custom`, `system`

ref_name object

Properties of ref_name

名前, タイプ, 説明
`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.

Can be one of these objects:

名前, タイプ, 説明

creation object

Only allow users with bypass permission to create matching refs.

Properties of creation

名前, タイプ, 説明
`type` string 必須 Value: `creation`

update object

Only allow users with bypass permission to update matching refs.

Properties of update

名前, タイプ, 説明

type string 必須

Value: update

parameters object

Properties of parameters

名前, タイプ, 説明
`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.

Properties of deletion

名前, タイプ, 説明
`type` string 必須 Value: `deletion`

required_linear_history object

Prevent merge commits from being pushed to matching refs.

Properties of required_linear_history

名前, タイプ, 説明
`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.

Properties of required_deployments

名前, タイプ, 説明

type string 必須

Value: required_deployments

parameters object

Properties of parameters

名前, タイプ, 説明
`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.

Properties of required_signatures

名前, タイプ, 説明
`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.

Properties of pull_request

名前, タイプ, 説明

type string 必須

Value: pull_request

parameters object

Properties of parameters

名前, タイプ, 説明

allowed_merge_methods array of strings

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

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_reviewers array of objects

Note

required_reviewers is in beta and subject to change.

A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.

Properties of required_reviewers

名前, タイプ, 説明

file_patterns array of strings 必須

Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.

minimum_approvals integer 必須

Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.

reviewer object 必須

A required reviewing team

Properties of reviewer

名前, タイプ, 説明
`id` integer 必須 ID of the reviewer which must review changes to matching files.
`type` string 必須 The type of the reviewer Value: `Team`

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.

Properties of required_status_checks

名前, タイプ, 説明

type string 必須

Value: required_status_checks

parameters object

Properties of parameters

名前, タイプ, 説明

do_not_enforce_on_create boolean

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

required_status_checks array of objects 必須

Status checks that are required.

Properties of required_status_checks

名前, タイプ, 説明
`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.

Properties of non_fast_forward

名前, タイプ, 説明
`type` string 必須 Value: `non_fast_forward`

commit_message_pattern object

Parameters to be used for the commit_message_pattern rule

Properties of commit_message_pattern

名前, タイプ, 説明

type string 必須

Value: commit_message_pattern

parameters object

Properties of parameters

名前, タイプ, 説明
`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

Properties of commit_author_email_pattern

名前, タイプ, 説明

type string 必須

Value: commit_author_email_pattern

parameters object

Properties of parameters

名前, タイプ, 説明
`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

Properties of committer_email_pattern

名前, タイプ, 説明

type string 必須

Value: committer_email_pattern

parameters object

Properties of parameters

名前, タイプ, 説明
`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

Properties of branch_name_pattern

名前, タイプ, 説明

type string 必須

Value: branch_name_pattern

parameters object

Properties of parameters

名前, タイプ, 説明
`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

Properties of tag_name_pattern

名前, タイプ, 説明

type string 必須

Value: tag_name_pattern

parameters object

Properties of parameters

名前, タイプ, 説明
`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

Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.

Properties of file_path_restriction

名前, タイプ, 説明

type string 必須

Value: file_path_restriction

parameters object

Properties of parameters

名前, タイプ, 説明
`restricted_file_paths` array of strings 必須 The file paths that are restricted from being pushed to the commit graph.

max_file_path_length object

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

Properties of max_file_path_length

名前, タイプ, 説明

type string 必須

Value: max_file_path_length

parameters object

Properties of parameters

名前, タイプ, 説明
`max_file_path_length` integer 必須 The maximum amount of characters allowed in file paths.

file_extension_restriction object

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

Properties of file_extension_restriction

名前, タイプ, 説明

type string 必須

Value: file_extension_restriction

parameters object

Properties of parameters

名前, タイプ, 説明
`restricted_file_extensions` array of strings 必須 The file extensions that are restricted from being pushed to the commit graph.

max_file_size object

Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.

Properties of max_file_size

名前, タイプ, 説明

type string 必須

Value: max_file_size

parameters object

Properties of parameters

名前, タイプ, 説明
`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.

Properties of workflows

名前, タイプ, 説明

type string 必須

Value: workflows

parameters object

Properties of parameters

名前, タイプ, 説明

do_not_enforce_on_create boolean

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

workflows array of objects 必須

Workflows that must pass for this rule to pass.

Properties of workflows

名前, タイプ, 説明
`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.

Properties of code_scanning

名前, タイプ, 説明

type string 必須

Value: code_scanning

parameters object

Properties of parameters

名前, タイプ, 説明

code_scanning_tools array of objects 必須

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

Properties of code_scanning_tools

名前, タイプ, 説明
`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

copilot_code_review object

Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.

Properties of copilot_code_review

名前, タイプ, 説明

type string 必須

Value: copilot_code_review

parameters object

Properties of parameters

名前, タイプ, 説明
`review_draft_pull_requests` boolean Copilot automatically reviews draft pull requests before they are marked as ready for review.
`review_on_push` boolean Copilot automatically reviews each new push to the pull request.

"Create an enterprise repository ruleset" の HTTP 応答状態コード

状態コード	説明
`201`	Created
`404`	Resource not found
`500`	Internal Error

"Create an enterprise repository ruleset" のコードサンプル

GHE.com で GitHub にアクセスする場合は、api.github.com を api.SUBDOMAIN.ghe.com にあるエンタープライズの専用サブドメインに置き換えます。

要求の例

post/enterprises/{enterprise}/rulesets

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http://api.github.com/enterprises/ENTERPRISE/rulesets \
  -d '{"name":"super cool ruleset","target":"repository","enforcement":"active","bypass_actors":[{"actor_id":234,"actor_type":"Team","bypass_mode":"always"}],"conditions":{"org_name":{"include":["important_org"],"exclude":["unimportant_org"]}},"rules":[{"type":"repository_delete"}]}'

Response

Status: 201

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

Get an enterprise repository ruleset

Get a repository ruleset for an enterprise.

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

"Get an enterprise repository ruleset" のきめ細かいアクセストークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

"Enterprise administration" enterprise permissions (write)

"Get an enterprise repository ruleset" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`enterprise` string 必須 The slug version of the enterprise name.
`ruleset_id` integer 必須 The ID of the ruleset.

"Get an enterprise repository ruleset" の HTTP 応答状態コード

状態コード	説明
`200`	OK
`404`	Resource not found
`500`	Internal Error

"Get an enterprise repository ruleset" のコードサンプル

GHE.com で GitHub にアクセスする場合は、api.github.com を api.SUBDOMAIN.ghe.com にあるエンタープライズの専用サブドメインに置き換えます。

要求の例

get/enterprises/{enterprise}/rulesets/{ruleset_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http://api.github.com/enterprises/ENTERPRISE/rulesets/RULESET_ID

Response

Status: 200

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

Update an enterprise repository ruleset

Update a ruleset for an enterprise.

"Update an enterprise repository ruleset" のきめ細かいアクセストークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

"Enterprise administration" enterprise permissions (write)

"Update an enterprise repository ruleset" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`enterprise` string 必須 The slug version of the enterprise name.
`ruleset_id` integer 必須 The ID of the ruleset.

名前, タイプ, 説明

name string

The name of the ruleset.

target string

The target of the ruleset

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

enforcement string

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

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Properties of bypass_actors

名前, タイプ, 説明
`actor_id` integer or null The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories.
`actor_type` string 必須 The type of actor that can bypass a ruleset 次のいずれかにできます: `Integration`, `OrganizationAdmin`, `RepositoryRole`, `Team`, `DeployKey`, `EnterpriseOwner`
`bypass_mode` string When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created. Default: `always` 次のいずれかにできます: `always`, `pull_request`, `exempt`

conditions object

Can be one of these objects:

名前, タイプ, 説明

organization_name_and_repository_name object

Conditions to target organizations by name and all repositories

Properties of organization_name_and_repository_name

名前, タイプ, 説明

organization_name object 必須

Properties of organization_name

名前, タイプ, 説明
`include` array of strings Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.
`exclude` array of strings Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.

repository_name object 必須

Properties of repository_name

名前, タイプ, 説明
`include` array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.
`exclude` array of strings Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
`protected` boolean Whether renaming of target repositories is prevented.

ref_name object

Properties of ref_name

名前, タイプ, 説明
`include` array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.
`exclude` array of strings Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_name_and_repository_property object

Conditions to target organizations by name and repositories by property

Properties of organization_name_and_repository_property

名前, タイプ, 説明

organization_name object 必須

Properties of organization_name

名前, タイプ, 説明
`include` array of strings Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.
`exclude` array of strings Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.

repository_property object 必須

Properties of repository_property

名前, タイプ, 説明

include array of objects

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

Properties of include

名前, タイプ, 説明
`name` string 必須 The name of the repository property to target
`property_values` array of strings 必須 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 次のいずれかにできます: `custom`, `system`

exclude array of objects

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

Properties of exclude

名前, タイプ, 説明
`name` string 必須 The name of the repository property to target
`property_values` array of strings 必須 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 次のいずれかにできます: `custom`, `system`

ref_name object

Properties of ref_name

名前, タイプ, 説明
`include` array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.
`exclude` array of strings Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_id_and_repository_name object

Conditions to target organizations by id and all repositories

Properties of organization_id_and_repository_name

名前, タイプ, 説明

organization_id object 必須

Properties of organization_id

名前, タイプ, 説明
`organization_ids` array of integers The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

repository_name object 必須

Properties of repository_name

名前, タイプ, 説明
`include` array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.
`exclude` array of strings Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
`protected` boolean Whether renaming of target repositories is prevented.

ref_name object

Properties of ref_name

名前, タイプ, 説明
`include` array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.
`exclude` array of strings Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_id_and_repository_property object

Conditions to target organization by id and repositories by property

Properties of organization_id_and_repository_property

名前, タイプ, 説明

organization_id object 必須

Properties of organization_id

名前, タイプ, 説明
`organization_ids` array of integers The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

repository_property object 必須

Properties of repository_property

名前, タイプ, 説明

include array of objects

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

Properties of include

名前, タイプ, 説明
`name` string 必須 The name of the repository property to target
`property_values` array of strings 必須 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 次のいずれかにできます: `custom`, `system`

exclude array of objects

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

Properties of exclude

名前, タイプ, 説明
`name` string 必須 The name of the repository property to target
`property_values` array of strings 必須 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 次のいずれかにできます: `custom`, `system`

ref_name object

Properties of ref_name

名前, タイプ, 説明
`include` array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.
`exclude` array of strings Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_property_and_repository_name object

Conditions to target organizations by property and all repositories

Properties of organization_property_and_repository_name

名前, タイプ, 説明

organization_property object 必須

Properties of organization_property

名前, タイプ, 説明

include array of objects

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

Properties of include

名前, タイプ, 説明
`name` string 必須 The name of the organization property to target
`property_values` array of strings 必須 The values to match for the organization property

exclude array of objects

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

Properties of exclude

名前, タイプ, 説明
`name` string 必須 The name of the organization property to target
`property_values` array of strings 必須 The values to match for the organization property

repository_name object 必須

Properties of repository_name

名前, タイプ, 説明
`include` array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.
`exclude` array of strings Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
`protected` boolean Whether renaming of target repositories is prevented.

ref_name object

Properties of ref_name

名前, タイプ, 説明
`include` array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.
`exclude` array of strings Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_property_and_repository_property object

Conditions to target organizations by property and repositories by property

Properties of organization_property_and_repository_property

名前, タイプ, 説明

organization_property object 必須

Properties of organization_property

名前, タイプ, 説明

include array of objects

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

Properties of include

名前, タイプ, 説明
`name` string 必須 The name of the organization property to target
`property_values` array of strings 必須 The values to match for the organization property

exclude array of objects

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

Properties of exclude

名前, タイプ, 説明
`name` string 必須 The name of the organization property to target
`property_values` array of strings 必須 The values to match for the organization property

repository_property object 必須

Properties of repository_property

名前, タイプ, 説明

include array of objects

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

Properties of include

名前, タイプ, 説明
`name` string 必須 The name of the repository property to target
`property_values` array of strings 必須 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 次のいずれかにできます: `custom`, `system`

exclude array of objects

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

Properties of exclude

名前, タイプ, 説明
`name` string 必須 The name of the repository property to target
`property_values` array of strings 必須 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 次のいずれかにできます: `custom`, `system`

ref_name object

Properties of ref_name

名前, タイプ, 説明
`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.

Can be one of these objects:

名前, タイプ, 説明

creation object

Only allow users with bypass permission to create matching refs.

Properties of creation

名前, タイプ, 説明
`type` string 必須 Value: `creation`

update object

Only allow users with bypass permission to update matching refs.

Properties of update

名前, タイプ, 説明

type string 必須

Value: update

parameters object

Properties of parameters

名前, タイプ, 説明
`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.

Properties of deletion

名前, タイプ, 説明
`type` string 必須 Value: `deletion`

required_linear_history object

Prevent merge commits from being pushed to matching refs.

Properties of required_linear_history

名前, タイプ, 説明
`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.

Properties of required_deployments

名前, タイプ, 説明

type string 必須

Value: required_deployments

parameters object

Properties of parameters

名前, タイプ, 説明
`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.

Properties of required_signatures

名前, タイプ, 説明
`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.

Properties of pull_request

名前, タイプ, 説明

type string 必須

Value: pull_request

parameters object

Properties of parameters

名前, タイプ, 説明

allowed_merge_methods array of strings

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

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_reviewers array of objects

Note

required_reviewers is in beta and subject to change.

A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.

Properties of required_reviewers

名前, タイプ, 説明

file_patterns array of strings 必須

Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.

minimum_approvals integer 必須

Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.

reviewer object 必須

A required reviewing team

Properties of reviewer

名前, タイプ, 説明
`id` integer 必須 ID of the reviewer which must review changes to matching files.
`type` string 必須 The type of the reviewer Value: `Team`

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.

Properties of required_status_checks

名前, タイプ, 説明

type string 必須

Value: required_status_checks

parameters object

Properties of parameters

名前, タイプ, 説明

do_not_enforce_on_create boolean

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

required_status_checks array of objects 必須

Status checks that are required.

Properties of required_status_checks

名前, タイプ, 説明
`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.

Properties of non_fast_forward

名前, タイプ, 説明
`type` string 必須 Value: `non_fast_forward`

commit_message_pattern object

Parameters to be used for the commit_message_pattern rule

Properties of commit_message_pattern

名前, タイプ, 説明

type string 必須

Value: commit_message_pattern

parameters object

Properties of parameters

名前, タイプ, 説明
`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

Properties of commit_author_email_pattern

名前, タイプ, 説明

type string 必須

Value: commit_author_email_pattern

parameters object

Properties of parameters

名前, タイプ, 説明
`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

Properties of committer_email_pattern

名前, タイプ, 説明

type string 必須

Value: committer_email_pattern

parameters object

Properties of parameters

名前, タイプ, 説明
`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

Properties of branch_name_pattern

名前, タイプ, 説明

type string 必須

Value: branch_name_pattern

parameters object

Properties of parameters

名前, タイプ, 説明
`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

Properties of tag_name_pattern

名前, タイプ, 説明

type string 必須

Value: tag_name_pattern

parameters object

Properties of parameters

名前, タイプ, 説明
`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

Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.

Properties of file_path_restriction

名前, タイプ, 説明

type string 必須

Value: file_path_restriction

parameters object

Properties of parameters

名前, タイプ, 説明
`restricted_file_paths` array of strings 必須 The file paths that are restricted from being pushed to the commit graph.

max_file_path_length object

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

Properties of max_file_path_length

名前, タイプ, 説明

type string 必須

Value: max_file_path_length

parameters object

Properties of parameters

名前, タイプ, 説明
`max_file_path_length` integer 必須 The maximum amount of characters allowed in file paths.

file_extension_restriction object

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

Properties of file_extension_restriction

名前, タイプ, 説明

type string 必須

Value: file_extension_restriction

parameters object

Properties of parameters

名前, タイプ, 説明
`restricted_file_extensions` array of strings 必須 The file extensions that are restricted from being pushed to the commit graph.

max_file_size object

Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.

Properties of max_file_size

名前, タイプ, 説明

type string 必須

Value: max_file_size

parameters object

Properties of parameters

名前, タイプ, 説明
`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.

Properties of workflows

名前, タイプ, 説明

type string 必須

Value: workflows

parameters object

Properties of parameters

名前, タイプ, 説明

do_not_enforce_on_create boolean

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

workflows array of objects 必須

Workflows that must pass for this rule to pass.

Properties of workflows

名前, タイプ, 説明
`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

Properties of code_scanning

名前, タイプ, 説明

type string 必須

Value: code_scanning

parameters object

Properties of parameters

名前, タイプ, 説明

code_scanning_tools array of objects 必須

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

Properties of code_scanning_tools

名前, タイプ, 説明
`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

copilot_code_review object

Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.

Properties of copilot_code_review

名前, タイプ, 説明

type string 必須

Value: copilot_code_review

parameters object

Properties of parameters

名前, タイプ, 説明
`review_draft_pull_requests` boolean Copilot automatically reviews draft pull requests before they are marked as ready for review.
`review_on_push` boolean Copilot automatically reviews each new push to the pull request.

"Update an enterprise repository ruleset" の HTTP 応答状態コード

状態コード	説明
`200`	OK
`404`	Resource not found
`500`	Internal Error

"Update an enterprise repository ruleset" のコードサンプル

GHE.com で GitHub にアクセスする場合は、api.github.com を api.SUBDOMAIN.ghe.com にあるエンタープライズの専用サブドメインに置き換えます。

要求の例

put/enterprises/{enterprise}/rulesets/{ruleset_id}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http://api.github.com/enterprises/ENTERPRISE/rulesets/RULESET_ID \
  -d '{"name":"super cool ruleset","target":"repository","enforcement":"active","bypass_actors":[{"actor_id":234,"actor_type":"Team","bypass_mode":"always"}],"conditions":{"org_name":{"include":["important_org"],"exclude":["unimportant_org"]}},"rules":[{"type":"repository_delete"}]}'

Response

Status: 200

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

Delete an enterprise repository ruleset

Delete a ruleset for an enterprise.

"Delete an enterprise repository ruleset" のきめ細かいアクセストークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

"Enterprise administration" enterprise permissions (write)

"Delete an enterprise repository ruleset" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`enterprise` string 必須 The slug version of the enterprise name.
`ruleset_id` integer 必須 The ID of the ruleset.

"Delete an enterprise repository ruleset" の HTTP 応答状態コード

状態コード	説明
`204`	No Content
`404`	Resource not found
`500`	Internal Error

"Delete an enterprise repository ruleset" のコードサンプル

GHE.com で GitHub にアクセスする場合は、api.github.com を api.SUBDOMAIN.ghe.com にあるエンタープライズの専用サブドメインに置き換えます。

要求の例

delete/enterprises/{enterprise}/rulesets/{ruleset_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http://api.github.com/enterprises/ENTERPRISE/rulesets/RULESET_ID

Response

Status: 204

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`enterprise` string 必須 The slug version of the enterprise name.
`ruleset_id` integer 必須 The ID of the ruleset.

クエリパラメーター
名前, タイプ, 説明
`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 enterprise ruleset history" の HTTP 応答状態コード

状態コード	説明
`200`	OK
`404`	Resource not found
`500`	Internal Error

"Get enterprise ruleset history" のコードサンプル

GHE.com で GitHub にアクセスする場合は、api.github.com を api.SUBDOMAIN.ghe.com にあるエンタープライズの専用サブドメインに置き換えます。

要求の例

get/enterprises/{enterprise}/rulesets/{ruleset_id}/history

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http://api.github.com/enterprises/ENTERPRISE/rulesets/RULESET_ID/history

Response

Status: 200

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

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`enterprise` string 必須 The slug version of the enterprise name.
`ruleset_id` integer 必須 The ID of the ruleset.
`version_id` integer 必須 The ID of the version

"Get enterprise ruleset version" の HTTP 応答状態コード

状態コード	説明
`200`	OK
`404`	Resource not found
`500`	Internal Error

"Get enterprise ruleset version" のコードサンプル

GHE.com で GitHub にアクセスする場合は、api.github.com を api.SUBDOMAIN.ghe.com にあるエンタープライズの専用サブドメインに置き換えます。

要求の例

get/enterprises/{enterprise}/rulesets/{ruleset_id}/history/{version_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http://api.github.com/enterprises/ENTERPRISE/rulesets/RULESET_ID/history/VERSION_ID

Response

Status: 200

[
  {
    "version_id": 3,
    "actor": {
      "id": 1,
      "type": "User"
    },
    "updated_at": "2024-010-23T16:29:47Z",
    "state": {
      "id": 21,
      "name": "super cool ruleset",
      "target": "repository",
      "source_type": "Enterprise",
      "source": "my-enterprise",
      "enforcement": "active",
      "conditions": {
        "organization_name": {
          "include": [
            "important_organization"
          ]
        },
        "repository_name": {
          "include": [
            "~ALL"
          ]
        }
      },
      "rules": [
        {
          "type": "repository_delete"
        }
      ]
    }
  }
]