Ahora la API de REST tiene control de versiones. Para obtener más información, consulta "Acerca del control de versiones de la API".

Puntos de conexión de la API de REST para reglas

Usa la API REST para administrar conjuntos de reglas para una empresa. Los conjuntos de reglas controlan cómo las personas pueden interactuar con repositorios y código.

Create an enterprise repository ruleset

Create a repository ruleset for an enterprise.

Tokens de acceso específicos para "Create an enterprise repository ruleset"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Enterprise administration" enterprise permissions (write)

Parámetros para "Create an enterprise repository ruleset"

Encabezados
accept string

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

Parámetros de la ruta de acceso
enterprise string Obligatorio

The slug version of the enterprise name.

Parámetros del cuerpo
name string Obligatorio

The name of the ruleset.

target string

The target of the ruleset

Valor predeterminado: branch

Puede ser uno de los siguientes: branch, tag, push, repository

enforcement string Obligatorio

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.

Puede ser uno de los siguientes: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

actor_id integer or null

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, this should be 1. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

actor_type string Obligatorio

The type of actor that can bypass a ruleset

Puede ser uno de los siguientes: Integration, OrganizationAdmin, RepositoryRole, Team, DeployKey, EnterpriseOwner

bypass_mode string

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type. Also, pull_request is only applicable to branch rulesets. When bypass_mode is exempt, rules will not be run for that actor and a bypass audit entry will not be created.

Valor predeterminado: always

Puede ser uno de los siguientes: always, pull_request, exempt

conditions object

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

organization_name_and_repository_name object

Conditions to target organizations by name and all repositories

organization_name object Obligatorio
include array of strings

Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all organizations and ~EMUS to target all enterprise managed user accounts.

exclude array of strings

Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.

repository_name object Obligatorio
include array of strings

Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.

exclude array of strings

Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

protected boolean

Whether renaming of target repositories is prevented.

ref_name object
include array of strings

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_name_and_repository_property object

Conditions to target organizations by name and repositories by property

organization_name object Obligatorio
include array of strings

Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all organizations and ~EMUS to target all enterprise managed user accounts.

exclude array of strings

Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.

repository_property object Obligatorio
include array of objects

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

name string Obligatorio

The name of the repository property to target

property_values array of strings Obligatorio

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Puede ser uno de los siguientes: custom, system

exclude array of objects

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

name string Obligatorio

The name of the repository property to target

property_values array of strings Obligatorio

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Puede ser uno de los siguientes: custom, system

ref_name object
include array of strings

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_id_and_repository_name object

Conditions to target organizations by id and all repositories

organization_id object Obligatorio
organization_ids array of integers

The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

repository_name object Obligatorio
include array of strings

Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.

exclude array of strings

Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

protected boolean

Whether renaming of target repositories is prevented.

ref_name object
include array of strings

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_id_and_repository_property object

Conditions to target organization by id and repositories by property

organization_id object Obligatorio
organization_ids array of integers

The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

repository_property object Obligatorio
include array of objects

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

name string Obligatorio

The name of the repository property to target

property_values array of strings Obligatorio

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Puede ser uno de los siguientes: custom, system

exclude array of objects

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

name string Obligatorio

The name of the repository property to target

property_values array of strings Obligatorio

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Puede ser uno de los siguientes: custom, system

ref_name object
include array of strings

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_property_and_repository_name object

Conditions to target organizations by property and all repositories

organization_property object Obligatorio
include array of objects

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

name string Obligatorio

The name of the organization property to target

property_values array of strings Obligatorio

The values to match for the organization property

exclude array of objects

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

name string Obligatorio

The name of the organization property to target

property_values array of strings Obligatorio

The values to match for the organization property

repository_name object Obligatorio
include array of strings

Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.

exclude array of strings

Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

protected boolean

Whether renaming of target repositories is prevented.

ref_name object
include array of strings

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_property_and_repository_property object

Conditions to target organizations by property and repositories by property

organization_property object Obligatorio
include array of objects

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

name string Obligatorio

The name of the organization property to target

property_values array of strings Obligatorio

The values to match for the organization property

exclude array of objects

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

name string Obligatorio

The name of the organization property to target

property_values array of strings Obligatorio

The values to match for the organization property

repository_property object Obligatorio
include array of objects

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

name string Obligatorio

The name of the repository property to target

property_values array of strings Obligatorio

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Puede ser uno de los siguientes: custom, system

