GitHub Code API

The Code API from GitHub — 9 operation(s) for code.

Documentation Provider Profile APIs.io OpenAPI GitHub

GitHub Code API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Code. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

This API exposes 11 operations across 8 paths, and defines 56 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against 2 base URLs: {protocol}://{hostname}/api/v3, {protocol}://{hostname}.

11 operations 8 paths 56 schemas 1 DELETE8 GET2 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.2.0

API Version

1.1.4

Base URL

https://api.github.com

Authentication

HTTP Bearer

License

MIT

View terms

Resource Areas

Authentication & Security 1

GitHub Code API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

bearerHttpAuthentication — Bearer Token

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 8 GET, 2 PATCH. Each is listed below with its method, path, parameters, and response codes.

Code 11

GET

/codes_of_conduct/{key}

GitHub Get Code of Conduct

getCodeOfConduct 1 param → 200304404

GET

/orgs/{org}/code-scanning/alerts

GitHub List Code Scanning Alerts for an Organization

listCodeScanningAlertsForAnOrganization 11 params → 200404503

GET

/repos/{owner}/{repo}/code-scanning/alerts

GitHub List Code Scanning Alerts for Repository

listCodeScanningAlertsForRepository 14 params → 200304403404503

GET

/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}

GitHub Get Code Scanning Alert

getCodeScanningAlert 6 params → 200304403404503

PATCH

/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}

GitHub Update Code Scanning Alert

updateCodeScanningAlert 6 params body → 200403404503

GET

/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances

GitHub List Instances of Code Scanning Alert

listInstancesOfCodeScanningAlert 9 params → 200403404503

GET

/repos/{owner}/{repo}/code-scanning/analyses

GitHub List Code Scanning Analyses for Repository

listCodeScanningAnalysesForRepository 13 params → 200403404503

GET

/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}

GitHub Get Code Scanning Analysis for Repository

getCodeScanningAnalysisForRepository 6 params → 200403404503

DELETE

/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}

GitHub Delete Code Scanning Analysis from Repository

deleteCodeScanningAnalysisFromRepository 7 params → 200400403404503

GET

/repos/{owner}/{repo}/code-scanning/default-setup

GitHub Get Code Scanning Default Setup Configuration

getCodeScanningDefaultSetupConfiguration 5 params → 200403404503

PATCH

/repos/{owner}/{repo}/code-scanning/default-setup

GitHub Update Code Scanning Default Setup Configuration

updateCodeScanningDefaultSetupConfiguration 5 params body → 200202403404409503

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are simple-repository (46 properties), nullable-simple-user_2 (21 properties), simple-user (21 properties), nullable-simple-user (21 properties). Each schema is shown below with its type and property counts.

code-of-conduct

object

Code Of Conduct

5 properties 4 required

basic-error

object

Basic Error

4 properties

code-scanning-analysis-analysis-key

string

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

code-scanning-ref

string

The Git reference, formatted as refs/pull/ /merge, refs/pull/ /head, refs/heads/ or simply .

code-scanning-alert-state

string

State of a code scanning alert.

alert-created-at

string

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

code-scanning-alert-instance

object

10 properties

code-scanning-alert-severity

string

Severity of a code scanning alert.

alert-html-url

string

The GitHub URL of the alert resource.

alert-updated-at

string

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

code-scanning-analysis-tool-guid

stringnull

The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.

code-scanning-alert-rule-summary

object

6 properties

code-scanning-alert-state-query

string

State of a code scanning alert.

simple-user

object

A GitHub user.

21 properties 18 required

code-scanning-analysis-tool-name

string

The name of the tool used to generate the code scanning analysis.

code-scanning-analysis-category

string

Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed o…

alert-instances-url

string

The REST API URL for fetching the list of instances for an alert.

simple-repository

object

A GitHub repository.

46 properties 46 required

alert-number

integer

The security alert number.

alert-fixed-at

stringnull

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

code-scanning-organization-alert-items

object

16 properties 13 required

alert-dismissed-at

stringnull

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

code-scanning-analysis-tool-version

stringnull

