GitHub

GitHub v3 REST API

GitHub's v3 REST API.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

GitHub's v3 REST API.

Endpoints 400

actions

  • GETGet GitHub Actions cache retention limit for an enterprise/enterprises/:enterprise/actions/cache/retention-limitGets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this enterprise may not set a higher cache retention…
  • PUTSet GitHub Actions cache retention limit for an enterprise/enterprises/:enterprise/actions/cache/retention-limitSets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this enterprise may not set a higher cache retention…
  • GETGet GitHub Actions cache storage limit for an enterprise/enterprises/:enterprise/actions/cache/storage-limitGets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this enterprise may not set a higher cache storage limit.…
  • PUTSet GitHub Actions cache storage limit for an enterprise/enterprises/:enterprise/actions/cache/storage-limitSets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this enterprise may not set a higher cache storage limit.…
  • GETGet GitHub Actions cache retention limit for an organization/organizations/:org/actions/cache/retention-limitGets GitHub Actions cache retention limit for an organization. All repositories under this organization may not set a higher cache retention limit. OAuth…
  • PUTSet GitHub Actions cache retention limit for an organization/organizations/:org/actions/cache/retention-limitSets GitHub Actions cache retention limit for an organization. All repositories under this organization may not set a higher cache retention limit. OAuth…
  • GETGet GitHub Actions cache storage limit for an organization/organizations/:org/actions/cache/storage-limitGets GitHub Actions cache storage limit for an organization. All repositories under this organization may not set a higher cache storage limit. OAuth tokens…
  • PUTSet GitHub Actions cache storage limit for an organization/organizations/:org/actions/cache/storage-limitSets GitHub Actions cache storage limit for an organization. All organizations and repositories under this organization may not set a higher cache storage…
  • GETGet GitHub Actions cache usage for an organization/orgs/:org/actions/cache/usageGets the total GitHub Actions cache usage for an organization. The data fetched using this API is refreshed approximately every 5 minutes, so values returned…
  • GETList repositories with GitHub Actions cache usage for an organization/orgs/:org/actions/cache/usage-by-repository?per_page=30&page=1Lists repositories and their GitHub Actions cache usage for an organization. The data fetched using this API is refreshed approximately every 5 minutes, so…
  • GETList GitHub-hosted runners for an organization/orgs/:org/actions/hosted-runners?per_page=30&page=1Lists all GitHub-hosted runners configured in an organization. OAuth app tokens and personal access tokens (classic) need the manage_runner:org scope to use…
  • POSTCreate a GitHub-hosted runner for an organization/orgs/:org/actions/hosted-runnersCreates a GitHub-hosted runner for an organization. OAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.
  • GETList custom images for an organization/orgs/:org/actions/hosted-runners/images/customList custom images for an organization. OAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.
  • GETGet a custom image definition for GitHub Actions Hosted Runners/orgs/:org/actions/hosted-runners/images/custom/:image_definition_idGet a custom image definition for GitHub Actions Hosted Runners. OAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use…
  • DELETEDelete a custom image from the organization/orgs/:org/actions/hosted-runners/images/custom/:image_definition_idDelete a custom image from the organization. OAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.
  • GETList image versions of a custom image for an organization/orgs/:org/actions/hosted-runners/images/custom/:image_definition_id/versionsList image versions of a custom image for an organization. OAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this…
  • GETGet an image version of a custom image for GitHub Actions Hosted Runners/orgs/:org/actions/hosted-runners/images/custom/:image_definition_id/versions/:versionGet an image version of a custom image for GitHub Actions Hosted Runners. OAuth tokens and personal access tokens (classic) need the manage_runners:org scope…
  • DELETEDelete an image version of custom image from the organization/orgs/:org/actions/hosted-runners/images/custom/:image_definition_id/versions/:versionDelete an image version of custom image from the organization. OAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this…
  • GETGet GitHub-owned images for GitHub-hosted runners in an organization/orgs/:org/actions/hosted-runners/images/github-ownedGet the list of GitHub-owned images available for GitHub-hosted runners for an organization.
  • GETGet partner images for GitHub-hosted runners in an organization/orgs/:org/actions/hosted-runners/images/partnerGet the list of partner images available for GitHub-hosted runners for an organization.
  • GETGet limits on GitHub-hosted runners for an organization/orgs/:org/actions/hosted-runners/limitsGet the GitHub-hosted runners limits for an organization.
  • GETGet GitHub-hosted runners machine specs for an organization/orgs/:org/actions/hosted-runners/machine-sizesGet the list of machine specs available for GitHub-hosted runners for an organization.
  • GETGet platforms for GitHub-hosted runners in an organization/orgs/:org/actions/hosted-runners/platformsGet the list of platforms available for GitHub-hosted runners for an organization.
  • GETGet a GitHub-hosted runner for an organization/orgs/:org/actions/hosted-runners/:hosted_runner_idGets a GitHub-hosted runner configured in an organization. OAuth app tokens and personal access tokens (classic) need the manage_runners:org scope to use this…
  • DELETEDelete a GitHub-hosted runner for an organization/orgs/:org/actions/hosted-runners/:hosted_runner_idDeletes a GitHub-hosted runner for an organization.
  • PATCHUpdate a GitHub-hosted runner for an organization/orgs/:org/actions/hosted-runners/:hosted_runner_idUpdates a GitHub-hosted runner for an organization. OAuth app tokens and personal access tokens (classic) need the manage_runners:org scope to use this…
  • GETGet GitHub Actions permissions for an organization/orgs/:org/actions/permissionsGets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. OAuth tokens and personal access…
  • PUTSet GitHub Actions permissions for an organization/orgs/:org/actions/permissionsSets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. OAuth app tokens and personal…
  • GETGet artifact and log retention settings for an organization/orgs/:org/actions/permissions/artifact-and-log-retentionGets retention settings for checks, workflow runs, commit statuses, artifacts, and logs for an organization. Checks include check suites, check runs, and…
  • PUTSet artifact and log retention settings for an organization/orgs/:org/actions/permissions/artifact-and-log-retentionSets retention settings for checks, workflow runs, commit statuses, artifacts, and logs for an organization. Checks include check suites, check runs, and…
  • GETGet fork PR contributor approval permissions for an organization/orgs/:org/actions/permissions/fork-pr-contributor-approvalGets the fork PR contributor approval policy for an organization. OAuth app tokens and personal access tokens (classic) need the admin:org scope or the…
  • PUTSet fork PR contributor approval permissions for an organization/orgs/:org/actions/permissions/fork-pr-contributor-approvalSets the fork PR contributor approval policy for an organization. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this…
  • GETGet private repo fork PR workflow settings for an organization/orgs/:org/actions/permissions/fork-pr-workflows-private-reposGets the settings for whether workflows from fork pull requests can run on private repositories in an organization.
  • PUTSet private repo fork PR workflow settings for an organization/orgs/:org/actions/permissions/fork-pr-workflows-private-reposSets the settings for whether workflows from fork pull requests can run on private repositories in an organization.
  • GETList selected repositories enabled for GitHub Actions in an organization/orgs/:org/actions/permissions/repositories?per_page=30&page=1Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for…
  • PUTSet selected repositories enabled for GitHub Actions in an organization/orgs/:org/actions/permissions/repositoriesReplaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy…
  • PUTEnable a selected repository for GitHub Actions in an organization/orgs/:org/actions/permissions/repositories/:repository_idAdds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization…
  • DELETEDisable a selected repository for GitHub Actions in an organization/orgs/:org/actions/permissions/repositories/:repository_idRemoves a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization…
  • GETGet allowed actions and reusable workflows for an organization/orgs/:org/actions/permissions/selected-actionsGets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for…
  • PUTSet allowed actions and reusable workflows for an organization/orgs/:org/actions/permissions/selected-actionsSets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must…
  • GETGet self-hosted runners settings for an organization/orgs/:org/actions/permissions/self-hosted-runnersGets the settings for self-hosted runners for an organization. OAuth app tokens and personal access tokens (classic) need the admin:org scope or the "Actions…
  • PUTSet self-hosted runners settings for an organization/orgs/:org/actions/permissions/self-hosted-runnersSets the settings for self-hosted runners for an organization. OAuth app tokens and personal access tokens (classic) need the admin:org scope or the "Actions…
  • GETList repositories allowed to use self-hosted runners in an organization/orgs/:org/actions/permissions/self-hosted-runners/repositories?per_page=30&page=1Lists repositories that are allowed to use self-hosted runners in an organization. OAuth app tokens and personal access tokens (classic) need the admin:org…
  • PUTSet repositories allowed to use self-hosted runners in an organization/orgs/:org/actions/permissions/self-hosted-runners/repositoriesSets repositories that are allowed to use self-hosted runners in an organization. OAuth app tokens and personal access tokens (classic) need the admin:org…
  • PUTAdd a repository to the list of repositories allowed to use self-hosted runners in an organization/orgs/:org/actions/permissions/self-hosted-runners/repositories/:repository_idAdds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. OAuth app tokens and personal access tokens…
  • DELETERemove a repository from the list of repositories allowed to use self-hosted runners in an organization/orgs/:org/actions/permissions/self-hosted-runners/repositories/:repository_idRemoves a repository from the list of repositories that are allowed to use self-hosted runners in an organization. OAuth app tokens and personal access tokens…
  • GETGet default workflow permissions for an organization/orgs/:org/actions/permissions/workflowGets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, as well as whether GitHub Actions can submit…
  • PUTSet default workflow permissions for an organization/orgs/:org/actions/permissions/workflowSets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, and sets if GitHub Actions can submit approving…
  • GETList organization Actions policies/orgs/:org/actions/policies?per_page=30&page=1&has_parents=trueList all Actions policies for an organization.
  • POSTCreate an organization Actions policy/orgs/:org/actions/policiesCreate an Actions policy for an organization. Omitting workflow_path targets all workflows without storing an explicit condition.
  • GETGet an organization Actions policy/orgs/:org/actions/policies/:policy_idGet a specific Actions policy for an organization.
  • PUTUpdate an organization Actions policy/orgs/:org/actions/policies/:policy_idUpdate an Actions policy for an organization. Omitting workflow_path preserves the policy's existing workflow targeting.
  • DELETEDelete an organization Actions policy/orgs/:org/actions/policies/:policy_idDelete an Actions policy for an organization.
  • GETList self-hosted runner groups for an organization/orgs/:org/actions/runner-groups?per_page=30&page=1&visible_to_repository=stringLists all self-hosted runner groups configured in an organization and inherited from an enterprise. OAuth app tokens and personal access tokens (classic) need…
  • POSTCreate a self-hosted runner group for an organization/orgs/:org/actions/runner-groupsCreates a new self-hosted runner group for an organization. OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
  • GETGet a self-hosted runner group for an organization/orgs/:org/actions/runner-groups/:runner_group_idGets a specific self-hosted runner group for an organization. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this…
  • DELETEDelete a self-hosted runner group from an organization/orgs/:org/actions/runner-groups/:runner_group_idDeletes a self-hosted runner group for an organization. OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
  • PATCHUpdate a self-hosted runner group for an organization/orgs/:org/actions/runner-groups/:runner_group_idUpdates the name and visibility of a self-hosted runner group in an organization. OAuth app tokens and personal access tokens (classic) need the admin:org…
  • GETList GitHub-hosted runners in a group for an organization/orgs/:org/actions/runner-groups/:runner_group_id/hosted-runners?per_page=30&page=1Lists the GitHub-hosted runners in an organization group. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
  • GETList repository access to a self-hosted runner group in an organization/orgs/:org/actions/runner-groups/:runner_group_id/repositories?page=1&per_page=30Lists the repositories with access to a self-hosted runner group configured in an organization. OAuth app tokens and personal access tokens (classic) need the…
  • PUTSet repository access for a self-hosted runner group in an organization/orgs/:org/actions/runner-groups/:runner_group_id/repositoriesReplaces the list of repositories that have access to a self-hosted runner group configured in an organization. OAuth app tokens and personal access tokens…
  • PUTAdd repository access to a self-hosted runner group in an organization/orgs/:org/actions/runner-groups/:runner_group_id/repositories/:repository_idAdds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more…
  • DELETERemove repository access to a self-hosted runner group in an organization/orgs/:org/actions/runner-groups/:runner_group_id/repositories/:repository_idRemoves a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected.…
  • GETList self-hosted runners in a group for an organization/orgs/:org/actions/runner-groups/:runner_group_id/runners?per_page=30&page=1Lists self-hosted runners that are in a specific organization group. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use…
  • PUTSet self-hosted runners in a group for an organization/orgs/:org/actions/runner-groups/:runner_group_id/runnersReplaces the list of self-hosted runners that are part of an organization runner group. OAuth app tokens and personal access tokens (classic) need the…
  • PUTAdd a self-hosted runner to a group for an organization/orgs/:org/actions/runner-groups/:runner_group_id/runners/:runner_idAdds a self-hosted runner to a runner group configured in an organization. OAuth tokens and personal access tokens (classic) need the admin:org scope to use…
  • DELETERemove a self-hosted runner from a group for an organization/orgs/:org/actions/runner-groups/:runner_group_id/runners/:runner_idRemoves a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. OAuth app tokens and personal…
  • GETList self-hosted runners for an organization/orgs/:org/actions/runners?name=string&per_page=30&page=1Lists all self-hosted runners configured in an organization. Authenticated users must have admin access to the organization to use this endpoint. OAuth app…
  • GETGet runner version end-of-life schedule for an organization/orgs/:org/actions/runners/deprecations/:versionGets the end-of-life schedule for a specific runner version in an organization. Returns the runner version and the dates when registration and runtime support…
  • GETList runner applications for an organization/orgs/:org/actions/runners/downloadsLists binaries for the runner application that you can download and run. Authenticated users must have admin access to the organization to use this endpoint.…
  • POSTCreate configuration for a just-in-time runner for an organization/orgs/:org/actions/runners/generate-jitconfigGenerates a configuration that can be passed to the runner application at startup. The authenticated user must have admin access to the organization. OAuth…
  • POSTCreate a registration token for an organization/orgs/:org/actions/runners/registration-tokenReturns a token that you can pass to the config script. The token expires after one hour. For example, you can replace TOKEN in the following example with the…
  • POSTCreate a remove token for an organization/orgs/:org/actions/runners/remove-tokenReturns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour. For example, you…
  • GETGet a self-hosted runner for an organization/orgs/:org/actions/runners/:runner_idGets a specific self-hosted runner configured in an organization. Authenticated users must have admin access to the organization to use this endpoint. OAuth…
  • DELETEDelete a self-hosted runner from an organization/orgs/:org/actions/runners/:runner_idForces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no…
  • GETList labels for a self-hosted runner for an organization/orgs/:org/actions/runners/:runner_id/labelsLists all labels for a self-hosted runner configured in an organization. Authenticated users must have admin access to the organization to use this endpoint.…
  • PUTSet custom labels for a self-hosted runner for an organization/orgs/:org/actions/runners/:runner_id/labelsRemove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an organization. Authenticated users must have…
  • POSTAdd custom labels to a self-hosted runner for an organization/orgs/:org/actions/runners/:runner_id/labelsAdds custom labels to a self-hosted runner configured in an organization. Authenticated users must have admin access to the organization to use this endpoint.…
  • DELETERemove all custom labels from a self-hosted runner for an organization/orgs/:org/actions/runners/:runner_id/labelsRemove all custom labels from a self-hosted runner configured in an organization. Returns the remaining read-only labels from the runner. Authenticated users…
  • DELETERemove a custom label from a self-hosted runner for an organization/orgs/:org/actions/runners/:runner_id/labels/:nameRemove a custom label from a self-hosted runner configured in an organization. Returns the remaining labels from the runner. This endpoint returns a 404 Not…
  • GETList organization secrets/orgs/:org/actions/secrets?per_page=30&page=1Lists all secrets available in an organization without revealing their encrypted values. Authenticated users must have collaborator access to a repository to…
  • GETGet an organization public key/orgs/:org/actions/secrets/public-keyGets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. The authenticated user must…
  • GETGet an organization secret/orgs/:org/actions/secrets/:secret_nameGets a single organization secret without revealing its encrypted value. The authenticated user must have collaborator access to a repository to create,…
  • PUTCreate or update an organization secret/orgs/:org/actions/secrets/:secret_nameCreates or updates an organization secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the…
  • DELETEDelete an organization secret/orgs/:org/actions/secrets/:secret_nameDeletes a secret in an organization using the secret name. Authenticated users must have collaborator access to a repository to create, update, or read…
  • GETList selected repositories for an organization secret/orgs/:org/actions/secrets/:secret_name/repositories?page=1&per_page=30Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected. Authenticated users must have…
  • PUTSet selected repositories for an organization secret/orgs/:org/actions/secrets/:secret_name/repositoriesReplaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or…
  • PUTAdd selected repository to an organization secret/orgs/:org/actions/secrets/:secret_name/repositories/:repository_idAdds a repository to an organization secret when the visibility for repository access is set to selected. For more information about setting the visibility,…
  • DELETERemove selected repository from an organization secret/orgs/:org/actions/secrets/:secret_name/repositories/:repository_idRemoves a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update…
  • GETList organization variables/orgs/:org/actions/variables?per_page=10&page=1Lists all organization variables. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and…
  • POSTCreate an organization variable/orgs/:org/actions/variablesCreates an organization variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to…
  • GETGet an organization variable/orgs/:org/actions/variables/:nameGets a specific variable in an organization. The authenticated user must have collaborator access to a repository to create, update, or read variables. OAuth…
  • DELETEDelete an organization variable/orgs/:org/actions/variables/:nameDeletes an organization variable using the variable name. Authenticated users must have collaborator access to a repository to create, update, or read…
  • PATCHUpdate an organization variable/orgs/:org/actions/variables/:nameUpdates an organization variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to…
  • GETList selected repositories for an organization variable/orgs/:org/actions/variables/:name/repositories?page=1&per_page=30Lists all repositories that can access an organization variable that is available to selected repositories. Authenticated users must have collaborator access…
  • PUTSet selected repositories for an organization variable/orgs/:org/actions/variables/:name/repositoriesReplaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected…
  • PUTAdd selected repository to an organization variable/orgs/:org/actions/variables/:name/repositories/:repository_idAdds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories…
  • DELETERemove selected repository from an organization variable/orgs/:org/actions/variables/:name/repositories/:repository_idRemoves a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected…
  • GETList artifacts for a repository/repos/:owner/:repo/actions/artifacts?per_page=30&page=1&name=stringLists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic)…
  • GETGet an artifact/repos/:owner/:repo/actions/artifacts/:artifact_idGets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and…
  • DELETEDelete an artifact/repos/:owner/:repo/actions/artifacts/:artifact_idDeletes an artifact for a workflow run. OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
  • GETDownload an artifact/repos/:owner/:repo/actions/artifacts/:artifact_id/:archive_formatGets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in the response header to find the URL for…
  • GETGet GitHub Actions cache retention limit for a repository/repos/:owner/:repo/actions/cache/retention-limitGets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if not manually removed or evicted due to…
  • PUTSet GitHub Actions cache retention limit for a repository/repos/:owner/:repo/actions/cache/retention-limitSets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if not manually removed or evicted due to…
  • GETGet GitHub Actions cache storage limit for a repository/repos/:owner/:repo/actions/cache/storage-limitGets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be stored before eviction occurs. OAuth tokens…
  • PUTSet GitHub Actions cache storage limit for a repository/repos/:owner/:repo/actions/cache/storage-limitSets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be stored before eviction occurs. OAuth tokens…
  • GETGet GitHub Actions cache usage for a repository/repos/:owner/:repo/actions/cache/usageGets GitHub Actions cache usage for a repository. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this…
  • GETList GitHub Actions caches for a repository/repos/:owner/:repo/actions/caches?per_page=30&page=1&ref=string&key=string&sort=last_accessed_at&direction=descLists the GitHub Actions caches for a repository. OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
  • DELETEDelete GitHub Actions caches for a repository (using a cache key)/repos/:owner/:repo/actions/caches?key=string&ref=stringDeletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but…
  • DELETEDelete a GitHub Actions cache for a repository (using a cache ID)/repos/:owner/:repo/actions/caches/:cache_idDeletes a GitHub Actions cache for a repository, using a cache ID. OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
  • GETList concurrency groups for a repository/repos/:owner/:repo/actions/concurrency_groups?per_page=30&after=stringLists the active concurrency groups for a repository. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a…
  • GETGet a concurrency group for a repository/repos/:owner/:repo/actions/concurrency_groups/:concurrency_group_name?ahead_of_run=1&ahead_of_job=1Gets a specific concurrency group for a repository, including all instances in the group's queue. Returns 404 if the group is inactive or does not exist.…
  • GETGet a job for a workflow run/repos/:owner/:repo/actions/jobs/:job_idGets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and…
  • GETDownload job logs for a workflow run/repos/:owner/:repo/actions/jobs/:job_id/logsGets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look for Location: in the response header to…
  • POSTRe-run a job from a workflow run/repos/:owner/:repo/actions/jobs/:job_id/rerunRe-run a job and its dependent jobs in a workflow run. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
  • GETDownload step logs for a workflow run job/repos/:owner/:repo/actions/jobs/:job_id/steps/:step_number/logsGets a redirect URL to download a plain text file of logs for a specific step of a workflow job. This link expires after 1 minute. Look for Location: in the…
  • GETGet the customization template for an OIDC subject claim for a repository/repos/:owner/:repo/actions/oidc/customization/subGets the customization template for an OpenID Connect (OIDC) subject claim. OAuth tokens and personal access tokens (classic) need the repo scope to use this…
  • PUTSet the customization template for an OIDC subject claim for a repository/repos/:owner/:repo/actions/oidc/customization/subSets the customization template and opt-in or opt-out flag for an OpenID Connect (OIDC) subject claim for a repository. OAuth app tokens and personal access…
  • GETList repository organization secrets/repos/:owner/:repo/actions/organization-secrets?per_page=30&page=1Lists all organization secrets shared with a repository without revealing their encrypted values. Authenticated users must have collaborator access to a…
  • GETList repository organization variables/repos/:owner/:repo/actions/organization-variables?per_page=10&page=1Lists all organization variables shared with a repository. Authenticated users must have collaborator access to a repository to create, update, or read…
  • GETGet GitHub Actions permissions for a repository/repos/:owner/:repo/actions/permissionsGets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run…
  • PUTSet GitHub Actions permissions for a repository/repos/:owner/:repo/actions/permissionsSets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. OAuth app tokens and…
  • GETGet the level of access for workflows outside of the repository/repos/:owner/:repo/actions/permissions/accessGets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to…
  • PUTSet the level of access for workflows outside of the repository/repos/:owner/:repo/actions/permissions/accessSets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to…
  • GETGet artifact and log retention settings for a repository/repos/:owner/:repo/actions/permissions/artifact-and-log-retentionGets retention settings for checks, workflow runs, commit statuses, artifacts, and logs for a repository. Checks include check suites, check runs, and check…
  • PUTSet artifact and log retention settings for a repository/repos/:owner/:repo/actions/permissions/artifact-and-log-retentionSets retention settings for checks, workflow runs, commit statuses, artifacts, and logs for a repository. Checks include check suites, check runs, and check…
  • GETGet fork PR contributor approval permissions for a repository/repos/:owner/:repo/actions/permissions/fork-pr-contributor-approvalGets the fork PR contributor approval policy for a repository. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
  • PUTSet fork PR contributor approval permissions for a repository/repos/:owner/:repo/actions/permissions/fork-pr-contributor-approvalSets the fork PR contributor approval policy for a repository. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
  • GETGet private repo fork PR workflow settings for a repository/repos/:owner/:repo/actions/permissions/fork-pr-workflows-private-reposGets the settings for whether workflows from fork pull requests can run on a private repository. OAuth app tokens and personal access tokens (classic) need…
  • PUTSet private repo fork PR workflow settings for a repository/repos/:owner/:repo/actions/permissions/fork-pr-workflows-private-reposSets the settings for whether workflows from fork pull requests can run on a private repository. OAuth app tokens and personal access tokens (classic) need…
  • GETGet allowed actions and reusable workflows for a repository/repos/:owner/:repo/actions/permissions/selected-actionsGets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for…
  • PUTSet allowed actions and reusable workflows for a repository/repos/:owner/:repo/actions/permissions/selected-actionsSets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be…
  • GETGet default workflow permissions for a repository/repos/:owner/:repo/actions/permissions/workflowGets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, as well as if GitHub Actions can submit approving…
  • PUTSet default workflow permissions for a repository/repos/:owner/:repo/actions/permissions/workflowSets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, and sets if GitHub Actions can submit approving pull…
  • GETList repository Actions policies/repos/:owner/:repo/actions/policies?per_page=30&page=1&has_parents=trueList all Actions policies for a repository.
  • POSTCreate a repository Actions policy/repos/:owner/:repo/actions/policiesCreate an Actions policy for a repository. Omitting workflow_path targets all workflows without storing an explicit condition.
  • GETGet a repository Actions policy/repos/:owner/:repo/actions/policies/:policy_idGet a specific Actions policy for a repository.
  • PUTUpdate a repository Actions policy/repos/:owner/:repo/actions/policies/:policy_idUpdate an Actions policy for a repository. Omitting workflow_path preserves the policy's existing workflow targeting.
  • DELETEDelete a repository Actions policy/repos/:owner/:repo/actions/policies/:policy_idDelete an Actions policy for a repository.
  • GETList self-hosted runners for a repository/repos/:owner/:repo/actions/runners?name=string&per_page=30&page=1Lists all self-hosted runners configured in a repository. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens…
  • GETGet runner version end-of-life schedule for a repository/repos/:owner/:repo/actions/runners/deprecations/:versionGets the end-of-life schedule for a specific runner version in a repository. Returns the runner version and the dates when registration and runtime support…
  • GETList runner applications for a repository/repos/:owner/:repo/actions/runners/downloadsLists binaries for the runner application that you can download and run. Authenticated users must have admin access to the repository to use this endpoint.…
  • POSTCreate configuration for a just-in-time runner for a repository/repos/:owner/:repo/actions/runners/generate-jitconfigGenerates a configuration that can be passed to the runner application at startup. The authenticated user must have admin access to the repository. OAuth…
  • POSTCreate a registration token for a repository/repos/:owner/:repo/actions/runners/registration-tokenReturns a token that you can pass to the config script. The token expires after one hour. For example, you can replace TOKEN in the following example with the…
  • POSTCreate a remove token for a repository/repos/:owner/:repo/actions/runners/remove-tokenReturns a token that you can pass to the config script to remove a self-hosted runner from an repository. The token expires after one hour. For example, you…
  • GETGet a self-hosted runner for a repository/repos/:owner/:repo/actions/runners/:runner_idGets a specific self-hosted runner configured in a repository. Authenticated users must have admin access to the repository to use this endpoint. OAuth app…
  • DELETEDelete a self-hosted runner from a repository/repos/:owner/:repo/actions/runners/:runner_idForces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no…
  • GETList labels for a self-hosted runner for a repository/repos/:owner/:repo/actions/runners/:runner_id/labelsLists all labels for a self-hosted runner configured in a repository. Authenticated users must have admin access to the repository to use this endpoint. OAuth…
  • PUTSet custom labels for a self-hosted runner for a repository/repos/:owner/:repo/actions/runners/:runner_id/labelsRemove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in a repository. Authenticated users must have…
  • POSTAdd custom labels to a self-hosted runner for a repository/repos/:owner/:repo/actions/runners/:runner_id/labelsAdds custom labels to a self-hosted runner configured in a repository. Authenticated users must have admin access to the organization to use this endpoint.…
  • DELETERemove all custom labels from a self-hosted runner for a repository/repos/:owner/:repo/actions/runners/:runner_id/labelsRemove all custom labels from a self-hosted runner configured in a repository. Returns the remaining read-only labels from the runner. Authenticated users…
  • DELETERemove a custom label from a self-hosted runner for a repository/repos/:owner/:repo/actions/runners/:runner_id/labels/:nameRemove a custom label from a self-hosted runner configured in a repository. Returns the remaining labels from the runner. This endpoint returns a 404 Not…
  • GETList workflow runs for a repository/repos/:owner/:repo/actions/runs?actor=string&branch=string&event=string&status=completed&per_page=30&page=1&created=2024-01-01T00:00:00Z&exclude_pull_requests=false&check_suite_id=0&head_sha=stringLists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.…
  • GETGet a workflow run/repos/:owner/:repo/actions/runs/:run_id?exclude_pull_requests=falseGets a specific workflow run. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the…
  • DELETEDelete a workflow run/repos/:owner/:repo/actions/runs/:run_idDeletes a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal…
  • GETGet the review history for a workflow run/repos/:owner/:repo/actions/runs/:run_id/approvalsAnyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the repo scope to use this…
  • POSTApprove a workflow run for a fork pull request/repos/:owner/:repo/actions/runs/:run_id/approveApproves a workflow run for a pull request from a public fork of a first time contributor. For more information, see "Approving workflow runs from public…
  • GETList workflow run artifacts/repos/:owner/:repo/actions/runs/:run_id/artifacts?per_page=30&page=1&name=string&direction=descLists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic)…
  • GETGet a workflow run attempt/repos/:owner/:repo/actions/runs/:run_id/attempts/:attempt_number?exclude_pull_requests=falseGets a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic)…
  • GETList jobs for a workflow run attempt/repos/:owner/:repo/actions/runs/:run_id/attempts/:attempt_number/jobs?per_page=30&page=1Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information about using parameters, see…
  • GETDownload workflow run attempt logs/repos/:owner/:repo/actions/runs/:run_id/attempts/:attempt_number/logsGets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after 1 minute. Look for Location: in the…
  • POSTCancel a workflow run/repos/:owner/:repo/actions/runs/:run_id/cancelCancels a workflow run using its id. OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
  • GETList concurrency groups for a workflow run/repos/:owner/:repo/actions/runs/:run_id/concurrency_groups?per_page=30&before=string&after=stringLists all concurrency groups associated with a workflow run or its jobs. The set of groups is derived from the run's configuration, so a group is included…
  • POSTReview custom deployment protection rules for a workflow run/repos/:owner/:repo/actions/runs/:run_id/deployment_protection_ruleApprove or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "Using environments for…
  • POSTForce cancel a workflow run/repos/:owner/:repo/actions/runs/:run_id/force-cancelCancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an always() condition on a job. You should…
  • GETList jobs for a workflow run/repos/:owner/:repo/actions/runs/:run_id/jobs?filter=latest&per_page=30&page=1Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters. Anyone with…
  • GETDownload workflow run logs/repos/:owner/:repo/actions/runs/:run_id/logsGets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for Location: in the response header to…
  • DELETEDelete workflow run logs/repos/:owner/:repo/actions/runs/:run_id/logsDeletes all logs for a workflow run. OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
  • GETGet pending deployments for a workflow run/repos/:owner/:repo/actions/runs/:run_id/pending_deploymentsGet all deployment environments for a workflow run that are waiting for protection rules to pass. Anyone with read access to the repository can use this…
  • POSTReview pending deployments for a workflow run/repos/:owner/:repo/actions/runs/:run_id/pending_deploymentsApprove or reject pending deployments that are waiting on approval by a required reviewer. Required reviewers with read access to the repository contents and…
  • POSTRe-run a workflow/repos/:owner/:repo/actions/runs/:run_id/rerunRe-runs your workflow run using its id. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
  • POSTRe-run failed jobs from a workflow run/repos/:owner/:repo/actions/runs/:run_id/rerun-failed-jobsRe-run all of the failed jobs and their dependent jobs in a workflow run using the id of the workflow run. OAuth app tokens and personal access tokens…
  • GETGet workflow run usage/repos/:owner/:repo/actions/runs/:run_id/timing> [!WARNING] > This endpoint is in the process of closing down. Refer to "Actions Get workflow usage and Get workflow run usage endpoints closing down" for…
  • GETList repository secrets/repos/:owner/:repo/actions/secrets?per_page=30&page=1Lists all secrets available in a repository without revealing their encrypted values. Authenticated users must have collaborator access to a repository to…
  • GETGet a repository public key/repos/:owner/:repo/actions/secrets/public-keyGets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the…
  • GETGet a repository secret/repos/:owner/:repo/actions/secrets/:secret_nameGets a single repository secret without revealing its encrypted value. The authenticated user must have collaborator access to the repository to use this…
  • PUTCreate or update a repository secret/repos/:owner/:repo/actions/secrets/:secret_nameCreates or updates a repository secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the…
  • DELETEDelete a repository secret/repos/:owner/:repo/actions/secrets/:secret_nameDeletes a secret in a repository using the secret name. Authenticated users must have collaborator access to a repository to create, update, or read secrets.…
  • GETList repository variables/repos/:owner/:repo/actions/variables?per_page=10&page=1Lists all repository variables. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and…
  • POSTCreate a repository variable/repos/:owner/:repo/actions/variablesCreates a repository variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to…
  • GETGet a repository variable/repos/:owner/:repo/actions/variables/:nameGets a specific variable in a repository. The authenticated user must have collaborator access to the repository to use this endpoint. OAuth app tokens and…
  • DELETEDelete a repository variable/repos/:owner/:repo/actions/variables/:nameDeletes a repository variable using the variable name. Authenticated users must have collaborator access to a repository to create, update, or read variables.…
  • PATCHUpdate a repository variable/repos/:owner/:repo/actions/variables/:nameUpdates a repository variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to…
  • GETList repository workflows/repos/:owner/:repo/actions/workflows?per_page=30&page=1Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic)…
  • GETGet a workflow/repos/:owner/:repo/actions/workflows/:workflow_idGets a specific workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. Anyone with read access to the…
  • PUTDisable a workflow/repos/:owner/:repo/actions/workflows/:workflow_id/disableDisables a workflow and sets the state of the workflow to disabled_manually. You can replace workflow_id with the workflow file name. For example, you could…
  • POSTCreate a workflow dispatch event/repos/:owner/:repo/actions/workflows/:workflow_id/dispatchesYou can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could…
  • PUTEnable a workflow/repos/:owner/:repo/actions/workflows/:workflow_id/enableEnables a workflow and sets the state of the workflow to active. You can replace workflow_id with the workflow file name. For example, you could use…
  • GETList workflow runs for a workflow/repos/:owner/:repo/actions/workflows/:workflow_id/runs?actor=string&branch=string&event=string&status=completed&per_page=30&page=1&created=2024-01-01T00:00:00Z&exclude_pull_requests=false&check_suite_id=0&head_sha=stringList all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters…
  • GETGet workflow usage/repos/:owner/:repo/actions/workflows/:workflow_id/timing> [!WARNING] > This endpoint is in the process of closing down. Refer to "Actions Get workflow usage and Get workflow run usage endpoints closing down" for…
  • GETList environment secrets/repos/:owner/:repo/environments/:environment_name/secrets?per_page=30&page=1Lists all secrets available in an environment without revealing their encrypted values. Authenticated users must have collaborator access to a repository to…
  • GETGet an environment public key/repos/:owner/:repo/environments/:environment_name/secrets/public-keyGet the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets.…
  • GETGet an environment secret/repos/:owner/:repo/environments/:environment_name/secrets/:secret_nameGets a single environment secret without revealing its encrypted value. Authenticated users must have collaborator access to a repository to create, update,…
  • PUTCreate or update an environment secret/repos/:owner/:repo/environments/:environment_name/secrets/:secret_nameCreates or updates an environment secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the…
  • DELETEDelete an environment secret/repos/:owner/:repo/environments/:environment_name/secrets/:secret_nameDeletes a secret in an environment using the secret name. Authenticated users must have collaborator access to a repository to create, update, or read…
  • GETList environment variables/repos/:owner/:repo/environments/:environment_name/variables?per_page=10&page=1Lists all environment variables. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and…
  • POSTCreate an environment variable/repos/:owner/:repo/environments/:environment_name/variablesCreate an environment variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to…
  • GETGet an environment variable/repos/:owner/:repo/environments/:environment_name/variables/:nameGets a specific variable in an environment. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth…
  • DELETEDelete an environment variable/repos/:owner/:repo/environments/:environment_name/variables/:nameDeletes an environment variable using the variable name. Authenticated users must have collaborator access to a repository to create, update, or read…
  • PATCHUpdate an environment variable/repos/:owner/:repo/environments/:environment_name/variables/:nameUpdates an environment variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to…

