Articles in this section

Available GitHub APIs

When you configure an export, import, or other type of flow step using the prebuilt GitHub connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the GitHub API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Actions: Artifacts

List artifacts for a repository

X

Get an artifact

X

Delete an artifact

X

Download an artifact

X

List workflow run artifacts

X

Actions: Cache

Get GitHub Actions cache usage for an organization

X

List repositories with GitHub Actions cache usage for an organization

X

Get GitHub Actions cache usage for a repository

X

List GitHub Actions caches for a repository

X

Delete GitHub Actions caches for a repository (using a cache key)

X

Delete a GitHub Actions cache for a repository (using a cache ID)

X

Actions: GitHub-hosted runners

List GitHub-hosted runners for an organization

X

Create a GitHub-hosted runner for an organization

X

List custom images for an organization

X

Get a custom image definition for GitHub Actions hosted runners

X

Delete a custom image from the organization

X

List image versions of a custom image for an organization

X

Get an image version of a custom image for GitHub Actions hosted runners

X

Delete an image version of custom image from the organization

X

Get GitHub-owned images for GitHub-hosted runners in an organization

X

Get partner images for GitHub-hosted runners in an organization

X

Get limits on GitHub-hosted runners for an organization

X

Get GitHub-hosted runners machine specs for an organization

X

Get platforms for GitHub-hosted runners in an organization

X

Get a GitHub-hosted runner for an organization

X

Update a GitHub-hosted runner for an organization

X

Delete a GitHub-hosted runner for an organization

X

Actions: OIDC

Get the customization template for an OIDC subject claim for an organization

X

Set the customization template for an OIDC subject claim for an organization

X

Get the customization template for an OIDC subject claim for a repository

X

Set the customization template for an OIDC subject claim for a repository

X

Actions: Permissions

Get GitHub Actions permissions for an organization

X

Get artifact and log retention settings for an organization

X

Set artifact and log retention settings for an organization

X

Get fork PR contributor approval permissions for an organization

X

Set fork PR contributor approval permissions for an organization

X

Get private repo fork PR workflow settings for an organization

X

Set private repo fork PR workflow settings for an organization

X

List selected repositories enabled for GitHub Actions in an organization

X

Get allowed actions and reusable workflows for an organization

X

Get self-hosted runners settings for an organization

X

Set self-hosted runners settings for an organization

X

List repositories allowed to use self-hosted runners in an organization

X

Set repositories allowed to use self-hosted runners in an organization

X

Add a repository to the list of repositories allowed to use self-hosted runners in an organization

X

Remove a repository from the list of repositories allowed to use self-hosted runners in an organization

X

Get default workflow permissions for an organization

X

Set default workflow permissions for an organization

X

Get GitHub Actions permissions for a repository

X

Get the level of access for workflows outside of the repository

X

Set the level of access for workflows outside of the repository

X

Get artifact and log retention settings for a repository

X

Set artifact and log retention settings for a repository

X

Get fork PR contributor approval permissions for a repository

X

Set fork PR contributor approval permissions for a repository

X

Get private repo fork PR workflow settings for a repository

X

Set private repo fork PR workflow settings for a repository

X

Get allowed actions and reusable workflows for a repository

X

Get default workflow permissions for a repository

X

Set default workflow permissions for a repository

X

Actions: Secrets

List organization secrets

X

Get an organization public key

X

Get an organization secret

X

Create or update an organization secret

X

Delete an organization secret

X

List selected repositories for an organization secret

X

Set selected repositories for an organization secret

X

Set selected repositories for an organization secret

X

Set selected repositories for an organization secret

X

List repository organization secrets

X

List repository secrets

X

Get a repository public key

X

Get a repository secret

X

Create or update a repository secret

X

Delete a repository secret

X

List environment secrets

X

Get an environment public key

X

Get an environment secret

X

Create or update an environment secret

X

Delete an environment secret

X

Actions: Self-hosted runner groups

List self-hosted runner groups for an organization

X

Create a self-hosted runner group for an organization

X

Get a self-hosted runner group for an organization

X

