Skip to main content
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

Use la API de REST para administrar conjuntos de reglas para organizaciones. Los conjuntos de reglas de la organización controlan cómo los usuarios pueden interactuar con ramas y etiquetas seleccionadas en repositorios de una organización.

Get all organization repository rulesets

Get all the repository rulesets for an organization.

Tokens de acceso específicos para "Get all organization repository rulesets"

This endpoint works with the following fine-grained token types:

El token debe tener el siguiente conjunto de permisos.:

  • "Administration" organization permissions (write)

Parámetros para "Get all organization repository rulesets"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
org string Requerido

The organization name. The name is not case sensitive.

Parámetros de consulta
Nombre, Tipo, Descripción
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 all organization repository rulesets"

status codeDescripción
200

OK

404

Resource not found

500

Internal Error

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

Ejemplo de solicitud

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 acceso específicos para "Create an organization repository ruleset"

This endpoint works with the following fine-grained token types:

El token debe tener el siguiente conjunto de permisos.:

  • "Administration" organization permissions (write)

Parámetros para "Create an organization repository ruleset"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
org string Requerido

The organization name. The name is not case sensitive.

Parámetros del cuerpo
Nombre, Tipo, Descripción
name string Requerido

The name of the ruleset.

target string

The target of the ruleset

Note: The push target is in beta and is subject to change.

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

enforcement string Requerido

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

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

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Nombre, Tipo, Descripción
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 Requerido

The type of actor that can bypass a ruleset.

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

bypass_mode string Requerido

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.

Puede ser uno de los siguientes: always, pull_request

conditions object

Conditions for an organization ruleset. The conditions object should contain both repository_name and ref_name properties or both repository_id and ref_name properties.

Nombre, Tipo, Descripción
repository_name_and_ref_name object Requerido

Conditions to target repositories by name and refs by name

Nombre, Tipo, Descripción
ref_name object
Nombre, Tipo, Descripción
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 Requerido
Nombre, Tipo, Descripción
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 Requerido

Conditions to target repositories by id and refs by name

Nombre, Tipo, Descripción
ref_name object
Nombre, Tipo, Descripción
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 Requerido
Nombre, Tipo, Descripción
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 Requerido

Conditions to target repositories by property and refs by name

Nombre, Tipo, Descripción
ref_name object
Nombre, Tipo, Descripción
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 Requerido
Nombre, Tipo, Descripción
include array of objects

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

Nombre, Tipo, Descripción
name string Requerido

The name of the repository property to target

property_values array of strings Requerido

The values to match for the repository property

exclude array of objects

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

Nombre, Tipo, Descripción
name string Requerido

The name of the repository property to target

property_values array of strings Requerido

The values to match for the repository property

rules array of objects

An array of rules within the ruleset.

Nombre, Tipo, Descripción
creation object Requerido

Only allow users with bypass permission to create matching refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: creation

update object Requerido

Only allow users with bypass permission to update matching refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: update

parameters object
Nombre, Tipo, Descripción
update_allows_fetch_and_merge boolean Requerido

Branch can pull changes from its upstream repository

deletion object Requerido

Only allow users with bypass permissions to delete matching refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: deletion

required_linear_history object Requerido

Prevent merge commits from being pushed to matching refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: required_linear_history

required_deployments object Requerido

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

Nombre, Tipo, Descripción
type string Requerido

Valor: required_deployments

parameters object
Nombre, Tipo, Descripción
required_deployment_environments array of strings Requerido

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

required_signatures object Requerido

Commits pushed to matching refs must have verified signatures.

Nombre, Tipo, Descripción
type string Requerido

Valor: required_signatures

pull_request object Requerido

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

Nombre, Tipo, Descripción
type string Requerido

Valor: pull_request

parameters object
Nombre, Tipo, Descripción
dismiss_stale_reviews_on_push boolean Requerido

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

require_code_owner_review boolean Requerido

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

require_last_push_approval boolean Requerido

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

required_approving_review_count integer Requerido

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

