Pontos de extremidade da API REST para regras

Get all organization repository rulesets

Get all the repository rulesets for an organization.

Tokens de acesso refinados para "Get all organization repository rulesets"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" organization permissions (write)

Parâmetros para "Get all organization repository rulesets"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.

Parâmetros de consulta
Nome, Tipo, Descrição
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: `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`.

Códigos de status de resposta HTTP para "Get all organization repository rulesets"

Código de status	Descrição
`200`	OK
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "Get all organization repository rulesets"

Exemplo de solicitação

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.

Tokens de acesso refinados para "Create an organization repository ruleset"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" organization permissions (write)

Parâmetros para "Create an organization repository ruleset"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.

Nome, Tipo, Descrição

name string Obrigatório

The name of the ruleset.

target string

The target of the ruleset

Padrão: branch

Pode ser um dos: branch, tag, push

enforcement string Obrigatório

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

Pode ser um dos: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Properties of bypass_actors

Nome, Tipo, Descrição
`actor_id` integer or null The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories.
`actor_type` string Obrigatório The type of actor that can bypass a ruleset. Pode ser um dos: `Integration`, `OrganizationAdmin`, `RepositoryRole`, `Team`, `DeployKey`
`bypass_mode` string When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. Padrão: `always` Pode ser um dos: `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.

Can be one of these objects:

Nome, Tipo, Descrição

repository_name_and_ref_name object Obrigatório

Conditions to target repositories by name and refs by name

Properties of repository_name_and_ref_name

Nome, Tipo, Descrição

ref_name object

Properties of ref_name

Nome, Tipo, Descrição
`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 Obrigatório

Properties of repository_name

Nome, Tipo, Descrição
`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 Obrigatório

Conditions to target repositories by id and refs by name

Properties of repository_id_and_ref_name

Nome, Tipo, Descrição

ref_name object

Properties of ref_name

Nome, Tipo, Descrição
`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 Obrigatório

Properties of repository_id

Nome, Tipo, Descrição
`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 Obrigatório

Conditions to target repositories by property and refs by name

Properties of repository_property_and_ref_name

Nome, Tipo, Descrição

ref_name object

Properties of ref_name

Nome, Tipo, Descrição
`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 Obrigatório

Properties of repository_property

Nome, Tipo, Descrição

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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `custom`, `system`

rules array of objects

An array of rules within the ruleset.

Can be one of these objects:

Nome, Tipo, Descrição

creation object Obrigatório

Only allow users with bypass permission to create matching refs.

Properties of creation

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `creation`

update object Obrigatório

Only allow users with bypass permission to update matching refs.

Properties of update

Nome, Tipo, Descrição

type string Obrigatório

Valor: update

parameters object

Properties of parameters

Nome, Tipo, Descrição
`update_allows_fetch_and_merge` boolean Obrigatório Branch can pull changes from its upstream repository

deletion object Obrigatório

Only allow users with bypass permissions to delete matching refs.

Properties of deletion

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `deletion`

required_linear_history object Obrigatório

Prevent merge commits from being pushed to matching refs.

Properties of required_linear_history

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `required_linear_history`

merge_queue object Obrigatório

Merges must be performed via a merge queue.

Properties of merge_queue

Nome, Tipo, Descrição

type string Obrigatório

Valor: merge_queue

parameters object

Properties of parameters

Nome, Tipo, Descrição
`check_response_timeout_minutes` integer Obrigatório 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 Obrigatório 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. Pode ser um dos: `ALLGREEN`, `HEADGREEN`
`max_entries_to_build` integer Obrigatório Limit the number of queued pull requests requesting checks and workflow runs at the same time.
`max_entries_to_merge` integer Obrigatório The maximum number of PRs that will be merged together in a group.
`merge_method` string Obrigatório Method to use when merging changes from queued pull requests. Pode ser um dos: `MERGE`, `SQUASH`, `REBASE`
`min_entries_to_merge` integer Obrigatório The minimum number of PRs that will be merged together in a group.
`min_entries_to_merge_wait_minutes` integer Obrigatório 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 Obrigatório

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

Properties of required_deployments

Nome, Tipo, Descrição

type string Obrigatório

Valor: required_deployments

parameters object

Properties of parameters

Nome, Tipo, Descrição
`required_deployment_environments` array of strings Obrigatório The environments that must be successfully deployed to before branches can be merged.

required_signatures object Obrigatório

Commits pushed to matching refs must have verified signatures.

Properties of required_signatures

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `required_signatures`

pull_request object Obrigatório

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

Nome, Tipo, Descrição

type string Obrigatório

Valor: pull_request