Update a self-hosted runner group for an organization

X

Delete a self-hosted runner group from an organization

X

List GitHub-hosted runners in a group for an organization

X

List repository access to a self-hosted runner group in an organization

X

Set repository access for a self-hosted runner group in an organization

X

Add repository access to a self-hosted runner group in an organization

X

Remove repository access to a self-hosted runner group in an organization

X

List self-hosted runners in a group for an organization

X

Set self-hosted runners in a group for an organization

X

Add a self-hosted runner to a group for an organization

X

Remove a self-hosted runner from a group for an organization

X

Actions: Self-hosted runners

List self-hosted runners for an organization

X

List runner applications for an organization

X

Create configuration for a just-in-time runner for an organization

X

Create a registration token for an organization

X

Create a remove token for an organization

X

Get a self-hosted runner for an organization

X

Delete a self-hosted runner from an organization

X

List labels for a self-hosted runner for an organization

X

Add custom labels to a self-hosted runner for an organization

X

Set custom labels for a self-hosted runner for an organization

X

Remove all custom labels from a self-hosted runner for an organization

X

Remove a custom label from a self-hosted runner for an organization

X

List self-hosted runners for a repository

X

List runner applications for a repository

X

Create configuration for a just-in-time runner for a repository

X

Create a registration token for a repository

X

Create a remove token for a repository

X

Get a self-hosted runner for a repository

X

Delete a self-hosted runner from a repository

X

List labels for a self-hosted runner for a repository

X

Add custom labels to a self-hosted runner for a repository

X

Set custom labels for a self-hosted runner for a repository

X

Remove all custom labels from a self-hosted runner for a repository

X

Remove a custom label from a self-hosted runner for a repository

X

Actions: Variables

List organization variables

X

Create an organization variable

X

Get an organization variable

X

Update an organization variable

X

Delete an organization variable

X

List selected repositories for an organization variable

X

Set selected repositories for an organization variable

X

Add selected repository to an organization variable

X

Remove selected repository from an organization variable

X

List repository organization variables

X

List repository variables

X

Create a repository variable

X

Get a repository variable

X

Update a repository variable

X

Delete a repository variable

X

List environment variables

X

Create an environment variable

X

Get an environment variable

X

Update an environment variable

X

Delete an environment variable

X

Actions: Workflow jobs

Get a job for a workflow run

X

Download job logs for a workflow run

X

List jobs for a workflow run attempt

X

List jobs for a workflow run

X

Re-run a job from a workflow run

X

List workflow runs for a repository

X

Get a workflow run

X

Delete a workflow run

X

Get the review history for a workflow run

X

Get a workflow run attempt

X

Download workflow run attempt logs

X

Cancel a workflow run

X

Review custom deployment protection rules for a workflow run

X

Force cancel a workflow run

X

Download workflow run logs

X

Delete workflow run logs

X

Get pending deployments for a workflow run

X

Review pending deployments for a workflow run

X

Re-run a workflow

X

Re-run failed jobs from a workflow run

X

Get workflow run usage

X

List workflow runs for a workflow

X

Actions: Workflows

List repository workflows

X

Get a workflow

X

Disable a workflow

X

Create a workflow dispatch event

X

Enable a workflow

X

Get workflow usage

X

Activity: Events

List public events

X

List public events for a network of repositories

X

List public organization events

X

List repository events

X

List events for the authenticated user

X

List organization events for the authenticated user

X

List public events for a user

X

List events received by the authenticated user

X

List public events received by a user

X

Activity: Feeds

Get feeds

X

Billing: Billing usage

Get all budgets for an organization

X

Get a budget by ID for an organization

X

Update a budget for an organization

X

Delete a budget for an organization

X

Billing: Budgets

Get all budgets for an organization

X

Get a budget by ID for an organization

X

Update a budget for an organization

X

Delete a budget for an organization

X

Branches: Branches

List branches

X

Get a branch

X

Rename a branch

X

Sync a fork branch with the upstream repository

X

Merge a branch

X

Branches: Protected branches

Get branch protection

X

Update branch protection

X

Delete branch protection

