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 Static Analysis Results Interchange Format API

The Static Analysis Results Interchange Format API from GitHub — 2 operation(s) for static analysis results interchange format.

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

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

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

2 operations 2 paths 7 schemas 1 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 Static Analysis Results Interchange Format API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 2

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

Static Analysis Results Interchange Format 2
POST
/repos/{owner}/{repo}/code-scanning/sarifs
GitHub Upload an Analysis as Sarif Data
uploadAnAnalysisAsSarifData 5 params body → 202400403404413503
GET
/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}
GitHub Get Information About Sarif Upload
getInformationAboutSarifUpload 6 params → 200403404503

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are basic-error (4 properties), code-scanning-sarifs-status (3 properties), code-scanning-sarifs-receipt (2 properties). Each schema is shown below with its type and property counts.

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-commit-sha
string
The SHA of the commit to which the analysis you are uploading relates.
code-scanning-analysis-sarif-id
string
An identifier for the upload.
basic-error
object
Basic Error
4 properties
code-scanning-sarifs-receipt
object
2 properties
code-scanning-sarifs-status
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-static-analysis-results-interchange-format-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 Static Analysis Results Interchange Format 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.