Skip to main content
Die REST-API verfügt jetzt über eine Versionskontrolle. Weitere Informationen findest du unter Informationen zur API-Versionsverwaltung.

Regeln

Verwenden Sie die REST-API, um Regelsätze für Organisationen zu verwalten. Organisationsregelsätze steuern, wie Benutzer*innen mit ausgewählten Branches und Tags in den Repositorys einer Organisation interagieren können.

Get all organization repository rulesets

Get all the repository rulesets for an organization.

Differenzierte Zugriffstoken für "Get all organization repository rulesets"

Dieser Endpunkt funktioniert mit den folgenden Tokentypen.:

Das Token muss einen der folgenden Berechtigungssätze aufweisen.:

  • organization_administration:write

Parameter für „Get all organization repository rulesets“

Header
Name, type, BESCHREIBUNG
accept string

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

Pfadparameter
Name, type, BESCHREIBUNG
org string Erforderlich

The organization name. The name is not case sensitive.

Abfrageparameter
Name, type, BESCHREIBUNG
per_page integer

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

Standard: 30

page integer

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

Standard: 1

HTTP-Antwortstatuscodes für „Get all organization repository rulesets“

StatuscodeBESCHREIBUNG
200

OK

404

Resource not found

500

Internal Error

Codebeispiele für „Get all organization repository rulesets“

Beispiel für eine Anfrage

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

Response

Status: 200
[ { "id": 21, "name": "super cool ruleset", "source_type": "Organization", "source": "my-org", "enforcement": "enabled", "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://api.github.com/orgs/my-org/rulesets/21" }, "html": { "href": "https://github.com/organizations/my-org/settings/rules/21" } }, "created_at": "2023-07-15T08:43:03Z", "updated_at": "2023-08-23T16:29:47Z" }, { "id": 432, "name": "Another ruleset", "source_type": "Organization", "source": "my-org", "enforcement": "enabled", "node_id": "RRS_lACkVXNlcgQQ", "_links": { "self": { "href": "https://api.github.com/orgs/my-org/rulesets/432" }, "html": { "href": "https://github.com/organizations/my-org/settings/rules/432" } }, "created_at": "2023-08-15T08:43:03Z", "updated_at": "2023-09-23T16:29:47Z" } ]

Create an organization repository ruleset

Create a repository ruleset for an organization.

Differenzierte Zugriffstoken für "Create an organization repository ruleset"

Dieser Endpunkt funktioniert mit den folgenden Tokentypen.:

Das Token muss einen der folgenden Berechtigungssätze aufweisen.:

  • organization_administration:write

Parameter für „Create an organization repository ruleset“

Header
Name, type, BESCHREIBUNG
accept string

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

Pfadparameter
Name, type, BESCHREIBUNG
org string Erforderlich

The organization name. The name is not case sensitive.

Textparameter
Name, type, BESCHREIBUNG
name string Erforderlich

The name of the ruleset.

target string

The target of the ruleset.

Kann eine der Folgenden sein: branch, tag

enforcement string Erforderlich

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

Kann eine der Folgenden sein: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Name, type, BESCHREIBUNG
actor_id integer Erforderlich

The ID of the actor that can bypass a ruleset. If actor_type is OrganizationAdmin, this should be 1.

actor_type string Erforderlich

The type of actor that can bypass a ruleset

Kann eine der Folgenden sein: RepositoryRole, Team, Integration, OrganizationAdmin

bypass_mode string Erforderlich

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests.

Kann eine der Folgenden sein: always, pull_request

conditions object

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

Name, type, BESCHREIBUNG
repository_name_and_ref_name object Erforderlich

Conditions to target repositories by name and refs by name

Name, type, BESCHREIBUNG
ref_name object
Name, type, BESCHREIBUNG
include array of strings

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

exclude array of strings

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

repository_name object Erforderlich
Name, type, BESCHREIBUNG
include array of strings

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

exclude array of strings

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

protected boolean

Whether renaming of target repositories is prevented.

repository_id_and_ref_name object Erforderlich

Conditions to target repositories by id and refs by name

Name, type, BESCHREIBUNG
ref_name object
Name, type, BESCHREIBUNG
include array of strings

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

exclude array of strings

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

repository_id object Erforderlich
Name, type, BESCHREIBUNG
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 Erforderlich

Conditions to target repositories by property and refs by name

Name, type, BESCHREIBUNG
ref_name object
Name, type, BESCHREIBUNG
include array of strings

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

exclude array of strings

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

