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

Get all organization repository rulesets

Get all the repository rulesets for an organization.

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

Эта конечная точка работает со следующими точными типами маркеров:

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

"Administration" organization permissions (write)

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

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.

Параметры запроса
Имя., Тип, Description
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." По умолчанию.: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." По умолчанию.: `1`
`targets` string A comma-separated list of rule targets to filter by. If provided, only rulesets that apply to the specified targets will be returned. For example, `branch,tag,push`.

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

Код состояния	Описание
`200`	OK
`404`	Resource not found
`500`	Internal Error

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

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

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

get/orgs/{org}/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/orgs/ORG/rulesets

Response

Status: 200

[
  {
    "id": 21,
    "name": "super cool ruleset",
    "source_type": "Organization",
    "source": "my-org",
    "enforcement": "enabled",
    "node_id": "RRS_lACkVXNlcgQB",
    "_links": {
      "self": {
        "href": "https://api.github.com/orgs/my-org/rulesets/21"
      },
      "html": {
        "href": "https://github.com/organizations/my-org/settings/rules/21"
      }
    },
    "created_at": "2023-07-15T08:43:03Z",
    "updated_at": "2023-08-23T16:29:47Z"
  },
  {
    "id": 432,
    "name": "Another ruleset",
    "source_type": "Organization",
    "source": "my-org",
    "enforcement": "enabled",
    "node_id": "RRS_lACkVXNlcgQQ",
    "_links": {
      "self": {
        "href": "https://api.github.com/orgs/my-org/rulesets/432"
      },
      "html": {
        "href": "https://github.com/organizations/my-org/settings/rules/432"
      }
    },
    "created_at": "2023-08-15T08:43:03Z",
    "updated_at": "2023-09-23T16:29:47Z"
  }
]

Create an organization repository ruleset

Create a repository ruleset for an organization.

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

Эта конечная точка работает со следующими точными типами маркеров:

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

"Administration" organization permissions (write)

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

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.

Имя., Тип, Description

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

The name of the ruleset.

target string

The target of the ruleset

По умолчанию.: 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

Имя., Тип, Description
`actor_id` integer or null The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. 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. По умолчанию.: `always` Возможные значения: `always`, `pull_request`

conditions object

Conditions for an organization ruleset. The branch and tag rulesets conditions object should contain both repository_name and ref_name properties, or both repository_id and ref_name properties, or both repository_property and ref_name properties. The push rulesets conditions object does not require the ref_name property. For repository policy rulesets, the conditions object should only contain the repository_name, the repository_id, or the repository_property.

Can be one of these objects:

Имя., Тип, Description

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

Conditions to target repositories by name and refs by name

Properties of repository_name_and_ref_name

Имя., Тип, Description

ref_name object

Properties of ref_name

Имя., Тип, Description
`include` array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.
`exclude` array of strings Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

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

Properties of repository_name

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

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

Conditions to target repositories by id and refs by name

Properties of repository_id_and_ref_name

Имя., Тип, Description

ref_name object

Properties of ref_name

Имя., Тип, Description
`include` array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.
`exclude` array of strings Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

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

Properties of repository_id

Имя., Тип, Description
`repository_ids` array of integers The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

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

Conditions to target repositories by property and refs by name

Properties of repository_property_and_ref_name

Имя., Тип, Description

ref_name object

Properties of ref_name

Имя., Тип, Description
`include` array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.
`exclude` array of strings Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

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

Properties of repository_property

Имя., Тип, Description

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

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

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

rules array of objects

An array of rules within the ruleset.

Can be one of these objects:

Имя., Тип, Description

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

Only allow users with bypass permission to create matching refs.

Properties of creation

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

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

Only allow users with bypass permission to update matching refs.

Properties of update

Имя., Тип, Description

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

значение: update

parameters object

Properties of parameters

Имя., Тип, Description
`update_allows_fetch_and_merge` boolean Обязательное поле Branch can pull changes from its upstream repository

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

Only allow users with bypass permissions to delete matching refs.

Properties of deletion

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

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

Prevent merge commits from being pushed to matching refs.

Properties of required_linear_history

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

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

Merges must be performed via a merge queue.

Properties of merge_queue

Имя., Тип, Description

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

значение: merge_queue

parameters object

Properties of parameters

