REST API endpoints for rule suites

Use the REST API to manage rule suites for repositories.

List repository rule suites

GET /repos/{owner}/{repo}/rulesets/rule-suites

Lists suites of rule evaluations at the repository level.
For more information, see "Managing rulesets for a repository."

Parameters

Headers

• accept (string)
  Setting to application/vnd.github+json is recommended.

Path and query parameters

• owner (string) (required)
  The account owner of the repository. The name is not case sensitive.

• repo (string) (required)
  The name of the repository without the .git extension. The name is not case sensitive.

• ref (string)
  The name of the ref. Cannot contain wildcard characters. Optionally prefix with refs/heads/ to limit to branches or refs/tags/ to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.

• time_period (string)
  The time period to filter by.
  For example, day will filter for rule suites that occurred in the past 24 hours, and week will filter for rule suites that occurred in the past 7 days (168 hours).
  Default: day
  Can be one of: hour, day, week, month

• actor_name (string)
  The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.

• rule_suite_result (string)
  The rule suite results to filter on. When specified, only suites with this result will be returned.
  Default: all
  Can be one of: pass, fail, bypass, all

• evaluate_status (string)
  The evaluate status to filter on. When specified, only rule suites resulting from rulesets with the specified evaluate status will be returned.

  all - all rule suites will be returned.
  active - only rule suites resulting from rulesets in active (non-evaluate) mode will be returned.
  evaluate - only rule suites resulting from rulesets in evaluate mode will be returned.
  Default: all
  Can be one of: all, active, evaluate

• per_page (integer)
  The number of results per page (max 100). For more information, see "Using pagination in the REST API."
  Default: 30

• page (integer)
  The page number of the results to fetch. For more information, see "Using pagination in the REST API."
  Default: 1

HTTP response status codes

• 200 - OK

• 404 - Resource not found

• 500 - Internal Error

Code examples

Example

Request:

curl -L \
  -X GET \
  https://api.github.com/repos/OWNER/REPO/rulesets/rule-suites

Response schema (Status: 200):

Array of objects:

• id: integer
• actor_id: integer
• actor_name: string
• before_sha: string
• after_sha: string
• ref: string
• repository_id: integer
• repository_name: string
• pushed_at: string, format: date-time
• result: string, enum: pass, fail, bypass
• evaluation_result: string, enum: pass, fail, bypass

Get a repository rule suite

GET /repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}

Gets information about a suite of rule evaluations from within a repository.
For more information, see "Managing rulesets for a repository."

Parameters

Headers

• accept (string)
  Setting to application/vnd.github+json is recommended.

Path and query parameters

• owner (string) (required)
  The account owner of the repository. The name is not case sensitive.

• repo (string) (required)
  The name of the repository without the .git extension. The name is not case sensitive.

• rule_suite_id (integer) (required)
  The unique identifier of the rule suite result.
  To get this ID, you can use GET /repos/{owner}/{repo}/rulesets/rule-suites
  for repositories and GET /orgs/{org}/rulesets/rule-suites
  for organizations.

• include_metadata (boolean)
  When set to true, the response will include additional metadata for pull request and required status check rule evaluation.
  Results are capped at 50 entries.
  Default: false

HTTP response status codes

• 200 - OK

• 404 - Resource not found

• 500 - Internal Error

Code examples

Example

Request:

curl -L \
  -X GET \
  https://api.github.com/repos/OWNER/REPO/rulesets/rule-suites/RULE_SUITE_ID

Response schema (Status: 200):

• id: integer
• actor_id: integer or null
• actor_name: string or null
• before_sha: string
• after_sha: string
• ref: string
• repository_id: integer
• repository_name: string
• pushed_at: string, format: date-time
• result: string, enum: pass, fail, bypass
• evaluation_result: string or null, enum: pass, fail, bypass, null
• rule_evaluations: array of objects:
  • rule_source: object:
    • type: string
    • id: integer or null
    • name: string or null
  • enforcement: string, enum: active, evaluate, deleted ruleset
  • result: string, enum: pass, fail
  • rule_type: string
  • metadata: one of:
    • Pull request rule suite metadata
      • pull_request: object:
        • id: integer
        • number: integer
        • user: object:
          • id: integer
          • login: string
          • type: string
        • reviews: array of objects:
          • id: integer
          • user: object
          • state: string
        • proof_of_presence: object or null:
          • state: string
          • code: string
          • base_sha: string
          • head_sha: string
          • required_level: string
          • verified_level: string
          • verified_at: string
          • verifier: object or null
    • Required status checks rule suite metadata
      • checks: array of objects:
        • id: integer
        • context: string
        • state: string
        • type: string
        • app: object or null:
          • id: integer
          • slug: string
          • name: string
  • details: string or null