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 References API

The References API from GitHub — 10 operation(s) for references.

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

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

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

12 operations 10 paths 18 schemas 2 DELETE7 GET1 PATCH2 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 References API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 12

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

References 12
POST
/repos/{owner}/{repo}/autolinks
GitHub Create an Autolink Reference for Repository
createAnAutolinkReferenceForRepository 5 params body → 201422
GET
/repos/{owner}/{repo}/autolinks/{autolink_id}
GitHub Get an Autolink Reference of Repository
getAnAutolinkReferenceOfRepository 6 params → 200404
DELETE
/repos/{owner}/{repo}/autolinks/{autolink_id}
GitHub Delete an Autolink Reference from Repository
deleteAnAutolinkReferenceFromRepository 6 params → 204404
GET
/repos/{owner}/{repo}/commits/{ref}/check-runs
GitHub List Check Runs for Git Reference
listCheckRunsForGitReference 12 params → 200
GET
/repos/{owner}/{repo}/commits/{ref}/check-suites
GitHub List Check Suites for Git Reference
listCheckSuitesForGitReference 10 params → 200
GET
/repos/{owner}/{repo}/commits/{ref}/status
GitHub Get the Combined Status for Specific Reference
getTheCombinedStatusForSpecificReference 8 params → 200404
GET
/repos/{owner}/{repo}/commits/{ref}/statuses
GitHub List Commit Statuses for Reference
listCommitStatusesForReference 8 params → 200301
GET
/repos/{owner}/{repo}/git/matching-refs/{ref}
GitHub List Matching References
listMatchingReferences 6 params → 200
GET
/repos/{owner}/{repo}/git/ref/{ref}
GitHub Get Reference
getReference 6 params → 200404
POST
/repos/{owner}/{repo}/git/refs
GitHub Create Reference
createReference 5 params body → 201422
PATCH
/repos/{owner}/{repo}/git/refs/{ref}
GitHub Update Reference
updateReference 6 params body → 200422
DELETE
/repos/{owner}/{repo}/git/refs/{ref}
GitHub Delete Reference
deleteReference 6 params → 204422

Schemas 18

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

validation-error
object
Validation Error
3 properties 2 required
basic-error
object
Basic Error
4 properties
autolink
object
An autolink reference.
4 properties 4 required
code-of-conduct
object
Code Of Conduct
5 properties 4 required
minimal-repository
object
Minimal Repository
87 properties 46 required
git-ref
object
Git references within a repository
4 properties 4 required
check-suite
object
suite of checks performed on the code of a given code change
19 properties 17 required
security-and-analysis
object
3 properties
simple-commit-status
object
11 properties 10 required
simple-user
object
GitHub user.
21 properties 18 required
nullable-integration
object
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties 11 required
status
object
The status of a commit.
11 properties 11 required
deployment-simple
object
deployment created as the result of an Actions check run from a workflow that references an environment
14 properties 10 required
simple-commit
object
commit.
6 properties 6 required
pull-request-minimal
object
5 properties 5 required
combined-commit-status
object
Combined Commit Status
7 properties 7 required
check-run
object
check performed on the code of a given code change
17 properties 16 required
nullable-simple-user
object
GitHub user.
21 properties 18 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-references-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 References 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.