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

GET /orgs/{org}/rulesets/{ruleset_id} — GitHub API

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

GitHub API

Get an organization repository ruleset

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
→ 184 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/orgs/example-org/rulesets/10' \  -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
org path string Yes The organization name. The name is not case sensitive.
ruleset_id path integer Yes The ID of the ruleset.

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.