X

Get admin branch protection

X

Set admin branch protection

X

Delete admin branch protection

X

Get pull request review protection

X

Update pull request review protection

X

Delete pull request review protection

X

Get commit signature protection

X

Create commit signature protection

X

Delete commit signature protection

X

Get status checks protection

X

Update status check protection

X

Remove status check protection

X

Get all status check contexts

X

Add status check contexts

X

Set status check contexts

X

Remove status check contexts

X

Get access restrictions

X

Delete access restrictions

X

Get apps with access to the protected branch

X

Add app access restrictions

X

Set app access restrictions

X

Remove app access restrictions

X

Get teams with access to the protected branch

X

Add team access restrictions

X

Set team access restrictions

X

Remove team access restrictions

X

Get users with access to the protected branch

X

Add user access restrictions

X

Set user access restrictions

X

Remove user access restrictions

X

Campaigns: Security campaigns

List campaigns for an organization

X

Create a campaign for an organization

X

Get a campaign for an organization

X

Update a campaign

X

Delete a campaign for an organization

X

Checks: Check runs

Create a check run

X

Get a check run

X

Update a check run

X

List check run annotations

X

Rerequest a check run

X

List check runs in a check suite

X

List check runs for a git reference

X

Checks: Check suites

Create a check suite

X

Update repository preferences for check suites

X

Get a check suite

X

Rerequest a check suite

X

List check suites for a git reference

X

Classroom

Get an assignment

X

List accepted assignments for an assignment

X

Get assignment grades

X

List classrooms

X

Get a classroom

X

List assignments for a classroom

X

Code security settings: Configurations

Get code security configurations for an enterprise

X

Create a code security configuration for an enterprise

X

Get default code security configurations for an enterprise

X

Retrieve a code security configuration of an enterprise

X

Update a custom code security configuration for an enterprise

X

Delete a code security configuration for an enterprise

X

Attach an enterprise configuration to repositories

X

Set a code security configuration as a default for an enterprise

X

Get repositories associated with an enterprise code security configuration

X

Get code security configurations for an organization

X

Create a code security configuration

X

Get default code security configurations

X

Detach configurations from repositories

X

Get a code security configuration

X

Update a code security configuration

X

Delete a code security configuration

X

Attach a configuration to repositories

X

Set a code security configuration as a default for an organization

X

Get repositories associated with a code security configuration

X

Get the code security configuration associated with a repository

X

Codes of conduct

Get all codes of conduct

X

Get a code of conduct

X

Codespaces: Machines

Codespaces machine types

X

List available machine types for a repository

X

Codespaces: Organization secrets

List organization secrets

X

Get an organization public key

X

Get an organization secret

X

Create or update an organization secret

X

Delete an organization secret

X

List selected repositories for an organization secret

X

Set selected repositories for an organization secret

X

Add selected repository to an organization secret

X

Remove selected repository from an organization secret

X

Collaborators: Collaborators

List repository collaborators

X

Check if a user is a repository collaborator

X

Add a repository collaborator

X

Remove a repository collaborator

X

Get repository permissions for a user

X

Commits: Commits

List commits

X

List branches for head commit

X

List merged pull requests by commit

X

Get a commit

X

Compare two commits

X

Copilot: Copilot metrics

Get Copilot metrics for an organization

X

Get Copilot metrics for a team

X

Copilot: Copilot user management

Get Copilot seat information and settings for an organization

X

List all Copilot seat assignments for an organization

X

Add teams to the Copilot subscription for an organization

X

Remove teams from the Copilot subscription for an organization

X

Add users to the Copilot subscription for an organization

X

Remove users from the Copilot subscription for an organization

X

Get Copilot seat assignment details for a user

X

Credentials: Revocation

Revoke credentials

X

Dependency graph: Dependency review

Dependency review

X

Get a diff of the dependencies between commits

X

Dependency graph: Dependency submission

Dependency submission API

X

Create a snapshot of dependencies for a repository

X

Dependency graph: Software bill of materials (SBOM)

Export a software bill of materials (SBOM) for a repository

X

