Points de terminaison d’API REST pour les règles
Utilisez l’API REST pour gérer les ensembles de règles pour une entreprise. Les ensembles de règles contrôlent la façon dont les utilisateurs peuvent interagir avec les référentiels et le code.
Create an enterprise repository ruleset
Create a repository ruleset for an enterprise.
Jetons d’accès affinés pour « Create an enterprise repository ruleset »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis doit avoir l’ensemble d’autorisations suivant:
- "Enterprise administration" business permissions (write)
Paramètres pour « Create an enterprise repository ruleset »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
enterprise string ObligatoireThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nom, Type, Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name string ObligatoireThe name of the ruleset. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target string The target of the ruleset Default: Peut être: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enforcement string ObligatoireThe enforcement level of the ruleset. Peut être: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bypass_actors array of objects The actors that can bypass the rules in this ruleset | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties of |
Nom, Type, Description |
---|
actor_id integer or null The ID of the actor that can bypass a ruleset. If |
actor_type string ObligatoireThe type of actor that can bypass a ruleset Peut être: |
bypass_mode string When the specified actor can bypass the ruleset. Default: Peut être: |
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.
Can be one of these objects:
Nom, Type, Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
organization_name_and_repository_name object ObligatoireConditions to target organizations by name and all repositories | ||||||||||||||||||||||||||
Properties of |
Nom, Type, Description | ||||
---|---|---|---|---|
organization_name object Obligatoire | ||||
Properties of |
Nom, Type, Description |
---|
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 |
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 ObligatoireProperties of repository_name
Nom, Type, Description |
---|
include array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts |
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 Properties of ref_name
Nom, Type, Description |
---|
include array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts |
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 ObligatoireConditions to target organizations by name and repositories by property
Properties of organization_name_and_repository_property
Nom, Type, Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
organization_name object Obligatoire | |||||||||||||
Properties of |
Nom, Type, Description |
---|
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 |
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 ObligatoireProperties of repository_property
Nom, Type, Description | ||||
---|---|---|---|---|
include array of objects The repository properties and values to include. All of these properties must match for the condition to pass. | ||||
Properties of |
Nom, Type, Description |
---|
name string ObligatoireThe name of the repository property to target |
property_values array of strings ObligatoireThe values to match for the repository property |
source string The source of the repository property. Defaults to 'custom' if not specified. Peut être: |
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
Nom, Type, Description |
---|
name string ObligatoireThe name of the repository property to target |
property_values array of strings ObligatoireThe values to match for the repository property |
source string The source of the repository property. Defaults to 'custom' if not specified. Peut être: |
ref_name
object Properties of ref_name
Nom, Type, Description |
---|
include array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts |
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 ObligatoireConditions to target organizations by id and all repositories
Properties of organization_id_and_repository_name
Nom, Type, Description | ||||
---|---|---|---|---|
organization_id object Obligatoire | ||||
Properties of |
Nom, Type, Description |
---|
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 ObligatoireProperties of repository_name
Nom, Type, Description |
---|
include array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts |
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 Properties of ref_name
Nom, Type, Description |
---|
include array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts |
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 ObligatoireConditions to target organization by id and repositories by property
Properties of organization_id_and_repository_property
Nom, Type, Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
organization_id object Obligatoire | |||||||||||||
Properties of |
Nom, Type, Description |
---|
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 ObligatoireProperties of repository_property
Nom, Type, Description | ||||
---|---|---|---|---|
include array of objects The repository properties and values to include. All of these properties must match for the condition to pass. | ||||
Properties of |
Nom, Type, Description |
---|
name string ObligatoireThe name of the repository property to target |
property_values array of strings ObligatoireThe values to match for the repository property |
source string The source of the repository property. Defaults to 'custom' if not specified. Peut être: |
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
Nom, Type, Description |
---|
name string ObligatoireThe name of the repository property to target |
property_values array of strings ObligatoireThe values to match for the repository property |
source string The source of the repository property. Defaults to 'custom' if not specified. Peut être: |
ref_name
object Properties of ref_name
Nom, Type, Description |
---|
include array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts |
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.
Can be one of these objects:
Nom, Type, Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
creation object ObligatoireOnly allow users with bypass permission to create matching refs. | |||||||||||||
Properties of |
Nom, Type, Description |
---|
type string ObligatoireValue: |
update
object ObligatoireOnly allow users with bypass permission to update matching refs.
Properties of update
Nom, Type, Description | ||
---|---|---|
type string ObligatoireValue: | ||
parameters object | ||
Properties of |
Nom, Type, Description |
---|
update_allows_fetch_and_merge boolean ObligatoireBranch can pull changes from its upstream repository |
deletion
object ObligatoireOnly allow users with bypass permissions to delete matching refs.
Properties of deletion
Nom, Type, Description |
---|
type string ObligatoireValue: |
required_linear_history
object ObligatoirePrevent merge commits from being pushed to matching refs.
Properties of required_linear_history
Nom, Type, Description |
---|
type string ObligatoireValue: |
merge_queue
object ObligatoireMerges must be performed via a merge queue.
Properties of merge_queue
Nom, Type, Description | ||||||||
---|---|---|---|---|---|---|---|---|
type string ObligatoireValue: | ||||||||
parameters object | ||||||||
Properties of |
Nom, Type, Description |
---|
check_response_timeout_minutes integer ObligatoireMaximum 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 ObligatoireWhen 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. Peut être: |
max_entries_to_build integer ObligatoireLimit the number of queued pull requests requesting checks and workflow runs at the same time. |
max_entries_to_merge integer ObligatoireThe maximum number of PRs that will be merged together in a group. |
merge_method string ObligatoireMethod to use when merging changes from queued pull requests. Peut être: |
min_entries_to_merge integer ObligatoireThe minimum number of PRs that will be merged together in a group. |
min_entries_to_merge_wait_minutes integer ObligatoireThe 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 ObligatoireChoose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
Properties of required_deployments
Nom, Type, Description | ||
---|---|---|
type string ObligatoireValue: | ||
parameters object | ||
Properties of |
Nom, Type, Description |
---|
required_deployment_environments array of strings ObligatoireThe environments that must be successfully deployed to before branches can be merged. |
required_signatures
object ObligatoireCommits pushed to matching refs must have verified signatures.
Properties of required_signatures
Nom, Type, Description |
---|
type string ObligatoireValue: |
pull_request
object ObligatoireRequire all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Properties of pull_request
Nom, Type, Description | |||||||
---|---|---|---|---|---|---|---|
type string ObligatoireValue: | |||||||
parameters object | |||||||
Properties of |
Nom, Type, Description |
---|
allowed_merge_methods array of strings When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. |
dismiss_stale_reviews_on_push boolean ObligatoireNew, reviewable commits pushed will dismiss previous pull request review approvals. |
require_code_owner_review boolean ObligatoireRequire an approving review in pull requests that modify files that have a designated code owner. |
require_last_push_approval boolean ObligatoireWhether the most recent reviewable push must be approved by someone other than the person who pushed it. |
required_approving_review_count integer ObligatoireThe number of approving reviews that are required before a pull request can be merged. |
required_review_thread_resolution boolean ObligatoireAll conversations on code must be resolved before a pull request can be merged. |
required_status_checks
object ObligatoireChoose 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
Nom, Type, Description | ||||||||
---|---|---|---|---|---|---|---|---|
type string ObligatoireValue: | ||||||||
parameters object | ||||||||
Properties of |
Nom, Type, Description | |||
---|---|---|---|
do_not_enforce_on_create boolean Allow repositories and branches to be created if a check would otherwise prohibit it. | |||
required_status_checks array of objects ObligatoireStatus checks that are required. | |||
Properties of |
Nom, Type, Description |
---|
context string ObligatoireThe 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 ObligatoireWhether 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 ObligatoirePrevent users with push access from force pushing to refs.
Properties of non_fast_forward
Nom, Type, Description |
---|
type string ObligatoireValue: |
commit_message_pattern
object ObligatoireParameters to be used for the commit_message_pattern rule
Properties of commit_message_pattern
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
commit_author_email_pattern
object ObligatoireParameters to be used for the commit_author_email_pattern rule
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
committer_email_pattern
object ObligatoireParameters to be used for the committer_email_pattern rule
Properties of committer_email_pattern
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
branch_name_pattern
object ObligatoireParameters to be used for the branch_name_pattern rule
Properties of branch_name_pattern
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
tag_name_pattern
object ObligatoireParameters to be used for the tag_name_pattern rule
Properties of tag_name_pattern
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
file_path_restriction
object ObligatoirePrevent commits that include changes in specified file paths from being pushed to the commit graph.
Properties of file_path_restriction
Nom, Type, Description | ||
---|---|---|
type string ObligatoireValue: | ||
parameters object | ||
Properties of |
Nom, Type, Description |
---|
restricted_file_paths array of strings ObligatoireThe file paths that are restricted from being pushed to the commit graph. |
max_file_path_length
object ObligatoirePrevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.
Properties of max_file_path_length
Nom, Type, Description | ||
---|---|---|
type string ObligatoireValue: | ||
parameters object | ||
Properties of |
Nom, Type, Description |
---|
max_file_path_length integer ObligatoireThe maximum amount of characters allowed in file paths |
file_extension_restriction
object ObligatoirePrevent commits that include files with specified file extensions from being pushed to the commit graph.
Properties of file_extension_restriction
Nom, Type, Description | ||
---|---|---|
type string ObligatoireValue: | ||
parameters object | ||
Properties of |
Nom, Type, Description |
---|
restricted_file_extensions array of strings ObligatoireThe file extensions that are restricted from being pushed to the commit graph. |
max_file_size
object ObligatoirePrevent commits that exceed a specified file size limit from being pushed to the commit.
Properties of max_file_size
Nom, Type, Description | ||
---|---|---|
type string ObligatoireValue: | ||
parameters object | ||
Properties of |
Nom, Type, Description |
---|
max_file_size integer ObligatoireThe maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). |
workflows
object ObligatoireRequire all changes made to a targeted branch to pass the specified workflows before they can be merged.
Properties of workflows
Nom, Type, Description | |||||||||
---|---|---|---|---|---|---|---|---|---|
type string ObligatoireValue: | |||||||||
parameters object | |||||||||
Properties of |
Nom, Type, Description | |||||
---|---|---|---|---|---|
do_not_enforce_on_create boolean Allow repositories and branches to be created if a check would otherwise prohibit it. | |||||
workflows array of objects ObligatoireWorkflows that must pass for this rule to pass. | |||||
Properties of |
Nom, Type, Description |
---|
path string ObligatoireThe path to the workflow file |
ref string The ref (branch or tag) of the workflow file to use |
repository_id integer ObligatoireThe ID of the repository where the workflow is defined |
sha string The commit SHA of the workflow file to use |
code_scanning
object ObligatoireChoose 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
Nom, Type, Description | |||||||
---|---|---|---|---|---|---|---|
type string ObligatoireValue: | |||||||
parameters object | |||||||
Properties of |
Nom, Type, Description | ||||
---|---|---|---|---|
code_scanning_tools array of objects ObligatoireTools that must provide code scanning results for this rule to pass. | ||||
Properties of |
Nom, Type, Description |
---|
alerts_threshold string ObligatoireThe 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." Peut être: |
security_alerts_threshold string ObligatoireThe 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." Peut être: |
tool string ObligatoireThe name of a code scanning tool |
Codes d’état de la réponse HTTP pour « Create an enterprise repository ruleset »
Code d’état | Description |
---|---|
201 | Created |
404 | Resource not found |
500 | Internal Error |
Exemples de code pour « Create an enterprise repository ruleset »
Si vous accédez à GitHub à GHE.com, remplacez api.github.com
par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com
.
Exemple de requête
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.
Jetons d’accès affinés pour « Get an enterprise repository ruleset »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis doit avoir l’ensemble d’autorisations suivant:
- "Enterprise administration" business permissions (write)
Paramètres pour « Get an enterprise repository ruleset »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
enterprise string ObligatoireThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
ruleset_id integer ObligatoireThe ID of the ruleset. |
Codes d’état de la réponse HTTP pour « Get an enterprise repository ruleset »
Code d’état | Description |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
Exemples de code pour « Get an enterprise repository ruleset »
Si vous accédez à GitHub à GHE.com, remplacez api.github.com
par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com
.
Exemple de requête
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.
Jetons d’accès affinés pour « Update an enterprise repository ruleset »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis doit avoir l’ensemble d’autorisations suivant:
- "Enterprise administration" business permissions (write)
Paramètres pour « Update an enterprise repository ruleset »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
enterprise string ObligatoireThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
ruleset_id integer ObligatoireThe ID of the ruleset. |
Nom, Type, Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name string The name of the ruleset. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target string The target of the ruleset Peut être: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enforcement string The enforcement level of the ruleset. Peut être: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bypass_actors array of objects The actors that can bypass the rules in this ruleset | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties of |
Nom, Type, Description |
---|
actor_id integer or null The ID of the actor that can bypass a ruleset. If |
actor_type string ObligatoireThe type of actor that can bypass a ruleset Peut être: |
bypass_mode string When the specified actor can bypass the ruleset. Default: Peut être: |
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.
Can be one of these objects:
Nom, Type, Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
organization_name_and_repository_name object ObligatoireConditions to target organizations by name and all repositories | ||||||||||||||||||||||||||
Properties of |
Nom, Type, Description | ||||
---|---|---|---|---|
organization_name object Obligatoire | ||||
Properties of |
Nom, Type, Description |
---|
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 |
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 ObligatoireProperties of repository_name
Nom, Type, Description |
---|
include array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts |
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 Properties of ref_name
Nom, Type, Description |
---|
include array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts |
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 ObligatoireConditions to target organizations by name and repositories by property
Properties of organization_name_and_repository_property
Nom, Type, Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
organization_name object Obligatoire | |||||||||||||
Properties of |
Nom, Type, Description |
---|
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 |
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 ObligatoireProperties of repository_property
Nom, Type, Description | ||||
---|---|---|---|---|
include array of objects The repository properties and values to include. All of these properties must match for the condition to pass. | ||||
Properties of |
Nom, Type, Description |
---|
name string ObligatoireThe name of the repository property to target |
property_values array of strings ObligatoireThe values to match for the repository property |
source string The source of the repository property. Defaults to 'custom' if not specified. Peut être: |
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
Nom, Type, Description |
---|
name string ObligatoireThe name of the repository property to target |
property_values array of strings ObligatoireThe values to match for the repository property |
source string The source of the repository property. Defaults to 'custom' if not specified. Peut être: |
ref_name
object Properties of ref_name
Nom, Type, Description |
---|
include array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts |
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 ObligatoireConditions to target organizations by id and all repositories
Properties of organization_id_and_repository_name
Nom, Type, Description | ||||
---|---|---|---|---|
organization_id object Obligatoire | ||||
Properties of |
Nom, Type, Description |
---|
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 ObligatoireProperties of repository_name
Nom, Type, Description |
---|
include array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts |
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 Properties of ref_name
Nom, Type, Description |
---|
include array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts |
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 ObligatoireConditions to target organization by id and repositories by property
Properties of organization_id_and_repository_property
Nom, Type, Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
organization_id object Obligatoire | |||||||||||||
Properties of |
Nom, Type, Description |
---|
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 ObligatoireProperties of repository_property
Nom, Type, Description | ||||
---|---|---|---|---|
include array of objects The repository properties and values to include. All of these properties must match for the condition to pass. | ||||
Properties of |
Nom, Type, Description |
---|
name string ObligatoireThe name of the repository property to target |
property_values array of strings ObligatoireThe values to match for the repository property |
source string The source of the repository property. Defaults to 'custom' if not specified. Peut être: |
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
Nom, Type, Description |
---|
name string ObligatoireThe name of the repository property to target |
property_values array of strings ObligatoireThe values to match for the repository property |
source string The source of the repository property. Defaults to 'custom' if not specified. Peut être: |
ref_name
object Properties of ref_name
Nom, Type, Description |
---|
include array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts |
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.
Can be one of these objects:
Nom, Type, Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
creation object ObligatoireOnly allow users with bypass permission to create matching refs. | |||||||||||||
Properties of |
Nom, Type, Description |
---|
type string ObligatoireValue: |
update
object ObligatoireOnly allow users with bypass permission to update matching refs.
Properties of update
Nom, Type, Description | ||
---|---|---|
type string ObligatoireValue: | ||
parameters object | ||
Properties of |
Nom, Type, Description |
---|
update_allows_fetch_and_merge boolean ObligatoireBranch can pull changes from its upstream repository |
deletion
object ObligatoireOnly allow users with bypass permissions to delete matching refs.
Properties of deletion
Nom, Type, Description |
---|
type string ObligatoireValue: |
required_linear_history
object ObligatoirePrevent merge commits from being pushed to matching refs.
Properties of required_linear_history
Nom, Type, Description |
---|
type string ObligatoireValue: |
merge_queue
object ObligatoireMerges must be performed via a merge queue.
Properties of merge_queue
Nom, Type, Description | ||||||||
---|---|---|---|---|---|---|---|---|
type string ObligatoireValue: | ||||||||
parameters object | ||||||||
Properties of |
Nom, Type, Description |
---|
check_response_timeout_minutes integer ObligatoireMaximum 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 ObligatoireWhen 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. Peut être: |
max_entries_to_build integer ObligatoireLimit the number of queued pull requests requesting checks and workflow runs at the same time. |
max_entries_to_merge integer ObligatoireThe maximum number of PRs that will be merged together in a group. |
merge_method string ObligatoireMethod to use when merging changes from queued pull requests. Peut être: |
min_entries_to_merge integer ObligatoireThe minimum number of PRs that will be merged together in a group. |
min_entries_to_merge_wait_minutes integer ObligatoireThe 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 ObligatoireChoose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
Properties of required_deployments
Nom, Type, Description | ||
---|---|---|
type string ObligatoireValue: | ||
parameters object | ||
Properties of |
Nom, Type, Description |
---|
required_deployment_environments array of strings ObligatoireThe environments that must be successfully deployed to before branches can be merged. |
required_signatures
object ObligatoireCommits pushed to matching refs must have verified signatures.
Properties of required_signatures
Nom, Type, Description |
---|
type string ObligatoireValue: |
pull_request
object ObligatoireRequire all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Properties of pull_request
Nom, Type, Description | |||||||
---|---|---|---|---|---|---|---|
type string ObligatoireValue: | |||||||
parameters object | |||||||
Properties of |
Nom, Type, Description |
---|
allowed_merge_methods array of strings When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. |
dismiss_stale_reviews_on_push boolean ObligatoireNew, reviewable commits pushed will dismiss previous pull request review approvals. |
require_code_owner_review boolean ObligatoireRequire an approving review in pull requests that modify files that have a designated code owner. |
require_last_push_approval boolean ObligatoireWhether the most recent reviewable push must be approved by someone other than the person who pushed it. |
required_approving_review_count integer ObligatoireThe number of approving reviews that are required before a pull request can be merged. |
required_review_thread_resolution boolean ObligatoireAll conversations on code must be resolved before a pull request can be merged. |
required_status_checks
object ObligatoireChoose 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
Nom, Type, Description | ||||||||
---|---|---|---|---|---|---|---|---|
type string ObligatoireValue: | ||||||||
parameters object | ||||||||
Properties of |
Nom, Type, Description | |||
---|---|---|---|
do_not_enforce_on_create boolean Allow repositories and branches to be created if a check would otherwise prohibit it. | |||
required_status_checks array of objects ObligatoireStatus checks that are required. | |||
Properties of |
Nom, Type, Description |
---|
context string ObligatoireThe 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 ObligatoireWhether 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 ObligatoirePrevent users with push access from force pushing to refs.
Properties of non_fast_forward
Nom, Type, Description |
---|
type string ObligatoireValue: |
commit_message_pattern
object ObligatoireParameters to be used for the commit_message_pattern rule
Properties of commit_message_pattern
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
commit_author_email_pattern
object ObligatoireParameters to be used for the commit_author_email_pattern rule
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
committer_email_pattern
object ObligatoireParameters to be used for the committer_email_pattern rule
Properties of committer_email_pattern
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
branch_name_pattern
object ObligatoireParameters to be used for the branch_name_pattern rule
Properties of branch_name_pattern
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
tag_name_pattern
object ObligatoireParameters to be used for the tag_name_pattern rule
Properties of tag_name_pattern
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
file_path_restriction
object ObligatoirePrevent commits that include changes in specified file paths from being pushed to the commit graph.
Properties of file_path_restriction
Nom, Type, Description | ||
---|---|---|
type string ObligatoireValue: | ||
parameters object | ||
Properties of |
Nom, Type, Description |
---|
restricted_file_paths array of strings ObligatoireThe file paths that are restricted from being pushed to the commit graph. |
max_file_path_length
object ObligatoirePrevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.
Properties of max_file_path_length
Nom, Type, Description | ||
---|---|---|
type string ObligatoireValue: | ||
parameters object | ||
Properties of |
Nom, Type, Description |
---|
max_file_path_length integer ObligatoireThe maximum amount of characters allowed in file paths |
file_extension_restriction
object ObligatoirePrevent commits that include files with specified file extensions from being pushed to the commit graph.
Properties of file_extension_restriction
Nom, Type, Description | ||
---|---|---|
type string ObligatoireValue: | ||
parameters object | ||
Properties of |
Nom, Type, Description |
---|
restricted_file_extensions array of strings ObligatoireThe file extensions that are restricted from being pushed to the commit graph. |
max_file_size
object ObligatoirePrevent commits that exceed a specified file size limit from being pushed to the commit.
Properties of max_file_size
Nom, Type, Description | ||
---|---|---|
type string ObligatoireValue: | ||
parameters object | ||
Properties of |
Nom, Type, Description |
---|
max_file_size integer ObligatoireThe maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). |
workflows
object ObligatoireRequire all changes made to a targeted branch to pass the specified workflows before they can be merged.
Properties of workflows
Nom, Type, Description | |||||||||
---|---|---|---|---|---|---|---|---|---|
type string ObligatoireValue: | |||||||||
parameters object | |||||||||
Properties of |
Nom, Type, Description | |||||
---|---|---|---|---|---|
do_not_enforce_on_create boolean Allow repositories and branches to be created if a check would otherwise prohibit it. | |||||
workflows array of objects ObligatoireWorkflows that must pass for this rule to pass. | |||||
Properties of |
Nom, Type, Description |
---|
path string ObligatoireThe path to the workflow file |
ref string The ref (branch or tag) of the workflow file to use |
repository_id integer ObligatoireThe ID of the repository where the workflow is defined |
sha string The commit SHA of the workflow file to use |
code_scanning
object ObligatoireChoose 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
Nom, Type, Description | |||||||
---|---|---|---|---|---|---|---|
type string ObligatoireValue: | |||||||
parameters object | |||||||
Properties of |
Nom, Type, Description | ||||
---|---|---|---|---|
code_scanning_tools array of objects ObligatoireTools that must provide code scanning results for this rule to pass. | ||||
Properties of |
Nom, Type, Description |
---|
alerts_threshold string ObligatoireThe 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." Peut être: |
security_alerts_threshold string ObligatoireThe 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." Peut être: |
tool string ObligatoireThe name of a code scanning tool |
Codes d’état de la réponse HTTP pour « Update an enterprise repository ruleset »
Code d’état | Description |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
Exemples de code pour « Update an enterprise repository ruleset »
Si vous accédez à GitHub à GHE.com, remplacez api.github.com
par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com
.
Exemple de requête
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.
Jetons d’accès affinés pour « Delete an enterprise repository ruleset »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis doit avoir l’ensemble d’autorisations suivant:
- "Enterprise administration" business permissions (write)
Paramètres pour « Delete an enterprise repository ruleset »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
enterprise string ObligatoireThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
ruleset_id integer ObligatoireThe ID of the ruleset. |
Codes d’état de la réponse HTTP pour « Delete an enterprise repository ruleset »
Code d’état | Description |
---|---|
204 | No Content |
404 | Resource not found |
500 | Internal Error |
Exemples de code pour « Delete an enterprise repository ruleset »
Si vous accédez à GitHub à GHE.com, remplacez api.github.com
par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com
.
Exemple de requête
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