repository_property object Erforderlich
Name, type, BESCHREIBUNG
include array of objects

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

Name, type, BESCHREIBUNG
name string Erforderlich

The name of the repository property to target

property_values array of strings Erforderlich

The values to match for the repository property

exclude array of objects

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

Name, type, BESCHREIBUNG
name string Erforderlich

The name of the repository property to target

property_values array of strings Erforderlich

The values to match for the repository property

rules array of objects

An array of rules within the ruleset.

Name, type, BESCHREIBUNG
creation object Erforderlich

Only allow users with bypass permission to create matching refs.

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: creation

update object Erforderlich

Only allow users with bypass permission to update matching refs.

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: update

parameters object
Name, type, BESCHREIBUNG
update_allows_fetch_and_merge boolean Erforderlich

Branch can pull changes from its upstream repository

deletion object Erforderlich

Only allow users with bypass permissions to delete matching refs.

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: deletion

required_linear_history object Erforderlich

Prevent merge commits from being pushed to matching refs.

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: required_linear_history

required_deployments object Erforderlich

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

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: required_deployments

parameters object
Name, type, BESCHREIBUNG
required_deployment_environments array of strings Erforderlich

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

required_signatures object Erforderlich

Commits pushed to matching refs must have verified signatures.

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: required_signatures

pull_request object Erforderlich

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

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: pull_request

parameters object
Name, type, BESCHREIBUNG
dismiss_stale_reviews_on_push boolean Erforderlich

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

require_code_owner_review boolean Erforderlich

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

require_last_push_approval boolean Erforderlich

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

required_approving_review_count integer Erforderlich

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

required_review_thread_resolution boolean Erforderlich

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

required_status_checks object Erforderlich

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

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: required_status_checks

parameters object
Name, type, BESCHREIBUNG
required_status_checks array of objects Erforderlich

Status checks that are required.

Name, type, BESCHREIBUNG
context string Erforderlich

The status check context name that must be present on the commit.

integration_id integer

The optional integration ID that this status check must originate from.

strict_required_status_checks_policy boolean Erforderlich

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

non_fast_forward object Erforderlich

Prevent users with push access from force pushing to refs.

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: non_fast_forward

commit_message_pattern object Erforderlich

Parameters to be used for the commit_message_pattern rule

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: commit_message_pattern

parameters object
Name, type, BESCHREIBUNG
name string

How this rule will appear to users.

negate boolean

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

operator string Erforderlich

The operator to use for matching.

Kann eine der Folgenden sein: starts_with, ends_with, contains, regex

pattern string Erforderlich

The pattern to match with.

commit_author_email_pattern object Erforderlich

Parameters to be used for the commit_author_email_pattern rule

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: commit_author_email_pattern

parameters object
Name, type, BESCHREIBUNG
name string

How this rule will appear to users.

negate boolean

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

operator string Erforderlich

The operator to use for matching.

Kann eine der Folgenden sein: starts_with, ends_with, contains, regex

pattern string Erforderlich

The pattern to match with.

committer_email_pattern object Erforderlich

Parameters to be used for the committer_email_pattern rule

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: committer_email_pattern

parameters object
Name, type, BESCHREIBUNG
name string

How this rule will appear to users.

negate boolean

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

operator string Erforderlich

The operator to use for matching.

Kann eine der Folgenden sein: starts_with, ends_with, contains, regex

pattern string Erforderlich

The pattern to match with.

branch_name_pattern object Erforderlich

Parameters to be used for the branch_name_pattern rule

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: branch_name_pattern

parameters object
Name, type, BESCHREIBUNG
name string

How this rule will appear to users.

negate boolean

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

operator string Erforderlich

The operator to use for matching.

Kann eine der Folgenden sein: starts_with, ends_with, contains, regex

pattern string Erforderlich

The pattern to match with.

tag_name_pattern object Erforderlich

Parameters to be used for the tag_name_pattern rule

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: tag_name_pattern

parameters object
Name, type, BESCHREIBUNG
name string

How this rule will appear to users.

negate boolean

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

operator string Erforderlich

The operator to use for matching.

Kann eine der Folgenden sein: starts_with, ends_with, contains, regex

pattern string Erforderlich

The pattern to match with.

workflows object Erforderlich

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

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: workflows

parameters object
Name, type, BESCHREIBUNG
workflows array of objects Erforderlich

Workflows that must pass for this rule to pass.

Name, type, BESCHREIBUNG
path string Erforderlich

The path to the workflow file

ref string

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

