Sample - GitHub REST API
PUT/repos/{owner}/{repo}/rulesets/{ruleset_id}

Update a repository ruleset

Updates a repository ruleset identified by its repository and ruleset ID. Supply only the ruleset properties you want to change, including its name, target, enforcement, bypass actors, conditions, or rules. The updated ruleset response includes its current configuration and timestamps.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters · 6 body fields
ownerstringrequired
The account owner of the repository; the name is not case sensitive.
repostringrequired
The repository name without the `.git` extension; the name is not case sensitive.
ruleset_idintegerrequired
The numeric identifier of the ruleset to update.

Optional repository ruleset properties to update, including its name, target, enforcement, bypass actors, conditions, and rules.

namestringoptional
The name of the ruleset.
targetstringoptional
The target of the ruleset
Allowed:branchtagpush
enforcementstringoptional
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).
Allowed:disabledactiveevaluate
bypass_actorsarray<RepositoryRulesetBypassActor>optional
The actors that can bypass the rules in this ruleset
conditionsobjectoptional
Parameters for a repository ruleset ref name condition
rulesarray<RepositoryRule>optional
An array of rules within the ruleset.

4 status codes
200Returns the updated repository ruleset, including its identifier, name, source, enforcement level, bypass actors, conditions, rules, and creation and update timestamps.
idintegerrequired
The ID of the ruleset
namestringrequired
The name of the ruleset
targetstringoptional
The target of the ruleset
Allowed:branchtagpushrepository
source_typestringoptional
The type of the source of the ruleset
Allowed:RepositoryOrganizationEnterprise
sourcestringrequired
The name of the source
enforcementstringrequired
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).
Allowed:disabledactiveevaluate
bypass_actorsarray<RepositoryRulesetBypassActor>optional
The actors that can bypass the rules in this ruleset
current_user_can_bypassstringoptional
The bypass type of the user making the API request for this ruleset. This field is only returned when querying the repository-level endpoint.
Allowed:alwayspull_requests_onlyneverexempt
node_idstringoptional
_linksobjectoptional
conditionsobjectoptional
Parameters for a repository ruleset ref name condition
rulesarray<RepositoryRule>optional
created_atstringoptional
updated_atstringoptional
404Returned when the repository or ruleset does not exist.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Returned when the request fails validation or the endpoint has been spammed.
messagestringrequired
documentation_urlstringrequired
errorsarray<object>optional
500Returned when an internal server error occurs.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 404 is returned when the repository or ruleset cannot be found. A 422 is returned when the request fails validation or the endpoint has been spammed. A 500 is returned for an internal error; target must be branch, tag, or push, and enforcement must be disabled, active, or evaluate.