Deployments: Deployment statuses

List deployment statuses

X

Create a deployment status

X

Get a deployment status

X

Deployments: Protection rules

Get all deployment protection rules for an environment

X

Create a custom deployment protection rule on an environment

X

List custom deployment rule integrations available for an environment

X

Get a custom deployment protection rule

X

Disable a custom protection rule for an environment

X

Emojis

Github emojis API

X

Git database: Blobs

Create a blob

X

Git database: Commits

Create a commit

X

Git database: Tags

Git tags API

X

Create a tag object

X

Git database: Trees

Git trees

X

Create a tree

X

.gitignore

Get .gitignore templates

X

Get a .gitignore template

X

Issues: Assignees

List assignees

X

Check if a user can be assigned

X

Add assignees to an issue

X

Remove assignees from an issue

X

Check if a user can be assigned to an issue

X

Issues: Comments

List issue comments for a repository

X

Get an issue comment

X

Update an issue comment

X

Delete an issue comment

X

List issue comments

X

Create an issue comment

X

Issues: Events

List issue events for a repository

X

Get an issue event

X

List issue events

X

Issues: Issue dependencies

List dependencies an issue is blocked by

X

Add a dependency an issue is blocked by

X

Remove dependency an issue is blocked by

X

List dependencies an issue is blocking

X

Issues: Issues

List issues assigned to the authenticated user

X

List organization issues assigned to the authenticated user

X

List repository issues

X

Create an issue

X

Get an issue

X

Update an issue

X

Lock an issue

X

Unlock an issue

X

List user account issues assigned to the authenticated user

X

Issues: Milestones

List milestones

X

Create a milestone

X

Get a milestone

X

Update a milestone

X

Delete a milestone

X

Issues: Sub-issues

Get parent issue

X

Remove sub-issue

X

List sub-issues

X

Add sub-issue

X

Reprioritize sub-issue

X

Issues: Timeline

List timeline events for an issue

X

Markdown

Render a Markdown document

X

Render a Markdown document in raw mode

X

Meta

Github API root

X

Get GitHub meta information

X

Get Octocat

X

Get all API versions

X

Get the zen of GitHub

X

Metrics: Community

Get community profile metrics

X

Models: Catalog

List all models

X

Models: Embeddings

GitHub models inference

X

Organizations

List organizations for the authenticated user

X

List organizations

X

Get an organization

X

List organization members

X

Check organization membership for a user

X

List pending organization invitations

X

List organization memberships for the authenticated user

X

Get an organization membership for the authenticated user

X

List teams

X

Get a team by name

X

List child teams

X

List team members

X

Get team membership for a user

X

List team repositories

X

List teams for the authenticated user

X

Remove an organization member

X

Set public organization membership for the authenticated user

X

Update an organization membership for the authenticated user

X

Remove public organization membership for the authenticated user

X

Create a team

X

Update a team

X

Create an organization invitation

X

List failed organization invitations

X

Cancel an organization invitation

X

List organization invitation teams

X

Get organization membership for a user

X

Set organization membership for a user

X

Remove organization membership for a user

X

List public organization members

X

Check public organization membership for a user

X

Update an organization

X

Delete an organization

X

List app installations for an organization

X

Get immutable releases settings for an organization

X

Set immutable releases settings for an organization

X

List selected repositories for immutable releases enforcement

X

Set selected repositories for immutable releases enforcement

X

Set selected repositories for immutable releases enforcement

X

Set selected repositories for immutable releases enforcement

X

Enable or disable a security feature for an organization

X

List organizations for a user

X

Organizations: API insights

Get route stats by actor

X

Get subject stats

X

Get summary stats

X

Get summary stats by user

X

Get summary stats by actor

X

Get time stats

X

Get time stats by user

X

Get time stats by actor

X

Get user stats

X

Organizations: Artifact attestations

List attestations by bulk subject digests

X

Delete attestations in bulk

X

Delete attestations by subject digest

X

List attestation repositories

X

Delete attestations by ID

X

Organizations: Artifact metadata

Create an artifact deployment record

X

