---
title: "Get a repository ruleset"
method: GET
path: "/api/repos/{owner}/{repo}/rulesets/{ruleset}"
tags: ["Repositories"]
---

# Get a repository ruleset

`GET /api/repos/{owner}/{repo}/rulesets/{ruleset}`

## Request

- Base URL: `https://git.cafe`
- URL: `https://git.cafe/api/repos/{owner}/{repo}/rulesets/{ruleset}`
- Auth: one of:
  - none
  - API key in cookie `gc-session`
  - HTTP bearer
  - HTTP basic
  - HTTP token
  - OAuth 2
    - Authorization code: `/api/oauth/authorize`
    - Token URL: `/api/oauth/token` scopes: `repo:rulesets:read`

Returns one repository ruleset by its stable ruleset ID or a concealed not-found result. Public repositories allow anonymous reads; supplied credentials are validated and may expand access to private resources.

## Path parameters

- `owner` string, required
- `repo` string, required
- `ruleset` string, required

## Response `200`

Response for status 200

- RulesetRead
  - `ruleset` Ruleset, required
    - `name` string, required
    - `target` 'branch' | 'tag', required
    - `enforcement` 'active' | 'evaluate' | 'disabled', required
    - `patterns` string[], required
    - `rules` RulesetRule[], required
      - union
        - object
          - `ruleType` 'require_pull_request', required
          - `parameters` object, required
            - `min_approvals` integer, required
            - `dismiss_stale_reviews` boolean, required
            - `require_code_owner_review` boolean, required
        - object
          - `ruleType` 'require_status_checks', required
          - `parameters` object, required
            - `contexts` string[]
            - `checks` object[]
              - …
            - `strict` boolean, required
        - object
          - `ruleType` 'require_signatures', required
          - `parameters` object, required
        - object
          - `ruleType` 'require_linear_history', required
          - `parameters` object, required
        - object
          - `ruleType` 'require_merge_strategy', required
          - `parameters` object, required
            - `allowed_strategies` string[], required
        - object
          - `ruleType` 'restrict_pushes', required
          - `parameters` object, required
        - object
          - `ruleType` 'restrict_deletions', required
          - `parameters` object, required
        - object
          - `ruleType` 'restrict_force_pushes', required
          - `parameters` object, required
        - object
          - `ruleType` 'restrict_creations', required
          - `parameters` object, required
        - object
          - `ruleType` 'require_deployments', required
          - `parameters` object, required
            - `environments` string[], required
        - object
          - `ruleType` 'restrict_file_paths', required
          - `parameters` object, required
            - `paths` string[], required
            - `action` 'restrict' | 'require_pr', required
    - `bypassActors` RulesetBypass[]
      - union
        - object
          - `actorType` 'actor', required
          - `actorId` string, required
          - `bypassMode` 'always' | 'pull_request', required
        - object
          - `actorType` 'org_role', required
          - `orgRole` 'org-owner' | 'org-admin' | 'org-member-read' | 'org-member-write' | 'org-member-none' | 'org-outside-collaborator', required
          - `bypassMode` 'always' | 'pull_request', required
    - `id` string, required
    - `version` integer, required
    - `scope` 'repo' | 'org' | 'team', required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `config` integer, required

## Other responses

- `400`: The request is invalid.
- `401`: Authentication is required, or the supplied credential is invalid.
- `403`: The credential does not permit this operation. A `code`, when present, names the refusal.
- `404`: The resource does not exist or is not visible to the caller.
- `409`: The request conflicts with the current state. A `code`, when present, names the refusal; `retryable` says whether the same request can succeed later, and `operationId` names the operation in the way.
- `429`: A rate limit is exhausted. Wait Retry-After seconds; the value is a hint, so back off on a repeat 429.
- `503`: A required service is temporarily unavailable; retry later.

---

[API](https://skmtc.dev/gitcafe/apis/git-cafe-api.md) - [All operations](https://skmtc.dev/gitcafe/apis/git-cafe-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gitcafe/apis/git-cafe-api/revisions/9fa233d2986d?raw)