Full GitHub API reference

All operations available through the GitHub API

By calling the full_docs method, we can get the name, documentation link, parameters, and summary for every endpoint in the GitHub API. Here is the full reference:

Markdown(GhApi().full_docs())

actions

activity

apps

billing

checks

  • checks.create(owner, repo, name, head_sha, details_url, external_id, status, started_at, conclusion, completed_at, output, actions): Create a check run
  • checks.get(owner, repo, check_run_id): Get a check run
  • checks.update(owner, repo, check_run_id, name, details_url, external_id, started_at, status, conclusion, completed_at, output, actions): Update a check run
  • checks.list_annotations(owner, repo, check_run_id, per_page, page): List check run annotations
  • checks.rerequest_run(owner, repo, check_run_id): Rerequest a check run
  • checks.create_suite(owner, repo, head_sha): Create a check suite
  • checks.set_suites_preferences(owner, repo, auto_trigger_checks): Update repository preferences for check suites
  • checks.get_suite(owner, repo, check_suite_id): Get a check suite
  • checks.list_for_suite(owner, repo, check_suite_id, check_name, status, filter, per_page, page): List check runs in a check suite
  • checks.rerequest_suite(owner, repo, check_suite_id): Rerequest a check suite
  • checks.list_for_ref(owner, repo, ref, check_name, status, filter, per_page, page, app_id): List check runs for a Git reference
  • checks.list_suites_for_ref(owner, repo, ref, app_id, check_name, per_page, page): List check suites for a Git reference

code_scanning

codes_of_conduct

codespaces

dependabot

dependency_graph

emojis

enterprise_admin

gists

git

gitignore

interactions

issues

licenses

markdown

meta

migrations

oauth_authorizations

oidc

orgs

packages

projects

pulls

rate_limit

reactions

repos

scim

secret_scanning

teams

users