apicheats.dev github/llms.txt Raw .md
GET

GET /repos/{owner}/{repo}/rulesets — GitHub API

GitHub token (required); https://api.github.com

GitHub API

Get all repository rulesets

Base URL
https://api.github.com
Auth
Authorization: Bearer <GITHUB_API_KEY>
Last verified
2026-10-20 · upstream hash matched
Actions Try in browser→
Agents: curl -H "Accept: text/markdown" this URL
→ 318 tokens · Vary: Accept

Critical gotchas

GitHub recommends an Accept: application/vnd.github+json header and an explicit X-GitHub-Api-Version header.

Fine-grained tokens only authorize repositories and permissions selected when the token is created.

cURL

curl -X GET 'https://api.github.com/repos/example-owner/example-repo/rulesets?per_page=30&page=1&includes_parents=true&targets=branch%2Ctag%2Cpush' \  -H "Authorization: Bearer $GITHUB_TOKEN" \  -H 'Accept: application/vnd.github+json' \  -H 'X-GitHub-Api-Version: 2026-03-10'

Parameters

Name In Type Required Description
owner path string Yes The account owner of the repository. The name is not case sensitive.
repo path string Yes The name of the repository without the `.git` extension. The name is not case sensitive.
per_page query integer No The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
page query integer No The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
includes_parents query boolean No Include rulesets configured at higher levels that apply to this repository
targets query string No 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`.

Response 200 OK

[
  {
    "id": 0,
    "name": "string",
    "target": "branch",
    "source_type": "Repository",
    "source": "string",
    "enforcement": "disabled",
    "bypass_actors": [
      {
        "actor_id": 0,
        "actor_type": "Integration",
        "bypass_mode": "always"
      }
    ],
    "current_user_can_bypass": "always",
    "node_id": "string",
    "_links": {
      "self": {
        "href": "string"
      },
      "html": {
        "href": "string"
      }
    },
    "conditions": {
      "ref_name": {
        "include": [
          "string"
        ],
        "exclude": [
          "string"
        ]
      }
    },
    "rules": [
      {
        "type": "creation"
      }
    ],
    "created_at": "2026-09-03T00:00:00Z",
    "updated_at": "2026-09-03T00:00:00Z"
  }
]
Get a free GitHub API key → sponsored

Affiliate link - we may earn a commission, at no extra cost to you.