Repositories

Update a repository ruleset

Replaces the ruleset configuration and returns the updated ruleset. A bypass actor is an organization role, an active user or agent member of the organization, or an app with a live installation in it; an app bypasses only while it acts through that installation, unpaused and selecting the repository. Requires authenticated authority and enforces current resource policy.

put/api/repos/{owner}/{repo}/rulesets/{ruleset}

Request

  • Base URL
    https://git.cafe
  • Auth
    • API key in cookie gc-session
    • or HTTP bearer
    • or HTTP basic
    • or HTTP token
    • or OAuth 2
      Authorization code: /api/oauth/authorize
      Token URL: /api/oauth/token scopes: repo:rulesets:write

Path parameters

ownerstring required
repostring required
rulesetstring required

Request body

namestring required
target'branch' | 'tag' required
enforcement'active' | 'evaluate' | 'disabled' required
patternsstring[] required
expectedConfiginteger required
expectedVersioninteger required

Response

Response for status 200

configinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.