REST API endpoints for code quality

Use the REST API to manage a code quality configuration.

List code quality findings for a repository

GET /repos/{owner}/{repo}/code-quality/findings

Lists code quality findings for a repository.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

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.

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

• direction (string)
  The direction to sort the results by.
  Default: desc
  Can be one of: asc, desc

• before (string)
  A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."

• after (string)
  A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

• state (string)
  If specified, only code quality findings with this state will be returned.
  Can be one of: open, dismissed

HTTP response status codes

• 200 - OK

• 403 - Response if the user is not authorized to access Code quality for this repository.

• 404 - Resource not found

• 503 - Service unavailable

Code examples

Example

Request:

curl -L \
  -X GET \
  https://api.github.com/repos/OWNER/REPO/code-quality/findings

Response schema (Status: 200):

Array of objects:

• number: required, integer
• state: required, string, enum: open, dismissed
• url: required, string, format: uri
• rule: required, object:
  • id: required, string
  • title: required, string
  • description: required, string
  • help: string
  • severity: required, string, enum: error, warning, note, none
  • category: required, string, enum: none, maintainability, reliability
• location: required, object:
  • path: required, string
  • start_line: integer
  • start_column: integer
  • end_line: integer
  • end_column: integer
• message: required, object:
  • text: required, string
  • markdown: required, string
• created_at: string, format: date-time

Get a code quality finding

GET /repos/{owner}/{repo}/code-quality/findings/{finding_number}

Gets a single code quality finding.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

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.

• finding_number (integer) (required)
  The number that identifies a finding.

HTTP response status codes

• 200 - OK

• 403 - Response if the user is not authorized to access Code quality for this repository.

• 404 - Resource not found

• 503 - Service unavailable

Code examples

Example

Request:

curl -L \
  -X GET \
  https://api.github.com/repos/OWNER/REPO/code-quality/findings/FINDING_NUMBER

Response schema (Status: 200):

• number: required, integer
• state: required, string, enum: open, dismissed
• url: required, string, format: uri
• rule: required, object:
  • id: required, string
  • title: required, string
  • description: required, string
  • help: string
  • severity: required, string, enum: error, warning, note, none
  • category: required, string, enum: none, maintainability, reliability
• location: required, object:
  • path: required, string
  • start_line: integer
  • start_column: integer
  • end_line: integer
  • end_column: integer
• message: required, object:
  • text: required, string
  • markdown: required, string
• created_at: string, format: date-time

Get a code quality setup configuration

GET /repos/{owner}/{repo}/code-quality/setup

Gets a code quality setup configuration.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

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.

HTTP response status codes

• 200 - OK

• 403 - Response if the user is not authorized to access Code quality for this repository.

• 404 - Resource not found

• 503 - Service unavailable

Code examples

Example

Request:

curl -L \
  -X GET \
  https://api.github.com/repos/OWNER/REPO/code-quality/setup

Response schema (Status: 200):

• state: string, enum: configured, not-configured
• languages: array of string, enum: csharp, go, java-kotlin, javascript-typescript, python, ruby, rust
• runner_type: string or null, enum: standard, labeled, null
• runner_label: string or null
• updated_at: string or null, format: date-time
• schedule: string or null, enum: weekly, null
• ai_findings_option: string or null, enum: disabled, on_push, null

Update a code quality setup configuration

PATCH /repos/{owner}/{repo}/code-quality/setup

Updates a code quality setup configuration.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

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.

Body parameters

• state (string)
  The desired state of code quality setup.
  Can be one of: configured, not-configured

• runner_type (string)
  Runner type to be used.
  Can be one of: standard, labeled

• runner_label (string or null)
  Runner label to be used if the runner type is labeled.

• languages (array of strings)
  Languages to be analyzed.
  Supported values are: csharp, go, java-kotlin, javascript-typescript, python, ruby

• ai_findings_option (string)
  Whether AI findings run for Code Quality on this repository.
  Can be one of: disabled, on_push

HTTP response status codes

• 200 - OK

• 202 - Accepted

• 403 - Response if the repository is archived or if Code quality is not enabled for this repository

• 404 - Resource not found

• 409 - Response if there is already a code quality setup configuration update in progress

• 422 - Response if the configuration change cannot be made

• 503 - Service unavailable

Code examples

Example

Request:

curl -L \
  -X PATCH \
  https://api.github.com/repos/OWNER/REPO/code-quality/setup \
  -d '{
  "state": "configured",
  "languages": [
    "javascript-typescript",
    "python",
    "ruby"
  ]
}'

Response schema (Status: 202):

• run_id: integer
• run_url: string