exclude array of objects

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

name string Obligatorio

The name of the repository property to target

property_values array of strings Obligatorio

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Puede ser uno de los siguientes: custom, system

ref_name object
include array of strings

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

rules array of objects

An array of rules within the ruleset.

creation object

Only allow users with bypass permission to create matching refs.

type string Obligatorio

Valor: creation

update object

Only allow users with bypass permission to update matching refs.

type string Obligatorio

Valor: update

parameters object
update_allows_fetch_and_merge boolean Obligatorio

Branch can pull changes from its upstream repository

deletion object

Only allow users with bypass permissions to delete matching refs.

type string Obligatorio

Valor: deletion

required_linear_history object

Prevent merge commits from being pushed to matching refs.

type string Obligatorio

Valor: required_linear_history

required_deployments object

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

type string Obligatorio

Valor: required_deployments

parameters object
required_deployment_environments array of strings Obligatorio

The environments that must be successfully deployed to before branches can be merged.

required_signatures object

Commits pushed to matching refs must have verified signatures.

type string Obligatorio

Valor: required_signatures

pull_request object

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

type string Obligatorio

Valor: pull_request

parameters object
allowed_merge_methods array of strings

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

dismiss_stale_reviews_on_push boolean Obligatorio

New, reviewable commits pushed will dismiss previous pull request review approvals.

require_code_owner_review boolean Obligatorio

Require an approving review in pull requests that modify files that have a designated code owner.

require_last_push_approval boolean Obligatorio

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

required_approving_review_count integer Obligatorio

The number of approving reviews that are required before a pull request can be merged.

required_review_thread_resolution boolean Obligatorio

All conversations on code must be resolved before a pull request can be merged.

required_reviewers array of objects

Note

required_reviewers is in beta and subject to change.

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

file_patterns array of strings Obligatorio

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

minimum_approvals integer Obligatorio

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

reviewer object Obligatorio

A required reviewing team

id integer Obligatorio

ID of the reviewer which must review changes to matching files.

type string Obligatorio

The type of the reviewer

Valor: Team

required_status_checks object

Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.

type string Obligatorio

Valor: required_status_checks

parameters object
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 Obligatorio

Status checks that are required.

context string Obligatorio

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 Obligatorio

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

non_fast_forward object

Prevent users with push access from force pushing to refs.

type string Obligatorio

Valor: non_fast_forward

commit_message_pattern object

Parameters to be used for the commit_message_pattern rule

type string Obligatorio

Valor: commit_message_pattern

parameters object
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Obligatorio

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Obligatorio

The pattern to match with.

commit_author_email_pattern object

Parameters to be used for the commit_author_email_pattern rule

type string Obligatorio

Valor: commit_author_email_pattern

parameters object
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Obligatorio

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Obligatorio

The pattern to match with.

committer_email_pattern object

Parameters to be used for the committer_email_pattern rule

type string Obligatorio

Valor: committer_email_pattern

parameters object
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Obligatorio

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Obligatorio

The pattern to match with.

branch_name_pattern object

Parameters to be used for the branch_name_pattern rule

type string Obligatorio

Valor: branch_name_pattern

parameters object
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Obligatorio

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Obligatorio

The pattern to match with.

tag_name_pattern object

Parameters to be used for the tag_name_pattern rule

type string Obligatorio

Valor: tag_name_pattern

parameters object
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Obligatorio

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Obligatorio

The pattern to match with.

file_path_restriction object

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

type string Obligatorio

Valor: file_path_restriction

parameters object
restricted_file_paths array of strings Obligatorio

The file paths that are restricted from being pushed to the commit graph.

max_file_path_length object

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

type string Obligatorio

Valor: max_file_path_length

parameters object
max_file_path_length integer Obligatorio

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.

type string Obligatorio

Valor: file_extension_restriction

parameters object
restricted_file_extensions array of strings Obligatorio

The file extensions that are restricted from being pushed to the commit graph.

max_file_size object

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

type string Obligatorio

Valor: max_file_size

parameters object
max_file_size integer Obligatorio

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.

type string Obligatorio

Valor: workflows

parameters object
do_not_enforce_on_create boolean

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

workflows array of objects Obligatorio

Workflows that must pass for this rule to pass.

path string Obligatorio

The path to the workflow file

ref string

The ref (branch or tag) of the workflow file to use

repository_id integer Obligatorio

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.

type string Obligatorio

