---
title: "Evaluate rules for a branch"
method: GET
path: "/api/repos/{owner}/{repo}/rulesets/evaluate"
tags: ["Repositories"]
---

# Evaluate rules for a branch

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

## Request

- Base URL: `https://git.cafe`
- URL: `https://git.cafe/api/repos/{owner}/{repo}/rulesets/evaluate`
- 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`

Combines matching repository and inherited rulesets for the named branch and reports the effective requirements. Public repositories allow anonymous reads; supplied credentials are validated and may expand access to private resources.

## Path parameters

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

## Query parameters

- `branch` string, required

## Response `200`

Response for status 200

- object
  - `branch` string, required
  - `context` 'pull_request', required
  - `config` integer, required
  - `bypassed` boolean, required
  - `rules` object[], required
    - `rulesetId` string, required
    - `rulesetName` string, required
    - `scope` 'repo' | 'org' | 'team', required
    - `enforcement` 'active' | 'evaluate', required
    - `bypassed` boolean, required
    - `ruleType` 'require_pull_request' | 'require_status_checks' | 'require_signatures' | 'require_linear_history' | 'require_merge_strategy' | 'restrict_pushes' | 'restrict_deletions' | 'restrict_force_pushes' | 'restrict_creations' | 'require_deployments' | 'restrict_file_paths', required
    - `parameters` object, 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)