Имя., Тип, Description
`check_response_timeout_minutes` integer Обязательное поле Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
`grouping_strategy` string Обязательное поле When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. Возможные значения: `ALLGREEN`, `HEADGREEN`
`max_entries_to_build` integer Обязательное поле Limit the number of queued pull requests requesting checks and workflow runs at the same time.
`max_entries_to_merge` integer Обязательное поле The maximum number of PRs that will be merged together in a group.
`merge_method` string Обязательное поле Method to use when merging changes from queued pull requests. Возможные значения: `MERGE`, `SQUASH`, `REBASE`
`min_entries_to_merge` integer Обязательное поле The minimum number of PRs that will be merged together in a group.
`min_entries_to_merge_wait_minutes` integer Обязательное поле The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.

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

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

Properties of required_deployments

Имя., Тип, Description

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

значение: required_deployments

parameters object

Properties of parameters

Имя., Тип, Description
`required_deployment_environments` array of strings Обязательное поле The environments that must be successfully deployed to before branches can be merged.

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

Commits pushed to matching refs must have verified signatures.

Properties of required_signatures

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

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

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

Properties of pull_request

Имя., Тип, Description

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

значение: pull_request

parameters object

Properties of parameters

Имя., Тип, Description
`allowed_merge_methods` array of strings When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.
`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.

Properties of required_status_checks

Имя., Тип, Description

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

значение: required_status_checks

parameters object

Properties of parameters

Имя., Тип, Description

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

Имя., Тип, Description
`context` string Обязательное поле The status check context name that must be present on the commit.
`integration_id` integer The optional integration ID that this status check must originate from.

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

Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.

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

Prevent users with push access from force pushing to refs.

Properties of non_fast_forward

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

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

Parameters to be used for the commit_message_pattern rule

Properties of commit_message_pattern

Имя., Тип, Description

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

значение: commit_message_pattern

parameters object

Properties of parameters

Имя., Тип, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательное поле The operator to use for matching. Возможные значения: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательное поле The pattern to match with.

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

Parameters to be used for the commit_author_email_pattern rule

Properties of commit_author_email_pattern

Имя., Тип, Description

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

значение: commit_author_email_pattern

parameters object

Properties of parameters

Имя., Тип, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательное поле The operator to use for matching. Возможные значения: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательное поле The pattern to match with.

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

Parameters to be used for the committer_email_pattern rule

Properties of committer_email_pattern

Имя., Тип, Description

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

значение: committer_email_pattern

parameters object

Properties of parameters

Имя., Тип, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательное поле The operator to use for matching. Возможные значения: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательное поле The pattern to match with.

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

Parameters to be used for the branch_name_pattern rule

Properties of branch_name_pattern

Имя., Тип, Description

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

значение: branch_name_pattern

parameters object

Properties of parameters

Имя., Тип, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательное поле The operator to use for matching. Возможные значения: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательное поле The pattern to match with.

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

Parameters to be used for the tag_name_pattern rule

Properties of tag_name_pattern

Имя., Тип, Description

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

значение: tag_name_pattern

parameters object

Properties of parameters

Имя., Тип, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательное поле The operator to use for matching. Возможные значения: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательное поле The pattern to match with.

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

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

Properties of file_path_restriction

Имя., Тип, Description

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

значение: file_path_restriction

parameters object

Properties of parameters

Имя., Тип, Description
`restricted_file_paths` array of strings Обязательное поле The file paths that are restricted from being pushed to the commit graph.

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

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

Properties of max_file_path_length

Имя., Тип, Description

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

значение: max_file_path_length

parameters object

Properties of parameters

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

Имя., Тип, Description

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

значение: file_extension_restriction

parameters object

Properties of parameters

Имя., Тип, Description
`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 that exceed a specified file size limit from being pushed to the commit.

Properties of max_file_size

Имя., Тип, Description

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

значение: max_file_size

parameters object

Properties of parameters

Имя., Тип, Description
`max_file_size` integer Обязательное поле The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).

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

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

Properties of workflows

Имя., Тип, Description

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

значение: workflows

parameters object

Properties of parameters

Имя., Тип, Description

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

Имя., Тип, Description
`path` string Обязательное поле The path to the workflow file
`ref` string The ref (branch or tag) of the workflow file to use
`repository_id` integer Обязательное поле The ID of the repository where the workflow is defined
`sha` string The commit SHA of the workflow file to use

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

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