Set cluster deployment records

X

Create artifact metadata storage record

X

List artifact deployment records

X

List artifact storage records

X

Organizations: Issue types

List issue types for an organization

X

Create issue type for an organization

X

Update issue type for an organization

X

Delete issue type for an organization

X

Organizations: Network configurations

List hosted compute network configurations for an organization

X

Create a hosted compute network configuration for an organization

X

Get a hosted compute network configuration for an organization

X

Update a hosted compute network configuration for an organization

X

Delete a hosted compute network configuration from an organization

X

Get a hosted compute network settings resource for an organization

X

Organizations: Organization roles

Get all organization roles for an organization

X

Remove all organization roles for a team

X

Assign an organization role to a team

X

Remove an organization role from a team

X

Remove all organization roles for a user

X

Assign an organization role to a user

X

Remove an organization role from a user

X

Get an organization role

X

List teams that are assigned to an organization role

X

List users that are assigned to an organization role

X

Organizations: Outside collaborators

List outside collaborators for an organization

X

Convert an organization member to outside collaborator

X

Remove outside collaborator from an organization

X

Organizations: Personal access tokens

List requests to access organization resources with fine-grained personal access tokens

X

Review requests to access organization resources with fine-grained personal access tokens

X

List repositories requested to be accessed by a fine-grained personal access token

X

List fine-grained personal access tokens with access to organization resources

X

Update organization resources access

X

Update fine-grained personal access token access

X

List repositories a fine-grained personal access token has access to

X

Organizations: Rule suites

List organization rule suites

X

Get an organization rule suite

X

Organizations: Rules

Get all organization repository rulesets

X

Create organization repository ruleset

X

Get an organization repository ruleset

X

Update organization repository ruleset

X

Delete an organization repository ruleset

X

Get organization ruleset history

X

Get organization ruleset version

X

Pages

Get a GitHub Pages site

X

Create a GitHub Pages site

X

Update information about a GitHub Pages site

X

Delete a GitHub Pages site

X

List GitHub Pages builds

X

Get latest pages build

X

Get GitHub Pages build

X

Create a GitHub Pages deployment

X

Get the status of a GitHub Pages deployment

X

Cancel a GitHub Pages deployment

X

Get a DNS health check for GitHub Pages

X

Private registries: Organization configurations

List private registries for an organization

X

Create a private registry for an organization

X

Get private registries public key for an organization

X

Get a private registry for an organization

X

Update a private registry for an organization

X

Delete a private registry for an organization

X

Projects

List repository projects

X

List organization projects

X

Get a project

X

List project cards

X

Get a project card

X

List project columns

X

Get a project column

X

Create repo project

X

Create organizations project

X

Update project

X

Delete a project

X

Create a project card

X

Update a project card

X

Delete a project card

X

Create a project column

X

Update a project column

X

Delete a project column

X

Move a project column

X

Projects (Classic): Collaborators

List project collaborators

X

Add project collaborator

X

Remove user as a collaborator

X

Get project permission for a user

X

Projects: Draft project items

Create draft item for organization owned project

X

Create draft item for user owned project

X

Projects: Project fields

List project fields for organization

X

Get project field for organization

X

List project fields for user

X

Get project field for user

X

Projects: Project items

List items for an organization owned project

X

Add item to organization owned project

X

Delete project item for organization

X

List user items

X

Add item to user owned project

X

Get an item for a user owned project

X

Update project item

X

Delete project item for user

X

Projects: Projects

List projects for organization

X

Get project for organization

X

List projects for user

X

Get project for user

X

Pull requests: Review comments

List review comments in a repository

X

Get a review comment for a pull request

X

Update a review comment for a pull request

X

Delete a review comment for a pull request

X

List review comments on a pull request

X

Create a review comment for a pull request

X

Create a reply for a review comment

X

Pull requests: Review requests

Pull request review request

X

Pull requests: Reviews

List reviews for a pull request

X

Create a review for a pull request

X

Get a review for a pull request

X

Update a review for a pull request

X

Delete a pending review for a pull request

X

List comments for a pull request review

X

