How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitHub Analysis API

The Analysis API from GitHub — 3 operation(s) for analysis.

GitHub Analysis 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 Analysis. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

This API exposes 4 operations across 3 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against a single base URL, {protocol}://{hostname}.

4 operations 3 paths 19 schemas 1 DELETE2 GET1 POST

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
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 4

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

Analysis 4
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
POST
/repos/{owner}/{repo}/code-scanning/sarifs
GitHub Upload an Analysis as Sarif Data
uploadAnAnalysisAsSarifData 5 params body → 202400403404413503

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are code-scanning-analysis (15 properties), scim-error (6 properties), basic-error (4 properties), code-scanning-analysis-tool (3 properties). Each schema is shown below with its type and property counts.

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-analysis-environment
string
Identifies the variable values associated with the environment in which this analysis was performed.
code-scanning-sarifs-receipt
object
2 properties
code-scanning-analysis-tool-guid
string
The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.
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-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…
code-scanning-analysis-tool-name
string
The name of the tool used to generate the code scanning analysis.
basic-error
object
Basic Error
4 properties
code-scanning-analysis-created-at
string
The time that the analysis was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-ref-full
string
The full Git reference, formatted as refs/heads/ , refs/tags/ , refs/pull/ /merge, or refs/pull/ /head.
code-scanning-analysis-tool-version
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.
code-scanning-analysis
object
15 properties 14 required
code-scanning-analysis-url
string
The REST API URL of the analysis resource.
code-scanning-analysis-tool
object
3 properties
code-scanning-analysis-sarif-file
string
Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [gzip](http://www.gnu.org/software/gzip/manual/gzip.html) an…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-analysis-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
GitHub Feeds API
GitHub Gists API
GitHub Issues API
GitHub Licenses API
GitHub Markdown API
GitHub Meta API
GitHub Notifications API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
Where this information came from

This is an independent, third-party profile of GitHub Analysis 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.