Properties of code_scanning

Имя., Тип, Description

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

значение: code_scanning

parameters object

Properties of parameters

Имя., Тип, Description

code_scanning_tools array of objects Обязательное поле

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

Properties of code_scanning_tools

Имя., Тип, Description
`alerts_threshold` string Обязательное поле The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "About code scanning alerts." Возможные значения: `none`, `errors`, `errors_and_warnings`, `all`
`security_alerts_threshold` string Обязательное поле The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "About code scanning alerts." Возможные значения: `none`, `critical`, `high_or_higher`, `medium_or_higher`, `all`
`tool` string Обязательное поле The name of a code scanning tool

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

Код состояния	Описание
`201`	Created
`404`	Resource not found
`500`	Internal Error

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

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

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

post/orgs/{org}/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/orgs/ORG/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*"]},"repository_name":{"include":["important_repository","another_important_repository"],"exclude":["unimportant_repository"],"protected":true}},"rules":[{"type":"commit_author_email_pattern","parameters":{"operator":"contains","pattern":"github"}}]}'

Response

Status: 201

{
  "id": 21,
  "name": "super cool ruleset",
  "target": "branch",
  "source_type": "Organization",
  "source": "my-org",
  "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*"
      ]
    },
    "repository_name": {
      "include": [
        "important_repository",
        "another_important_repository"
      ],
      "exclude": [
        "unimportant_repository"
      ],
      "protected": true
    }
  },
  "rules": [
    {
      "type": "commit_author_email_pattern",
      "parameters": {
        "operator": "contains",
        "pattern": "github"
      }
    }
  ],
  "node_id": "RRS_lACkVXNlcgQB",
  "_links": {
    "self": {
      "href": "https://api.github.com/orgs/my-org/rulesets/21"
    },
    "html": {
      "href": "https://github.com/organizations/my-org/settings/rules/21"
    }
  },
  "created_at": "2023-08-15T08:43:03Z",
  "updated_at": "2023-09-23T16:29:47Z"
}

Get an organization repository ruleset

Get a repository ruleset for an organization.

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 organization repository ruleset

Эта конечная точка работает со следующими точными типами маркеров:

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

"Administration" organization permissions (write)

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

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.
`ruleset_id` integer Обязательное поле The ID of the ruleset.

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

Код состояния	Описание
`200`	OK
`404`	Resource not found
`500`	Internal Error

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

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

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

get/orgs/{org}/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/orgs/ORG/rulesets/RULESET_ID

Response

Status: 200

{
  "id": 21,
  "name": "super cool ruleset",
  "target": "branch",
  "source_type": "Organization",
  "source": "my-org",
  "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*"
      ]
    },
    "repository_name": {
      "include": [
        "important_repository",
        "another_important_repository"
      ],
      "exclude": [
        "unimportant_repository"
      ],
      "protected": true
    }
  },
  "rules": [
    {
      "type": "commit_author_email_pattern",
      "parameters": {
        "operator": "contains",
        "pattern": "github"
      }
    }
  ],
  "node_id": "RRS_lACkVXNlcgQB",
  "_links": {
    "self": {
      "href": "https://api.github.com/orgs/my-org/rulesets/21"
    },
    "html": {
      "href": "https://github.com/organizations/my-org/settings/rules/21"
    }
  },
  "created_at": "2023-08-15T08:43:03Z",
  "updated_at": "2023-09-23T16:29:47Z"
}

Update an organization repository ruleset

Update a ruleset for an organization.

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

Эта конечная точка работает со следующими точными типами маркеров:

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

"Administration" organization permissions (write)

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

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.
`ruleset_id` integer Обязательное поле The ID of the ruleset.

Имя., Тип, Description

name string

The name of the ruleset.

target string

The target of the ruleset

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

Имя., Тип, Description
`actor_id` integer or null The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. 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. По умолчанию.: `always` Возможные значения: `always`, `pull_request`

conditions object

Conditions for an organization ruleset. The branch and tag rulesets conditions object should contain both repository_name and ref_name properties, or both repository_id and ref_name properties, or both repository_property and ref_name properties. The push rulesets conditions object does not require the ref_name property. For repository policy rulesets, the conditions object should only contain the repository_name, the repository_id, or the repository_property.

