GitHub v3 REST API
  1. actions
GitHub v3 REST API
  • meta
    • GitHub API Root
    • Get GitHub meta information
    • Get Octocat
    • Get all API versions
    • Get the Zen of GitHub
  • apps
    • Get the authenticated app
    • Create a GitHub App from a manifest
    • Get a webhook configuration for an app
    • Update a webhook configuration for an app
    • List deliveries for an app webhook
    • Get a delivery for an app webhook
    • Redeliver a delivery for an app webhook
    • List installations for the authenticated app
    • Delete an installation for the authenticated app
    • Get an installation for the authenticated app
    • Create an installation access token for an app
    • Revoke a grant for an application
    • Unsuspend an app installation
    • Suspend an app installation
    • Delete an app authorization
    • Delete an app token
    • Reset a token
    • Check a token
    • Revoke an authorization for an application
    • Create a scoped access token
    • Check an authorization
    • Reset an authorization
    • Get an app
    • List repositories accessible to the app installation
    • Create a content attachment
    • Revoke an installation access token
    • Get a subscription plan for an account
    • List plans
    • List accounts for a plan
    • Get a subscription plan for an account (stubbed)
    • List plans (stubbed)
    • List accounts for a plan (stubbed)
    • Get an organization installation for the authenticated app
    • Get a repository installation for the authenticated app
    • List app installations accessible to the user access token
    • List repositories accessible to the user access token
    • Remove a repository from an app installation
    • Add a repository to an app installation
    • List subscriptions for the authenticated user
    • List subscriptions for the authenticated user (stubbed)
    • Get a user installation for the authenticated app
  • oauth-authorizations
    • List your grants
    • Delete a grant
    • Get a single grant
    • List your authorizations
    • Create a new authorization
    • Get-or-create an authorization for a specific app
    • Get-or-create an authorization for a specific app and fingerprint
    • Delete an authorization
    • Get a single authorization
    • Update an existing authorization
  • codes-of-conduct
    • Get all codes of conduct
    • Get a code of conduct
    • Get the code of conduct for a repository
  • emojis
    • Get emojis
  • enterprise-admin
    • Get GitHub Actions permissions for an enterprise
    • Set GitHub Actions permissions for an enterprise
    • List selected organizations enabled for GitHub Actions in an enterprise
    • Set selected organizations enabled for GitHub Actions in an enterprise
    • Disable a selected organization for GitHub Actions in an enterprise
    • Enable a selected organization for GitHub Actions in an enterprise
    • Get allowed actions for an enterprise
    • Set allowed actions for an enterprise
    • List self-hosted runner groups for an enterprise
    • Create a self-hosted runner group for an enterprise
    • Delete a self-hosted runner group from an enterprise
    • Get a self-hosted runner group for an enterprise
    • Update a self-hosted runner group for an enterprise
    • List organization access to a self-hosted runner group in an enterprise
    • Set organization access for a self-hosted runner group in an enterprise
    • Remove organization access to a self-hosted runner group in an enterprise
    • Add organization access to a self-hosted runner group in an enterprise
    • List self-hosted runners in a group for an enterprise
    • Set self-hosted runners in a group for an enterprise
    • Remove a self-hosted runner from a group for an enterprise
    • Add a self-hosted runner to a group for an enterprise
    • List self-hosted runners for an enterprise
    • List runner applications for an enterprise
    • Create a registration token for an enterprise
    • Create a remove token for an enterprise
    • Delete a self-hosted runner from an enterprise
    • Get a self-hosted runner for an enterprise
    • List provisioned SCIM groups for an enterprise
    • Provision a SCIM enterprise group and invite users
    • Delete a SCIM group from an enterprise
    • Get SCIM provisioning information for an enterprise group
    • Update an attribute for a SCIM enterprise group
    • Set SCIM information for a provisioned enterprise group
    • List SCIM provisioned identities for an enterprise
    • Provision and invite a SCIM enterprise user
    • Delete a SCIM user from an enterprise
    • Get SCIM provisioning information for an enterprise user
    • Update an attribute for a SCIM enterprise user
    • Set SCIM information for a provisioned enterprise user
  • audit-log
    • Get the audit log for an enterprise
  • billing
    • Get GitHub Actions billing for an enterprise
    • Get GitHub Actions billing for an organization
    • Get GitHub Packages billing for an enterprise
    • Get GitHub Packages billing for an organization
    • Get shared storage billing for an enterprise
    • Get shared storage billing for an organization
    • Get GitHub Actions billing for a user
    • Get GitHub Packages billing for a user
    • Get shared storage billing for a user
  • activity
    • List public events
    • Get feeds
    • List public events for a network of repositories
    • List notifications for the authenticated user
    • Mark notifications as read
    • Get a thread
    • Mark a thread as read
    • Delete a thread subscription
    • Get a thread subscription for the authenticated user
    • Set a thread subscription
    • List public organization events
    • List repository events
    • List repository notifications for the authenticated user
    • Mark repository notifications as read
    • List stargazers
    • List watchers
    • Delete a repository subscription
    • Get a repository subscription
    • Set a repository subscription
    • List repositories starred by the authenticated user
    • Unstar a repository for the authenticated user
    • Check if a repository is starred by the authenticated user
    • Star a repository for the authenticated user
    • List repositories watched by the authenticated user
    • List events for the authenticated user
    • List organization events for the authenticated user
    • List public events for a user
    • List events received by the authenticated user
    • List public events received by a user
    • List repositories starred by a user
    • List repositories watched by a user
  • gists
    • List gists for the authenticated user
    • Create a gist
    • List public gists
    • List starred gists
    • Delete a gist
    • Get a gist
    • Update a gist
    • List gist comments
    • Create a gist comment
    • Delete a gist comment
    • Get a gist comment
    • Update a gist comment
    • List gist commits
    • List gist forks
    • Fork a gist
    • Unstar a gist
    • Check if a gist is starred
    • Star a gist
    • Get a gist revision
    • List gists for a user
  • gitignore
    • Get all gitignore templates
    • Get a gitignore template
  • issues
    • List issues assigned to the authenticated user
    • List organization issues assigned to the authenticated user
    • List assignees
    • Check if a user can be assigned
    • List repository issues
    • Create an issue
    • List issue comments for a repository
    • Delete an issue comment
    • Get an issue comment
    • Update an issue comment
    • List issue events for a repository
    • Get an issue event
    • Get an issue
    • Update an issue
    • Remove assignees from an issue
    • Add assignees to an issue
    • Check if a user can be assigned to a issue
    • List issue comments
    • Create an issue comment
    • List issue events
    • Remove all labels from an issue
    • List labels for an issue
    • Add labels to an issue
    • Set labels for an issue
    • Remove a label from an issue
    • Unlock an issue
    • Lock an issue
    • List timeline events for an issue
    • List labels for a repository
    • Create a label
    • Delete a label
    • Get a label
    • Update a label
    • List milestones
    • Create a milestone
    • Delete a milestone
    • Get a milestone
    • Update a milestone
    • List labels for issues in a milestone
    • List user account issues assigned to the authenticated user
  • licenses
    • Get all commonly used licenses
    • Get a license
    • Get the license for a repository
  • markdown
    • Render a Markdown document
    • Render a Markdown document in raw mode
  • orgs
    • List organizations
    • Get an organization
    • Update an organization
    • Get the audit log for an organization
    • List users blocked by an organization
    • Unblock a user from an organization
    • Check if a user is blocked by an organization
    • Block a user from an organization
    • List failed organization invitations
    • List SAML SSO authorizations for an organization
    • List organization webhooks
    • Remove a SAML SSO authorization for an organization
    • Create an organization webhook
    • Delete an organization webhook
    • Get an organization webhook
    • Update an organization webhook
    • Get a webhook configuration for an organization
    • Update a webhook configuration for an organization
    • List deliveries for an organization webhook
    • Get a webhook delivery for an organization webhook
    • Redeliver a delivery for an organization webhook
    • Ping an organization webhook
    • List app installations for an organization
    • List pending organization invitations
    • Create an organization invitation
    • Cancel an organization invitation
    • List organization invitation teams
    • List organization members
    • Remove an organization member
    • Check organization membership for a user
    • Remove organization membership for a user
    • Get organization membership for a user
    • Set organization membership for a user
    • List outside collaborators for an organization
    • Remove outside collaborator from an organization
    • Convert an organization member to outside collaborator
    • List public organization members
    • Remove public organization membership for the authenticated user
    • Check public organization membership for a user
    • Set public organization membership for the authenticated user
    • List security manager teams
    • Remove a security manager team
    • Add a security manager team
    • Enable or disable a security feature for an organization
    • List organization memberships for the authenticated user
    • Get an organization membership for the authenticated user
    • Update an organization membership for the authenticated user
    • List organizations for the authenticated user
    • List organizations for a user
  • actions
    • Get GitHub Actions cache usage for an organization
      GET
    • List repositories with GitHub Actions cache usage for an organization
      GET
    • Get GitHub Actions permissions for an organization
      GET
    • Set GitHub Actions permissions for an organization
      PUT
    • List selected repositories enabled for GitHub Actions in an organization
      GET
    • Set selected repositories enabled for GitHub Actions in an organization
      PUT
    • Disable a selected repository for GitHub Actions in an organization
      DELETE
    • Enable a selected repository for GitHub Actions in an organization
      PUT
    • Get allowed actions and reusable workflows for an organization
      GET
    • List self-hosted runner groups for an organization
      GET
    • Set allowed actions and reusable workflows for an organization
      PUT
    • Create a self-hosted runner group for an organization
      POST
    • Delete a self-hosted runner group from an organization
      DELETE
    • Get default workflow permissions for an organization
      GET
    • Get a self-hosted runner group for an organization
      GET
    • Set default workflow permissions for an organization
      PUT
    • Update a self-hosted runner group for an organization
      PATCH
    • List required workflows
      GET
    • List repository access to a self-hosted runner group in an organization
      GET
    • Create a required workflow
      POST
    • Set repository access for a self-hosted runner group in an organization
      PUT
    • Delete a required workflow
      DELETE
    • Remove repository access to a self-hosted runner group in an organization
      DELETE
    • Get a required workflow
      GET
    • Add repository access to a self-hosted runner group in an organization
      PUT
    • Update a required workflow
      PATCH
    • List self-hosted runners in a group for an organization
      GET
    • List selected repositories for a required workflow
      GET
    • Set self-hosted runners in a group for an organization
      PUT
    • Sets repositories for a required workflow
      PUT
    • Remove a self-hosted runner from a group for an organization
      DELETE
    • Remove a selected repository from required workflow
      DELETE
    • Add a self-hosted runner to a group for an organization
      PUT
    • Add a repository to a required workflow
      PUT
    • List self-hosted runners for an organization
      GET
    • List runner applications for an organization
      GET
    • Create a registration token for an organization
      POST
    • Create a remove token for an organization
      POST
    • Delete a self-hosted runner from an organization
      DELETE
    • Get a self-hosted runner for an organization
      GET
    • Remove all custom labels from a self-hosted runner for an organization
      DELETE
    • List labels for a self-hosted runner for an organization
      GET
    • Add custom labels to a self-hosted runner for an organization
      POST
    • Set custom labels for a self-hosted runner for an organization
      PUT
    • Remove a custom label from a self-hosted runner for an organization
      DELETE
    • List organization secrets
      GET
    • Get an organization public key
      GET
    • Delete an organization secret
      DELETE
    • Get an organization secret
      GET
    • Create or update an organization secret
      PUT
    • List selected repositories for an organization secret
      GET
    • Set selected repositories for an organization secret
      PUT
    • Remove selected repository from an organization secret
      DELETE
    • Add selected repository to an organization secret
      PUT
    • List organization variables
      GET
    • Create an organization variable
      POST
    • Delete an organization variable
      DELETE
    • Get an organization variable
      GET
    • Update an organization variable
      PATCH
    • List selected repositories for an organization variable
      GET
    • Set selected repositories for an organization variable
      PUT
    • Remove selected repository from an organization variable
      DELETE
    • Add selected repository to an organization variable
      PUT
    • List repository required workflows
      GET
    • Get a required workflow entity for a repository
      GET
    • Get required workflow usage
      GET
    • List artifacts for a repository
      GET
    • Delete an artifact
      DELETE
    • Get an artifact
      GET
    • Download an artifact
      GET
    • Get GitHub Actions cache usage for a repository
      GET
    • Delete GitHub Actions caches for a repository (using a cache key)
      DELETE
    • List GitHub Actions caches for a repository
      GET
    • Delete a GitHub Actions cache for a repository (using a cache ID)
      DELETE
    • Get a job for a workflow run
      GET
    • Download job logs for a workflow run
      GET
    • Re-run a job from a workflow run
      POST
    • Get the customization template for an OIDC subject claim for a repository
      GET
    • Set the customization template for an OIDC subject claim for a repository
      PUT
    • Get GitHub Actions permissions for a repository
      GET
    • Set GitHub Actions permissions for a repository
      PUT
    • Get the level of access for workflows outside of the repository
      GET
    • Set the level of access for workflows outside of the repository
      PUT
    • Get allowed actions and reusable workflows for a repository
      GET
    • Set allowed actions and reusable workflows for a repository
      PUT
    • Get default workflow permissions for a repository
      GET
    • Set default workflow permissions for a repository
      PUT
    • List workflow runs for a required workflow
      GET
    • List self-hosted runners for a repository
      GET
    • List runner applications for a repository
      GET
    • Create a registration token for a repository
      POST
    • Create a remove token for a repository
      POST
    • Delete a self-hosted runner from a repository
      DELETE
    • Get a self-hosted runner for a repository
      GET
    • Remove all custom labels from a self-hosted runner for a repository
      DELETE
    • List labels for a self-hosted runner for a repository
      GET
    • Add custom labels to a self-hosted runner for a repository
      POST
    • Set custom labels for a self-hosted runner for a repository
      PUT
    • Remove a custom label from a self-hosted runner for a repository
      DELETE
    • List workflow runs for a repository
      GET
    • Delete a workflow run
      DELETE
    • Get a workflow run
      GET
    • Get the review history for a workflow run
      GET
    • Approve a workflow run for a fork pull request
      POST
    • List workflow run artifacts
      GET
    • Get a workflow run attempt
      GET
    • List jobs for a workflow run attempt
      GET
    • Download workflow run attempt logs
      GET
    • Cancel a workflow run
      POST
    • List jobs for a workflow run
      GET
    • Delete workflow run logs
      DELETE
    • Download workflow run logs
      GET
    • Get pending deployments for a workflow run
      GET
    • Review pending deployments for a workflow run
      POST
    • Re-run a workflow
      POST
    • Re-run failed jobs from a workflow run
      POST
    • Get workflow run usage
      GET
    • List repository secrets
      GET
    • Get a repository public key
      GET
    • Delete a repository secret
      DELETE
    • Get a repository secret
      GET
    • Create or update a repository secret
      PUT
    • List repository variables
      GET
    • Create a repository variable
      POST
    • Delete a repository variable
      DELETE
    • Get a repository variable
      GET
    • Update a repository variable
      PATCH
    • List repository workflows
      GET
    • Get a workflow
      GET
    • Disable a workflow
      PUT
    • Create a workflow dispatch event
      POST
    • Enable a workflow
      PUT
    • List workflow runs for a workflow
      GET
    • Get workflow usage
      GET
    • List environment secrets
      GET
    • Get an environment public key
      GET
    • Delete an environment secret
      DELETE
    • Get an environment secret
      GET
    • Create or update an environment secret
      PUT
    • List environment variables
      GET
    • Create an environment variable
      POST
    • Delete an environment variable
      DELETE
    • Get an environment variable
      GET
    • Update an environment variable
      PATCH
  • interactions
    • Remove interaction restrictions for an organization
    • Get interaction restrictions for an organization
    • Set interaction restrictions for an organization
    • Remove interaction restrictions for a repository
    • Get interaction restrictions for a repository
    • Set interaction restrictions for a repository
    • Remove interaction restrictions from your public repositories
    • Get interaction restrictions for your public repositories
    • Set interaction restrictions for your public repositories
  • migrations
    • List organization migrations
    • Start an organization migration
    • Get an organization migration status
    • Delete an organization migration archive
    • Download an organization migration archive
    • Unlock an organization repository
    • List repositories in an organization migration
    • Cancel an import
    • Get an import status
    • Update an import
    • Start an import
    • Get commit authors
    • Map a commit author
    • Get large files
    • Update Git LFS preference
    • List user migrations
    • Start a user migration
    • Get a user migration status
    • Delete a user migration archive
    • Download a user migration archive
    • Unlock a user repository
    • List repositories for a user migration
  • packages
    • List packages for an organization
    • Delete a package for an organization
    • Get a package for an organization
    • Restore a package for an organization
    • List package versions for a package owned by an organization
    • Delete package version for an organization
    • Get a package version for an organization
    • Restore package version for an organization
    • List packages for the authenticated user's namespace
    • Delete a package for the authenticated user
    • Get a package for the authenticated user
    • Restore a package for the authenticated user
    • List package versions for a package owned by the authenticated user
    • Delete a package version for the authenticated user
    • Get a package version for the authenticated user
    • Restore a package version for the authenticated user
    • List packages for a user
    • Delete a package for a user
    • Get a package for a user
    • Restore a package for a user
    • List package versions for a package owned by a user
    • Delete package version for a user
    • Get a package version for a user
    • Restore package version for a user
  • projects
    • List organization projects
    • Create an organization project
    • Delete a project card
    • Get a project card
    • Update an existing project card
    • Move a project card
    • Delete a project column
    • Get a project column
    • Update an existing project column
    • List project cards
    • Create a project card
    • Move a project column
    • Delete a project
    • Get a project
    • Update a project
    • List project collaborators
    • Remove user as a collaborator
    • Add project collaborator
    • Get project permission for a user
    • List project columns
    • Create a project column
    • List repository projects
    • Create a repository project
    • Create a user project
    • List user projects
  • repos
    • List organization repositories
    • Create an organization repository
    • Delete a repository
    • Get a repository
    • Update a repository
    • List all autolinks of a repository
    • Create an autolink reference for a repository
    • Delete an autolink reference from a repository
    • Get an autolink reference of a repository
    • Disable automated security fixes
    • Enable automated security fixes
    • List branches
    • Get a branch
    • Delete branch protection
    • Get branch protection
    • Update branch protection
    • Delete admin branch protection
    • Get admin branch protection
    • Set admin branch protection
    • Delete pull request review protection
    • Get pull request review protection
    • Update pull request review protection
    • Delete commit signature protection
    • Get commit signature protection
    • Create commit signature protection
    • Remove status check protection
    • Get status checks protection
    • Update status check protection
    • Remove status check contexts
    • Get all status check contexts
    • Add status check contexts
    • Set status check contexts
    • Delete access restrictions
    • Get access restrictions
    • Remove app access restrictions
    • Get apps with access to the protected branch
    • Add app access restrictions
    • Set app access restrictions
    • Remove team access restrictions
    • Get teams with access to the protected branch
    • Add team access restrictions
    • Set team access restrictions
    • Remove user access restrictions
    • Get users with access to the protected branch
    • Add user access restrictions
    • Set user access restrictions
    • Rename a branch
    • List CODEOWNERS errors
    • List repository collaborators
    • Remove a repository collaborator
    • Check if a user is a repository collaborator
    • Add a repository collaborator
    • Get repository permissions for a user
    • List commit comments for a repository
    • Delete a commit comment
    • Get a commit comment
    • Update a commit comment
    • List commits
    • List branches for HEAD commit
    • List commit comments
    • Create a commit comment
    • List pull requests associated with a commit
    • Compare two commits
    • Get a commit
    • Get the combined status for a specific reference
    • List commit statuses for a reference
    • Get community profile metrics
    • Compare two commits
    • Delete a file
    • Get repository content
    • Create or update file contents
    • List repository contributors
    • List deployments
    • Create a deployment
    • Delete a deployment
    • Get a deployment
    • List deployment statuses
    • Create a deployment status
    • Get a deployment status
    • Create a repository dispatch event
    • List environments
    • Delete an environment
    • Get an environment
    • Create or update an environment
    • List deployment branch policies
    • Create a deployment branch policy
    • Delete a deployment branch policy
    • Get a deployment branch policy
    • Update a deployment branch policy
    • List forks
    • Create a fork
    • List repository webhooks
    • Create a repository webhook
    • Delete a repository webhook
    • Get a repository webhook
    • Update a repository webhook
    • Get a webhook configuration for a repository
    • Update a webhook configuration for a repository
    • List deliveries for a repository webhook
    • Get a delivery for a repository webhook
    • Redeliver a delivery for a repository webhook
    • Ping a repository webhook
    • Test the push repository webhook
    • List repository invitations
    • Delete a repository invitation
    • Update a repository invitation
    • List deploy keys
    • Create a deploy key
    • Delete a deploy key
    • Get a deploy key
    • List repository languages
    • Disable Git LFS for a repository
    • Enable Git LFS for a repository
    • Sync a fork branch with the upstream repository
    • Merge a branch
    • Delete a GitHub Pages site
    • Get a GitHub Pages site
    • Create a GitHub Pages site
    • Update information about a GitHub Pages site
    • List GitHub Pages builds
    • Request a GitHub Pages build
    • Get latest Pages build
    • Get GitHub Pages build
    • Create a GitHub Pages deployment
    • Get a DNS health check for GitHub Pages
    • Get a repository README
    • Get a repository README for a directory
    • List releases
    • Create a release
    • Delete a release asset
    • Get a release asset
    • Update a release asset
    • Generate release notes content for a release
    • Get the latest release
    • Get a release by tag name
    • Delete a release
    • Get a release
    • Update a release
    • List release assets
    • Upload a release asset
    • Get the weekly commit activity
    • Get the last year of commit activity
    • Get all contributor commit activity
    • Get the weekly commit count
    • Get the hourly commit count for each day
    • Create a commit status
    • List repository tags
    • List tag protection states for a repository
    • Create a tag protection state for a repository
    • Delete a tag protection state for a repository
    • Download a repository archive (tar)
    • List repository teams
    • Get all repository topics
    • Replace all repository topics
    • Get repository clones
    • Get top referral paths
    • Get top referral sources
    • Get page views
    • Transfer a repository
    • Disable vulnerability alerts
    • Check if vulnerability alerts are enabled for a repository
    • Enable vulnerability alerts
    • Download a repository archive (zip)
    • Create a repository using a template
    • List public repositories
    • List repositories for the authenticated user
    • Create a repository for the authenticated user
    • List repository invitations for the authenticated user
    • Decline a repository invitation
    • Accept a repository invitation
    • List repositories for a user
  • teams
    • List IdP groups for an organization
    • List teams
    • Create a team
    • Delete a team
    • Get a team by name
    • Update a team
    • List discussions
    • Create a discussion
    • Delete a discussion
    • Get a discussion
    • Update a discussion
    • List discussion comments
    • Create a discussion comment
    • Delete a discussion comment
    • Get a discussion comment
    • Update a discussion comment
    • List pending team invitations
    • List team members
    • Remove team membership for a user
    • Get team membership for a user
    • Add or update team membership for a user
    • List team projects
    • Remove a project from a team
    • Check team permissions for a project
    • Add or update team project permissions
    • List team repositories
    • Remove a repository from a team
    • Check team permissions for a repository
    • Add or update team repository permissions
    • List child teams
    • List IdP groups for a team
    • Delete a team (Legacy)
    • Get a team (Legacy)
    • Create or update IdP group connections
    • Update a team (Legacy)
    • List discussions (Legacy)
    • Create a discussion (Legacy)
    • Delete a discussion (Legacy)
    • Get a discussion (Legacy)
    • Update a discussion (Legacy)
    • List discussion comments (Legacy)
    • Create a discussion comment (Legacy)
    • Delete a discussion comment (Legacy)
    • Get a discussion comment (Legacy)
    • Update a discussion comment (Legacy)
    • List pending team invitations (Legacy)
    • List team members (Legacy)
    • Remove team member (Legacy)
    • Get team member (Legacy)
    • Add team member (Legacy)
    • Remove team membership for a user (Legacy)
    • Get team membership for a user (Legacy)
    • Add or update team membership for a user (Legacy)
    • List team projects (Legacy)
    • Remove a project from a team (Legacy)
    • Check team permissions for a project (Legacy)
    • Add or update team project permissions (Legacy)
    • List team repositories (Legacy)
    • Remove a repository from a team (Legacy)
    • Check team permissions for a repository (Legacy)
    • Add or update team repository permissions (Legacy)
    • List child teams (Legacy)
    • List teams for the authenticated user
    • List IdP groups for a team (Legacy)
    • Create or update IdP group connections (Legacy)
  • reactions
    • List reactions for a team discussion comment
    • Create reaction for a team discussion comment
    • Delete team discussion comment reaction
    • List reactions for a team discussion
    • Create reaction for a team discussion
    • Delete team discussion reaction
    • Delete a reaction (Legacy)
    • List reactions for a commit comment
    • Create reaction for a commit comment
    • Delete a commit comment reaction
    • List reactions for an issue comment
    • Create reaction for an issue comment
    • Delete an issue comment reaction
    • List reactions for an issue
    • Create reaction for an issue
    • Delete an issue reaction
    • List reactions for a pull request review comment
    • Create reaction for a pull request review comment
    • Delete a pull request comment reaction
    • List reactions for a release
    • Create reaction for a release
    • Delete a release reaction
    • List reactions for a team discussion comment (Legacy)
    • Create reaction for a team discussion comment (Legacy)
    • List reactions for a team discussion (Legacy)
    • Create reaction for a team discussion (Legacy)
  • rate-limit
    • Get rate limit status for the authenticated user
  • checks
    • Create a check run
    • Get a check run
    • Update a check run
    • List check run annotations
    • Rerequest a check run
    • Create a check suite
    • Update repository preferences for check suites
    • Get a check suite
    • List check runs in a check suite
    • Rerequest a check suite
    • List check runs for a Git reference
    • List check suites for a Git reference
  • code-scanning
    • List code scanning alerts for an organization
    • List code scanning alerts for a repository
    • Get a code scanning alert
    • Update a code scanning alert
    • List instances of a code scanning alert
    • List code scanning analyses for a repository
    • Delete a code scanning analysis from a repository
    • Get a code scanning analysis for a repository
    • List CodeQL databases for a repository
    • Get a CodeQL database for a repository
    • Upload an analysis as SARIF data
    • Get information about a SARIF upload
  • git
    • Create a blob
    • Get a blob
    • Create a commit
    • Get a commit
    • List matching references
    • Get a reference
    • Create a reference
    • Delete a reference
    • Update a reference
    • Create a tag object
    • Get a tag
    • Create a tree
    • Get a tree
  • pulls
    • List pull requests
    • Create a pull request
    • List review comments in a repository
    • Delete a review comment for a pull request
    • Get a review comment for a pull request
    • Update a review comment for a pull request
    • Get a pull request
    • Update a pull request
    • List review comments on a pull request
    • Create a review comment for a pull request
    • Create a reply for a review comment
    • List commits on a pull request
    • List pull requests files
    • Check if a pull request has been merged
    • Merge a pull request
    • Remove requested reviewers from a pull request
    • Get all requested reviewers for a pull request
    • Request reviewers for a pull request
    • List reviews for a pull request
    • Create a review for a pull request
    • Delete a pending review for a pull request
    • Get a review for a pull request
    • Update a review for a pull request
    • List comments for a pull request review
    • Dismiss a review for a pull request
    • Submit a review for a pull request
    • Update a pull request branch
  • secret-scanning
    • List secret scanning alerts for an enterprise
    • List secret scanning alerts for an organization
    • List secret scanning alerts for a repository
    • Get a secret scanning alert
    • Update a secret scanning alert
    • List locations for a secret scanning alert
  • scim
    • List SCIM provisioned identities
    • Provision and invite a SCIM user
    • Delete a SCIM user from an organization
    • Get SCIM provisioning information for a user
    • Update an attribute for a SCIM user
    • Update a provisioned organization membership
  • search
    • Search code
    • Search commits
    • Search issues and pull requests
    • Search labels
    • Search repositories
    • Search topics
    • Search users
  • users
    • Get the authenticated user
    • Update the authenticated user
    • List users blocked by the authenticated user
    • Unblock a user
    • Check if a user is blocked by the authenticated user
    • Block a user
    • Set primary email visibility for the authenticated user
    • Delete an email address for the authenticated user
    • List email addresses for the authenticated user
    • Add an email address for the authenticated user
    • List followers of the authenticated user
    • List the people the authenticated user follows
    • Unfollow a user
    • Check if a person is followed by the authenticated user
    • Follow a user
    • List GPG keys for the authenticated user
    • Create a GPG key for the authenticated user
    • Delete a GPG key for the authenticated user
    • Get a GPG key for the authenticated user
    • List public SSH keys for the authenticated user
    • Create a public SSH key for the authenticated user
    • Delete a public SSH key for the authenticated user
    • Get a public SSH key for the authenticated user
    • List public email addresses for the authenticated user
    • List SSH signing keys for the authenticated user
    • Create a SSH signing key for the authenticated user
    • Delete an SSH signing key for the authenticated user
    • Get an SSH signing key for the authenticated user
    • List users
    • Get a user
    • List followers of a user
    • List the people a user follows
    • Check if a user follows another user
    • List GPG keys for a user
    • Get contextual information for a user
    • List public keys for a user
    • List SSH signing keys for a user
  • dependabot
    • List Dependabot alerts for an enterprise
    • List Dependabot alerts for an organization
    • List organization secrets
    • Get an organization public key
    • Delete an organization secret
    • Get an organization secret
    • Create or update an organization secret
    • List selected repositories for an organization secret
    • Set selected repositories for an organization secret
    • Remove selected repository from an organization secret
    • Add selected repository to an organization secret
    • List Dependabot alerts for a repository
    • Get a Dependabot alert
    • Update a Dependabot alert
    • List repository secrets
    • Get a repository public key
    • Delete a repository secret
    • Get a repository secret
    • Create or update a repository secret
  • oidc
    • Get the customization template for an OIDC subject claim for an organization
    • Set the customization template for an OIDC subject claim for an organization
  • codespaces
    • List codespaces for the organization
    • Manage access control for organization codespaces
    • Removes users from Codespaces billing for an organization
    • Add users to Codespaces billing for an organization
    • List organization secrets
    • Get an organization public key
    • Delete an organization secret
    • Get an organization secret
    • Create or update an organization secret
    • List selected repositories for an organization secret
    • Set selected repositories for an organization secret
    • Remove selected repository from an organization secret
    • Add selected repository to an organization secret
    • List codespaces for a user in organization
    • Delete a codespace from the organization
    • Stop a codespace for an organization user
    • List codespaces in a repository for the authenticated user
    • Create a codespace in a repository
    • List devcontainer configurations in a repository for the authenticated user
    • List available machine types for a repository
    • Get default attributes for a codespace
    • List repository secrets
    • Get a repository public key
    • Delete a repository secret
    • Get a repository secret
    • Create or update a repository secret
    • Create a codespace from a pull request
    • List codespaces for the authenticated user
    • Create a codespace for the authenticated user
    • List secrets for the authenticated user
    • Get public key for the authenticated user
    • Delete a secret for the authenticated user
    • Get a secret for the authenticated user
    • Create or update a secret for the authenticated user
    • List selected repositories for a user secret
    • Set selected repositories for a user secret
    • Remove a selected repository from a user secret
    • Add a selected repository to a user secret
    • Delete a codespace for the authenticated user
    • Get a codespace for the authenticated user
    • Update a codespace for the authenticated user
    • Export a codespace for the authenticated user
    • Get details about a codespace export
    • List machine types for a codespace
    • Create a repository from an unpublished codespace
    • Start a codespace for the authenticated user
    • Stop a codespace for the authenticated user
  • dependency-graph
    • Get a diff of the dependencies between commits
    • Create a snapshot of dependencies for a repository
  1. actions

Cancel a workflow run

POST
/repos/{owner}/{repo}/actions/runs/{run_id}/cancel
Cancels a workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

Request

Path Params

Responses

🟢202Response
application/json
Body

🟠409409
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.github.com/repos///actions/runs//cancel'
Response Response Example
202 - default
null
Modified at 2023-08-15 02:59:28
Previous
Download workflow run attempt logs
Next
List jobs for a workflow run
Built with