activity

  • GETList public events/events?per_page=15&page=1> [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
  • GETGet feeds/feedsLists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one…
  • GETList public events for a network of repositories/networks/:owner/:repo/events?per_page=30&page=1> [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
  • GETList notifications for the authenticated user/notifications?all=false&is_done=true&participating=false&since=2024-01-01T00:00:00Z&before=2024-01-01T00:00:00Z&page=1&per_page=50List all notifications for the current user, sorted by most recently updated.
  • PUTMark notifications as read/notificationsMarks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a 202…
  • GETGet a thread/notifications/threads/:thread_idGets information about a notification thread.
  • DELETEMark a thread as done/notifications/threads/:thread_idMarks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done:…
  • PATCHMark a thread as read/notifications/threads/:thread_idMarks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub:…
  • GETGet a thread subscription for the authenticated user/notifications/threads/:thread_id/subscriptionThis checks to see if the current user is subscribed to a thread. You can also get a repository subscription. Note that subscriptions are only generated if a…
  • PUTSet a thread subscription/notifications/threads/:thread_id/subscriptionIf you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you…
  • DELETEDelete a thread subscription/notifications/threads/:thread_id/subscriptionMutes all future notifications for a conversation until you comment on the thread or get an @mention. If you are watching the repository of the thread, you…
  • GETList public organization events/orgs/:org/events?per_page=30&page=1> [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
  • GETList repository events/repos/:owner/:repo/events?per_page=30&page=1> [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
  • GETList repository notifications for the authenticated user/repos/:owner/:repo/notifications?all=false&is_done=true&participating=false&since=2024-01-01T00:00:00Z&before=2024-01-01T00:00:00Z&per_page=30&page=1Lists all notifications for the current user in the specified repository.
  • PUTMark repository notifications as read/repos/:owner/:repo/notificationsMarks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will…
  • GETList stargazers/repos/:owner/:repo/stargazers?per_page=30&page=1Lists the people that have starred the repository. This endpoint supports the following custom media types. For more information, see "Media types."…
  • GETGet stargazer count/repos/:owner/:repo/stargazers/countGets the current number of users who have starred the repository. Users who previously starred the repository but later removed their star are not included.
  • GETGet repository star history/repos/:owner/:repo/stargazers/history?per_page=30&page=1Returns repository stars grouped by calendar weeks, most recent first. Pages move backward toward the repository's creation week, and weeks within a page are…
  • GETList watchers/repos/:owner/:repo/subscribers?per_page=30&page=1Lists the people watching the specified repository.
  • GETGet a repository subscription/repos/:owner/:repo/subscriptionGets information about whether the authenticated user is subscribed to the repository.
  • PUTSet a repository subscription/repos/:owner/:repo/subscriptionIf you would like to watch a repository, set subscribed to true. If you would like to ignore notifications made within a repository, set ignored to true. If…
  • DELETEDelete a repository subscription/repos/:owner/:repo/subscriptionThis endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the…
  • GETList repositories starred by the authenticated user/user/starred?sort=created&direction=desc&per_page=30&page=1Lists repositories the authenticated user has starred. This endpoint supports the following custom media types. For more information, see "Media types."…
  • GETCheck if a repository is starred by the authenticated user/user/starred/:owner/:repoWhether the authenticated user has starred the repository.
  • PUTStar a repository for the authenticated user/user/starred/:owner/:repoNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP method."
  • DELETEUnstar a repository for the authenticated user/user/starred/:owner/:repoUnstar a repository that the authenticated user has previously starred.
  • GETList repositories watched by the authenticated user/user/subscriptions?per_page=30&page=1Lists repositories the authenticated user is watching.
  • GETList events for the authenticated user/users/:username/events?per_page=30&page=1If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token…
  • GETList organization events for the authenticated user/users/:username/events/orgs/:org?per_page=30&page=1This is the user's organization dashboard. You must be authenticated as the user to view this. > [!NOTE] > This API is not built to serve real-time use cases.…
  • GETList public events for a user/users/:username/events/public?per_page=30&page=1> [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
  • GETList events received by the authenticated user/users/:username/received_events?per_page=30&page=1These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events.…
  • GETList public events received by a user/users/:username/received_events/public?per_page=30&page=1> [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
  • GETList repositories starred by a user/users/:username/starred?sort=created&direction=desc&per_page=30&page=1Lists repositories a user has starred. If the specified user has a private profile, this endpoint returns an empty list unless the request is authenticated as…
  • GETList repositories watched by a user/users/:username/subscriptions?per_page=30&page=1Lists repositories a user is watching.

apps

  • GETGet the authenticated app/appReturns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the…
  • POSTCreate a GitHub App from a manifest/app-manifests/:code/conversionsUse this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. When you create a GitHub App with the manifest flow, you…
  • GETGet a webhook configuration for an app/app/hook/configReturns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "Creating a GitHub App." You must use a…
  • PATCHUpdate a webhook configuration for an app/app/hook/configUpdates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "Creating a GitHub App." You must use a…
  • GETList deliveries for an app webhook/app/hook/deliveries?per_page=30&cursor=string&status=successReturns a list of webhook deliveries for the webhook configured for a GitHub App. You must use a JWT to access this endpoint.
  • GETGet a delivery for an app webhook/app/hook/deliveries/:delivery_idReturns a delivery for the webhook configured for a GitHub App. You must use a JWT to access this endpoint.
  • POSTRedeliver a delivery for an app webhook/app/hook/deliveries/:delivery_id/attemptsRedeliver a delivery for the webhook configured for a GitHub App. You must use a JWT to access this endpoint.
  • GETList installation requests for the authenticated app/app/installation-requests?per_page=30&page=1Lists all the pending installation requests for the authenticated GitHub App.
  • GETList installations for the authenticated app/app/installations?per_page=30&page=1&since=2024-01-01T00:00:00Z&outdated=stringThe permissions the installation has are included under the permissions key. You must use a JWT to access this endpoint.
  • GETGet an installation for the authenticated app/app/installations/:installation_idEnables an authenticated GitHub App to find an installation's information using the installation id. You must use a JWT to access this endpoint.
  • DELETEDelete an installation for the authenticated app/app/installations/:installation_idUninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then…
  • POSTCreate an installation access token for an app/app/installations/:installation_id/access_tokensCreates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual…
  • PUTSuspend an app installation/app/installations/:installation_id/suspendedSuspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is…
  • DELETEUnsuspend an app installation/app/installations/:installation_id/suspendedRemoves a GitHub App installation suspension. You must use a JWT to access this endpoint.
  • DELETEDelete an app authorization/applications/:client_id/grantOAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth access_token as an input…
  • POSTCheck a token/applications/:client_id/tokenOAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal…
  • DELETEDelete an app token/applications/:client_id/tokenOAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.
  • PATCHReset a token/applications/:client_id/tokenOAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement.…
  • POSTCreate a scoped access token/applications/:client_id/token/scopedUse a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify which repositories the token can…
  • GETGet an app/apps/:app_slug> [!NOTE] > The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g.,…
  • GETList repositories accessible to the app installation/installation/repositories?per_page=30&page=1List repositories that an app installation can access.
  • DELETERevoke an installation access token/installation/tokenRevokes the installation token you're using to authenticate as an installation and access this endpoint. Once an installation token is revoked, the token is…
  • GETGet a subscription plan for an account/marketplace_listing/accounts/:account_idShows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that…
  • GETList plans/marketplace_listing/plans?per_page=30&page=1Lists all plans that are part of your GitHub Marketplace listing. GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication…
  • GETList accounts for a plan/marketplace_listing/plans/:plan_id/accounts?sort=created&direction=asc&per_page=30&page=1Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have…
  • GETGet a subscription plan for an account (stubbed)/marketplace_listing/stubbed/accounts/:account_idShows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that…
  • GETList plans (stubbed)/marketplace_listing/stubbed/plans?per_page=30&page=1Lists all plans that are part of your GitHub Marketplace listing. GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication…
  • GETList accounts for a plan (stubbed)/marketplace_listing/stubbed/plans/:plan_id/accounts?sort=created&direction=asc&per_page=30&page=1Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that…
  • GETGet an organization installation for the authenticated app/orgs/:org/installationEnables an authenticated GitHub App to find the organization's installation information. You must use a JWT to access this endpoint.
  • GETGet a repository installation for the authenticated app/repos/:owner/:repo/installationEnables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a…
  • GETList app installations accessible to the user access token/user/installations?per_page=30&page=1Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access. The authenticated user has…
  • GETList repositories accessible to the user access token/user/installations/:installation_id/repositories?per_page=30&page=1List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation. The authenticated user has…
  • PUTAdd a repository to an app installation/user/installations/:installation_id/repositories/:repository_idAdd a single repository to an installation. The authenticated user must have admin access to the repository.
  • DELETERemove a repository from an app installation/user/installations/:installation_id/repositories/:repository_idRemove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the…
  • GETList subscriptions for the authenticated user/user/marketplace_purchases?per_page=30&page=1Lists the active subscriptions for the authenticated user.
  • GETList subscriptions for the authenticated user (stubbed)/user/marketplace_purchases/stubbed?per_page=30&page=1Lists the active subscriptions for the authenticated user.
  • GETGet a user installation for the authenticated app/users/:username/installationEnables an authenticated GitHub App to find the user’s installation information. You must use a JWT to access this endpoint.

billing

  • GETGet billing AI credit usage report for an organization/organizations/:org/settings/billing/ai_credit/usage?year=0&month=0&day=0&user=string&model=string&product=stringGets a report of AI credit usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an…
  • GETGet all budgets for an organization/organizations/:org/settings/billing/budgets?page=1&per_page=10&scope=enterprise&user=stringGets all budgets for an organization. The authenticated user must be an organization admin or billing manager. Each page returns up to 100 budgets.
  • POSTCreate a budget for an organization/organizations/:org/settings/billing/budgetsCreates a new budget for an organization. The authenticated user must be an organization admin or billing manager.
  • GETGet a budget by ID for an organization/organizations/:org/settings/billing/budgets/:budget_idGets a budget by ID. The authenticated user must be an organization admin or billing manager.
  • DELETEDelete a budget for an organization/organizations/:org/settings/billing/budgets/:budget_idDeletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.
  • PATCHUpdate a budget for an organization/organizations/:org/settings/billing/budgets/:budget_idUpdates an existing budget for an organization. The authenticated user must be an organization admin or billing manager.
  • GETGet billing premium request usage report for an organization/organizations/:org/settings/billing/premium_request/usage?year=0&month=0&day=0&user=string&model=string&product=stringGets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an…
  • GETGet billing usage report for an organization/organizations/:org/settings/billing/usage?year=0&month=0&day=0Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an…
  • GETGet billing usage summary for an organization/organizations/:org/settings/billing/usage/summary?year=0&month=0&day=0&repository=string&product=string&sku=string> [!NOTE] > This endpoint is in public preview and is subject to change. Gets a summary report of usage for an organization. To use this endpoint, you must be…
  • GETGet billing AI credit usage report for a user/users/:username/settings/billing/ai_credit/usage?year=0&month=0&day=0&model=string&product=stringGets a report of AI credit usage for a user. Note: Only data from the past 24 months is accessible via this endpoint.
  • GETGet billing premium request usage report for a user/users/:username/settings/billing/premium_request/usage?year=0&month=0&day=0&model=string&product=stringGets a report of premium request usage for a user. Note: Only data from the past 24 months is accessible via this endpoint.
  • GETGet billing usage report for a user/users/:username/settings/billing/usage?year=0&month=0&day=0Gets a report of the total usage for a user. Note: This endpoint is only available to users with access to the enhanced billing platform.
  • GETGet billing usage summary for a user/users/:username/settings/billing/usage/summary?year=0&month=0&day=0&repository=string&product=string&sku=string> [!NOTE] > This endpoint is in public preview and is subject to change. Gets a summary report of usage for a user. Note: Only data from the past 24 months is…

checks

  • POSTCreate a check run/repos/:owner/:repo/check-runsCreates a new check run for a specific commit in a repository. To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not…
  • GETGet a check run/repos/:owner/:repo/check-runs/:check_run_idGets a single check run using its id. > [!NOTE] > The Checks API only looks for pushes in the repository where the check suite or check run were created.…
  • PATCHUpdate a check run/repos/:owner/:repo/check-runs/:check_run_idUpdates a check run for a specific commit in a repository. > [!NOTE] > The endpoints to manage checks only look for pushes in the repository where the check…
  • GETList check run annotations/repos/:owner/:repo/check-runs/:check_run_id/annotations?per_page=30&page=1Lists annotations for a check run using the annotation id. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a…
  • POSTRerequest a check run/repos/:owner/:repo/check-runs/:check_run_id/rerequestTriggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhook event with the…
  • POSTCreate a check suite/repos/:owner/:repo/check-suitesCreates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for…
  • PATCHUpdate repository preferences for check suites/repos/:owner/:repo/check-suites/preferencesChanges the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository.…
  • GETGet a check suite/repos/:owner/:repo/check-suites/:check_suite_idGets a single check suite using its id. > [!NOTE] > The Checks API only looks for pushes in the repository where the check suite or check run were created.…
  • GETList check runs in a check suite/repos/:owner/:repo/check-suites/:check_suite_id/check-runs?check_name=string&status=queued&filter=latest&per_page=30&page=1Lists check runs for a check suite using its id. > [!NOTE] > The endpoints to manage checks only look for pushes in the repository where the check suite or…
  • POSTRerequest a check suite/repos/:owner/:repo/check-suites/:check_suite_id/rerequestTriggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with…
  • GETList check runs for a Git reference/repos/:owner/:repo/commits/:ref/check-runs?check_name=string&status=queued&filter=latest&per_page=30&page=1&app_id=0Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. > [!NOTE] > The endpoints to manage checks only look for pushes in the…
  • GETList check suites for a Git reference/repos/:owner/:repo/commits/:ref/check-suites?app_id=1&check_name=string&per_page=30&page=1Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. > [!NOTE] > The endpoints to manage checks only look for pushes in the…

code-scanning

  • GETGet the AI Scan setting for an organization/orgs/:org/code-scanning/ai-scanGets the AI Scan setting stored on an organization. The response reports the value stored on the organization. Organization respects enterprise policy. The…
  • PATCHUpdate the AI Scan setting for an organization/orgs/:org/code-scanning/ai-scanUpdates the AI Scan setting stored on an organization. The organization respects the enterprise policy, so enabling is rejected when the enterprise disallows…
  • GETList code scanning alerts for an organization/orgs/:org/code-scanning/alerts?tool_name=string&tool_guid=string&before=string&after=string&page=1&per_page=30&direction=desc&state=open&sort=created&severity=critical&assignees=stringLists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by…
  • GETGet AI Scan enablement for a repository/repos/:owner/:repo/code-scanning/ai-scanGets whether AI Scan is enabled for a repository. OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint…

Showing 300 of 400 endpoints. Fork the collection to see all of them.

API details

Base URL
https://api.github.com
Authentication
None declared in the description
Operations
1281 operations on 842 pathsGET 667POST 200DELETE 194PUT 141PATCH 79
38 marked deprecated
Main resources
repos 204actions 200orgs 116issues 66users 55codespaces 48copilot 44apps 37pulls 36activity 34
Response formats
application/json application/vnd.github.diff application/vnd.github.patch text/html
Description format
OpenAPI 3.0.3, API version 1.1.4

How to test the GitHub v3 REST API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the GitHub v3 REST API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get GitHub Actions cache retention limit for an enterprise” (GET /enterprises/:enterprise/actions/cache/retention-limit), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the GitHub v3 REST API?

GitHub's v3 REST API. It is listed under Developer tools and has 1281 endpoints.

Who publishes the GitHub v3 REST API?

It is listed from GitHub's public API description (an OpenAPI document), not published by GitHub on Swastik Codes. Anyone who controls github.com can claim the profile by adding a DNS TXT record.

What is the base URL of the GitHub v3 REST API?

Requests go to https://api.github.com. Endpoint paths are added to this base URL.

How do I authenticate with the GitHub v3 REST API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the GitHub v3 REST API have?

1281 operations on 842 paths (667 GET, 200 POST, 194 DELETE, 141 PUT, 79 PATCH). The largest groups are repos, actions, orgs, issues. This listing's collection holds the first 400.

Is forking the GitHub v3 REST API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.