Can be one of these objects:

Имя., Тип, Description

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

Conditions to target repositories by name and refs by name

Properties of repository_name_and_ref_name

Имя., Тип, Description

ref_name object

Properties of ref_name

Имя., Тип, Description
`include` array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.
`exclude` array of strings Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

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

Properties of repository_name

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

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

Conditions to target repositories by id and refs by name

Properties of repository_id_and_ref_name

Имя., Тип, Description

ref_name object

Properties of ref_name

Имя., Тип, Description
`include` array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.
`exclude` array of strings Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

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

Properties of repository_id

Имя., Тип, Description
`repository_ids` array of integers The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

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

Conditions to target repositories by property and refs by name

Properties of repository_property_and_ref_name

Имя., Тип, Description

ref_name object

Properties of ref_name

Имя., Тип, Description
`include` array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.
`exclude` array of strings Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

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

Properties of repository_property

Имя., Тип, Description

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

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

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

rules array of objects

An array of rules within the ruleset.

Can be one of these objects:

Имя., Тип, Description

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

Only allow users with bypass permission to create matching refs.

Properties of creation

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

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

Only allow users with bypass permission to update matching refs.

Properties of update

Имя., Тип, Description

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

значение: update

parameters object

Properties of parameters

Имя., Тип, Description
`update_allows_fetch_and_merge` boolean Обязательное поле Branch can pull changes from its upstream repository

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

Only allow users with bypass permissions to delete matching refs.

Properties of deletion

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

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

Prevent merge commits from being pushed to matching refs.

Properties of required_linear_history

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

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

Merges must be performed via a merge queue.

Properties of merge_queue

Имя., Тип, Description

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

значение: merge_queue

parameters object

Properties of parameters

Имя., Тип, Description
`check_response_timeout_minutes` integer Обязательное поле Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
`grouping_strategy` string Обязательное поле When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. Возможные значения: `ALLGREEN`, `HEADGREEN`
`max_entries_to_build` integer Обязательное поле Limit the number of queued pull requests requesting checks and workflow runs at the same time.
`max_entries_to_merge` integer Обязательное поле The maximum number of PRs that will be merged together in a group.
`merge_method` string Обязательное поле Method to use when merging changes from queued pull requests. Возможные значения: `MERGE`, `SQUASH`, `REBASE`
`min_entries_to_merge` integer Обязательное поле The minimum number of PRs that will be merged together in a group.
`min_entries_to_merge_wait_minutes` integer Обязательное поле The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.

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

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

Properties of required_deployments

Имя., Тип, Description

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

значение: required_deployments

parameters object

Properties of parameters

Имя., Тип, Description
`required_deployment_environments` array of strings Обязательное поле The environments that must be successfully deployed to before branches can be merged.

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

Commits pushed to matching refs must have verified signatures.

Properties of required_signatures

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

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

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

Properties of pull_request

Имя., Тип, Description

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

значение: pull_request

parameters object

Properties of parameters

Имя., Тип, Description
`allowed_merge_methods` array of strings When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.
`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.

Properties of required_status_checks

Имя., Тип, Description

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

значение: required_status_checks

parameters object

Properties of parameters

Имя., Тип, Description

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

Имя., Тип, Description
`context` string Обязательное поле The status check context name that must be present on the commit.
`integration_id` integer The optional integration ID that this status check must originate from.

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

Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.

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

Prevent users with push access from force pushing to refs.

Properties of non_fast_forward

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

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

Parameters to be used for the commit_message_pattern rule

Properties of commit_message_pattern

Имя., Тип, Description

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

значение: commit_message_pattern

parameters object

Properties of parameters

Имя., Тип, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательное поле The operator to use for matching. Возможные значения: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательное поле The pattern to match with.

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

Parameters to be used for the commit_author_email_pattern rule

Properties of commit_author_email_pattern

Имя., Тип, Description

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

значение: commit_author_email_pattern

parameters object

Properties of parameters

Имя., Тип, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательное поле The operator to use for matching. Возможные значения: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательное поле The pattern to match with.

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

Parameters to be used for the committer_email_pattern rule

Properties of committer_email_pattern

Имя., Тип, Description

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

значение: committer_email_pattern

parameters object

Properties of parameters

Имя., Тип, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательное поле The operator to use for matching. Возможные значения: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательное поле The pattern to match with.

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

Parameters to be used for the branch_name_pattern rule

Properties of branch_name_pattern

Имя., Тип, Description

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

значение: branch_name_pattern

parameters object

Properties of parameters

Имя., Тип, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательное поле The operator to use for matching. Возможные значения: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательное поле The pattern to match with.

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

Parameters to be used for the tag_name_pattern rule

Properties of tag_name_pattern

Имя., Тип, Description

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

значение: tag_name_pattern

parameters object

Properties of parameters

Имя., Тип, Description
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательное поле The operator to use for matching. Возможные значения: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательное поле The pattern to match with.

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

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

Properties of file_path_restriction

Имя., Тип, Description

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

значение: file_path_restriction

parameters object

Properties of parameters

Имя., Тип, Description
`restricted_file_paths` array of strings Обязательное поле The file paths that are restricted from being pushed to the commit graph.

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

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

Properties of max_file_path_length

Имя., Тип, Description

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

значение: max_file_path_length

parameters object

Properties of parameters

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

Имя., Тип, Description

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

значение: file_extension_restriction

parameters object

Properties of parameters

Имя., Тип, Description
`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 that exceed a specified file size limit from being pushed to the commit.

