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"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Administration" organization permissions (write)
Parámetros para "Get all organization repository rulesets"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
org string RequeridoThe organization name. The name is not case sensitive. |
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: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: |
targets string A comma-separated list of rule targets to filter by.
If provided, only rulesets that apply to the specified targets will be returned.
For example, |
Códigos de estado de respuesta HTTP para "Get all organization repository rulesets"
status code | Descripción |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
Ejemplos de código para "Get all organization repository rulesets"
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
Ejemplo de solicitud
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"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Administration" organization permissions (write)
Parámetros para "Create an organization repository ruleset"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
org string RequeridoThe organization name. The name is not case sensitive. |
Nombre, Tipo, Descripción | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name string RequeridoThe name of the ruleset. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target string The target of the ruleset Valor predeterminado: Puede ser uno de los siguientes: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enforcement string RequeridoThe enforcement level of the ruleset. Puede ser uno de los siguientes: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bypass_actors array of objects The actors that can bypass the rules in this ruleset | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties of |
Nombre, Tipo, Descripción |
---|
actor_id integer or null The ID of the actor that can bypass a ruleset. If |
actor_type string RequeridoThe type of actor that can bypass a ruleset Puede ser uno de los siguientes: |
bypass_mode string When the specified actor can bypass the ruleset. Valor predeterminado: Puede ser uno de los siguientes: |
conditions
object Conditions for an organization ruleset.
The branch and tag rulesets conditions object should contain both repository_name
and ref_name
properties, or both repository_id
and ref_name
properties, or both repository_property
and ref_name
properties.
The push rulesets conditions object does not require the ref_name
property.
Can be one of these objects:
Nombre, Tipo, Descripción | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
repository_name_and_ref_name object RequeridoConditions to target repositories by name and refs by name | |||||||||||||||||||||
Properties of |
Nombre, Tipo, Descripción | ||||
---|---|---|---|---|
ref_name object | ||||
Properties of |
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 |
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 RequeridoProperties of repository_name
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 |
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 RequeridoConditions to target repositories by id and refs by name
Properties of repository_id_and_ref_name
Nombre, Tipo, Descripción | |||
---|---|---|---|
ref_name object | |||
Properties of |
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 |
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 RequeridoProperties of repository_id
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 RequeridoConditions to target repositories by property and refs by name
Properties of repository_property_and_ref_name
Nombre, Tipo, Descripción | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ref_name object | |||||||||||||
Properties of |
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 |
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 RequeridoProperties of repository_property
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. | ||||
Properties of |
Nombre, Tipo, Descripción |
---|
name string RequeridoThe name of the repository property to target |
property_values array of strings RequeridoThe 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: |
exclude
array of objects The repository properties and values to exclude. The condition will not pass if any of these properties match.
Properties of exclude
Nombre, Tipo, Descripción |
---|
name string RequeridoThe name of the repository property to target |
property_values array of strings RequeridoThe 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: |
rules
array of objects An array of rules within the ruleset.
Can be one of these objects:
Nombre, Tipo, Descripción | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
creation object RequeridoOnly allow users with bypass permission to create matching refs. | |||||||||||||
Properties of |
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
update
object RequeridoOnly allow users with bypass permission to update matching refs.
Properties of update
Nombre, Tipo, Descripción | ||
---|---|---|
type string RequeridoValor: | ||
parameters object | ||
Properties of |
Nombre, Tipo, Descripción |
---|
update_allows_fetch_and_merge boolean RequeridoBranch can pull changes from its upstream repository |
deletion
object RequeridoOnly allow users with bypass permissions to delete matching refs.
Properties of deletion
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
required_linear_history
object RequeridoPrevent merge commits from being pushed to matching refs.
Properties of required_linear_history
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
merge_queue
object RequeridoMerges must be performed via a merge queue.
Properties of merge_queue
Nombre, Tipo, Descripción | ||||||||
---|---|---|---|---|---|---|---|---|
type string RequeridoValor: | ||||||||
parameters object | ||||||||
Properties of |
Nombre, Tipo, Descripción |
---|
check_response_timeout_minutes integer RequeridoMaximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed |
grouping_strategy string RequeridoWhen set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. Puede ser uno de los siguientes: |
max_entries_to_build integer RequeridoLimit the number of queued pull requests requesting checks and workflow runs at the same time. |
max_entries_to_merge integer RequeridoThe maximum number of PRs that will be merged together in a group. |
merge_method string RequeridoMethod to use when merging changes from queued pull requests. Puede ser uno de los siguientes: |
min_entries_to_merge integer RequeridoThe minimum number of PRs that will be merged together in a group. |
min_entries_to_merge_wait_minutes integer RequeridoThe time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. |
required_deployments
object RequeridoChoose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
Properties of required_deployments
Nombre, Tipo, Descripción | ||
---|---|---|
type string RequeridoValor: | ||
parameters object | ||
Properties of |
Nombre, Tipo, Descripción |
---|
required_deployment_environments array of strings RequeridoThe environments that must be successfully deployed to before branches can be merged. |
required_signatures
object RequeridoCommits pushed to matching refs must have verified signatures.
Properties of required_signatures
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
pull_request
object RequeridoRequire all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Properties of pull_request
Nombre, Tipo, Descripción | ||||||
---|---|---|---|---|---|---|
type string RequeridoValor: | ||||||
parameters object | ||||||
Properties of |
Nombre, Tipo, Descripción |
---|
dismiss_stale_reviews_on_push boolean RequeridoNew, reviewable commits pushed will dismiss previous pull request review approvals. |
require_code_owner_review boolean RequeridoRequire an approving review in pull requests that modify files that have a designated code owner. |
require_last_push_approval boolean RequeridoWhether the most recent reviewable push must be approved by someone other than the person who pushed it. |
required_approving_review_count integer RequeridoThe number of approving reviews that are required before a pull request can be merged. |
required_review_thread_resolution boolean RequeridoAll conversations on code must be resolved before a pull request can be merged. |
required_status_checks
object RequeridoChoose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
Properties of required_status_checks
Nombre, Tipo, Descripción | ||||||||
---|---|---|---|---|---|---|---|---|
type string RequeridoValor: | ||||||||
parameters object | ||||||||
Properties of |
Nombre, Tipo, Descripción | |||
---|---|---|---|
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 RequeridoStatus checks that are required. | |||
Properties of |
Nombre, Tipo, Descripción |
---|
context string RequeridoThe 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 RequeridoWhether 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 RequeridoPrevent users with push access from force pushing to refs.
Properties of non_fast_forward
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
commit_message_pattern
object RequeridoParameters to be used for the commit_message_pattern rule
Properties of commit_message_pattern
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
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 RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
commit_author_email_pattern
object RequeridoParameters to be used for the commit_author_email_pattern rule
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
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 RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
committer_email_pattern
object RequeridoParameters to be used for the committer_email_pattern rule
Properties of committer_email_pattern
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
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 RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
branch_name_pattern
object RequeridoParameters to be used for the branch_name_pattern rule
Properties of branch_name_pattern
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
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 RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
tag_name_pattern
object RequeridoParameters to be used for the tag_name_pattern rule
Properties of tag_name_pattern
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
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 RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
file_path_restriction
object RequeridoPrevent commits that include changes in specified file paths from being pushed to the commit graph.
Properties of file_path_restriction
Nombre, Tipo, Descripción | ||
---|---|---|
type string RequeridoValor: | ||
parameters object | ||
Properties of |
Nombre, Tipo, Descripción |
---|
restricted_file_paths array of strings RequeridoThe file paths that are restricted from being pushed to the commit graph. |
max_file_path_length
object RequeridoPrevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.
Properties of max_file_path_length
Nombre, Tipo, Descripción | ||
---|---|---|
type string RequeridoValor: | ||
parameters object | ||
Properties of |
Nombre, Tipo, Descripción |
---|
max_file_path_length integer RequeridoThe maximum amount of characters allowed in file paths |
file_extension_restriction
object RequeridoPrevent commits that include files with specified file extensions from being pushed to the commit graph.
Properties of file_extension_restriction
Nombre, Tipo, Descripción | ||
---|---|---|
type string RequeridoValor: | ||
parameters object | ||
Properties of |
Nombre, Tipo, Descripción |
---|
restricted_file_extensions array of strings RequeridoThe file extensions that are restricted from being pushed to the commit graph. |
max_file_size
object RequeridoPrevent commits that exceed a specified file size limit from being pushed to the commit.
Properties of max_file_size
Nombre, Tipo, Descripción | ||
---|---|---|
type string RequeridoValor: | ||
parameters object | ||
Properties of |
Nombre, Tipo, Descripción |
---|
max_file_size integer RequeridoThe maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). |
workflows
object RequeridoRequire all changes made to a targeted branch to pass the specified workflows before they can be merged.
Properties of workflows
Nombre, Tipo, Descripción | |||||||||
---|---|---|---|---|---|---|---|---|---|
type string RequeridoValor: | |||||||||
parameters object | |||||||||
Properties of |
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
do_not_enforce_on_create boolean Allow repositories and branches to be created if a check would otherwise prohibit it. | |||||
workflows array of objects RequeridoWorkflows that must pass for this rule to pass. | |||||
Properties of |
Nombre, Tipo, Descripción |
---|
path string RequeridoThe path to the workflow file |
ref string The ref (branch or tag) of the workflow file to use |
repository_id integer RequeridoThe ID of the repository where the workflow is defined |
sha string The commit SHA of the workflow file to use |
code_scanning
object RequeridoChoose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
Properties of code_scanning
Nombre, Tipo, Descripción | |||||||
---|---|---|---|---|---|---|---|
type string RequeridoValor: | |||||||
parameters object | |||||||
Properties of |
Nombre, Tipo, Descripción | ||||
---|---|---|---|---|
code_scanning_tools array of objects RequeridoTools that must provide code scanning results for this rule to pass. | ||||
Properties of |
Nombre, Tipo, Descripción |
---|
alerts_threshold string RequeridoThe 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: |
security_alerts_threshold string RequeridoThe 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: |
tool string RequeridoThe name of a code scanning tool |
Códigos de estado de respuesta HTTP para "Create an organization repository ruleset"
status code | Descripción |
---|---|
201 | Created |
404 | Resource not found |
500 | Internal Error |
Ejemplos de código para "Create an organization repository ruleset"
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
Ejemplo de solicitud
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/orgs/ORG/rulesets \
-d '{"name":"super cool ruleset","target":"branch","enforcement":"active","bypass_actors":[{"actor_id":234,"actor_type":"Team","bypass_mode":"always"}],"conditions":{"ref_name":{"include":["refs/heads/main","refs/heads/master"],"exclude":["refs/heads/dev*"]},"repository_name":{"include":["important_repository","another_important_repository"],"exclude":["unimportant_repository"],"protected":true}},"rules":[{"type":"commit_author_email_pattern","parameters":{"operator":"contains","pattern":"github"}}]}'
Response
Status: 201
{
"id": 21,
"name": "super cool ruleset",
"target": "branch",
"source_type": "Organization",
"source": "my-org",
"enforcement": "active",
"bypass_actors": [
{
"actor_id": 234,
"actor_type": "Team",
"bypass_mode": "always"
}
],
"conditions": {
"ref_name": {
"include": [
"refs/heads/main",
"refs/heads/master"
],
"exclude": [
"refs/heads/dev*"
]
},
"repository_name": {
"include": [
"important_repository",
"another_important_repository"
],
"exclude": [
"unimportant_repository"
],
"protected": true
}
},
"rules": [
{
"type": "commit_author_email_pattern",
"parameters": {
"operator": "contains",
"pattern": "github"
}
}
],
"node_id": "RRS_lACkVXNlcgQB",
"_links": {
"self": {
"href": "https://api.github.com/orgs/my-org/rulesets/21"
},
"html": {
"href": "https://github.com/organizations/my-org/settings/rules/21"
}
},
"created_at": "2023-08-15T08:43:03Z",
"updated_at": "2023-09-23T16:29:47Z"
}
Get an organization repository ruleset
Get a repository ruleset for an organization.
Note: To prevent leaking sensitive information, the bypass_actors
property is only returned if the user
making the API request has write access to the ruleset.
Tokens de acceso específicos para "Get an organization repository ruleset"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Administration" organization permissions (write)
Parámetros para "Get an organization repository ruleset"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
org string RequeridoThe organization name. The name is not case sensitive. |
ruleset_id integer RequeridoThe ID of the ruleset. |
Códigos de estado de respuesta HTTP para "Get an organization repository ruleset"
status code | Descripción |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
Ejemplos de código para "Get an organization repository ruleset"
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
Ejemplo de solicitud
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"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Administration" organization permissions (write)
Parámetros para "Update an organization repository ruleset"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
org string RequeridoThe organization name. The name is not case sensitive. |
ruleset_id integer RequeridoThe ID of the ruleset. |
Nombre, Tipo, Descripción | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name string The name of the ruleset. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target string The target of the ruleset Puede ser uno de los siguientes: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enforcement string The enforcement level of the ruleset. Puede ser uno de los siguientes: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bypass_actors array of objects The actors that can bypass the rules in this ruleset | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties of |
Nombre, Tipo, Descripción |
---|
actor_id integer or null The ID of the actor that can bypass a ruleset. If |
actor_type string RequeridoThe type of actor that can bypass a ruleset Puede ser uno de los siguientes: |
bypass_mode string When the specified actor can bypass the ruleset. Valor predeterminado: Puede ser uno de los siguientes: |
conditions
object Conditions for an organization ruleset.
The branch and tag rulesets conditions object should contain both repository_name
and ref_name
properties, or both repository_id
and ref_name
properties, or both repository_property
and ref_name
properties.
The push rulesets conditions object does not require the ref_name
property.
Can be one of these objects:
Nombre, Tipo, Descripción | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
repository_name_and_ref_name object RequeridoConditions to target repositories by name and refs by name | |||||||||||||||||||||
Properties of |
Nombre, Tipo, Descripción | ||||
---|---|---|---|---|
ref_name object | ||||
Properties of |
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 |
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 RequeridoProperties of repository_name
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 |
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 RequeridoConditions to target repositories by id and refs by name
Properties of repository_id_and_ref_name
Nombre, Tipo, Descripción | |||
---|---|---|---|
ref_name object | |||
Properties of |
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 |
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 RequeridoProperties of repository_id
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 RequeridoConditions to target repositories by property and refs by name
Properties of repository_property_and_ref_name
Nombre, Tipo, Descripción | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ref_name object | |||||||||||||
Properties of |
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 |
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 RequeridoProperties of repository_property
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. | ||||
Properties of |
Nombre, Tipo, Descripción |
---|
name string RequeridoThe name of the repository property to target |
property_values array of strings RequeridoThe 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: |
exclude
array of objects The repository properties and values to exclude. The condition will not pass if any of these properties match.
Properties of exclude
Nombre, Tipo, Descripción |
---|
name string RequeridoThe name of the repository property to target |
property_values array of strings RequeridoThe 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: |
rules
array of objects An array of rules within the ruleset.
Can be one of these objects:
Nombre, Tipo, Descripción | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
creation object RequeridoOnly allow users with bypass permission to create matching refs. | |||||||||||||
Properties of |
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
update
object RequeridoOnly allow users with bypass permission to update matching refs.
Properties of update
Nombre, Tipo, Descripción | ||
---|---|---|
type string RequeridoValor: | ||
parameters object | ||
Properties of |
Nombre, Tipo, Descripción |
---|
update_allows_fetch_and_merge boolean RequeridoBranch can pull changes from its upstream repository |
deletion
object RequeridoOnly allow users with bypass permissions to delete matching refs.
Properties of deletion
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
required_linear_history
object RequeridoPrevent merge commits from being pushed to matching refs.
Properties of required_linear_history
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
merge_queue
object RequeridoMerges must be performed via a merge queue.
Properties of merge_queue
Nombre, Tipo, Descripción | ||||||||
---|---|---|---|---|---|---|---|---|
type string RequeridoValor: | ||||||||
parameters object | ||||||||
Properties of |
Nombre, Tipo, Descripción |
---|
check_response_timeout_minutes integer RequeridoMaximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed |
grouping_strategy string RequeridoWhen set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. Puede ser uno de los siguientes: |
max_entries_to_build integer RequeridoLimit the number of queued pull requests requesting checks and workflow runs at the same time. |
max_entries_to_merge integer RequeridoThe maximum number of PRs that will be merged together in a group. |
merge_method string RequeridoMethod to use when merging changes from queued pull requests. Puede ser uno de los siguientes: |
min_entries_to_merge integer RequeridoThe minimum number of PRs that will be merged together in a group. |
min_entries_to_merge_wait_minutes integer RequeridoThe time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. |
required_deployments
object RequeridoChoose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
Properties of required_deployments
Nombre, Tipo, Descripción | ||
---|---|---|
type string RequeridoValor: | ||
parameters object | ||
Properties of |
Nombre, Tipo, Descripción |
---|
required_deployment_environments array of strings RequeridoThe environments that must be successfully deployed to before branches can be merged. |
required_signatures
object RequeridoCommits pushed to matching refs must have verified signatures.
Properties of required_signatures
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
pull_request
object RequeridoRequire all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Properties of pull_request
Nombre, Tipo, Descripción | ||||||
---|---|---|---|---|---|---|
type string RequeridoValor: | ||||||
parameters object | ||||||
Properties of |
Nombre, Tipo, Descripción |
---|
dismiss_stale_reviews_on_push boolean RequeridoNew, reviewable commits pushed will dismiss previous pull request review approvals. |
require_code_owner_review boolean RequeridoRequire an approving review in pull requests that modify files that have a designated code owner. |
require_last_push_approval boolean RequeridoWhether the most recent reviewable push must be approved by someone other than the person who pushed it. |
required_approving_review_count integer RequeridoThe number of approving reviews that are required before a pull request can be merged. |
required_review_thread_resolution boolean RequeridoAll conversations on code must be resolved before a pull request can be merged. |
required_status_checks
object RequeridoChoose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
Properties of required_status_checks
Nombre, Tipo, Descripción | ||||||||
---|---|---|---|---|---|---|---|---|
type string RequeridoValor: | ||||||||
parameters object | ||||||||
Properties of |
Nombre, Tipo, Descripción | |||
---|---|---|---|
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 RequeridoStatus checks that are required. | |||
Properties of |
Nombre, Tipo, Descripción |
---|
context string RequeridoThe 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 RequeridoWhether 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 RequeridoPrevent users with push access from force pushing to refs.
Properties of non_fast_forward
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
commit_message_pattern
object RequeridoParameters to be used for the commit_message_pattern rule
Properties of commit_message_pattern
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
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 RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
commit_author_email_pattern
object RequeridoParameters to be used for the commit_author_email_pattern rule
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
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 RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
committer_email_pattern
object RequeridoParameters to be used for the committer_email_pattern rule
Properties of committer_email_pattern
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
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 RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
branch_name_pattern
object RequeridoParameters to be used for the branch_name_pattern rule
Properties of branch_name_pattern
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
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 RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
tag_name_pattern
object RequeridoParameters to be used for the tag_name_pattern rule
Properties of tag_name_pattern
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
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 RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
file_path_restriction
object RequeridoPrevent commits that include changes in specified file paths from being pushed to the commit graph.
Properties of file_path_restriction
Nombre, Tipo, Descripción | ||
---|---|---|
type string RequeridoValor: | ||
parameters object | ||
Properties of |
Nombre, Tipo, Descripción |
---|
restricted_file_paths array of strings RequeridoThe file paths that are restricted from being pushed to the commit graph. |
max_file_path_length
object RequeridoPrevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.
Properties of max_file_path_length
Nombre, Tipo, Descripción | ||
---|---|---|
type string RequeridoValor: | ||
parameters object | ||
Properties of |
Nombre, Tipo, Descripción |
---|
max_file_path_length integer RequeridoThe maximum amount of characters allowed in file paths |
file_extension_restriction
object RequeridoPrevent commits that include files with specified file extensions from being pushed to the commit graph.
Properties of file_extension_restriction
Nombre, Tipo, Descripción | ||
---|---|---|
type string RequeridoValor: | ||
parameters object | ||
Properties of |
Nombre, Tipo, Descripción |
---|
restricted_file_extensions array of strings RequeridoThe file extensions that are restricted from being pushed to the commit graph. |
max_file_size
object RequeridoPrevent commits that exceed a specified file size limit from being pushed to the commit.
Properties of max_file_size
Nombre, Tipo, Descripción | ||
---|---|---|
type string RequeridoValor: | ||
parameters object | ||
Properties of |
Nombre, Tipo, Descripción |
---|
max_file_size integer RequeridoThe maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). |
workflows
object RequeridoRequire all changes made to a targeted branch to pass the specified workflows before they can be merged.
Properties of workflows
Nombre, Tipo, Descripción | |||||||||
---|---|---|---|---|---|---|---|---|---|
type string RequeridoValor: | |||||||||
parameters object | |||||||||
Properties of |
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
do_not_enforce_on_create boolean Allow repositories and branches to be created if a check would otherwise prohibit it. | |||||
workflows array of objects RequeridoWorkflows that must pass for this rule to pass. | |||||
Properties of |
Nombre, Tipo, Descripción |
---|
path string RequeridoThe path to the workflow file |
ref string The ref (branch or tag) of the workflow file to use |
repository_id integer RequeridoThe ID of the repository where the workflow is defined |
sha string The commit SHA of the workflow file to use |
code_scanning
object RequeridoChoose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
Properties of code_scanning
Nombre, Tipo, Descripción | |||||||
---|---|---|---|---|---|---|---|
type string RequeridoValor: | |||||||
parameters object | |||||||
Properties of |
Nombre, Tipo, Descripción | ||||
---|---|---|---|---|
code_scanning_tools array of objects RequeridoTools that must provide code scanning results for this rule to pass. | ||||
Properties of |
Nombre, Tipo, Descripción |
---|
alerts_threshold string RequeridoThe 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: |
security_alerts_threshold string RequeridoThe 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: |
tool string RequeridoThe name of a code scanning tool |
Códigos de estado de respuesta HTTP para "Update an organization repository ruleset"
status code | Descripción |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
Ejemplos de código para "Update an organization repository ruleset"
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
Ejemplo de solicitud
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"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Administration" organization permissions (write)
Parámetros para "Delete an organization repository ruleset"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
org string RequeridoThe organization name. The name is not case sensitive. |
ruleset_id integer RequeridoThe ID of the ruleset. |
Códigos de estado de respuesta HTTP para "Delete an organization repository ruleset"
status code | Descripción |
---|---|
204 | No Content |
404 | Resource not found |
500 | Internal Error |
Ejemplos de código para "Delete an organization repository ruleset"
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
Ejemplo de solicitud
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