Valor: code_scanning

parameters object
code_scanning_tools array of objects Obligatorio

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

alerts_threshold string Obligatorio

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

Puede ser uno de los siguientes: none, errors, errors_and_warnings, all

security_alerts_threshold string Obligatorio

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

Puede ser uno de los siguientes: none, critical, high_or_higher, medium_or_higher, all

tool string Obligatorio

The name of a code scanning tool

copilot_code_review object

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

type string Obligatorio

Valor: copilot_code_review

parameters object
review_draft_pull_requests boolean

Copilot automatically reviews draft pull requests before they are marked as ready for review.

review_on_push boolean

Copilot automatically reviews each new push to the pull request.

Códigos de estado de respuesta HTTP para "Create an enterprise repository ruleset"

status codeDescripción
201

Created

404

Resource not found

500

Internal Error

Ejemplos de código para "Create an enterprise repository ruleset"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

Response

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

Get an enterprise repository ruleset

Get a repository ruleset for an enterprise.

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

Tokens de acceso específicos para "Get an enterprise repository ruleset"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Enterprise administration" enterprise permissions (write)

Parámetros para "Get an enterprise repository ruleset"

Encabezados
accept string

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

Parámetros de la ruta de acceso
enterprise string Obligatorio

The slug version of the enterprise name.

ruleset_id integer Obligatorio

The ID of the ruleset.

Códigos de estado de respuesta HTTP para "Get an enterprise repository ruleset"

status codeDescripción
200

OK

404

Resource not found

500

Internal Error

Ejemplos de código para "Get an enterprise repository ruleset"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

Response

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

Update an enterprise repository ruleset

Update a ruleset for an enterprise.

Tokens de acceso específicos para "Update an enterprise repository ruleset"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Enterprise administration" enterprise permissions (write)

Parámetros para "Update an enterprise repository ruleset"

Encabezados
accept string

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

Parámetros de la ruta de acceso
enterprise string Obligatorio

The slug version of the enterprise name.

ruleset_id integer Obligatorio

The ID of the ruleset.

Parámetros del cuerpo
name string

The name of the ruleset.

target string

The target of the ruleset

Puede ser uno de los siguientes: 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.

Puede ser uno de los siguientes: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

actor_id integer or null

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, this should be 1. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

actor_type string Obligatorio

The type of actor that can bypass a ruleset

Puede ser uno de los siguientes: Integration, OrganizationAdmin, RepositoryRole, Team, DeployKey, EnterpriseOwner

bypass_mode string

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type. Also, pull_request is only applicable to branch rulesets. When bypass_mode is exempt, rules will not be run for that actor and a bypass audit entry will not be created.

Valor predeterminado: always

Puede ser uno de los siguientes: always, pull_request, exempt

conditions object

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

organization_name_and_repository_name object

Conditions to target organizations by name and all repositories

organization_name object Obligatorio
include array of strings

Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all organizations and ~EMUS to target all enterprise managed user accounts.

exclude array of strings

Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.

repository_name object Obligatorio
include array of strings

Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.

exclude array of strings

Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

protected boolean

Whether renaming of target repositories is prevented.

ref_name object
include array of strings

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_name_and_repository_property object

Conditions to target organizations by name and repositories by property

organization_name object Obligatorio
include array of strings

Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all organizations and ~EMUS to target all enterprise managed user accounts.

exclude array of strings

Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.

repository_property object Obligatorio
include array of objects

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

name string Obligatorio

The name of the repository property to target

property_values array of strings Obligatorio

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Puede ser uno de los siguientes: custom, system

exclude array of objects

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

name string Obligatorio

The name of the repository property to target

property_values array of strings Obligatorio

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Puede ser uno de los siguientes: custom, system

ref_name object
include array of strings

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_id_and_repository_name object

Conditions to target organizations by id and all repositories

organization_id object Obligatorio
organization_ids array of integers

The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

repository_name object Obligatorio
include array of strings

Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.

exclude array of strings

Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

protected boolean

Whether renaming of target repositories is prevented.

ref_name object
include array of strings

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_id_and_repository_property object

Conditions to target organization by id and repositories by property

organization_id object Obligatorio
organization_ids array of integers

The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

repository_property object Obligatorio
include array of objects

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

name string Obligatorio

The name of the repository property to target

property_values array of strings Obligatorio

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Puede ser uno de los siguientes: custom, system

exclude array of objects

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