repository_id integer Erforderlich

The ID of the repository where the workflow is defined

sha string

The commit SHA of the workflow file to use

HTTP-Antwortstatuscodes für „Create an organization repository ruleset“

StatuscodeBESCHREIBUNG
201

Created

404

Resource not found

500

Internal Error

Codebeispiele für „Create an organization repository ruleset“

Beispiel für eine Anfrage

post/orgs/{org}/rulesets
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/rulesets \ -d '{"name":"super cool ruleset","target":"branch","enforcement":"active","bypass_actors":[{"actor_id":234,"actor_type":"Team","bypass_mode":"always"}],"conditions":{"ref_name":{"include":["refs/heads/main","refs/heads/master"],"exclude":["refs/heads/dev*"]},"repository_name":{"include":["important_repository","another_important_repository"],"exclude":["unimportant_repository"],"protected":true}},"rules":[{"type":"commit_author_email_pattern","parameters":{"operator":"contains","pattern":"github"}}]}'

Response

Status: 201
{ "id": 21, "name": "super cool ruleset", "target": "branch", "source_type": "Organization", "source": "my-org", "enforcement": "active", "bypass_actors": [ { "actor_id": 234, "actor_type": "Team", "bypass_mode": "always" } ], "conditions": { "ref_name": { "include": [ "refs/heads/main", "refs/heads/master" ], "exclude": [ "refs/heads/dev*" ] }, "repository_name": { "include": [ "important_repository", "another_important_repository" ], "exclude": [ "unimportant_repository" ], "protected": true } }, "rules": [ { "type": "commit_author_email_pattern", "parameters": { "operator": "contains", "pattern": "github" } } ], "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://api.github.com/orgs/my-org/rulesets/21" }, "html": { "href": "https://github.com/organizations/my-org/settings/rules/21" } }, "created_at": "2023-08-15T08:43:03Z", "updated_at": "2023-09-23T16:29:47Z" }

Get an organization repository ruleset

Get a repository ruleset for an organization.

Differenzierte Zugriffstoken für "Get an organization repository ruleset"

Dieser Endpunkt funktioniert mit den folgenden Tokentypen.:

Das Token muss einen der folgenden Berechtigungssätze aufweisen.:

  • organization_administration:write

Parameter für „Get an organization repository ruleset“

Header
Name, type, BESCHREIBUNG
accept string

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

Pfadparameter
Name, type, BESCHREIBUNG
org string Erforderlich

The organization name. The name is not case sensitive.

ruleset_id integer Erforderlich

The ID of the ruleset.

HTTP-Antwortstatuscodes für „Get an organization repository ruleset“

StatuscodeBESCHREIBUNG
200

OK

404

Resource not found

500

Internal Error

Codebeispiele für „Get an organization repository ruleset“

Beispiel für eine Anfrage

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

Response

Status: 200
{ "id": 21, "name": "super cool ruleset", "target": "branch", "source_type": "Organization", "source": "my-org", "enforcement": "active", "bypass_actors": [ { "actor_id": 234, "actor_type": "Team", "bypass_mode": "always" } ], "conditions": { "ref_name": { "include": [ "refs/heads/main", "refs/heads/master" ], "exclude": [ "refs/heads/dev*" ] }, "repository_name": { "include": [ "important_repository", "another_important_repository" ], "exclude": [ "unimportant_repository" ], "protected": true } }, "rules": [ { "type": "commit_author_email_pattern", "parameters": { "operator": "contains", "pattern": "github" } } ], "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://api.github.com/orgs/my-org/rulesets/21" }, "html": { "href": "https://github.com/organizations/my-org/settings/rules/21" } }, "created_at": "2023-08-15T08:43:03Z", "updated_at": "2023-09-23T16:29:47Z" }

Update an organization repository ruleset

Update a ruleset for an organization.

Differenzierte Zugriffstoken für "Update an organization repository ruleset"

Dieser Endpunkt funktioniert mit den folgenden Tokentypen.:

Das Token muss einen der folgenden Berechtigungssätze aufweisen.:

  • organization_administration:write

Parameter für „Update an organization repository ruleset“

Header
Name, type, BESCHREIBUNG
accept string

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

Pfadparameter
Name, type, BESCHREIBUNG
org string Erforderlich

The organization name. The name is not case sensitive.

ruleset_id integer Erforderlich

The ID of the ruleset.

Textparameter
Name, type, BESCHREIBUNG
name string

The name of the ruleset.

target string

The target of the ruleset.

