Pontos de extremidade da API REST para regras

Get rules for a branch

Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" enforcement statuses are not returned.

Tokens de acesso refinados para "Get rules for a branch"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Metadata" repository permissions (read)

Esse ponto de extremidade pode ser usado sem autenticação ou as permissões acima mencionadas se apenas recursos públicos forem solicitados.

Parâmetros para "Get rules for a branch"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`branch` string Obrigatório The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Parâmetros de consulta
Nome, Tipo, Descrição
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: `1`

Códigos de status de resposta HTTP para "Get rules for a branch"

Código de status	Descrição
`200`	OK

Exemplos de código para "Get rules for a branch"

Exemplo de solicitação

get/repos/{owner}/{repo}/rules/branches/{branch}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/rules/branches/BRANCH

Response

Status: 200

[
  {
    "type": "commit_message_pattern",
    "ruleset_source_type": "Repository",
    "ruleset_source": "monalisa/my-repo",
    "ruleset_id": 42,
    "parameters": {
      "operator": "starts_with",
      "pattern": "issue"
    }
  },
  {
    "type": "commit_author_email_pattern",
    "ruleset_source_type": "Organization",
    "ruleset_source": "my-org",
    "ruleset_id": 73,
    "parameters": {
      "operator": "contains",
      "pattern": "github"
    }
  }
]

Get all repository rulesets

Get all the rulesets for a repository.

Tokens de acesso refinados para "Get all repository rulesets"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Metadata" repository permissions (read)

Esse ponto de extremidade pode ser usado sem autenticação ou as permissões acima mencionadas se apenas recursos públicos forem solicitados.

Parâmetros para "Get all repository rulesets"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.

Parâmetros de consulta
Nome, Tipo, Descrição
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: `1`
`includes_parents` boolean Include rulesets configured at higher levels that apply to this repository Padrão: `true`
`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, `branch,tag,push`.

Códigos de status de resposta HTTP para "Get all repository rulesets"

Código de status	Descrição
`200`	OK
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "Get all repository rulesets"

Exemplo de solicitação

get/repos/{owner}/{repo}/rulesets

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/rulesets

Response

Status: 200

[
  {
    "id": 42,
    "name": "super cool ruleset",
    "source_type": "Repository",
    "source": "monalisa/my-repo",
    "enforcement": "enabled",
    "node_id": "RRS_lACkVXNlcgQB",
    "_links": {
      "self": {
        "href": "https://HOSTNAME/repos/monalisa/my-repo/rulesets/42"
      },
      "html": {
        "href": "https://github.com/monalisa/my-repo/rules/42"
      }
    },
    "created_at": "2023-07-15T08:43:03Z",
    "updated_at": "2023-08-23T16:29:47Z"
  },
  {
    "id": 314,
    "name": "Another ruleset",
    "source_type": "Repository",
    "source": "monalisa/my-repo",
    "enforcement": "enabled",
    "node_id": "RRS_lACkVXNlcgQQ",
    "_links": {
      "self": {
        "href": "https://HOSTNAME/repos/monalisa/my-repo/rulesets/314"
      },
      "html": {
        "href": "https://github.com/monalisa/my-repo/rules/314"
      }
    },
    "created_at": "2023-08-15T08:43:03Z",
    "updated_at": "2023-09-23T16:29:47Z"
  }
]

Create a repository ruleset

Create a ruleset for a repository.

Tokens de acesso refinados para "Create a repository ruleset"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" repository permissions (write)

Parâmetros para "Create a repository ruleset"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.

Nome, Tipo, Descrição

name string Obrigatório

The name of the ruleset.

target string

The target of the ruleset.

Padrão: branch

Pode ser um dos: branch, tag

enforcement string Obrigatório

The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.

Pode ser um dos: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Properties of bypass_actors

Nome, Tipo, Descrição
`actor_id` integer Obrigatório The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`.
`actor_type` string Obrigatório The type of actor that can bypass a ruleset Pode ser um dos: `Integration`, `OrganizationAdmin`, `RepositoryRole`, `Team`
`bypass_mode` string Obrigatório When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. Padrão: `always` Pode ser um dos: `always`, `pull_request`

conditions object

Parameters for a repository ruleset ref name condition

Properties of conditions

Nome, Tipo, Descrição

ref_name object

Properties of ref_name

Nome, Tipo, Descrição
`include` array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.
`exclude` array of strings Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

rules array of objects

An array of rules within the ruleset.

