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

agent_tasks

agents

api_insights

apps

billing

campaigns

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

classroom

code_quality

code_scanning

code_security

  • code-security.get_configurations_for_enterprise(enterprise, per_page, before, after): Get code security configurations for an enterprise
  • code-security.create_configuration_for_enterprise(enterprise, name, description, advanced_security, code_security, dependency_graph, dependency_graph_autosubmit_action, dependency_graph_autosubmit_action_options, dependabot_alerts, dependabot_security_updates, code_scanning_options, code_scanning_default_setup, code_scanning_default_setup_options, code_scanning_delegated_alert_dismissal, secret_protection, secret_scanning, secret_scanning_push_protection, secret_scanning_validity_checks, secret_scanning_non_provider_patterns, secret_scanning_generic_secrets, secret_scanning_delegated_alert_dismissal, secret_scanning_extended_metadata, private_vulnerability_reporting, enforcement): Create a code security configuration for an enterprise
  • code-security.get_default_configurations_for_enterprise(enterprise): Get default code security configurations for an enterprise
  • code-security.get_single_configuration_for_enterprise(enterprise, configuration_id): Retrieve a code security configuration of an enterprise
  • code-security.update_enterprise_configuration(enterprise, configuration_id, name, description, advanced_security, code_security, dependency_graph, dependency_graph_autosubmit_action, dependency_graph_autosubmit_action_options, dependabot_alerts, dependabot_security_updates, code_scanning_default_setup, code_scanning_default_setup_options, code_scanning_options, code_scanning_delegated_alert_dismissal, secret_protection, secret_scanning, secret_scanning_push_protection, secret_scanning_validity_checks, secret_scanning_non_provider_patterns, secret_scanning_generic_secrets, secret_scanning_delegated_alert_dismissal, secret_scanning_extended_metadata, private_vulnerability_reporting, enforcement): Update a custom code security configuration for an enterprise
  • code-security.delete_configuration_for_enterprise(enterprise, configuration_id): Delete a code security configuration for an enterprise
  • code-security.attach_enterprise_configuration(enterprise, configuration_id, scope): Attach an enterprise configuration to repositories
  • code-security.set_configuration_as_default_for_enterprise(enterprise, configuration_id, default_for_new_repos): Set a code security configuration as a default for an enterprise
  • code-security.get_repositories_for_enterprise_configuration(enterprise, configuration_id, per_page, before, after, status): Get repositories associated with an enterprise code security configuration
  • code-security.get_configurations_for_org(org, target_type, per_page, before, after): Get code security configurations for an organization
  • code-security.create_configuration(org, name, description, advanced_security, code_security, dependency_graph, dependency_graph_autosubmit_action, dependency_graph_autosubmit_action_options, dependabot_alerts, dependabot_security_updates, dependabot_delegated_alert_dismissal, code_scanning_options, code_scanning_default_setup, code_scanning_default_setup_options, code_scanning_delegated_alert_dismissal, secret_protection, secret_scanning, secret_scanning_push_protection, secret_scanning_delegated_bypass, secret_scanning_delegated_bypass_options, secret_scanning_validity_checks, secret_scanning_non_provider_patterns, secret_scanning_generic_secrets, secret_scanning_delegated_alert_dismissal, secret_scanning_extended_metadata, private_vulnerability_reporting, enforcement): Create a code security configuration
  • code-security.get_default_configurations(org): Get default code security configurations
  • code-security.detach_configuration(org, selected_repository_ids): Detach configurations from repositories
  • code-security.get_configuration(org, configuration_id): Get a code security configuration
  • code-security.update_configuration(org, configuration_id, name, description, advanced_security, code_security, dependency_graph, dependency_graph_autosubmit_action, dependency_graph_autosubmit_action_options, dependabot_alerts, dependabot_security_updates, dependabot_delegated_alert_dismissal, code_scanning_default_setup, code_scanning_default_setup_options, code_scanning_options, code_scanning_delegated_alert_dismissal, secret_protection, secret_scanning, secret_scanning_push_protection, secret_scanning_delegated_bypass, secret_scanning_delegated_bypass_options, secret_scanning_validity_checks, secret_scanning_non_provider_patterns, secret_scanning_generic_secrets, secret_scanning_delegated_alert_dismissal, secret_scanning_extended_metadata, private_vulnerability_reporting, enforcement): Update a code security configuration
  • code-security.delete_configuration(org, configuration_id): Delete a code security configuration
  • code-security.attach_configuration(org, configuration_id, scope, selected_repository_ids): Attach a configuration to repositories
  • code-security.set_configuration_as_default(org, configuration_id, default_for_new_repos): Set a code security configuration as a default for an organization
  • code-security.get_repositories_for_configuration(org, configuration_id, per_page, before, after, status): Get repositories associated with a code security configuration
  • code-security.get_configuration_for_repository(owner, repo): Get the code security configuration associated with a repository