The version of the tool used to generate the code scanning analysis.

code-scanning-alert-location

object

Describe a region within a file for the alert.

5 properties

code-scanning-analysis-tool

object

3 properties

code-scanning-alert-dismissed-comment

stringnull

The dismissal comment associated with the dismissal of the alert.

code-scanning-alert-dismissed-reason

stringnull

Required when the state is dismissed. The reason for dismissing or closing the alert.

alert-url

string

The REST API URL of the alert resource.

code-scanning-alert-classification

stringnull

A classification of the file. For example to identify it as generated.

nullable-simple-user

objectnull

A GitHub user.

21 properties 18 required

code-scanning-alert-environment

string

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language tha…

code-scanning-default-setup

object

Configuration for code scanning default setup.

4 properties

code-scanning-alert-items

object

15 properties 12 required

code-scanning-analysis-environment

string

Identifies the variable values associated with the environment in which this analysis was performed.

code-scanning-default-setup-update

object

Configuration for code scanning default setup.

2 properties 1 required

code-scanning-alert

object

15 properties 12 required

code-scanning-alert-rule

object

9 properties

code-scanning-analysis-tool-guid_2

string

The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.

code-scanning-alert-rule-summary_2

object

6 properties

scim-error

object

Scim Error

6 properties

code-scanning-analysis-commit-sha

string

The SHA of the commit to which the analysis you are uploading relates.

code-scanning-alert-set-state

string

Sets the state of the code scanning alert. You must provide dismissedreason when you set the state to dismissed.

code-scanning-default-setup-update-response

object

You can use runurl to track the status of the run. This includes a property status and conclusion. You should not rely on this always being an actions workflow…

2 properties

code-scanning-analysis-created-at

string

The time that the analysis was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

alert-fixed-at_2

string

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

code-scanning-analysis-tool-version_2

string

The version of the tool used to generate the code scanning analysis.

code-scanning-analysis-deletion

object

Successful deletion of a code scanning analysis

2 properties 2 required

code-scanning-analysis-sarif-id

string

An identifier for the upload.

nullable-simple-user_2

object

GitHub user.

21 properties 18 required

code-scanning-analysis

object

15 properties 14 required

alert-dismissed-at_2

string

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

code-scanning-analysis-url

string

The REST API URL of the analysis resource.

empty-object

object

An object without any properties.

code-scanning-alert-dismissed-comment_2

string

The dismissal comment associated with the dismissal of the alert.

code-scanning-alert-dismissed-reason_2

string

Required when the state is dismissed. The reason for dismissing or closing the alert.

code-scanning-alert-classification_2

string

classification of the file. For example to identify it as generated.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs GitHub publishes across the network.

GitHub Events API

AE Profile APIs.io

GitHub Feeds API

AE Profile APIs.io

GitHub Gists API

AE Profile APIs.io

GitHub Issues API

AE Profile APIs.io

GitHub Licenses API

AE Profile APIs.io

GitHub Markdown API

AE Profile APIs.io

GitHub Meta API

AE Profile APIs.io

GitHub Notifications API

AE Profile APIs.io

GitHub Octocat API

AE Profile APIs.io

GitHub Projects API

AE Profile APIs.io

GitHub Repos API

AE Profile APIs.io

GitHub Search API

AE Profile APIs.io

#Code

← Back to G APIs

Call it yourself

curl for this page

Search the network for this

curl "https://api.apievangelist.com/v1/search?q=github-code-api&limit=10"

Everything under a tag

curl "https://api.apievangelist.com/v1/tags/github-code-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Where this information came from

This is an independent, third-party profile of GitHub Code API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

GitHub Code API

Metadata

Authentication & Security 1

Paths & Operations 11

Schemas 56

Specification

Source

API Details

Provider

Explore more

Work with this as data

MCP tools for apis

Call it yourself

Get an API key

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

GitHub Code API

Metadata

Authentication & Security 1

Paths & Operations 11

Schemas 56

Specification

Source

More from GitHub 12

API Details

Provider

Explore more

Work with this as data

MCP tools for apis

Call it yourself

Get an API key