Can be one of these objects:

Nome, Tipo, Descrição

creation object Obrigatório

Only allow users with bypass permission to create matching refs.

Properties of creation

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `creation`

update object Obrigatório

Only allow users with bypass permission to update matching refs.

Properties of update

Nome, Tipo, Descrição

type string Obrigatório

Valor: update

parameters object

Properties of parameters

Nome, Tipo, Descrição
`update_allows_fetch_and_merge` boolean Obrigatório Branch can pull changes from its upstream repository

deletion object Obrigatório

Only allow users with bypass permissions to delete matching refs.

Properties of deletion

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `deletion`

required_linear_history object Obrigatório

Prevent merge commits from being pushed to matching refs.

Properties of required_linear_history

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `required_linear_history`

required_deployments object Obrigatório

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

Properties of required_deployments

Nome, Tipo, Descrição

type string Obrigatório

Valor: required_deployments

parameters object

Properties of parameters

Nome, Tipo, Descrição
`required_deployment_environments` array of strings Obrigatório The environments that must be successfully deployed to before branches can be merged.

required_signatures object Obrigatório

Commits pushed to matching refs must have verified signatures.

Properties of required_signatures

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `required_signatures`

pull_request object Obrigatório

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

Properties of pull_request

Nome, Tipo, Descrição

type string Obrigatório

Valor: pull_request

parameters object

Properties of parameters

Nome, Tipo, Descrição
`dismiss_stale_reviews_on_push` boolean Obrigatório New, reviewable commits pushed will dismiss previous pull request review approvals.
`require_code_owner_review` boolean Obrigatório Require an approving review in pull requests that modify files that have a designated code owner.
`require_last_push_approval` boolean Obrigatório Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
`required_approving_review_count` integer Obrigatório The number of approving reviews that are required before a pull request can be merged.
`required_review_thread_resolution` boolean Obrigatório All conversations on code must be resolved before a pull request can be merged.

required_status_checks object Obrigatório

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.

Properties of required_status_checks

Nome, Tipo, Descrição

type string Obrigatório

Valor: required_status_checks

parameters object

Properties of parameters

Nome, Tipo, Descrição

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 Obrigatório

Status checks that are required.

Properties of required_status_checks

Nome, Tipo, Descrição
`context` string Obrigatório 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 Obrigatório

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 Obrigatório

Prevent users with push access from force pushing to refs.

Properties of non_fast_forward

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `non_fast_forward`

commit_message_pattern object Obrigatório

Parameters to be used for the commit_message_pattern rule

Properties of commit_message_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: commit_message_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

commit_author_email_pattern object Obrigatório

Parameters to be used for the commit_author_email_pattern rule

Properties of commit_author_email_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: commit_author_email_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

committer_email_pattern object Obrigatório

Parameters to be used for the committer_email_pattern rule

Properties of committer_email_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: committer_email_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

branch_name_pattern object Obrigatório

Parameters to be used for the branch_name_pattern rule

Properties of branch_name_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: branch_name_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

tag_name_pattern object Obrigatório

Parameters to be used for the tag_name_pattern rule

Properties of tag_name_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: tag_name_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

workflows object Obrigatório

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

Properties of workflows

Nome, Tipo, Descrição

type string Obrigatório

Valor: workflows

parameters object

Properties of parameters

Nome, Tipo, Descrição

do_not_enforce_on_create boolean

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

workflows array of objects Obrigatório

Workflows that must pass for this rule to pass.

Properties of workflows

Nome, Tipo, Descrição
`path` string Obrigatório The path to the workflow file
`ref` string The ref (branch or tag) of the workflow file to use
`repository_id` integer Obrigatório The ID of the repository where the workflow is defined
`sha` string The commit SHA of the workflow file to use

Códigos de status de resposta HTTP para "Create a repository ruleset"

Código de status	Descrição
`201`	Created
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "Create a repository ruleset"

Exemplo de solicitação

post/repos/{owner}/{repo}/rulesets

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/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*"]}},"rules":[{"type":"commit_author_email_pattern","parameters":{"operator":"contains","pattern":"github"}}]}'

Response

Status: 201