required_review_thread_resolution boolean Requerido

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

required_status_checks object Requerido

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.

Nombre, Tipo, Descripción
type string Requerido

Valor: required_status_checks

parameters object
Nombre, Tipo, Descripción
required_status_checks array of objects Requerido

Status checks that are required.

Nombre, Tipo, Descripción
context string Requerido

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 Requerido

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 Requerido

Prevent users with push access from force pushing to refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: non_fast_forward

commit_message_pattern object Requerido

Parameters to be used for the commit_message_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: commit_message_pattern

parameters object
Nombre, Tipo, Descripción
name string

How this rule will appear to users.

negate boolean

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

operator string Requerido

The operator to use for matching.

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

pattern string Requerido

The pattern to match with.

commit_author_email_pattern object Requerido

Parameters to be used for the commit_author_email_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: commit_author_email_pattern

parameters object
Nombre, Tipo, Descripción
name string

How this rule will appear to users.

negate boolean

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

operator string Requerido

The operator to use for matching.

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

pattern string Requerido

The pattern to match with.

committer_email_pattern object Requerido

Parameters to be used for the committer_email_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: committer_email_pattern

parameters object
Nombre, Tipo, Descripción
name string

How this rule will appear to users.

negate boolean

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

operator string Requerido

The operator to use for matching.

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

pattern string Requerido

The pattern to match with.

branch_name_pattern object Requerido

Parameters to be used for the branch_name_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: branch_name_pattern

parameters object
Nombre, Tipo, Descripción
name string

How this rule will appear to users.

negate boolean

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

operator string Requerido

The operator to use for matching.

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

pattern string Requerido

The pattern to match with.

tag_name_pattern object Requerido

Parameters to be used for the tag_name_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: tag_name_pattern

parameters object
Nombre, Tipo, Descripción
name string

How this rule will appear to users.

negate boolean

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

operator string Requerido

The operator to use for matching.

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

pattern string Requerido

The pattern to match with.

file_path_restriction object Requerido

Note: file_path_restriction is in beta and subject to change.

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

Nombre, Tipo, Descripción
type string Requerido

Valor: file_path_restriction

parameters object
Nombre, Tipo, Descripción
restricted_file_paths array of strings Requerido

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

max_file_path_length object Requerido

Note: max_file_path_length is in beta and subject to change.

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

Nombre, Tipo, Descripción
type string Requerido

Valor: max_file_path_length

parameters object
Nombre, Tipo, Descripción
max_file_path_length integer Requerido

The maximum amount of characters allowed in file paths

file_extension_restriction object Requerido

Note: file_extension_restriction is in beta and subject to change.

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

Nombre, Tipo, Descripción
type string Requerido

Valor: file_extension_restriction

parameters object
Nombre, Tipo, Descripción
restricted_file_extensions array of strings Requerido

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

max_file_size object Requerido

Note: max_file_size is in beta and subject to change.

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

Nombre, Tipo, Descripción
type string Requerido

Valor: max_file_size

parameters object
Nombre, Tipo, Descripción
max_file_size integer Requerido

The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).

workflows object Requerido

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

Nombre, Tipo, Descripción
type string Requerido

Valor: workflows

parameters object
Nombre, Tipo, Descripción
workflows array of objects Requerido

Workflows that must pass for this rule to pass.

Nombre, Tipo, Descripción
path string Requerido

The path to the workflow file

ref string

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

repository_id integer Requerido

The ID of the repository where the workflow is defined

sha string

The commit SHA of the workflow file to use

code_scanning object Requerido

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.

Nombre, Tipo, Descripción
type string Requerido

Valor: code_scanning

parameters object
Nombre, Tipo, Descripción
code_scanning_tools array of objects Requerido

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

Nombre, Tipo, Descripción
alerts_threshold string Requerido

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 Requerido

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 Requerido

The name of a code scanning tool

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

status codeDescripción
201

Created

404

Resource not found

500

Internal Error

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

Ejemplo de solicitud

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.

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

This endpoint works with the following fine-grained token types:

El token debe tener el siguiente conjunto de permisos.:

  • "Administration" organization permissions (write)

Parámetros para "Get an organization repository ruleset"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
org string Requerido

The organization name. The name is not case sensitive.

ruleset_id integer Requerido

The ID of the ruleset.

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

status codeDescripción
200

OK

404

Resource not found

500

Internal Error

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

Ejemplo de solicitud

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 acceso específicos para "Update an organization repository ruleset"

This endpoint works with the following fine-grained token types:

El token debe tener el siguiente conjunto de permisos.:

  • "Administration" organization permissions (write)

Parámetros para "Update an organization repository ruleset"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
org string Requerido

The organization name. The name is not case sensitive.

ruleset_id integer Requerido

The ID of the ruleset.

Parámetros del cuerpo
Nombre, Tipo, Descripción
name string

The name of the ruleset.

target string

The target of the ruleset

Note: The push target is in beta and is subject to change.

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

enforcement string

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

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

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Nombre, Tipo, Descripción
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 Requerido

The type of actor that can bypass a ruleset.

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

bypass_mode string Requerido

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.

Puede ser uno de los siguientes: always, pull_request

conditions object

Conditions for an organization ruleset. The conditions object should contain both repository_name and ref_name properties or both repository_id and ref_name properties.

Nombre, Tipo, Descripción
repository_name_and_ref_name object Requerido

Conditions to target repositories by name and refs by name

Nombre, Tipo, Descripción
ref_name object
Nombre, Tipo, Descripción
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 Requerido
Nombre, Tipo, Descripción
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 Requerido

Conditions to target repositories by id and refs by name

Nombre, Tipo, Descripción
ref_name object
Nombre, Tipo, Descripción
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 Requerido
Nombre, Tipo, Descripción
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 Requerido

Conditions to target repositories by property and refs by name

Nombre, Tipo, Descripción
ref_name object
Nombre, Tipo, Descripción
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 Requerido
Nombre, Tipo, Descripción
include array of objects

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

Nombre, Tipo, Descripción
name string Requerido

The name of the repository property to target

property_values array of strings Requerido

The values to match for the repository property

exclude array of objects

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

Nombre, Tipo, Descripción
name string Requerido

The name of the repository property to target

property_values array of strings Requerido

The values to match for the repository property

rules array of objects

An array of rules within the ruleset.

Nombre, Tipo, Descripción
creation object Requerido

Only allow users with bypass permission to create matching refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: creation

update object Requerido

Only allow users with bypass permission to update matching refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: update

parameters object
Nombre, Tipo, Descripción
update_allows_fetch_and_merge boolean Requerido

Branch can pull changes from its upstream repository

deletion object Requerido

Only allow users with bypass permissions to delete matching refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: deletion

required_linear_history object Requerido

Prevent merge commits from being pushed to matching refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: required_linear_history

required_deployments object Requerido

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

Nombre, Tipo, Descripción
type string Requerido

Valor: required_deployments

parameters object
Nombre, Tipo, Descripción
required_deployment_environments array of strings Requerido

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

required_signatures object Requerido

Commits pushed to matching refs must have verified signatures.

Nombre, Tipo, Descripción
type string Requerido

Valor: required_signatures

pull_request object Requerido

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

Nombre, Tipo, Descripción
type string Requerido

Valor: pull_request

parameters object
Nombre, Tipo, Descripción
dismiss_stale_reviews_on_push boolean Requerido

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

require_code_owner_review boolean Requerido

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

require_last_push_approval boolean Requerido

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

required_approving_review_count integer Requerido

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

required_review_thread_resolution boolean Requerido

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

required_status_checks object Requerido

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.

Nombre, Tipo, Descripción
type string Requerido

Valor: required_status_checks

parameters object
Nombre, Tipo, Descripción
required_status_checks array of objects Requerido

Status checks that are required.

Nombre, Tipo, Descripción
context string Requerido

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 Requerido

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 Requerido

Prevent users with push access from force pushing to refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: non_fast_forward

