Skip to content
forgit api docs

Get a repository ruleset

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

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.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
owner
required
string

The account owner of the repository. The name is not case sensitive.

repo
required
string

The name of the repository without the .git extension. The name is not case sensitive.

ruleset_id
required
integer

The ID of the ruleset.

Query Parameters

Section titled “ Query Parameters ”
includes_parents
boolean
default: true

Include rulesets configured at higher levels that apply to this repository

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Repository ruleset

A set of rules to apply when specified conditions are met.

object
id
required

The ID of the ruleset

integer
name
required

The name of the ruleset

string
target

The target of the ruleset

string
Allowed values: branch tag push repository
source_type

The type of the source of the ruleset

string
Allowed values: Repository Organization Enterprise
source
required

The name of the source

string
enforcement
required

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).

string
Allowed values: disabled active evaluate
bypass_actors

The actors that can bypass the rules in this ruleset

Array<object>
Repository Ruleset Bypass Actor

An actor that can bypass rules in a ruleset

object
actor_id

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, Team, and User actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. OrganizationAdmin is not applicable for personal repositories.

integer
nullable
actor_type
required

The type of actor that can bypass a ruleset.

string
Allowed values: Integration OrganizationAdmin RepositoryRole Team DeployKey User
bypass_mode

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. When bypass_mode is exempt, rules will not be run for that actor and a bypass audit entry will not be created.

string
default: always
Allowed values: always pull_request exempt
current_user_can_bypass

The bypass type of the user making the API request for this ruleset. This field is only returned when querying the repository-level endpoint.

string
Allowed values: always pull_requests_only never exempt
node_id
string
_links
object
self
object
href

The URL of the ruleset

string
html
object
href

The html URL of the ruleset

string
conditions
Any of:
Repository ruleset conditions for ref names

Parameters for a repository ruleset ref name condition

object
ref_name
object
include

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.

Array<string>
exclude

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

Array<string>
rules
Array<object>
One of:
creation

Only allow users with bypass permission to create matching refs.

object
type
required
string
Allowed values: creation
created_at
string format: date-time
updated_at
string format: date-time
Examples
Example default 
{
  "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://api.github.com/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"
}

404

Section titled “ 404 ”

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

500

Section titled “ 500 ”

Internal Error

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}