Properties of max_file_size

Имя., Тип, Description

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

значение: max_file_size

parameters object

Properties of parameters

Имя., Тип, Description
`max_file_size` integer Обязательное поле The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).

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

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

Properties of workflows

Имя., Тип, Description

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

значение: workflows

parameters object

Properties of parameters

Имя., Тип, Description

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

Имя., Тип, Description
`path` string Обязательное поле The path to the workflow file
`ref` string The ref (branch or tag) of the workflow file to use
`repository_id` integer Обязательное поле The ID of the repository where the workflow is defined
`sha` string The commit SHA of the workflow file to use

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

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

Properties of code_scanning

Имя., Тип, Description

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

значение: code_scanning

parameters object

Properties of parameters

Имя., Тип, Description

code_scanning_tools array of objects Обязательное поле

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

Properties of code_scanning_tools

Имя., Тип, Description
`alerts_threshold` string Обязательное поле The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "About code scanning alerts." Возможные значения: `none`, `errors`, `errors_and_warnings`, `all`
`security_alerts_threshold` string Обязательное поле The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "About code scanning alerts." Возможные значения: `none`, `critical`, `high_or_higher`, `medium_or_higher`, `all`
`tool` string Обязательное поле The name of a code scanning tool

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

Код состояния	Описание
`200`	OK
`404`	Resource not found
`500`	Internal Error

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

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

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

put/orgs/{org}/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/orgs/ORG/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*"]},"repository_name":{"include":["important_repository","another_important_repository"],"exclude":["unimportant_repository"],"protected":true}},"rules":[{"type":"commit_author_email_pattern","parameters":{"operator":"contains","pattern":"github"}}]}'

Response

Status: 200

{
  "id": 21,
  "name": "super cool ruleset",
  "target": "branch",
  "source_type": "Organization",
  "source": "my-org",
  "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*"
      ]
    },
    "repository_name": {
      "include": [
        "important_repository",
        "another_important_repository"
      ],
      "exclude": [
        "unimportant_repository"
      ],
      "protected": true
    }
  },
  "rules": [
    {
      "type": "commit_author_email_pattern",
      "parameters": {
        "operator": "contains",
        "pattern": "github"
      }
    }
  ],
  "node_id": "RRS_lACkVXNlcgQB",
  "_links": {
    "self": {
      "href": "https://api.github.com/orgs/my-org/rulesets/21"
    },
    "html": {
      "href": "https://github.com/organizations/my-org/settings/rules/21"
    }
  },
  "created_at": "2023-08-15T08:43:03Z",
  "updated_at": "2023-09-23T16:29:47Z"
}

Delete an organization repository ruleset

Delete a ruleset for an organization.

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

Эта конечная точка работает со следующими точными типами маркеров:

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

"Administration" organization permissions (write)

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

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.
`ruleset_id` integer Обязательное поле The ID of the ruleset.

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

Код состояния	Описание
`204`	No Content
`404`	Resource not found
`500`	Internal Error

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

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

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

delete/orgs/{org}/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/orgs/ORG/rulesets/RULESET_ID

Response

Status: 204