commit_message_pattern object Requerido

Parameters to be used for the commit_message_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: commit_message_pattern

parameters object
Nombre, Tipo, Descripción
name string

How this rule will appear to users.

negate boolean

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

operator string Requerido

The operator to use for matching.

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

pattern string Requerido

The pattern to match with.

commit_author_email_pattern object Requerido

Parameters to be used for the commit_author_email_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: commit_author_email_pattern

parameters object
Nombre, Tipo, Descripción
name string

How this rule will appear to users.

negate boolean

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

operator string Requerido

The operator to use for matching.

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

pattern string Requerido

The pattern to match with.

committer_email_pattern object Requerido

Parameters to be used for the committer_email_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: committer_email_pattern

parameters object
Nombre, Tipo, Descripción
name string

How this rule will appear to users.

negate boolean

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

operator string Requerido

The operator to use for matching.

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

pattern string Requerido

The pattern to match with.

branch_name_pattern object Requerido

Parameters to be used for the branch_name_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: branch_name_pattern

parameters object
Nombre, Tipo, Descripción
name string

How this rule will appear to users.

negate boolean

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

operator string Requerido

The operator to use for matching.

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

pattern string Requerido

The pattern to match with.

tag_name_pattern object Requerido

Parameters to be used for the tag_name_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: tag_name_pattern

parameters object
Nombre, Tipo, Descripción
name string

How this rule will appear to users.

negate boolean

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

operator string Requerido

The operator to use for matching.

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

pattern string Requerido

The pattern to match with.

file_path_restriction object Requerido

Note: file_path_restriction is in beta and subject to change.

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

Nombre, Tipo, Descripción
type string Requerido

Valor: file_path_restriction

parameters object
Nombre, Tipo, Descripción
restricted_file_paths array of strings Requerido

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

max_file_path_length object Requerido

Note: max_file_path_length is in beta and subject to change.

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

Nombre, Tipo, Descripción
type string Requerido

Valor: max_file_path_length

parameters object
Nombre, Tipo, Descripción
max_file_path_length integer Requerido

The maximum amount of characters allowed in file paths

file_extension_restriction object Requerido

Note: file_extension_restriction is in beta and subject to change.

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

Nombre, Tipo, Descripción
type string Requerido

Valor: file_extension_restriction

parameters object
Nombre, Tipo, Descripción
restricted_file_extensions array of strings Requerido

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

max_file_size object Requerido

Note: max_file_size is in beta and subject to change.

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

Nombre, Tipo, Descripción
type string Requerido

Valor: max_file_size

parameters object
Nombre, Tipo, Descripción
max_file_size integer Requerido

The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).

workflows object Requerido

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

Nombre, Tipo, Descripción
type string Requerido

Valor: workflows

parameters object
Nombre, Tipo, Descripción
workflows array of objects Requerido

Workflows that must pass for this rule to pass.

Nombre, Tipo, Descripción
path string Requerido

The path to the workflow file

ref string

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

repository_id integer Requerido

The ID of the repository where the workflow is defined

sha string

The commit SHA of the workflow file to use

code_scanning object Requerido

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.

Nombre, Tipo, Descripción
type string Requerido

Valor: code_scanning

parameters object
Nombre, Tipo, Descripción
code_scanning_tools array of objects Requerido

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

Nombre, Tipo, Descripción
alerts_threshold string Requerido

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 Requerido

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 Requerido

The name of a code scanning tool

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

status codeDescripción
200

OK

404

Resource not found

500

Internal Error

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

Ejemplo de solicitud

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 acceso específicos para "Delete an organization repository ruleset"

This endpoint works with the following fine-grained token types:

El token debe tener el siguiente conjunto de permisos.:

  • "Administration" organization permissions (write)

Parámetros para "Delete an organization repository ruleset"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
org string Requerido

The organization name. The name is not case sensitive.

ruleset_id integer Requerido

The ID of the ruleset.

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

status codeDescripción
204

No Content

404

Resource not found

500

Internal Error

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

Ejemplo de solicitud

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