parameters object

Properties of parameters

Nome, Tipo, Descrição
`dismiss_stale_reviews_on_push` boolean Obrigatório New, reviewable commits pushed will dismiss previous pull request review approvals.
`require_code_owner_review` boolean Obrigatório Require an approving review in pull requests that modify files that have a designated code owner.
`require_last_push_approval` boolean Obrigatório Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
`required_approving_review_count` integer Obrigatório The number of approving reviews that are required before a pull request can be merged.
`required_review_thread_resolution` boolean Obrigatório All conversations on code must be resolved before a pull request can be merged.

required_status_checks object Obrigatório

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

Nome, Tipo, Descrição

type string Obrigatório

Valor: required_status_checks

parameters object

Properties of parameters

Nome, Tipo, Descrição

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 Obrigatório

Status checks that are required.

Properties of required_status_checks

Nome, Tipo, Descrição
`context` string Obrigatório 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 Obrigatório

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 Obrigatório

Prevent users with push access from force pushing to refs.

Properties of non_fast_forward

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `non_fast_forward`

commit_message_pattern object Obrigatório

Parameters to be used for the commit_message_pattern rule

Properties of commit_message_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: commit_message_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

commit_author_email_pattern object Obrigatório

Parameters to be used for the commit_author_email_pattern rule

Properties of commit_author_email_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: commit_author_email_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

committer_email_pattern object Obrigatório

Parameters to be used for the committer_email_pattern rule

Properties of committer_email_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: committer_email_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

branch_name_pattern object Obrigatório

Parameters to be used for the branch_name_pattern rule

Properties of branch_name_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: branch_name_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

tag_name_pattern object Obrigatório

Parameters to be used for the tag_name_pattern rule

Properties of tag_name_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: tag_name_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

file_path_restriction object Obrigatório

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

Properties of file_path_restriction

Nome, Tipo, Descrição

type string Obrigatório

Valor: file_path_restriction

parameters object

Properties of parameters

Nome, Tipo, Descrição
`restricted_file_paths` array of strings Obrigatório The file paths that are restricted from being pushed to the commit graph.

max_file_path_length object Obrigatório

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

Nome, Tipo, Descrição

type string Obrigatório

Valor: max_file_path_length

parameters object

Properties of parameters

Nome, Tipo, Descrição
`max_file_path_length` integer Obrigatório The maximum amount of characters allowed in file paths

file_extension_restriction object Obrigatório

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

Properties of file_extension_restriction

Nome, Tipo, Descrição

type string Obrigatório

Valor: file_extension_restriction

parameters object

Properties of parameters

Nome, Tipo, Descrição
`restricted_file_extensions` array of strings Obrigatório The file extensions that are restricted from being pushed to the commit graph.

max_file_size object Obrigatório

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

Properties of max_file_size

Nome, Tipo, Descrição

type string Obrigatório

Valor: max_file_size

parameters object

Properties of parameters

Nome, Tipo, Descrição
`max_file_size` integer Obrigatório The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).

workflows object Obrigatório

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

Properties of workflows

Nome, Tipo, Descrição

type string Obrigatório

Valor: workflows

parameters object

Properties of parameters

Nome, Tipo, Descrição

do_not_enforce_on_create boolean

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

workflows array of objects Obrigatório

Workflows that must pass for this rule to pass.

Properties of workflows

Nome, Tipo, Descrição
`path` string Obrigatório The path to the workflow file
`ref` string The ref (branch or tag) of the workflow file to use
`repository_id` integer Obrigatório The ID of the repository where the workflow is defined
`sha` string The commit SHA of the workflow file to use

code_scanning object Obrigatório

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

Nome, Tipo, Descrição

type string Obrigatório

Valor: code_scanning

parameters object

Properties of parameters

Nome, Tipo, Descrição

code_scanning_tools array of objects Obrigatório

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

Properties of code_scanning_tools

Nome, Tipo, Descrição
`alerts_threshold` string Obrigatório 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." Pode ser um dos: `none`, `errors`, `errors_and_warnings`, `all`
`security_alerts_threshold` string Obrigatório 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." Pode ser um dos: `none`, `critical`, `high_or_higher`, `medium_or_higher`, `all`
`tool` string Obrigatório The name of a code scanning tool

Códigos de status de resposta HTTP para "Create an organization repository ruleset"

Código de status	Descrição
`201`	Created
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "Create an organization repository ruleset"

Exemplo de solicitação

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.

Tokens de acesso refinados para "Get an organization repository ruleset"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" organization permissions (write)

Parâmetros para "Get an organization repository ruleset"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
`ruleset_id` integer Obrigatório The ID of the ruleset.