{
  "id": 42,
  "name": "super cool ruleset",
  "target": "branch",
  "source_type": "Repository",
  "source": "monalisa/my-repo",
  "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*"
      ]
    }
  },
  "rules": [
    {
      "type": "commit_author_email_pattern",
      "parameters": {
        "operator": "contains",
        "pattern": "github"
      }
    }
  ],
  "node_id": "RRS_lACkVXNlcgQB",
  "_links": {
    "self": {
      "href": "https://HOSTNAME/repos/monalisa/my-repo/rulesets/42"
    },
    "html": {
      "href": "https://github.com/monalisa/my-repo/rules/42"
    }
  },
  "created_at": "2023-07-15T08:43:03Z",
  "updated_at": "2023-08-23T16:29:47Z"
}

Get a repository ruleset

Get a ruleset for a repository.

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 acesso refinados para "Get a repository ruleset"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Metadata" repository permissions (read)

Esse ponto de extremidade pode ser usado sem autenticação ou as permissões acima mencionadas se apenas recursos públicos forem solicitados.

Parâmetros para "Get a repository ruleset"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`ruleset_id` integer Obrigatório The ID of the ruleset.

Parâmetros de consulta
Nome, Tipo, Descrição
`includes_parents` boolean Include rulesets configured at higher levels that apply to this repository Padrão: `true`

Códigos de status de resposta HTTP para "Get a repository ruleset"

Código de status	Descrição
`200`	OK
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "Get a repository ruleset"

Exemplo de solicitação

get/repos/{owner}/{repo}/rulesets/{ruleset_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/rulesets/RULESET_ID

Response

Status: 200

{
  "id": 42,
  "name": "super cool ruleset",
  "target": "branch",
  "source_type": "Repository",
  "source": "monalisa/my-repo",
  "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*"
      ]
    }
  },
  "rules": [
    {
      "type": "commit_author_email_pattern",
      "parameters": {
        "operator": "contains",
        "pattern": "github"
      }
    }
  ],
  "node_id": "RRS_lACkVXNlcgQB",
  "_links": {
    "self": {
      "href": "https://HOSTNAME/repos/monalisa/my-repo/rulesets/42"
    },
    "html": {
      "href": "https://github.com/monalisa/my-repo/rules/42"
    }
  },
  "created_at": "2023-07-15T08:43:03Z",
  "updated_at": "2023-08-23T16:29:47Z"
}

Update a repository ruleset

Update a ruleset for a repository.

Tokens de acesso refinados para "Update a repository ruleset"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" repository permissions (write)

Parâmetros para "Update a repository ruleset"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`ruleset_id` integer Obrigatório The ID of the ruleset.

Nome, Tipo, Descrição

name string

The name of the ruleset.

target string

The target of the ruleset.

Pode ser um dos: 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.

Pode ser um dos: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Properties of bypass_actors