name string Obligatorio

The name of the repository property to target

property_values array of strings Obligatorio

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Puede ser uno de los siguientes: custom, system

ref_name object
include array of strings

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_property_and_repository_name object

Conditions to target organizations by property and all repositories

organization_property object Obligatorio
include array of objects

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

name string Obligatorio

The name of the organization property to target

property_values array of strings Obligatorio

The values to match for the organization property

exclude array of objects

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

name string Obligatorio

The name of the organization property to target

property_values array of strings Obligatorio

The values to match for the organization property

repository_name object Obligatorio
include array of strings

Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.

exclude array of strings

Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

protected boolean

Whether renaming of target repositories is prevented.

ref_name object
include array of strings

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

organization_property_and_repository_property object

Conditions to target organizations by property and repositories by property

organization_property object Obligatorio
include array of objects

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

name string Obligatorio

The name of the organization property to target

property_values array of strings Obligatorio

The values to match for the organization property

exclude array of objects

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

name string Obligatorio

The name of the organization property to target

property_values array of strings Obligatorio

The values to match for the organization property

repository_property object Obligatorio
include array of objects

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

name string Obligatorio

The name of the repository property to target

property_values array of strings Obligatorio

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Puede ser uno de los siguientes: custom, system

exclude array of objects

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

name string Obligatorio

The name of the repository property to target

property_values array of strings Obligatorio

The values to match for the repository property

source string

The source of the repository property. Defaults to 'custom' if not specified.

Puede ser uno de los siguientes: custom, system

ref_name object
include array of strings

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

rules array of objects

An array of rules within the ruleset.

creation object

Only allow users with bypass permission to create matching refs.

type string Obligatorio

Valor: creation

update object

Only allow users with bypass permission to update matching refs.

type string Obligatorio

Valor: update

parameters object
update_allows_fetch_and_merge boolean Obligatorio

Branch can pull changes from its upstream repository

deletion object

Only allow users with bypass permissions to delete matching refs.

type string Obligatorio

Valor: deletion

required_linear_history object

Prevent merge commits from being pushed to matching refs.

type string Obligatorio

Valor: required_linear_history

required_deployments object

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

type string Obligatorio

Valor: required_deployments

parameters object
required_deployment_environments array of strings Obligatorio

The environments that must be successfully deployed to before branches can be merged.

required_signatures object

Commits pushed to matching refs must have verified signatures.

type string Obligatorio

Valor: required_signatures

pull_request object

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

type string Obligatorio

Valor: pull_request

parameters object
allowed_merge_methods array of strings

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

dismiss_stale_reviews_on_push boolean Obligatorio

New, reviewable commits pushed will dismiss previous pull request review approvals.

require_code_owner_review boolean Obligatorio

Require an approving review in pull requests that modify files that have a designated code owner.

require_last_push_approval boolean Obligatorio

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

required_approving_review_count integer Obligatorio

The number of approving reviews that are required before a pull request can be merged.

required_review_thread_resolution boolean Obligatorio

All conversations on code must be resolved before a pull request can be merged.

required_reviewers array of objects

Note

required_reviewers is in beta and subject to change.

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

file_patterns array of strings Obligatorio

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

minimum_approvals integer Obligatorio

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

reviewer object Obligatorio

A required reviewing team

id integer Obligatorio

ID of the reviewer which must review changes to matching files.

type string Obligatorio

The type of the reviewer

Valor: Team

required_status_checks object

Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.

type string Obligatorio

Valor: required_status_checks

parameters object
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 Obligatorio

Status checks that are required.

context string Obligatorio

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 Obligatorio

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

non_fast_forward object

Prevent users with push access from force pushing to refs.

type string Obligatorio

Valor: non_fast_forward

commit_message_pattern object

Parameters to be used for the commit_message_pattern rule

type string Obligatorio

Valor: commit_message_pattern

parameters object
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Obligatorio

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Obligatorio

The pattern to match with.

commit_author_email_pattern object

Parameters to be used for the commit_author_email_pattern rule

type string Obligatorio

Valor: commit_author_email_pattern

parameters object
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Obligatorio

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Obligatorio

The pattern to match with.

committer_email_pattern object

Parameters to be used for the committer_email_pattern rule

type string Obligatorio

Valor: committer_email_pattern

parameters object
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Obligatorio

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Obligatorio

The pattern to match with.

branch_name_pattern object