Submit a review for a pull request

X

Rate limit

Rate limit status

X

Get rate limit status for the authenticated user

X

Releases: Release assets

Get a release asset

X

Update a release asset

X

Delete a release asset

X

List release assets

X

Upload a release asset

X

Releases: Releases

List releases

X

Create a release

X

Generate release notes content for a release

X

Get the latest release

X

Get a release by tag name

X

Get a release

X

Update a release

X

Delete a release

X

Repositories: Contents

Get repository content

X

Create or update file contents

X

Delete a file

X

Get a repository readme

X

Get a repository readme for a directory

X

Download a repository archive (tar)

X

Download a repository archive (zip)

X

Repositories: Custom properties

Custom properties API

X

Get all custom property values for a repository

X

Repositories: Forks

List forks

X

Create a fork

X

Repositories: Repositories

List organization repositories

X

Create repository

X

GitHub repository information

X

Update a repository

X

Delete a repository

X

List repository activities

X

Create an attestation

X

List artifact attestations

X

Check if Dependabot security updates are enabled for a repository

X

Enable Dependabot security updates

X

Disable Dependabot security updates

X

List codeowners errors

X

List repository contributors

X

Create a repository dispatch event

X

Check if immutable releases are enabled for a repository

X

Enable immutable releases

X

Disable immutable releases

X

List repository languages

X

Check if private vulnerability reporting is enabled for a repository

X

Enable private vulnerability reporting for a repository

X

Disable private vulnerability reporting for a repository

X

List repository tags

X

List repository teams

X

Get all repository topics

X

Replace all repository topics

X

Transfer a repository

X

Check if vulnerability alerts are enabled for a repository

X

Enable vulnerability alerts

X

Disable vulnerability alerts

X

Create repository from template

X

List public repositories

X

List repositories for the authenticated user

X

Create a repository for the authenticated user

X

List repositories for a user

X

Repositories: Rule suites

List repository rule suites

X

Get a repository rule suite

X

Repositories: Rules

Get rules for a branch

X

Get all repository rulesets

X

Create repository ruleset

X

Get a repository ruleset

X

Update repository ruleset

X

Delete a repository ruleset

X

Get repository ruleset history

X

Get repository ruleset version

X

Repositories: Tags

Closing down: List tag protection states for a repository

X

Closing down: Create a tag protection state for a repository

X

Closing down: Delete a tag protection state for a repository

X

Secrets scanning: Push protection

List organization pattern configurations

X

Update organization pattern configurations

X

Security advisories: Global security advisories

List global security advisories

X

Get a global security advisory

X

Security advisories: Repository security advisories

List repository security advisories for an organization

X

List security advisories

X

Create a repository security advisory

X

Privately report a security vulnerability

X

Get a repository security advisory

X

Update a repository security advisory

X

Teams: Discussion comments

List discussion comments

X

Create a discussion comment

X

Get a discussion comment

X

Update a discussion comment

X

Delete a discussion comment

X

List discussion comments (legacy)

X

Create a discussion comment (legacy)

X

Get a discussion comment (legacy)

X

Update a discussion comment (legacy)

X

Delete a discussion comment (legacy)

X

Teams: Discussions

List discussions

X

Create a discussion

X

Get a discussion

X

Update a discussion

X

Delete a discussion

X

List discussions (legacy)

X

Create a discussion (legacy)

X

Get a discussion (legacy)

X

Update a discussion (legacy)

X

Delete a discussion (legacy)

X

Users

Get the authenticated user

X

Get all users

X

Get a single user

X

List email addresses for a user

X

List public email addresses for a user

X

List a user's followers

X

List the authenticated user's followers

X

List who a user is following

X

List who the authenticated user is following

X

Check if you are following a user

X

Check if one user follows another

X

Search users

X

Follow a user

X

Update the authenticated user

X

Unfollow a user

X

Get a user using their ID

X

Get contextual information for a user

X

Users: Attestations

List attestations by bulk subject digests

X

Delete attestations in bulk

X

Delete attestations by subject digest

X

Delete attestations by ID

X

List attestations

X