Kann eine der Folgenden sein: branch, tag

enforcement string

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

Kann eine der Folgenden sein: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Name, type, BESCHREIBUNG
actor_id integer Erforderlich

The ID of the actor that can bypass a ruleset. If actor_type is OrganizationAdmin, this should be 1.

actor_type string Erforderlich

The type of actor that can bypass a ruleset

Kann eine der Folgenden sein: RepositoryRole, Team, Integration, OrganizationAdmin

bypass_mode string Erforderlich

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests.

Kann eine der Folgenden sein: always, pull_request

conditions object

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

Name, type, BESCHREIBUNG
repository_name_and_ref_name object Erforderlich

Conditions to target repositories by name and refs by name

Name, type, BESCHREIBUNG
ref_name object
Name, type, BESCHREIBUNG
include array of strings

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

exclude array of strings

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

repository_name object Erforderlich
Name, type, BESCHREIBUNG
include array of strings

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

exclude array of strings

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

protected boolean

Whether renaming of target repositories is prevented.

repository_id_and_ref_name object Erforderlich

Conditions to target repositories by id and refs by name

Name, type, BESCHREIBUNG
ref_name object
Name, type, BESCHREIBUNG
include array of strings

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

exclude array of strings

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

repository_id object Erforderlich
Name, type, BESCHREIBUNG
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 Erforderlich

Conditions to target repositories by property and refs by name

Name, type, BESCHREIBUNG
ref_name object
Name, type, BESCHREIBUNG
include array of strings

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

exclude array of strings

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

repository_property object Erforderlich
Name, type, BESCHREIBUNG
include array of objects

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

Name, type, BESCHREIBUNG
name string Erforderlich

The name of the repository property to target

property_values array of strings Erforderlich

The values to match for the repository property

exclude array of objects

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

Name, type, BESCHREIBUNG
name string Erforderlich

The name of the repository property to target

property_values array of strings Erforderlich

The values to match for the repository property

rules array of objects

An array of rules within the ruleset.

Name, type, BESCHREIBUNG
creation object Erforderlich

Only allow users with bypass permission to create matching refs.

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: creation

update object Erforderlich

Only allow users with bypass permission to update matching refs.

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: update

parameters object
Name, type, BESCHREIBUNG
update_allows_fetch_and_merge boolean Erforderlich

Branch can pull changes from its upstream repository

deletion object Erforderlich

Only allow users with bypass permissions to delete matching refs.

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: deletion

required_linear_history object Erforderlich

Prevent merge commits from being pushed to matching refs.

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: required_linear_history

required_deployments object Erforderlich

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

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: required_deployments

parameters object
Name, type, BESCHREIBUNG
required_deployment_environments array of strings Erforderlich

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

required_signatures object Erforderlich

Commits pushed to matching refs must have verified signatures.

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: required_signatures

pull_request object Erforderlich

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

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: pull_request

parameters object
Name, type, BESCHREIBUNG
dismiss_stale_reviews_on_push boolean Erforderlich

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

require_code_owner_review boolean Erforderlich

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

require_last_push_approval boolean Erforderlich

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

required_approving_review_count integer Erforderlich

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

required_review_thread_resolution boolean Erforderlich

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

required_status_checks object Erforderlich

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

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: required_status_checks

parameters object
Name, type, BESCHREIBUNG
required_status_checks array of objects Erforderlich

Status checks that are required.

Name, type, BESCHREIBUNG
context string Erforderlich

The status check context name that must be present on the commit.

integration_id integer

The optional integration ID that this status check must originate from.

strict_required_status_checks_policy boolean Erforderlich

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

non_fast_forward object Erforderlich

Prevent users with push access from force pushing to refs.

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: non_fast_forward

commit_message_pattern object Erforderlich

Parameters to be used for the commit_message_pattern rule

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: commit_message_pattern

parameters object
Name, type, BESCHREIBUNG
name string

How this rule will appear to users.

negate boolean

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

operator string Erforderlich

The operator to use for matching.

Kann eine der Folgenden sein: starts_with, ends_with, contains, regex

pattern string Erforderlich

The pattern to match with.

commit_author_email_pattern object Erforderlich

Parameters to be used for the commit_author_email_pattern rule

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: commit_author_email_pattern

parameters object
Name, type, BESCHREIBUNG
name string

How this rule will appear to users.

negate boolean

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

operator string Erforderlich

The operator to use for matching.

Kann eine der Folgenden sein: starts_with, ends_with, contains, regex