Códigos de status de resposta HTTP para "Get an organization repository ruleset"

Código de status	Descrição
`200`	OK
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "Get an organization repository ruleset"

Exemplo de solicitação

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.

Tokens de acesso refinados para "Update an organization repository ruleset"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" organization permissions (write)

Parâmetros para "Update an organization repository ruleset"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
`ruleset_id` integer Obrigatório The ID of the ruleset.

Nome, Tipo, Descrição

name string

The name of the ruleset.

target string

The target of the ruleset

Pode ser um dos: branch, tag, push

enforcement string

Pode ser um dos: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Properties of bypass_actors

Nome, Tipo, Descrição
`actor_id` integer or null The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories.
`actor_type` string Obrigatório The type of actor that can bypass a ruleset. Pode ser um dos: `Integration`, `OrganizationAdmin`, `RepositoryRole`, `Team`, `DeployKey`
`bypass_mode` string When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. Padrão: `always` Pode ser um dos: `always`, `pull_request`

conditions object

Can be one of these objects:

Nome, Tipo, Descrição

repository_name_and_ref_name object Obrigatório

Conditions to target repositories by name and refs by name

Properties of repository_name_and_ref_name

Nome, Tipo, Descrição

ref_name object

Properties of ref_name

Nome, Tipo, Descrição
`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 Obrigatório

Properties of repository_name

Nome, Tipo, Descrição
`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 Obrigatório

Conditions to target repositories by id and refs by name

Properties of repository_id_and_ref_name

Nome, Tipo, Descrição

ref_name object

Properties of ref_name

Nome, Tipo, Descrição
`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 Obrigatório

Properties of repository_id

Nome, Tipo, Descrição
`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 Obrigatório

Conditions to target repositories by property and refs by name

Properties of repository_property_and_ref_name

Nome, Tipo, Descrição

ref_name object

Properties of ref_name