Parameters to be used for the branch_name_pattern rule

type string Obligatorio

Valor: branch_name_pattern

parameters object
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Obligatorio

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Obligatorio

The pattern to match with.

tag_name_pattern object

Parameters to be used for the tag_name_pattern rule

type string Obligatorio

Valor: tag_name_pattern

parameters object
name string

How this rule will appear to users.

negate boolean

If true, the rule will fail if the pattern matches.

operator string Obligatorio

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Obligatorio

The pattern to match with.

file_path_restriction object

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

type string Obligatorio

Valor: file_path_restriction

parameters object
restricted_file_paths array of strings Obligatorio

The file paths that are restricted from being pushed to the commit graph.

max_file_path_length object

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

type string Obligatorio

Valor: max_file_path_length

parameters object
max_file_path_length integer Obligatorio

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.

type string Obligatorio

Valor: file_extension_restriction

parameters object
restricted_file_extensions array of strings Obligatorio

The file extensions that are restricted from being pushed to the commit graph.

max_file_size object

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

type string Obligatorio

Valor: max_file_size

parameters object
max_file_size integer Obligatorio

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.

type string Obligatorio

Valor: workflows

parameters object
do_not_enforce_on_create boolean

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

workflows array of objects Obligatorio

Workflows that must pass for this rule to pass.

path string Obligatorio

The path to the workflow file

ref string

The ref (branch or tag) of the workflow file to use

repository_id integer Obligatorio

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.

type string Obligatorio

Valor: code_scanning

parameters object
code_scanning_tools array of objects Obligatorio

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

alerts_threshold string Obligatorio

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

Puede ser uno de los siguientes: none, errors, errors_and_warnings, all

security_alerts_threshold string Obligatorio

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

Puede ser uno de los siguientes: none, critical, high_or_higher, medium_or_higher, all

tool string Obligatorio

The name of a code scanning tool

copilot_code_review object

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

type string Obligatorio

Valor: copilot_code_review

parameters object
review_draft_pull_requests boolean

Copilot automatically reviews draft pull requests before they are marked as ready for review.

review_on_push boolean

Copilot automatically reviews each new push to the pull request.

Códigos de estado de respuesta HTTP para "Update an enterprise repository ruleset"

status codeDescripción
200

OK

404

Resource not found

500

Internal Error

Ejemplos de código para "Update an enterprise repository ruleset"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

Response

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

Delete an enterprise repository ruleset

Delete a ruleset for an enterprise.

Tokens de acceso específicos para "Delete an enterprise repository ruleset"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Enterprise administration" enterprise permissions (write)

Parámetros para "Delete an enterprise repository ruleset"

Encabezados
accept string

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

Parámetros de la ruta de acceso
enterprise string Obligatorio

The slug version of the enterprise name.

ruleset_id integer Obligatorio

The ID of the ruleset.

Códigos de estado de respuesta HTTP para "Delete an enterprise repository ruleset"

status codeDescripción
204

No Content

404

Resource not found

500

Internal Error

Ejemplos de código para "Delete an enterprise repository ruleset"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

Response

Status: 204

Get enterprise ruleset history

Get the history of an enterprise ruleset.

Tokens de acceso específicos para "Get enterprise ruleset history"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "Get enterprise ruleset history"

Encabezados
accept string

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

Parámetros de la ruta de acceso
enterprise string Obligatorio

The slug version of the enterprise name.

ruleset_id integer Obligatorio

The ID of the ruleset.

Parámetros de consulta
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Valor predeterminado: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Valor predeterminado: 1

Códigos de estado de respuesta HTTP para "Get enterprise ruleset history"

status codeDescripción
200

OK

404

Resource not found

500

Internal Error

Ejemplos de código para "Get enterprise ruleset history"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

Response

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

Get enterprise ruleset version

Get a version of an enterprise ruleset.

Tokens de acceso específicos para "Get enterprise ruleset version"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "Get enterprise ruleset version"

Encabezados
accept string

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

Parámetros de la ruta de acceso
enterprise string Obligatorio

The slug version of the enterprise name.

ruleset_id integer Obligatorio

The ID of the ruleset.

version_id integer Obligatorio

The ID of the version

Códigos de estado de respuesta HTTP para "Get enterprise ruleset version"

status codeDescripción
200

OK

404

Resource not found

500

Internal Error

Ejemplos de código para "Get enterprise ruleset version"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

Response

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