pattern string Erforderlich

The pattern to match with.

committer_email_pattern object Erforderlich

Parameters to be used for the committer_email_pattern rule

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: committer_email_pattern

parameters object
Name, type, BESCHREIBUNG
name string

How this rule will appear to users.

negate boolean

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

operator string Erforderlich

The operator to use for matching.

Kann eine der Folgenden sein: starts_with, ends_with, contains, regex

pattern string Erforderlich

The pattern to match with.

branch_name_pattern object Erforderlich

Parameters to be used for the branch_name_pattern rule

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: branch_name_pattern

parameters object
Name, type, BESCHREIBUNG
name string

How this rule will appear to users.

negate boolean

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

operator string Erforderlich

The operator to use for matching.

Kann eine der Folgenden sein: starts_with, ends_with, contains, regex

pattern string Erforderlich

The pattern to match with.

tag_name_pattern object Erforderlich

Parameters to be used for the tag_name_pattern rule

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: tag_name_pattern

parameters object
Name, type, BESCHREIBUNG
name string

How this rule will appear to users.

negate boolean

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

operator string Erforderlich

The operator to use for matching.

Kann eine der Folgenden sein: starts_with, ends_with, contains, regex

pattern string Erforderlich

The pattern to match with.

workflows object Erforderlich

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

Name, type, BESCHREIBUNG
type string Erforderlich

Wert: workflows

parameters object
Name, type, BESCHREIBUNG
workflows array of objects Erforderlich

Workflows that must pass for this rule to pass.

Name, type, BESCHREIBUNG
path string Erforderlich

The path to the workflow file

ref string

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

repository_id integer Erforderlich

The ID of the repository where the workflow is defined

sha string

The commit SHA of the workflow file to use

HTTP-Antwortstatuscodes für „Update an organization repository ruleset“

StatuscodeBESCHREIBUNG
200

OK

404

Resource not found

500

Internal Error

Codebeispiele für „Update an organization repository ruleset“

Beispiel für eine Anfrage

put/orgs/{org}/rulesets/{ruleset_id}
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/rulesets/RULESET_ID \ -d '{"name":"super cool ruleset","target":"branch","enforcement":"active","bypass_actors":[{"actor_id":234,"actor_type":"Team","bypass_mode":"always"}],"conditions":{"ref_name":{"include":["refs/heads/main","refs/heads/master"],"exclude":["refs/heads/dev*"]},"repository_name":{"include":["important_repository","another_important_repository"],"exclude":["unimportant_repository"],"protected":true}},"rules":[{"type":"commit_author_email_pattern","parameters":{"operator":"contains","pattern":"github"}}]}'

Response

Status: 200
{ "id": 21, "name": "super cool ruleset", "target": "branch", "source_type": "Organization", "source": "my-org", "enforcement": "active", "bypass_actors": [ { "actor_id": 234, "actor_type": "Team", "bypass_mode": "always" } ], "conditions": { "ref_name": { "include": [ "refs/heads/main", "refs/heads/master" ], "exclude": [ "refs/heads/dev*" ] }, "repository_name": { "include": [ "important_repository", "another_important_repository" ], "exclude": [ "unimportant_repository" ], "protected": true } }, "rules": [ { "type": "commit_author_email_pattern", "parameters": { "operator": "contains", "pattern": "github" } } ], "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://api.github.com/orgs/my-org/rulesets/21" }, "html": { "href": "https://github.com/organizations/my-org/settings/rules/21" } }, "created_at": "2023-08-15T08:43:03Z", "updated_at": "2023-09-23T16:29:47Z" }

Delete an organization repository ruleset

Delete a ruleset for an organization.

Differenzierte Zugriffstoken für "Delete an organization repository ruleset"

Dieser Endpunkt funktioniert mit den folgenden Tokentypen.:

Das Token muss einen der folgenden Berechtigungssätze aufweisen.:

  • organization_administration:write

Parameter für „Delete an organization repository ruleset“

Header
Name, type, BESCHREIBUNG
accept string

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

Pfadparameter
Name, type, BESCHREIBUNG
org string Erforderlich

The organization name. The name is not case sensitive.

ruleset_id integer Erforderlich

The ID of the ruleset.

HTTP-Antwortstatuscodes für „Delete an organization repository ruleset“

StatuscodeBESCHREIBUNG
204

No Content

404

Resource not found

500

Internal Error

Codebeispiele für „Delete an organization repository ruleset“

Beispiel für eine Anfrage

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

Response

Status: 204