Nome, Tipo, Descrição
`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 Obrigatório

Properties of repository_property

Nome, Tipo, Descrição

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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `custom`, `system`

rules array of objects

An array of rules within the ruleset.

Can be one of these objects:

Nome, Tipo, Descrição

creation object Obrigatório

Only allow users with bypass permission to create matching refs.

Properties of creation

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `creation`

update object Obrigatório

Only allow users with bypass permission to update matching refs.

Properties of update

Nome, Tipo, Descrição

type string Obrigatório

Valor: update

parameters object

Properties of parameters

Nome, Tipo, Descrição
`update_allows_fetch_and_merge` boolean Obrigatório Branch can pull changes from its upstream repository

deletion object Obrigatório

Only allow users with bypass permissions to delete matching refs.

Properties of deletion

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `deletion`

required_linear_history object Obrigatório

Prevent merge commits from being pushed to matching refs.

Properties of required_linear_history

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `required_linear_history`

merge_queue object Obrigatório

Merges must be performed via a merge queue.

Properties of merge_queue

Nome, Tipo, Descrição

type string Obrigatório

Valor: merge_queue

parameters object

Properties of parameters

Nome, Tipo, Descrição
`check_response_timeout_minutes` integer Obrigatório 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 Obrigatório 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. Pode ser um dos: `ALLGREEN`, `HEADGREEN`
`max_entries_to_build` integer Obrigatório Limit the number of queued pull requests requesting checks and workflow runs at the same time.
`max_entries_to_merge` integer Obrigatório The maximum number of PRs that will be merged together in a group.
`merge_method` string Obrigatório Method to use when merging changes from queued pull requests. Pode ser um dos: `MERGE`, `SQUASH`, `REBASE`
`min_entries_to_merge` integer Obrigatório The minimum number of PRs that will be merged together in a group.
`min_entries_to_merge_wait_minutes` integer Obrigatório 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 Obrigatório

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

Properties of required_deployments

Nome, Tipo, Descrição

type string Obrigatório

Valor: required_deployments

parameters object

Properties of parameters

Nome, Tipo, Descrição
`required_deployment_environments` array of strings Obrigatório The environments that must be successfully deployed to before branches can be merged.

required_signatures object Obrigatório

Commits pushed to matching refs must have verified signatures.

Properties of required_signatures

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `required_signatures`

pull_request object Obrigatório

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

Nome, Tipo, Descrição

type string Obrigatório

Valor: pull_request

parameters object

Properties of parameters

Nome, Tipo, Descrição
`dismiss_stale_reviews_on_push` boolean Obrigatório New, reviewable commits pushed will dismiss previous pull request review approvals.
`require_code_owner_review` boolean Obrigatório Require an approving review in pull requests that modify files that have a designated code owner.
`require_last_push_approval` boolean Obrigatório Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
`required_approving_review_count` integer Obrigatório The number of approving reviews that are required before a pull request can be merged.
`required_review_thread_resolution` boolean Obrigatório All conversations on code must be resolved before a pull request can be merged.

required_status_checks object Obrigatório

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

Nome, Tipo, Descrição

type string Obrigatório

Valor: required_status_checks

parameters object

Properties of parameters

Nome, Tipo, Descrição

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 Obrigatório

Status checks that are required.

Properties of required_status_checks

Nome, Tipo, Descrição
`context` string Obrigatório 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 Obrigatório

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 Obrigatório

Prevent users with push access from force pushing to refs.

Properties of non_fast_forward

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `non_fast_forward`

commit_message_pattern object Obrigatório

Parameters to be used for the commit_message_pattern rule

Properties of commit_message_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: commit_message_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

commit_author_email_pattern object Obrigatório

Parameters to be used for the commit_author_email_pattern rule

Properties of commit_author_email_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: commit_author_email_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

committer_email_pattern object Obrigatório

Parameters to be used for the committer_email_pattern rule

Properties of committer_email_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: committer_email_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

branch_name_pattern object Obrigatório

Parameters to be used for the branch_name_pattern rule

Properties of branch_name_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: branch_name_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

tag_name_pattern object Obrigatório

Parameters to be used for the tag_name_pattern rule

Properties of tag_name_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: tag_name_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

file_path_restriction object Obrigatório

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

Properties of file_path_restriction

Nome, Tipo, Descrição

type string Obrigatório

Valor: file_path_restriction

parameters object

Properties of parameters

Nome, Tipo, Descrição
`restricted_file_paths` array of strings Obrigatório The file paths that are restricted from being pushed to the commit graph.

max_file_path_length object Obrigatório

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

Nome, Tipo, Descrição

type string Obrigatório

Valor: max_file_path_length

parameters object

Properties of parameters

Nome, Tipo, Descrição
`max_file_path_length` integer Obrigatório The maximum amount of characters allowed in file paths

file_extension_restriction object Obrigatório

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

Properties of file_extension_restriction

Nome, Tipo, Descrição

type string Obrigatório

Valor: file_extension_restriction

parameters object

Properties of parameters

Nome, Tipo, Descrição
`restricted_file_extensions` array of strings Obrigatório The file extensions that are restricted from being pushed to the commit graph.

max_file_size object Obrigatório

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

Properties of max_file_size

Nome, Tipo, Descrição

type string Obrigatório

Valor: max_file_size

parameters object

Properties of parameters

Nome, Tipo, Descrição
`max_file_size` integer Obrigatório The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).

workflows object Obrigatório

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

Properties of workflows

Nome, Tipo, Descrição

type string Obrigatório

Valor: workflows

parameters object

Properties of parameters

Nome, Tipo, Descrição

do_not_enforce_on_create boolean

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

workflows array of objects Obrigatório

Workflows that must pass for this rule to pass.

Properties of workflows

Nome, Tipo, Descrição
`path` string Obrigatório The path to the workflow file
`ref` string The ref (branch or tag) of the workflow file to use
`repository_id` integer Obrigatório The ID of the repository where the workflow is defined
`sha` string The commit SHA of the workflow file to use

code_scanning object Obrigatório

Properties of code_scanning

Nome, Tipo, Descrição

type string Obrigatório

Valor: code_scanning

parameters object

Properties of parameters

Nome, Tipo, Descrição

code_scanning_tools array of objects Obrigatório

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

Properties of code_scanning_tools

Nome, Tipo, Descrição
`alerts_threshold` string Obrigatório 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." Pode ser um dos: `none`, `errors`, `errors_and_warnings`, `all`
`security_alerts_threshold` string Obrigatório 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." Pode ser um dos: `none`, `critical`, `high_or_higher`, `medium_or_higher`, `all`
`tool` string Obrigatório The name of a code scanning tool

Códigos de status de resposta HTTP para "Update an organization repository ruleset"

Código de status	Descrição
`200`	OK
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "Update an organization repository ruleset"

Exemplo de solicitação

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.

Tokens de acesso refinados para "Delete an organization repository ruleset"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" organization permissions (write)

Parâmetros para "Delete an organization repository ruleset"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
`ruleset_id` integer Obrigatório The ID of the ruleset.

Códigos de status de resposta HTTP para "Delete an organization repository ruleset"

Código de status	Descrição
`204`	No Content
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "Delete an organization repository ruleset"

Exemplo de solicitação

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