Nome, Tipo, Descrição
`actor_id` integer Obrigatório The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`.
`actor_type` string Obrigatório The type of actor that can bypass a ruleset Pode ser um dos: `Integration`, `OrganizationAdmin`, `RepositoryRole`, `Team`
`bypass_mode` string Obrigatório When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. Padrão: `always` Pode ser um dos: `always`, `pull_request`

conditions object

Parameters for a repository ruleset ref name condition

Properties of conditions

Nome, Tipo, Descrição

ref_name object

Properties of ref_name

Nome, Tipo, Descrição
`include` array of strings Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.
`exclude` array of strings Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

rules array of objects

An array of rules within the ruleset.

Can be one of these objects:

Nome, Tipo, Descrição

creation object Obrigatório

Only allow users with bypass permission to create matching refs.

Properties of creation

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `creation`

update object Obrigatório

Only allow users with bypass permission to update matching refs.

Properties of update

Nome, Tipo, Descrição

type string Obrigatório

Valor: update

parameters object

Properties of parameters

Nome, Tipo, Descrição
`update_allows_fetch_and_merge` boolean Obrigatório Branch can pull changes from its upstream repository

deletion object Obrigatório

Only allow users with bypass permissions to delete matching refs.

Properties of deletion

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `deletion`

required_linear_history object Obrigatório

Prevent merge commits from being pushed to matching refs.

Properties of required_linear_history

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `required_linear_history`

required_deployments object Obrigatório

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

Properties of required_deployments

Nome, Tipo, Descrição

type string Obrigatório

Valor: required_deployments

parameters object

Properties of parameters

Nome, Tipo, Descrição
`required_deployment_environments` array of strings Obrigatório The environments that must be successfully deployed to before branches can be merged.

required_signatures object Obrigatório

Commits pushed to matching refs must have verified signatures.

Properties of required_signatures

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `required_signatures`

pull_request object Obrigatório

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

Properties of pull_request

Nome, Tipo, Descrição

type string Obrigatório

Valor: pull_request

parameters object

Properties of parameters

Nome, Tipo, Descrição
`dismiss_stale_reviews_on_push` boolean Obrigatório New, reviewable commits pushed will dismiss previous pull request review approvals.
`require_code_owner_review` boolean Obrigatório Require an approving review in pull requests that modify files that have a designated code owner.
`require_last_push_approval` boolean Obrigatório Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
`required_approving_review_count` integer Obrigatório The number of approving reviews that are required before a pull request can be merged.
`required_review_thread_resolution` boolean Obrigatório All conversations on code must be resolved before a pull request can be merged.

required_status_checks object Obrigatório

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.

Properties of required_status_checks

Nome, Tipo, Descrição

type string Obrigatório

Valor: required_status_checks

parameters object

Properties of parameters

Nome, Tipo, Descrição

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 Obrigatório

Status checks that are required.

Properties of required_status_checks

Nome, Tipo, Descrição
`context` string Obrigatório 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 Obrigatório

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 Obrigatório

Prevent users with push access from force pushing to refs.

Properties of non_fast_forward

Nome, Tipo, Descrição
`type` string Obrigatório Valor: `non_fast_forward`

commit_message_pattern object Obrigatório

Parameters to be used for the commit_message_pattern rule

Properties of commit_message_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: commit_message_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

commit_author_email_pattern object Obrigatório

Parameters to be used for the commit_author_email_pattern rule

Properties of commit_author_email_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: commit_author_email_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

committer_email_pattern object Obrigatório

Parameters to be used for the committer_email_pattern rule

Properties of committer_email_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: committer_email_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

branch_name_pattern object Obrigatório

Parameters to be used for the branch_name_pattern rule

Properties of branch_name_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: branch_name_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

tag_name_pattern object Obrigatório

Parameters to be used for the tag_name_pattern rule

Properties of tag_name_pattern

Nome, Tipo, Descrição

type string Obrigatório

Valor: tag_name_pattern

parameters object

Properties of parameters

Nome, Tipo, Descrição
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Obrigatório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

workflows object Obrigatório

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

Properties of workflows

Nome, Tipo, Descrição

type string Obrigatório

Valor: workflows

parameters object

Properties of parameters

Nome, Tipo, Descrição

do_not_enforce_on_create boolean

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

workflows array of objects Obrigatório

Workflows that must pass for this rule to pass.

Properties of workflows

Nome, Tipo, Descrição
`path` string Obrigatório The path to the workflow file
`ref` string The ref (branch or tag) of the workflow file to use
`repository_id` integer Obrigatório The ID of the repository where the workflow is defined
`sha` string The commit SHA of the workflow file to use

Códigos de status de resposta HTTP para "Update a repository ruleset"

Código de status	Descrição
`200`	OK
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "Update a repository ruleset"

Exemplo de solicitação

put/repos/{owner}/{repo}/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" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/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*"]}},"rules":[{"type":"commit_author_email_pattern","parameters":{"operator":"contains","pattern":"github"}}]}'

Response

Status: 200

{
  "id": 42,
  "name": "super cool ruleset",
  "target": "branch",
  "source_type": "Repository",
  "source": "monalisa/my-repo",
  "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*"
      ]
    }
  },
  "rules": [
    {
      "type": "commit_author_email_pattern",
      "parameters": {
        "operator": "contains",
        "pattern": "github"
      }
    }
  ],
  "node_id": "RRS_lACkVXNlcgQB",
  "_links": {
    "self": {
      "href": "https://HOSTNAME/repos/monalisa/my-repo/rulesets/42"
    },
    "html": {
      "href": "https://github.com/monalisa/my-repo/rules/42"
    }
  },
  "created_at": "2023-07-15T08:43:03Z",
  "updated_at": "2023-08-23T16:29:47Z"
}

Delete a repository ruleset

Delete a ruleset for a repository.

Tokens de acesso refinados para "Delete a repository ruleset"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" repository permissions (write)

Parâmetros para "Delete a repository ruleset"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`ruleset_id` integer Obrigatório The ID of the ruleset.

Códigos de status de resposta HTTP para "Delete a repository ruleset"

Código de status	Descrição
`204`	No Content
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "Delete a repository ruleset"

Exemplo de solicitação

delete/repos/{owner}/{repo}/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" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/rulesets/RULESET_ID

Response

Status: 204