codes_of_conduct

codespaces

copilot

copilot_spaces

credentials

dependabot

dependency_graph

emojis

enterprise_team_memberships

enterprise_team_organizations

enterprise_teams

  • enterprise-teams.list(enterprise, per_page, page): List enterprise teams
  • enterprise-teams.create(enterprise, name, description, sync_to_organizations, organization_selection_type, group_id, notification_setting): Create an enterprise team
  • enterprise-teams.get(enterprise, team_slug): Get an enterprise team
  • enterprise-teams.update(enterprise, team_slug, name, description, sync_to_organizations, organization_selection_type, group_id, notification_setting): Update an enterprise team
  • enterprise-teams.delete(enterprise, team_slug): Delete an enterprise team

gists

git

gitignore

hosted_compute

interactions

issues

licenses

markdown

meta

migrations

oidc

orgs

packages

private_registries

projects

pulls

  • pulls.list(owner, repo, state, head, base, sort, direction, per_page, page): List pull requests
  • pulls.create(owner, repo, title, head, head_repo, base, body, maintainer_can_modify, draft, issue): Create a pull request
  • pulls.list_review_comments_for_repo(owner, repo, sort, direction, since, per_page, page): List review comments in a repository
  • pulls.get_review_comment(owner, repo, comment_id): Get a review comment for a pull request
  • pulls.update_review_comment(owner, repo, comment_id, body): Update a review comment for a pull request
  • pulls.delete_review_comment(owner, repo, comment_id): Delete a review comment for a pull request
  • pulls.get(owner, repo, pull_number): Get a pull request
  • pulls.update(owner, repo, pull_number, title, body, state, base, maintainer_can_modify): Update a pull request
  • pulls.list_review_comments(owner, repo, pull_number, sort, direction, since, per_page, page): List review comments on a pull request
  • pulls.create_review_comment(owner, repo, pull_number, body, commit_id, path, position, side, line, start_line, start_side, in_reply_to, subject_type): Create a review comment for a pull request
  • pulls.create_reply_for_review_comment(owner, repo, pull_number, comment_id, body): Create a reply for a review comment
  • pulls.list_commits(owner, repo, pull_number, per_page, page): List commits on a pull request
  • pulls.list_files(owner, repo, pull_number, per_page, page): List pull requests files
  • pulls.check_if_merged(owner, repo, pull_number): Check if a pull request has been merged
  • pulls.merge(owner, repo, pull_number, commit_title, commit_message, sha, merge_method): Merge a pull request
  • pulls.list_requested_reviewers(owner, repo, pull_number): Get all requested reviewers for a pull request
  • pulls.request_reviewers(owner, repo, pull_number, reviewers, team_reviewers): Request reviewers for a pull request
  • pulls.remove_requested_reviewers(owner, repo, pull_number, reviewers, team_reviewers): Remove requested reviewers from a pull request
  • pulls.list_reviews(owner, repo, pull_number, per_page, page): List reviews for a pull request
  • pulls.create_review(owner, repo, pull_number, commit_id, body, event, comments): Create a review for a pull request
  • pulls.get_review(owner, repo, pull_number, review_id): Get a review for a pull request
  • pulls.update_review(owner, repo, pull_number, review_id, body): Update a review for a pull request
  • pulls.delete_pending_review(owner, repo, pull_number, review_id): Delete a pending review for a pull request
  • pulls.list_comments_for_review(owner, repo, pull_number, review_id, per_page, page): List comments for a pull request review
  • pulls.dismiss_review(owner, repo, pull_number, review_id, message, event): Dismiss a review for a pull request
  • pulls.submit_review(owner, repo, pull_number, review_id, body, event): Submit a review for a pull request
  • pulls.update_branch(owner, repo, pull_number, expected_head_sha): Update a pull request branch

rate_limit

reactions

repos

secret_scanning

security_advisories

teams

users