Github
Learn how to use Github with Composio
Overview
Enum
GITHUB
Description
GitHub is a code hosting platform for version control and collaboration, offering Git-based repository management, issue tracking, and continuous integration features
Authentication Details
OAUTH2
Actions
GITHUB_LIST_DEPENDABOT_ALERTS_FOR_AN_ORGANIZATION
This endpoint allows organization owners or security managers to view dependabot alerts. access requires an oauth or personal access token with security events scope, or public repo scope for public repositories.
Action Parameters
Action Response
GITHUB_LIST_GIST_COMMENTS
This api endpoint lists gist comments, supporting media types for raw markdown (default) or base64-encoded contents for handling invalid utf-8 sequences. for more, see github’s media types documentation.
Action Parameters
Action Response
GITHUB_CREATE_OR_UPDATE_A_REPOSITORY_SECRET
This text explains how to create or update a repository secret with an encrypted value using libsodium. it requires collaborator access and an oauth or personal access token with repo scope. for encryption details, visit github’s guide.
Action Parameters
Action Response
GITHUB_GET_A_CODE_QL_DATABASE_FOR_A_REPOSITORY
This endpoint fetches a codeql database for a repo, providing json metadata by default. for binary download, use accept: application/zip and handle redirects. requires security events scope for private/public repos, public repo for public only.
Action Parameters
Action Response
GITHUB_CREATE_A_GPG_KEY_FOR_THE_AUTHENTICATED_USER
Adds a gpg key to the authenticated user’s github account. oauth app tokens and personal access tokens (classic) need the write:gpg key scope to use this endpoint.
Action Parameters
Action Response
GITHUB_DELETE_A_DISCUSSION_COMMENT_LEGACY
The teams api endpoint for deleting a team discussion comment is deprecated. users are advised to switch to the new endpoint as outlined in the provided url. oauth and personal access tokens require write:discussion scope.
Action Parameters
Action Response
GITHUB_CREATE_A_REMOVE_TOKEN_FOR_A_REPOSITORY
This endpoint provides a token to remove a self-hosted runner from a repository, expiring in 1 hour. users require admin access and the repo scope for oauth/personal tokens to use it.
Action Parameters
Action Response
GITHUB_GET_THE_HOURLY_COMMIT_COUNT_FOR_EACH_DAY
The text details a format for tracking commits: [day, hour, commits], with days 0-6 for sunday-saturday and hours 0-23. example [2, 14, 25] represents 25 commits at 2pm on tuesdays, based on commit timestamps.
Action Parameters
Action Response
GITHUB_DOWNLOAD_A_REPOSITORY_ARCHIVE_ZIP
Get a redirect url for downloading a zip of a repo, defaulting to the main branch. ensure redirects are followed. link expires in 5 mins for private repos; empty ones give a 404 error.
Action Parameters
Action Response
GITHUB_UPDATE_A_PROJECT
Updates a project board’s information. returns a 404 not found status if projects are disabled. if you do not have sufficient privileges to perform this action, a 401 unauthorized or 410 gone status is returned.
Action Parameters
Action Response
GITHUB_REMOVE_USER_AS_A_COLLABORATOR
Removes a collaborator from an organization project. you must be an organization owner or a project admin to remove a collaborator.
Action Parameters
Action Response
GITHUB_CREATE_A_TAG_PROTECTION_STATE_FOR_A_REPOSITORY
This creates a tag protection state for a repository. this endpoint is only available to repository administrators.
Action Parameters
Action Response
GITHUB_DELETE_AN_ORGANIZATION_SECRET
Deletes an organization’s secret using its name. users need collaborator access or admin:org scope (for oauth/personal access tokens) to manage secrets. private repository actions require the repo scope.
Action Parameters
Action Response
GITHUB_CREATE_A_PROJECT_CARD
To create a project card, submit a post request with column id and a note or repository content details. successful submissions return a 201 response with card details.
Action Parameters
Action Response
GITHUB_GET_AN_ORGANIZATION_WEBHOOK
The text describes an api endpoint to get an organization’s webhook config. only organization owners can use it, requiring admin:org hook scope for oauth and personal tokens. oauth apps can’t interact with webhooks they didn’t create.
Action Parameters
Action Response
GITHUB_LIST_ARTIFACTS_FOR_A_REPOSITORY
Lists all artifacts for a repository. anyone 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 endpoint with a private repository.
Action Parameters
Action Response
GITHUB_CREATE_AN_AUTOLINK_REFERENCE_FOR_A_REPOSITORY
Users with admin access to the repository can create an autolink.
Action Parameters
Action Response
GITHUB_GET_ALL_STATUS_CHECK_CONTEXTS
Protected branches are accessible in both free and paid github plans, including public repositories with github free, and both public and private repositories with higher-tier plans. more details are in github’s help documentation.
Action Parameters
Action Response
GITHUB_CREATE_REACTION_FOR_A_PULL_REQUEST_REVIEW_COMMENT
Create a reaction to a pull request review comment as described in the github documentation. a successful reaction will return an http 200 status, indicating the reaction type was added.
Action Parameters
Action Response
GITHUB_LIST_ORGANIZATION_EVENTS_FOR_THE_AUTHENTICATED_USER
This is the user’s organization dashboard. you must be authenticated as the user to view this.
Action Parameters
Action Response
GITHUB_LIST_DEPENDABOT_ALERTS_FOR_A_REPOSITORY
Oauth app tokens and personal access tokens (classic) need the security events scope to use this endpoint. if this endpoint is only used with public repositories, the token can use the public repo scope instead.
Action Parameters
Action Response
GITHUB_MERGE_A_BRANCH
Github’s endpoint merges a branch by requiring the repo’s owner, name, and json details (base, head, optional message). it returns status 201 with commit info on success, or errors for issues like missing branches, conflicts, forbidden actions, or spam.
Action Parameters
Action Response
GITHUB_UPDATE_THE_AUTHENTICATED_USER
note: if your email is set to private and you send an email parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the api.
Action Parameters
Action Response
GITHUB_REVIEW_RESOURCE_REQUESTS_WITH_FINE_GRAINED_TOKENS
Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. only github apps can use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_SECRET_SCANNING_ALERTS_FOR_AN_ORGANIZATION
This endpoint displays secret scanning alerts for organization repositories, requiring admin/security manager roles and specific token scopes (repo, security events, public repo) for access.
Action Parameters
Action Response
GITHUB_CREATE_A_RELEASE
Users with push access can create a release, triggering notifications. rapid creation may face secondary rate limiting. for details, see github’s rate limits and rest api best practices.
Action Parameters
Action Response
GITHUB_CREATE_A_COMMIT_STATUS
Users with push access in a repository can create commit statuses for a given sha. note: there is a limit of 1000 statuses per sha and context within a repository. attempts to create more than 1000 statuses will result in a validation error.
Action Parameters
Action Response
GITHUB_GET_A_WEBHOOK_CONFIGURATION_FOR_AN_ORGANIZATION
The text discusses retrieving an organization’s webhook configuration, requiring ownership and admin:org hook scope for access. it notes limitations on viewing or editing webhooks based on their creation origin.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORIES_WATCHED_BY_THE_AUTHENTICATED_USER
Lists repositories the authenticated user is watching.
Action Parameters
Action Response
GITHUB_REMOVE_PUBLIC_ORG_MEMBERSHIP
Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
Action Parameters
Action Response
GITHUB_CREATE_AN_ORGANIZATION_WEBHOOK
To use the endpoint for posting json payloads, one must be an organization owner with admin:org hook scope for oauth or classic tokens. oauth apps can’t interact with non-owned webhooks, and users can’t manage webhooks made by oauth apps.
Action Parameters
Action Response
GITHUB_CREATE_A_REPOSITORY_USING_A_TEMPLATE
Create a repository from a template via template owner and template repo. non-public templates need authentication. verify with the is template value. oauth and personal tokens require specific scopes to create repositories.
Action Parameters
Action Response
GITHUB_DELETE_A_SELF_HOSTED_RUNNER_FROM_AN_ORGANIZATION
This endpoint enables the deletion of a self-hosted runner from an organization when the machine is unavailable, requiring admin access and specific oauth scopes (admin:org for all, plus repo for private repos).
Action Parameters
Action Response
GITHUB_LIST_TEAM_REPOSITORIES
Lists a team’s repositories visible to the authenticated user. note: you can also specify a team by org id and team id using the route get /organizations/{org_id}/team/{team_id}/repos.
Action Parameters
Action Response
GITHUB_GET_REPOSITORY_CONTENT
This api endpoint fetches contents of files or directories in various formats, uniquely manages directories, symlinks, and submodules, and supports up to 1,000 files per directory with size constraints on features.
Action Parameters
Action Response
GITHUB_GET_THE_WEEKLY_COMMIT_COUNT
The text explains how to find total commit counts for an owner and everyone (all) in the last 52 weeks, from the oldest to the most recent week (seven days ago until today at utc midnight), by subtracting the owner’s commits from all.
Action Parameters
Action Response
GITHUB_UPDATE_A_REPOSITORY_RULESET
Update a ruleset for a repository.
Action Parameters
Action Response
GITHUB_LIST_EVENTS_FOR_THE_AUTHENTICATED_USER
If you are authenticated as the given user, you will see your private events. otherwise, you’ll only see public events.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORIES_FOR_THE_AUTHENTICATED_USER
The text outlines that the authenticated user can access repositories they own, collaborate on, or are part of through an organization, given explicit :read, :write, or :admin permissions.
Action Parameters
Action Response
GITHUB_CREATE_REACTION_FOR_A_TEAM_DISCUSSION_COMMENT
Adding a reaction to a team discussion comment via github’s api results in http 200 if the reaction exists. specify teams by org id and team id. oauth tokens require write:discussion scope.
Action Parameters
Action Response
GITHUB_LIST_ORGANIZATION_WEBHOOKS
To use this endpoint, you must be an organization owner and have admin:org hook scope. oauth apps can’t interact with webhooks they didn’t create; users have similar restrictions with oauth app-created webhooks.
Action Parameters
Action Response
GITHUB_SET_INTERACTION_RESTRICTIONS_FOR_YOUR_PUBLIC_REPOSITORIES
Temporarily restricts which type of github user can interact with your public repositories. setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.
Action Parameters
Action Response
GITHUB_UPDATE_A_DISCUSSION_COMMENT
This text outlines how to edit discussion comments, specifying teams with org id and team id. it requires write:discussion scope for oauth and classic personal access tokens.
Action Parameters
Action Response
GITHUB_RESTORE_A_PACKAGE_VERSION_FOR_THE_AUTHENTICATED_USER
A user can restore a deleted package version within 30 days if its namespace and version are unclaimed. oauth and personal tokens need read:packages and write:packages scopes, plus repo scope for certain registries.
Action Parameters
Action Response
GITHUB_LIST_SSH_SIGNING_KEYS_FOR_A_USER
Lists the ssh signing keys for a user. this operation is accessible by anyone.
Action Parameters
Action Response
GITHUB_RE_RUN_A_WORKFLOW
Re-runs your workflow run using its id. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_ADD_USER_ACCESS_RESTRICTIONS
Protected branches are accessible in both public and private repositories across various github plans, including github free and paid accounts. they allow specific users to have push access, with a total limit of 100 items for users, apps, and teams.
Action Parameters
Action Response
GITHUB_GET_PROJECT_PERMISSION_FOR_A_USER
Returns the collaborator’s permission level for an organization project. possible values for the permission key: admin, write, read, none. you must be an organization owner or a project admin to review a user’s permission level.
Action Parameters
Action Response
GITHUB_GET_A_PROJECT
Gets a project by its id. returns a 404 not found status if projects are disabled. if you do not have sufficient privileges to perform this action, a 401 unauthorized or 410 gone status is returned.
Action Parameters
Action Response
GITHUB_LIST_REVIEW_COMMENTS_ON_A_PULL_REQUEST
Endpoint lists pull request review comments in ascending order by id, supporting custom media types for raw, text-only, html rendered, and full representations of markdown body. more info on media types at github docs.
Action Parameters
Action Response
GITHUB_DECLINE_A_REPOSITORY_INVITATION
Authenticated users can delete a repository invitation by invitation id. if declined, it returns 204, and for conflicts/errors such as 404 or 403, see github docs.
Action Parameters
Action Response
GITHUB_SET_A_THREAD_SUBSCRIPTION
This endpoint manages repo thread notifications: ignore to halt alerts until mentioned, subscribe to activate alerts, and unsubscribe to delete notifications for a thread.
Action Parameters
Action Response
GITHUB_LIST_STARRED_GISTS
List the authenticated user’s starred gists:
Action Parameters
Action Response
GITHUB_DELETE_AN_ORGANIZATION
This process deletes an organization and its repositories, making its login unavailable for 90 days. users should review the terms of service on github’s site before deletion.
Action Parameters
Action Response
GITHUB_LIST_PACKAGES_FOR_AN_ORGANIZATION
This endpoint lists user-readable packages in an organization, requiring read:packages scope for oauth and classic tokens. for certain registries, repo scope is also needed. details on these registries at github’s documentation on package permissions.
Action Parameters
Action Response
GITHUB_ADD_TEAM_ACCESS_RESTRICTIONS
Protected branches are accessible in both free and paid github plans, including public and private repositories. they allow granting push access to specific teams, including child teams. for more details, refer to github’s documentation.
Action Parameters
Action Response
GITHUB_CREATE_A_WORKFLOW_DISPATCH_EVENT
Manually trigger a github actions workflow by replacing workflow id with the file name (e.g., main.yaml). ensure it’s set to activate on a workflow dispatch event with properly configured inputs. oauth/personal tokens require repo scope.
Action Parameters
Action Response
GITHUB_DELETE_A_COMMIT_COMMENT_REACTION
Delete a reaction to a commit comment by using the delete method on /repositories/:repository id/comments/:comment id/reactions/:reaction id, specifying the repository id.
Action Parameters
Action Response
GITHUB_GET_A_PULL_REQUEST
Github supports draft pull requests in various plans, including free, pro, team, and enterprise. it tests mergeability without branch changes, using mergeable and merge commit sha attributes, and allows for specific media types in data retrieval.
Action Parameters
Action Response
GITHUB_CREATE_A_COMMIT
Git commits’ verification object confirms signature validity, detailing verification status and reason, with fields like verified, reason, signature, and payload, indicating reasons from expired key to valid.
Action Parameters
Action Response
GITHUB_GET_ALL_REPOSITORY_RULESETS
Get all the rulesets for a repository.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORIES_STARRED_BY_THE_AUTHENTICATED_USER
This endpoint lists starred repositories of the authenticated user and supports media type application/vnd.github.star+json to include star creation timestamps. more on media types at github docs.
Action Parameters
Action Response
GITHUB_DELETE_TEAM_DISCUSSION_COMMENT_REACTION
To remove a team discussion comment reaction, use delete with specific ids, requiring write:discussion scope via oauth/personal tokens. see documentation for details.
Action Parameters
Action Response
GITHUB_REPO_S_LIST_BRANCHES
This api endpoint returns a repository’s branch list, allows filtering by protection status, supports pagination (30 results/page), and is detailed in github’s documentation.(DEPRECATED use list_branches)
Action Parameters
Action Response
GITHUB_GET_A_TEAM_BY_NAME
Retrieves a github team using its slug, created by lowercasing the name, replacing spaces with -, and special characters. alternatively, specify a team by org id and team id.
Action Parameters
Action Response
GITHUB_GET_A_RELEASE_BY_TAG_NAME
Get a published release with the specified tag.
Action Parameters
Action Response
GITHUB_LIST_CODESPACES_FOR_THE_ORGANIZATION
Lists the codespaces associated to a specified organization. oauth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Action Parameters
Action Response
GITHUB_ADD_A_REPOSITORY_COLLABORATOR
This endpoint handles notifications and collaborator permissions with possible secondary rate limiting. it restricts adding outside collaborators and changing permissions, imposing guidelines and limits on invitation rates.
Action Parameters
Action Response
GITHUB_LIST_ORGANIZATION_RULE_SUITES
Summarizes how to manage and view rule evaluations for repositories within an organization, with detailed guidance available at the provided github documentation link.
Action Parameters
Action Response
GITHUB_GET_A_WEBHOOK_DELIVERY_FOR_AN_ORGANIZATION_WEBHOOK
This endpoint lets organization owners retrieve a delivery for their organization’s webhook, requiring admin:org hook scope. oauth apps can’t manage others’ webhooks, and users can’t manage those created by oauth apps.
Action Parameters
Action Response
GITHUB_LIST_RELEASE_ASSETS
This endpoint fetches assets for a repository’s release on github, needing repository owner, repo name, and release id. supports pagination with per page and page. returns asset details like download url and metadata. see documentation for more.
Action Parameters
Action Response
GITHUB_GET_TEAM_MEMBERSHIP_FOR_A_USER
To access team memberships, which include child members, team visibility is needed. use specific api endpoints to check membership details like state and role, noting organization owners are maintainers.
Action Parameters
Action Response
GITHUB_GET_A_PACKAGE_FOR_A_USER
To access a user’s public package metadata, oauth and classic tokens need read:packages scope; repo scope is also required for repository-scoped github packages. refer to github documentation for specific registry information.
Action Parameters
Action Response
GITHUB_GET_ORGANIZATION_MEMBERSHIP_FOR_A_USER
In order to get a user’s membership with an organization, the authenticated user must be an organization member. the state parameter in the response can be used to identify the user’s membership status.
Action Parameters
Action Response
GITHUB_LIST_LOCATIONS_FOR_A_SECRET_SCANNING_ALERT
This endpoint displays all secret scanning alerts for eligible repositories to their admins, requiring oauth or access tokens with repo, security events, or public repo for public ones.
Action Parameters
Action Response
GITHUB_SEARCH_REPOSITORIES
Search for github repositories by criteria, returning up to 100 results per page. search includes text match metadata for names and descriptions. example: find popular tetris repositories in assembly, sorted by stars.
Action Parameters
Action Response
GITHUB_GET_A_REVIEW_COMMENT_FOR_A_PULL_REQUEST
This endpoint details review comments, supporting media types for raw markdown, text, html representations, and all combined. for more, see github’s documentation on media types.
Action Parameters
Action Response
GITHUB_STOP_A_CODESPACE_FOR_AN_ORGANIZATION_USER
Stops a user’s codespace. oauth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Action Parameters
Action Response
GITHUB_TRANSFER_A_REPOSITORY
When transferring a personal repository to another user, the new owner must accept the request. the process is asynchronous, with details on the original owner included. for more on transferring repositories, visit github’s documentation.
Action Parameters
Action Response
GITHUB_REQUEST_A_GITHUB_PAGES_BUILD
Request site builds from the latest revision on the default branch without extra commits. useful for diagnosing build issues. limited to one concurrent build per repository and requester; additional requests are queued.
Action Parameters
Action Response
GITHUB_CREATE_OR_UPDATE_AN_ENVIRONMENT
Create/update environments with protection rules and requirements for reviewers, branch name patterns, and secrets. use repo scope for oauth/personal tokens. see github docs on environments, branch policies, and actions secrets for details.
Action Parameters
Action Response
GITHUB_LIST_GIST_FORKS
This endpoint lists all forks of a specified gist (gist id), supporting pagination via per page and page. it returns gist forks with user info and metadata. for more, see github’s documentation.
Action Parameters
Action Response
GITHUB_REMOVE_INTERACTION_RESTRICTIONS_FOR_A_REPOSITORY
This text outlines the process for removing interaction restrictions from a repository, requiring owner or admin access. attempting to change limits at the user or organization level without proper permissions results in a 409 conflict response.
Action Parameters
Action Response
GITHUB_TEST_THE_PUSH_REPOSITORY_WEBHOOK
This text explains that using a specified command can trigger a hook for the latest push in a repository if it’s subscribed to push events. without subscription, it responds with 204, without a test post.
Action Parameters
Action Response
GITHUB_LIST_MATCHING_REFERENCES
The git database api retrieves ref arrays for branches or tags. without specifying :ref, it returns all references. non-existent :refs yield starting matches. mergeability requires a pull request.
Action Parameters
Action Response
GITHUB_GET_AN_ORGANIZATION
When two factor requirement enabled is true, an organization mandates 2fa for all. details require organization ownership or admin:org scope with tokens. github apps need organization plan permission for plan details.
Action Parameters
Action Response
GITHUB_CREATE_A_FORK
Create a fork for the user; it’s asynchronous so wait a bit. if over 5 mins, contact github support. needs github app installed on both source and destination accounts with necessary access.
Action Parameters
Action Response
GITHUB_CUSTOM_OIDCSUBJECT_CLAIM_TEMPLATE_SETTER
Sets 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 tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_ORGANIZATIONS
The text describes an approach to list organizations by their creation order, utilizing a since parameter for pagination, with direction to use the [link header] for navigating to subsequent pages.
Action Parameters
Action Response
GITHUB_CREATE_REACTION_FOR_A_TEAM_DISCUSSION_COMMENT_LEGACY
The api endpoint to react to team discussion comments is outdated and recommends using a newer endpoint. reactions that work will give an http 200 response, needing write:discussion access.
Action Parameters
Action Response
GITHUB_LIST_ISSUES_ASSIGNED_TO_THE_AUTHENTICATED_USER
Fetches issues assigned to the user across all repos, using filters to customize the fetch. issues and pull requests are included, discernible by the pull request key. supports various media types for responses. visit github docs for more info.
Action Parameters
Action Response
GITHUB_LIST_WORKFLOW_RUNS_FOR_A_REPOSITORY
This document explains how to access and filter workflow runs in a github repository for users with read access, requiring repo scope for private ones. it limits searches to 1,000 results per query with parameters.
Action Parameters
Action Response
GITHUB_LIST_PUBLIC_GISTS
Public gists can be listed from most to least recently updated, with pagination allowing up to 3000 gists retrieval, e.g., 100 pages of 30 gists or 30 pages of 100 gists.
Action Parameters
Action Response
GITHUB_UPDATE_BRANCH_PROTECTION
Protected branches are enabled across various github plans, requiring admin permissions to set up. note that updating users and teams arrays overwrites existing ones, with a total limit of 100 items for users, apps, and teams combined.
Action Parameters
Action Response
GITHUB_COMPARE_TWO_COMMITS
The api enables comparison of two commits, across same/different repos or forks, focusing on file changes, order variations from git log, supports pagination for extensive comparisons, and provides signature verification for commits.
Action Parameters
Action Response
GITHUB_DELETE_PACKAGE_VERSION_FOR_A_USER
Users can delete a package version unless it’s public with over 5,000 downloads. admin permissions are required for certain registry types, with read:packages and delete:packages scopes needed. contact github support if unable to delete.
Action Parameters
Action Response
GITHUB_LIST_SUBSCRIPTIONS_FOR_THE_AUTHENTICATED_USER
Lists the active subscriptions for the authenticated user.
Action Parameters
Action Response
GITHUB_LIST_LABELS_FOR_A_REPOSITORY
Lists all labels for a repository.
Action Parameters
Action Response
GITHUB_DELETE_A_MILESTONE
Deletes a milestone using the given milestone number.
Action Parameters
Action Response
GITHUB_SET_DEFAULT_WORKFLOW_PERMISSIONS_FOR_AN_ORGANIZATION
The text outlines how to set default workflow permissions for the github token in an organization and its ability to approve pull requests. it mentions required scopes for oauth and personal tokens to use this endpoint.
Action Parameters
Action Response
GITHUB_GET_A_DISCUSSION_LEGACY
The teams api will remove the deprecated endpoint route. users are advised to switch to the get a discussion endpoint. access requires read:discussion scope for oauth and classic tokens.
Action Parameters
Action Response
GITHUB_GET_A_REPOSITORY_VARIABLE
Gets a specific variable in a repository. the authenticated user must have collaborator access to the repository to use this endpoint. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_UPDATE_A_REPOSITORY_INVITATION
Update github repo invitations by specifying user permissions (read, write, admin) through the path {owner}`/`{repo}`/invitations/`{invitation_id}. more info on github docs.
Action Parameters
Action Response
GITHUB_REMOVE_CUSTOM_LABEL_FROM_REPO_RUNNER
This endpoint allows admin users to remove a custom label from a self-hosted runner in a repository, returning the remaining labels. a 404 status occurs if the label is absent. oauth app tokens and personal access tokens require repo scope.
Action Parameters
Action Response
GITHUB_LIST_USERS_BLOCKED_BY_THE_AUTHENTICATED_USER
List the users you’ve blocked on your personal account.
Action Parameters
Action Response
GITHUB_GET_A_REPOSITORY_RULE_SUITE
This document provides details on obtaining rule evaluations for a repository, with further guidance available on managing rulesets at a provided github documentation link.
Action Parameters
Action Response
GITHUB_CANCEL_AN_IMPORT
The import feature for repositories is deprecated due to low usage and alternatives, ceasing on april 12, 2024. more info can be found in the changelog.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_LANGUAGES
Lists languages for the specified repository. the value shown for each language is the number of bytes of code written in that language.
Action Parameters
Action Response
GITHUB_LOCK_AN_ISSUE
Users with push access can lock conversations in issues or pull requests. without parameters, set content-length to zero. more info at github’s rest api guide.
Action Parameters
Action Response
GITHUB_LIST_PACKAGES_FOR_A_USER
This endpoint lists packages in a user’s namespace accessible to the requester, requiring read:packages scope, and repo scope for certain github packages registries. it directs to a doc for registry-specific permissions.
Action Parameters
Action Response
GITHUB_LIST_REVIEWS_FOR_A_PULL_REQUEST
This endpoint lists reviews for a pull request chronologically, supporting different media types for varying representations of the markdown body, including raw, text, html, or all.
Action Parameters
Action Response
GITHUB_GET_TEAM_MEMBER_LEGACY
The “get team member” endpoint is deprecated. instead, use the “get team membership for a user” endpoint for retrieving active and pending memberships, ensuring the team is visible to the authenticated user.
Action Parameters
Action Response
GITHUB_REMOVE_A_REPOSITORY_COLLABORATOR
Removing a collaborator from a repo revokes their access, cancels invitations, unassigns issues, affects their fork permissions, and updates org project access. changes may take time and access might persist through org permissions.
Action Parameters
Action Response
GITHUB_USERS_LIST_EMAILS_FOR_AUTHENTICATED_USER
Lists all of your email addresses, and specifies which one is visible to the public. oauth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.(DEPRECATED use list_email_addresses_for_the_authenticated_user)
Action Parameters
Action Response
GITHUB_GET_A_BRANCH
This api endpoint fetches details of a repository branch including commit info and protection status, requiring repo owner and branch name. it supports conditional requests, github apps, and offers detailed commit data and api links.
Action Parameters
Action Response
GITHUB_GET_A_REPOSITORY_README_FOR_A_DIRECTORY
This endpoint fetches a repository’s readme, offering raw file contents by default (application/vnd.github.raw+json) or in html format (application/vnd.github.html+json), utilizing github’s markup library for rendering.
Action Parameters
Action Response
GITHUB_DELETE_A_REFERENCE
Deletes the provided reference.
Action Parameters
Action Response
GITHUB_LIST_PULL_REQUESTS
Draft pull requests are available across various github plans. the endpoint supports custom media types like raw, text, html, diff, and patch representations. for more details, refer to github’s products and media types documentation.
Action Parameters
Action Response
GITHUB_LIST_WORKFLOW_RUNS_FOR_A_WORKFLOW
List all workflow runs using workflow id or the file name like main.yaml. parameters can refine results. it’s accessible to those with read access, and private repositories require repo scope via oauth or personal access tokens.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_INVITATIONS
When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORIES_WATCHED_BY_A_USER
Lists repositories a user is watching.
Action Parameters
Action Response
GITHUB_CREATE_AN_ENVIRONMENT_VARIABLE
To reference an environment variable in github actions, users need collaborator access. oauth and classic personal access tokens require the repo scope for creation, updating, or reading variables.
Action Parameters
Action Response
GITHUB_UPDATE_A_REPOSITORY_WEBHOOK
Update a repository’s webhook by providing the same or a new secret; otherwise, the secret is removed. for partial config updates, use the specific webhook configuration update guide.
Action Parameters
Action Response
GITHUB_DELETE_A_GITHUB_PAGES_SITE
This text explains how to delete a github pages site, requiring the user to be a repository admin, maintainer, or have specific permissions. oauth or personal access tokens with ‘repo’ scope are needed.
Action Parameters
Action Response
GITHUB_LIST_COMMITS
The verification object in a commit includes the verified status, reason, signature, and payload. failure can result from key issues, service errors, unsigned commits, unrecognized signatures, email issues, or invalid signatures.
Action Parameters
Action Response
GITHUB_REMOVE_USER_ACCESS_RESTRICTIONS
Protected branches in github restrict push access in public and private repositories, allowing only certain users with a total limit of 100 items, including users, apps, and teams. see github’s documentation for more.
Action Parameters
Action Response
GITHUB_DELETE_AN_APP_AUTHORIZATION
Oauth and github app owners can revoke user grants with basic authentication, using client id and client secret, along with a valid access token. this action deletes all oauth tokens and removes the app from the user’s github settings.
Action Parameters
Action Response
GITHUB_GET_A_WEBHOOK_CONFIGURATION_FOR_A_REPOSITORY
This text outlines how to retrieve a repository’s webhook configuration and details, specifying that oauth app tokens and personal access tokens require read:repo hook or repo scope for access.
Action Parameters
Action Response
GITHUB_LIST_DELIVERIES_FOR_A_REPOSITORY_WEBHOOK
Returns a list of webhook deliveries for a webhook configured in a repository.
Action Parameters
Action Response
GITHUB_DELETE_AN_ENVIRONMENT_VARIABLE
Authenticated users need collaborator access to delete an environment variable by its name. oauth and classic personal access tokens require the repo scope for this action.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_WORKFLOWS
Lists the workflows in a repository. anyone 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 endpoint with a private repository.
Action Parameters
Action Response
GITHUB_LIST_CODE_SCANNING_ALERTS_FOR_A_REPOSITORY
The document outlines how to obtain code scanning alerts, highlighting the inclusion of the most recent instance for a specified branch/reference. access requires security events scope for private/public repos or public repo scope for public ones.
Action Parameters
Action Response
GITHUB_LIST_CODE_SCANNING_ALERTS_FOR_AN_ORGANIZATION
The text outlines a feature for listing code scanning alerts on default branches in eligible repos. it requires oauth/access tokens with specific permissions for org owners or security managers, with additional notes on security management.
Action Parameters
Action Response
GITHUB_CREATE_A_DEPLOYMENT_STATUS
Users with push access can create deployment statuses for a given deployment. oauth app tokens and personal access tokens (classic) need the repo deployment scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_ASSIGNMENTS_FOR_A_CLASSROOM
Lists github classroom assignments for a classroom. assignments will only be returned if the current user is an administrator of the github classroom.
Action Parameters
Action Response
GITHUB_RENDER_A_MARKDOWN_DOCUMENT
This endpoint converts markdown to html, offering ‘markdown’ and ‘gfm’ modes, with ‘gfm’ requiring a repo context. see github docs for details.
Action Parameters
Action Response
GITHUB_GET_GITHUB_ACTIONS_CACHE_USAGE_FOR_A_REPOSITORY
This api fetches github actions cache usage for a repository, updating roughly every 5 minutes. it’s accessible by anyone with read access, but private repos require oauth or personal access tokens with repo scope.
Action Parameters
Action Response
GITHUB_UPDATE_A_REPOSITORY_VARIABLE
To create, update, or read variables in a github actions workflow, authenticated users need collaborator access, and oauth app tokens or classic personal access tokens must have the repo scope.
Action Parameters
Action Response
GITHUB_LIST_PUBLIC_EVENTS_FOR_A_USER
This endpoint lists a github user’s public events, accepting username and optional per page and page parameters for pagination. it shows activities such as watched repos and pushed commits.
Action Parameters
Action Response
GITHUB_CHECK_TEAM_PERMISSIONS_FOR_A_REPOSITORY
The text guides on verifying a team’s permissions for a repository, including inherited permissions, by using a special media type. it elaborates on the necessary permissions for private repositories and an alternative way to specify a team.
Action Parameters
Action Response
GITHUB_ADD_OR_UPDATE_TEAM_REPOSITORY_PERMISSIONS_LEGACY
The teams api is deprecated; use “add or update team repository permissions” instead. admins with proper visibility in organization or direct fork repos can modify permissions. it doesn’t work on non-organization repos, resulting in a 422 error.
Action Parameters
Action Response
GITHUB_LIST_ORGANIZATION_MEMBERS
List all users who are members of an organization. if the authenticated user is also a member of this organization then both concealed and public members will be returned.
Action Parameters
Action Response
GITHUB_GET_AN_APP
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., https://github.com/settings/apps/:app slug).
Action Parameters
Action Response
GITHUB_LIST_REPO_DEV_CONTAINER_CONFIGS_FOR_USER
This text describes an api endpoint that retrieves devcontainer.json files from a specified repository, detailing launch configurations for codespaces. oauth app and personal tokens require codespace scope to access.
Action Parameters
Action Response
GITHUB_META_ROOT
Get hypermedia links to resources accessible in github’s rest api(DEPRECATED use github_api_root)
Action Parameters
Action Response
GITHUB_GET_TEAMS_WITH_ACCESS_TO_THE_PROTECTED_BRANCH
Protected branches are accessible in public repos with github free and in both public/private repos with github pro, team, enterprise cloud, and server. it also lists teams with push access to the branch.
Action Parameters
Action Response
GITHUB_CREATE_A_REPOSITORY_DISPATCH_EVENT
Trigger the repository dispatch event on github to start workflows or webhooks with external activity. configure your github or app to respond to this event. use the client payload for extra info or testing. oauth and access tokens need repo scope.
Action Parameters
Action Response
GITHUB_LIST_PROJECT_CARDS
Lists the project cards in a project.
Action Parameters
Action Response
GITHUB_LIST_USER_PROJECTS
Lists projects for a user.
Action Parameters
Action Response
GITHUB_DELETE_A_DISCUSSION_COMMENT
This text explains how to delete a comment in a team discussion, either by specifying an organization and team id or directly. it notes that oauth or personal access tokens with the “write:discussion” scope are required.
Action Parameters
Action Response
GITHUB_CREATE_A_USER_PROJECT
Creates a user project board. returns a 410 gone status if the user does not have existing classic projects. if you do not have sufficient privileges to perform this action, a 401 unauthorized or 410 gone status is returned.
Action Parameters
Action Response
GITHUB_GET_ALL_ORGANIZATION_ROLES_FOR_AN_ORGANIZATION
The text lists roles in an organization, specifying access requires being an administrator, a user with specific permissions, or using tokens with admin:org scope. for more, see the provided link.
Action Parameters
Action Response
GITHUB_REMOVE_ALL_ORGANIZATION_ROLES_FOR_A_USER
This endpoint allows an organization’s admin to revoke all assigned roles from a user. it requires an admin:org scope for oauth and personal access tokens to access. for more on roles, visit github’s documentation.
Action Parameters
Action Response
GITHUB_CREATE_UPDATE_ORG_SECRET_WITH_LIB_SODIUM
This text explains how to create/update an organization secret with libsodium, requiring admin:org scope for access. it emphasizes using github’s rest api encryption documentation for encrypting secrets.
Action Parameters
Action Response
GITHUB_GET_AN_ORGANIZATION_REPOSITORY_RULESET
Get a repository ruleset for an organization.
Action Parameters
Action Response
GITHUB_CREATE_AN_ORGANIZATION_INVITATION
Owners can invite users to an organization via github id or email. invitations trigger notifications and rapid use may cause rate limiting. check github’s api rate limits and best practices for more info.
Action Parameters
Action Response
GITHUB_GET_A_THREAD
Gets information about a notification thread.
Action Parameters
Action Response
GITHUB_DELETE_REPO_CODESPACE_SECRET_BY_NAME
Deletes a development environment secret in a repository using the secret name. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_ISSUES_GET
Github api marks issue transfers with 301, restricts access with 404, signals deletions with 410, and tracks updates via the issues webhook. prs are tagged as issues with a pull request key, offering different media response types.(DEPRECATED use get_an_issue)
Action Parameters
Action Response
GITHUB_CHECK_TEAM_PERMISSIONS_FOR_A_PROJECT
The text explains how to check a team’s permissions (read, write, admin) on an organization project, including inherited projects. it also notes the option to specify a team by org id and team id for project access.
Action Parameters
Action Response
GITHUB_PULLS_CHECK_IF_MERGED
Checks if a pull request has been merged into the base branch. the http status of the response indicates whether or not the pull request has been merged; the response body is empty.(DEPRECATED use check_if_a_pull_request_has_been_merged)
Action Parameters
Action Response
GITHUB_LIST_JOBS_FOR_A_WORKFLOW_RUN_ATTEMPT
An api endpoint lists workflow run jobs, supports filtering, and is accessible with repository read access. it requires repo scope for private repositories when using oauth or personal access tokens.
Action Parameters
Action Response
GITHUB_GET_A_PROJECT_CARD
Gets information about a project card.
Action Parameters
Action Response
GITHUB_UPDATE_AN_ORGANIZATION_VARIABLE
This github feature allows updating an organization variable for workflow reference. users need collaborator access or admin:org and repo scopes for private repositories using oauth or classic tokens.
Action Parameters
Action Response
GITHUB_GET_ALL_REPOSITORY_TOPICS
This endpoint fetches topics of a github repository, using owner and repo. it supports pagination with page and per page. api details at github documentation.
Action Parameters
Action Response
GITHUB_REVIEW_CUSTOM_DEPLOYMENT_PROTECTION_RULES_FOR_A_WORKFLOW_RUN
Approve or reject github app custom deployment protection rules for workflow runs. only the app’s rules can be reviewed. use specific personal or oauth app tokens with ‘repo’ scope for private repositories.
Action Parameters
Action Response
GITHUB_USERS_LIST_PUBLIC_EMAILS_FOR_AUTHENTICATED_USER
This text guides on setting the visibility of a user’s email address via the specified github endpoint. it mentions that oauth app tokens and personal access tokens require the user:email scope to access this feature.(DEPRECATED use list_public_email_addresses_for_the_authenticated_user)
Action Parameters
Action Response
GITHUB_GET_RATE_LIMIT_STATUS_FOR_THE_AUTHENTICATED_USER
The api divides rate limits into categories like core, search, and others. certain endpoint uses don’t impact rest api limits. the rate object is now deprecated; use core.
Action Parameters
Action Response
GITHUB_GET_LATEST_PAGES_BUILD
Gets information about the single most recent build of a github pages site. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_STOP_A_CODESPACE_FOR_THE_AUTHENTICATED_USER
Stops a user’s codespace. oauth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
Action Parameters
Action Response
GITHUB_DOWNLOAD_A_USER_MIGRATION_ARCHIVE
The url downloads a migration archive (tar.gz) with data (e.g., issues, pull requests, comments) and directories for attachments and repositories’ git data.
Action Parameters
Action Response
GITHUB_CUSTOMIZE_OIDC_SUBJECT_CLAIM_TEMPLATE
Gets the customization template for an openid connect (oidc) subject claim. oauth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_CODESPACES_IN_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER
Lists the codespaces associated to a specified repository and the authenticated user. oauth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
Action Parameters
Action Response
GITHUB_SET_INTERACTION_RESTRICTIONS_FOR_A_REPOSITORY
This text outlines how to restrict interactions in a github repository to specific user types. it requires owner or admin access. setting restrictions when there’s already a limit at the user/organization level results in a 409 conflict error.
Action Parameters
Action Response
GITHUB_SET_SELECTED_REPOSITORIES_FOR_AN_ORGANIZATION_SECRET
When the visibility of an organization secret is set to selected, it replaces all repositories’ access. users need collaborator access or admin:org scope (plus repo for private repositories) to manage secrets.
Action Parameters
Action Response
GITHUB_GET_ALL_DEPLOYMENT_PROTECTION_RULES_FOR_AN_ENVIRONMENT
This endpoint fetches enabled custom deployment protection rules for environments, needing ‘repo’ scope for private repositories. it’s open to those with read access and includes more information in linked documentation.
Action Parameters
Action Response
GITHUB_REMOVE_TEAM_MEMBERSHIP_FOR_A_USER
To remove a team member, ‘admin’ rights or ownership is needed without deleting the user. on github enterprise cloud, team sync is supported, yet api edits to membership with sync on can lead to errors. teams can be managed through idp as well.
Action Parameters
Action Response
GITHUB_ENCRYPT_ORG_DEV_ENV_SECRET
This text explains how to create or update an organization development environment secret by encrypting it using libsodium. it requires admin:org scope for oauth or classic tokens. see more on encrypting secrets for rest api at github docs.
Action Parameters
Action Response
GITHUB_REMOVE_A_REPOSITORY_FROM_A_TEAM
Organization owners or team maintainers can remove repositories from their team if they are authenticated. members need admin access to remove a repository. removal doesn’t delete the repo. teams specified by org id and team id with a delete route.
Action Parameters
Action Response
GITHUB_DOWNLOAD_JOB_LOGS_FOR_A_WORKFLOW_RUN
Obtain a temporary (1-minute expiry) redirect url for downloading plain text workflow job logs from the location: response header. access needs repository read rights, with private repositories requiring oauth or tokens with repo scope.
Action Parameters
Action Response
GITHUB_GET_A_REPOSITORY_SECURITY_ADVISORY
Publicly published security advisories are freely accessible, while unpublished ones require authenticated access with specific roles. private repository advisories need tokens with repo or repository advisories:read scope.
Action Parameters
Action Response
GITHUB_GET_A_REPOSITORY_SECRET
This endpoint allows fetching a single repository secret without disclosing its encrypted value. it requires the user to have collaborator access and oauth or classic personal access tokens with repo scope.
Action Parameters
Action Response
GITHUB_GET_INTERACTION_RESTRICTIONS_FOR_AN_ORGANIZATION
Shows which type of github user can interact with this organization and when the restriction expires. if there is no restrictions, you will see an empty response.
Action Parameters
Action Response
GITHUB_GET_GITHUB_ACTIONS_PERMISSIONS_FOR_AN_ORGANIZATION
Gets the github actions permissions policy for repositories and allowed actions and reusable workflows in an organization. oauth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Action Parameters
Action Response
GITHUB_CUSTOM_OIDCSUBJECT_CLAIM_TEMPLATE
Gets the customization template for an openid connect (oidc) subject claim. oauth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Action Parameters
Action Response
GITHUB_UNLOCK_A_USER_REPOSITORY
This text explains that you can unlock repositories after a user migration is complete, allowing their use or deletion. if a repository isn’t locked, trying to unlock it will result in a 404 not found status.
Action Parameters
Action Response
GITHUB_PULLS_CREATE_REVIEW_COMMENT
To comment on a pull request diff, use parameters line, side, start line, and start side. avoid using the deprecated position. triggering notifications, beware of rate limits. supports custom media types for comment formatting.(DEPRECATED use create_a_review_comment_for_a_pull_request)
Action Parameters
Action Response
GITHUB_PRIVATELY_REPORT_A_SECURITY_VULNERABILITY
To report a security vulnerability in a repository, follow the guide on private reporting at: https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability.
Action Parameters
Action Response
GITHUB_REMOVE_INTERACTION_RESTRICTIONS_FOR_AN_ORGANIZATION
Removes all interaction restrictions from public repositories in the given organization. you must be an organization owner to remove restrictions.
Action Parameters
Action Response
GITHUB_DOWNLOAD_AN_ORGANIZATION_MIGRATION_ARCHIVE
Fetches the url to a migration archive.
Action Parameters
Action Response
GITHUB_DELETE_A_TEAM
To delete a team, one must be an organization owner or a team maintainer. deleting a parent team also removes its child teams. teams can be specified for deletion using org id and team id via the specified route.
Action Parameters
Action Response
GITHUB_GET_A_CUSTOM_DEPLOYMENT_PROTECTION_RULE
This endpoint retrieves an enabled custom deployment protection rule for an environment accessible to anyone with repository read access. it requires repo scope for private repositories when using oauth or personal access tokens.
Action Parameters
Action Response
GITHUB_ADD_CUSTOM_LABELS_TO_A_SELF_HOSTED_RUNNER_FOR_A_REPOSITORY
Adds custom labels to a self-hosted runner configured in a repository. authenticated users must have admin access to the organization to use this endpoint. oauth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_GET_A_MILESTONE
Gets a milestone using the given milestone number.
Action Parameters
Action Response
GITHUB_REMOVE_A_LABEL_FROM_AN_ISSUE
Removes the specified label from the issue, and returns the remaining labels on the issue. this endpoint returns a 404 not found status if the label does not exist.
Action Parameters
Action Response
GITHUB_FOLLOW_A_USER
To call the specified endpoint, set content-length to zero. it needs user:follow scope for oauth and classic tokens. visit the provided url for more on http methods.
Action Parameters
Action Response
GITHUB_LIST_ORG_RESOURCES_WITH_PERSONAL_TOKENS
Lists requests from organization members to access organization resources with a fine-grained personal access token. only github apps can use this endpoint.
Action Parameters
Action Response
GITHUB_DELETE_A_CUSTOM_ORGANIZATION_ROLE
Deletes a custom org role, requiring the user to be an org admin or have specific permissions. oauth tokens need admin:org scope. more info at github docs on managing access with roles.
Action Parameters
Action Response
GITHUB_LIST_LABELS_FOR_AN_ISSUE
Lists all labels for an issue.
Action Parameters
Action Response
GITHUB_DELETE_AN_ORGANIZATION_VARIABLE
Deletes an organization variable using its name. authenticated users need collaborator access to create, update, or read variables. oauth and personal access tokens require admin:org scope, and repo scope for private repositories.
Action Parameters
Action Response
GITHUB_LIST_PUBLIC_EMAIL_ADDRESSES_FOR_THE_AUTHENTICATED_USER
This text guides on setting the visibility of a user’s email address via the specified github endpoint. it mentions that oauth app tokens and personal access tokens require the user:email scope to access this feature.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORIES_STARRED_BY_A_USER
This endpoint lists repositories a user has starred and supports media types like application/vnd.github.star+json, which includes the star’s creation timestamp. for more, visit github’s documentation on media types.
Action Parameters
Action Response
GITHUB_DISABLE_AUTOMATED_SECURITY_FIXES
Disables automated security fixes for a repository. the authenticated user must have admin access to the repository. for more information, see “configuring automated security fixes”.
Action Parameters
Action Response
GITHUB_LIST_ENVIRONMENT_CUSTOM_DEPLOYMENT_RULES
This endpoint fetches custom deployment protection rules for an environment, needing repo scope for private repositories through oauth or tokens. details are in github documentation.
Action Parameters
Action Response
GITHUB_ENABLE_OR_DISABLE_A_SECURITY_FEATURE_FOR_AN_ORGANIZATION
This text outlines how to enable/disable security features for all eligible repositories in an organization, requiring the user to be an owner or a security manager with write:org scope for access.
Action Parameters
Action Response
GITHUB_ACTIVITY_LIST_REPO_S_STARRED_BY_AUTHENTICATED_USER
This endpoint lists starred repositories of the authenticated user and supports media type application/vnd.github.star+json to include star creation timestamps. more on media types at github docs.(DEPRECATED use list_repositories_starred_by_the_authenticated_user)
Action Parameters
Action Response
GITHUB_CREATE_A_COMMIT_COMMENT
The endpoint allows adding comments to commits with :commit sha, triggering notifications. rapid use may cause rate limiting. supports various media types for comments. see github docs for limits, best practices, and media type details.
Action Parameters
Action Response
GITHUB_DELETE_AN_ARTIFACT
Deletes an artifact for a workflow run. oauth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_REMOVE_REPO_FROM_ORG_DEV_ENV_SECRET
Removes a repo from an org development environment secret when access is set to ‘selected’. requires ‘admin:org’ scope for oauth app tokens and personal access tokens to use this endpoint.
Action Parameters
Action Response
GITHUB_GET_COMMUNITY_PROFILE_METRICS
The text details metrics for evaluating non-fork repositories, such as health score, documentation, and compliance with recommended files, including a ‘health percentage’ and notes that ‘content reports enabled’ is specific to organization repos.
Action Parameters
Action Response
GITHUB_SET_GITHUB_ACTIONS_PERMISSIONS_FOR_AN_ORGANIZATION
Sets the github actions permissions policy for repositories and allowed actions and reusable workflows in an organization. oauth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Action Parameters
Action Response
GITHUB_CREATE_AN_ISSUE_COMMENT
The rest api allows creating comments on issues and prs, noting that all prs are issues, but not vice versa. it can trigger notifications and may face rate limits. supports various media types for responses, including raw, text, html, or a combination.
Action Parameters
Action Response
GITHUB_GET_ALL_COMMONLY_USED_LICENSES
Lists the most commonly used licenses on github. for more information, see “licensing a repository .”
Action Parameters
Action Response
GITHUB_DELETE_PULL_REQUEST_REVIEW_PROTECTION
Protected branches can be used in public repositories with github free and in both public/private repositories with higher plans like github pro, team, and enterprise. more details are on github’s products page.
Action Parameters
Action Response
GITHUB_UPDATE_A_PULL_REQUEST_BRANCH
Updates the pull request branch with the latest upstream changes by merging head from the base branch into the pull request branch.
Action Parameters
Action Response
GITHUB_LIST_GLOBAL_SECURITY_ADVISORIES
The text describes how to find global security advisories with specific parameters. by default, it excludes malware advisories, which can be included by setting the type parameter to malware. more on advisory types at github docs.
Action Parameters
Action Response
GITHUB_DELETE_A_SELF_HOSTED_RUNNER_FROM_A_REPOSITORY
This endpoint allows admins to remove a self-hosted runner from a repository, especially useful if the machine is no longer available. users must have admin access and the repo scope on their oauth or personal access tokens.
Action Parameters
Action Response
GITHUB_UNSTAR_A_GIST
Endpoint supports un-starring a gist via delete method, providing responses for success (204), not modified (304), not found (404), and forbidden (403). more details at github docs.
Action Parameters
Action Response
GITHUB_DELETE_A_DEPLOY_KEY
Deploy keys are immutable. if you need to update a key, remove the key and create a new one instead.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_WEBHOOKS
Lists webhooks for a repository. last response may return null if there have not been any deliveries within 30 days.
Action Parameters
Action Response
GITHUB_GET_ALL_ORGANIZATION_REPOSITORY_RULESETS
Get all the repository rulesets for an organization.
Action Parameters
Action Response
GITHUB_CREATE_A_REFERENCE
Creates a reference for your repository. you are unable to create new references for empty repositories, even if the commit sha-1 hash used exists. empty repositories are repositories without branches.
Action Parameters
Action Response
GITHUB_REPLACE_ALL_REPOSITORY_TOPICS
Replace or clear github repo topics by passing an array of names or an empty array, respectively, including owner and repo name in the path. full details: https://docs.github.com/rest/repos/repos#replace-all-repository-topics
Action Parameters
Action Response
GITHUB_CREATE_A_SSH_SIGNING_KEY_FOR_THE_AUTHENTICATED_USER
Creates an ssh signing key for the authenticated user’s github account. oauth app tokens and personal access tokens (classic) need the write:ssh signing key scope to use this endpoint.
Action Parameters
Action Response
GITHUB_GET_THE_WEEKLY_COMMIT_ACTIVITY
The endpoint provides weekly aggregates of additions and deletions for repositories with fewer than 10,000 commits. repositories exceeding this limit return a 422 status code.
Action Parameters
Action Response
GITHUB_DELETE_WORKFLOW_RUN_LOGS
Deletes all logs for a workflow run. oauth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_CANCEL_A_WORKFLOW_RUN
Cancels a workflow run using its id. oauth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_ORG_SECRETS_WITHOUT_VALUES
Lists all secrets available in an organization without revealing their encrypted values. oauth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Action Parameters
Action Response
GITHUB_UPDATE_A_RELEASE
Users with push access to the repository can edit a release.
Action Parameters
Action Response
GITHUB_ASSIGN_AN_ORGANIZATION_ROLE_TO_A_TEAM
The text details how to assign an organization role to a team, requiring an admin user and admin:org scope for oauth or personal access tokens. for more, visit the provided github documentation link.
Action Parameters
Action Response
GITHUB_REMOVE_USERS_FROM_CODESPACES_ACCESS_FOR_AN_ORGANIZATION
Codespaces billing for certain users will stop. access requires selected members settings. to modify, see the guide. oauth and classic tokens need admin:org scope.
Action Parameters
Action Response
GITHUB_VERIFY_DEV_CONTAINER_PERMISSIONS_ACCEPTED
Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. oauth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
Action Parameters
Action Response
GITHUB_GET_AN_ORGANIZATION_PUBLIC_KEY
To encrypt secrets, acquire your public key. authenticated users need collaborator access for operations. for private repositories or org scope, admin:org and repo scopes are necessary for oauth and personal access tokens respectively.
Action Parameters
Action Response
GITHUB_UPDATE_REPOSITORY_PREFERENCES_FOR_CHECK_SUITES
The default process automatically creates a check suite for each push to a repository. disabling this allows for manual creation, requiring admin permissions to adjust preferences.
Action Parameters
Action Response
GITHUB_REPO_S_CREATE_IN_ORG
A new repository can be created in a specific organization by a member. oauth and personal access tokens require public repo or repo scope for public, and repo scope for private repositories.(DEPRECATED use create_an_organization_repository)
Action Parameters
Action Response
GITHUB_MARK_A_THREAD_AS_READ
Marks a thread as “read.” marking a thread as “read” is equivalent to clicking a notification in your notification inbox on github: https://github.com/notifications.
Action Parameters
Action Response
GITHUB_LIST_TEAMS_THAT_ARE_ASSIGNED_TO_AN_ORGANIZATION_ROLE
This text details an api endpoint for listing teams by organization role, requiring admin status and admin:org scope for access. for details on roles, visit the provided github link.
Action Parameters
Action Response
GITHUB_LIST_REACTIONS_FOR_A_TEAM_DISCUSSION_COMMENT
Api endpoint retrieves reactions to a team discussion comment; specify by org id and team id. requires read:discussion scope with oauth or personal access tokens.
Action Parameters
Action Response
GITHUB_DELETE_A_CODE_SCANNING_ANALYSIS_FROM_A_REPOSITORY
Delete the latest github code scanning analyses marked as deletable to avoid a 400 error. this requires oauth or access tokens with proper scopes and allows further deletion urls with options for entire tool analyses preservation or removal.
Action Parameters
Action Response
GITHUB_CONFIGURE_JITRUNNER_FOR_ORG
Generates a config for the runner app, requiring admin access and admin:org scope for tokens. private repos need repo scope for access.
Action Parameters
Action Response
GITHUB_LIST_TOKEN_ACCESS_REPOSITORIES
Lists the repositories a fine-grained personal access token has access to. only github apps can use this endpoint.
Action Parameters
Action Response
GITHUB_UPDATE_A_PULL_REQUEST
Draft pull requires write access and is available for both public and private repos on various github plans. github also supports custom media formats for markdown content responses.
Action Parameters
Action Response
GITHUB_ADD_ASSIGNEES_TO_AN_ISSUE
Adds up to 10 assignees to an issue. users already assigned to an issue are not replaced.
Action Parameters
Action Response
GITHUB_GET_GITHUB_ACTIONS_BILLING_FOR_A_USER
The summary details github actions’ used minutes, covering both free and paid, applicable only in private repos for github-hosted runners, including re-runs and os multipliers, rounded up by minute. usage requires user scope for tokens.
Action Parameters
Action Response
GITHUB_GET_A_USER
Github discloses publicly set user email information and offers an emails api for email visibility control. this access necessitates github authentication.
Action Parameters
Action Response
GITHUB_START_A_USER_MIGRATION
Initiates the generation of a user migration archive.
Action Parameters
Action Response
GITHUB_CREATE_A_CODESPACE_FOR_THE_AUTHENTICATED_USER
Creates a new codespace, owned by the authenticated user. this endpoint requires either a repository id or a pull request but not both. oauth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
Action Parameters
Action Response
GITHUB_CREATE_AN_ORGANIZATION_VARIABLE
This text describes how to create an organization variable in github actions, specifying that users need collaborator access, and oauth/personal access tokens require admin:org and repo scopes for public and private repositories, respectively.
Action Parameters
Action Response
GITHUB_DELETE_A_USER_MIGRATION_ARCHIVE
Migration archives are automatically deleted after 7 days. despite this, migration metadata remains accessible via specific github rest api endpoints even after archive deletion.
Action Parameters
Action Response
GITHUB_LIST_OUTSIDE_COLLABORATORS_FOR_AN_ORGANIZATION
List all users who are outside collaborators of an organization.
Action Parameters
Action Response
GITHUB_CLEAR_SELF_HOSTED_RUNNER_ORG_LABELS
This endpoint allows admins to remove custom labels from a self-hosted runner in an organization, leaving only read-only labels. it requires admin:org scope for oauth tokens and repo scope for private repos.
Action Parameters
Action Response
GITHUB_CREATE_A_CODESPACE_IN_A_REPOSITORY
Creates a codespace owned by the authenticated user in the specified repository. oauth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
Action Parameters
Action Response
GITHUB_GET_GITHUB_ACTIONS_BILLING_FOR_AN_ORGANIZATION
The summary discusses github actions’ usage, focusing on paid minutes for private repo workflows and job reruns on github-hosted runners. it mentions os-specific minute multipliers and the necessity of specific scopes for oauth tokens.
Action Parameters
Action Response
GITHUB_DELETE_A_REPOSITORY_WEBHOOK
To remove a repository webhook in github cloud or github apps, use the repository owner’s name, the repository’s name, and the webhook’s id. a 204 code confirms deletion, and a 404 code signifies a missing webhook. visit the official api for more.
Action Parameters
Action Response
GITHUB_DELETE_A_WORKFLOW_RUN
Deletes a specific workflow run. anyone with write access to the repository can use this endpoint. if the repository is private, oauth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_FORK_A_GIST
Forks a github gist using its id, returns forked gist details in json with a 201 status for success. requires gist id. see documentation for more.
Action Parameters
Action Response
GITHUB_ACTIVITY_STAR_REPO_FOR_AUTHENTICATED_USER
Star a github repository for given repo and owner(DEPRECATED use star_a_repository_for_the_authenticated_user)
Action Parameters
Action Response
GITHUB_DELETE_A_PROJECT
Deletes a project board. returns a 404 not found status if projects are disabled.
Action Parameters
Action Response
GITHUB_GET_AN_ENVIRONMENT_PUBLIC_KEY
To encrypt environment secrets, acquire the environment’s public key. encryption is essential for secret creation or update. read access to the repository is needed, with private repositories requiring oauth or personal access tokens with ‘repo’ scope.
Action Parameters
Action Response
GITHUB_LIST_PUBLIC_KEYS_FOR_A_USER
Lists the verified public ssh keys for a user. this is accessible by anyone.
Action Parameters
Action Response
GITHUB_DELETE_AN_ORGANIZATION_REPOSITORY_RULESET
Delete a ruleset for an organization.
Action Parameters
Action Response
GITHUB_ENABLE_AUTOMATED_SECURITY_FIXES
Enables automated security fixes for a repository. the authenticated user must have admin access to the repository. for more information, see “configuring automated security fixes”.
Action Parameters
Action Response
GITHUB_APPROVE_A_WORKFLOW_RUN_FOR_A_FORK_PULL_REQUEST
The text outlines how to approve workflow runs for pull requests from new contributors using public forks, highlighting the need for repo scope with oauth and personal access tokens. detailed guidance is provided in a github documentation link.
Action Parameters
Action Response
GITHUB_GET_A_SELF_HOSTED_RUNNER_FOR_AN_ORGANIZATION
This endpoint configures a self-hosted runner in an organization and requires admin access. oauth app tokens and classic personal access tokens need admin:org scope, and private repositories also require repo scope.
Action Parameters
Action Response
GITHUB_MERGE_A_PULL_REQUEST
This api endpoint merges a pull request, triggers notifications, and may face secondary rate limiting if used too rapidly. for details, refer to github’s rate limits and rest api best practices.
Action Parameters
Action Response
GITHUB_CREATE_REACTION_FOR_A_RELEASE
Create a reaction to a release. a response with a status: 200 ok means that you already added the reaction type to this release.
Action Parameters
Action Response
GITHUB_GET_A_PACKAGE_FOR_AN_ORGANIZATION
To access a package within an organization, oauth and personal access tokens need read:packages scope. if the package is in a registry requiring repository-scoped permissions, repo scope is also necessary. see github documentation for specifics.
Action Parameters
Action Response
GITHUB_LIST_TEAM_REPOSITORIES_LEGACY
deprecation notice: this endpoint route is deprecated and will be removed from the teams api. we recommend migrating your existing code to use the new list team repositories endpoint.
Action Parameters
Action Response
GITHUB_GET_A_TAG
The verification object in commit responses includes boolean verified, reason for verification status, signature, and payload signed. reasons for reason field range from expired keys, errors, to valid signatures.
Action Parameters
Action Response
GITHUB_UPDATE_STATUS_CHECK_PROTECTION
Protected branches are accessible in public repos with github free and in both public and private repos with github pro, team, and enterprise versions. admin permissions are needed to update status checks, with branch protection enabled.
Action Parameters
Action Response
GITHUB_CHECK_IF_A_USER_IS_A_REPOSITORY_COLLABORATOR
Organization repository collaborators encompass direct members, outside collaborators, team and child team members, and owners, all needing push access and the correct oauth/personal tokens for access.
Action Parameters
Action Response
GITHUB_LIST_SOCIAL_ACCOUNTS_FOR_THE_AUTHENTICATED_USER
Lists all of your social accounts.
Action Parameters
Action Response
GITHUB_GET_AN_ENVIRONMENT_SECRET
This api endpoint allows authenticated collaborators with repo scope via oauth or personal access tokens to get a single repository environment secret without decrypting it.
Action Parameters
Action Response
GITHUB_ISSUES_CREATE_COMMENT
The rest api allows creating comments on issues and prs, noting that all prs are issues, but not vice versa. it can trigger notifications and may face rate limits. supports various media types for responses, including raw, text, html, or a combination.(DEPRECATED use create_an_issue_comment)
Action Parameters
Action Response
GITHUB_GET_CONTEXTUAL_INFORMATION_FOR_A_USER
This hovercard feature provides detailed info about someone’s involvement in pull requests, issues, repositories, and organizations, using subject type and subject id for context. oauth tokens require repo scope to access this endpoint.
Action Parameters
Action Response
GITHUB_REDELIVER_A_DELIVERY_FOR_A_REPOSITORY_WEBHOOK
Redeliver a webhook delivery for a webhook configured in a repository.
Action Parameters
Action Response
GITHUB_LIST_APP_INSTALLATIONS_ACCESSIBLE_TO_THE_USER_ACCESS_TOKEN
This github app feature lets authenticated users view installations they have permissions (:read, :write, or :admin) for, including personal, collaborator, and organization repositories, detailing permissions under the permissions key.
Action Parameters
Action Response
GITHUB_LIST_FAILED_ORGANIZATION_INVITATIONS
The return hash contains failed at and failed reason fields which represent the time at which the invitation failed and the reason for the failure.
Action Parameters
Action Response
GITHUB_UPDATE_A_CHECK_RUN
Updates a check run for a commit in a repo. only detects pushes in the original repository, not in forks, returning an empty pull requests array. oauth apps and classic personal access tokens cannot use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_PENDING_TEAM_INVITATIONS_LEGACY
Endpoint route in teams api deprecated; advised to use new endpoint for pending team invitations. includes role field with specific values; login field null if invitee not a github member.
Action Parameters
Action Response
GITHUB_REVIEW_ACCESS_WITH_PERSONAL_TOKEN
Approves or denies a pending request to access organization resources via a fine-grained personal access token. only github apps can use this endpoint.
Action Parameters
Action Response
GITHUB_GET_ALL_CUSTOM_PROPERTY_VALUES_FOR_A_REPOSITORY
Gets all custom property values that are set for a repository. users with read access to the repository can use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_LABELS_FOR_ISSUES_IN_A_MILESTONE
Lists labels for issues in a milestone.
Action Parameters
Action Response
GITHUB_RESTORE_A_PACKAGE_FOR_AN_ORGANIZATION
A package in an organization can be restored within 30 days of deletion, provided its namespace and version aren’t reused. admin permissions and relevant token scopes are required for restoration.
Action Parameters
Action Response
GITHUB_UPDATE_A_WEBHOOK_CONFIGURATION_FOR_AN_ORGANIZATION
Updates webhook config for organizations, allowing changes to active state and events. requires organization owner status and admin:org hook scope for tokens. restrictions apply to oauth apps and users on editing webhooks.
Action Parameters
Action Response
GITHUB_ADD_AN_EMAIL_ADDRESS_FOR_THE_AUTHENTICATED_USER
Oauth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_ORGANIZATION_MIGRATIONS
Lists the most recent migrations, including both exports (which can be started through the rest api) and imports (which cannot be started using the rest api). a list of repositories is only returned for export migrations.
Action Parameters
Action Response
GITHUB_CHECK_TEAM_PERMISSIONS_FOR_A_PROJECT_LEGACY
The teams api endpoint is deprecated. use the “check team permissions for a project” endpoint to verify a team’s permissions (read, write, admin) on projects, including inherited ones.
Action Parameters
Action Response
GITHUB_GET_THE_ZEN_OF_GITHUB
Get a random sentence from the zen of github
Action Parameters
Action Response
GITHUB_ENABLE_VULNERABILITY_ALERTS
Enables dependency alerts/graph for a repository, requiring admin access. for details on security alerts for vulnerabilities, see the provided link.
Action Parameters
Action Response
GITHUB_LIST_LABELS_FOR_A_SELF_HOSTED_RUNNER_FOR_A_REPOSITORY
Lists 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 app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_SUBSCRIPTIONS_FOR_THE_AUTHENTICATED_USER_STUBBED
Lists the active subscriptions for the authenticated user.
Action Parameters
Action Response
GITHUB_CREATE_A_BLOB
This api endpoint enables creating a new blob in a specified repository, supporting utf-8 and base64 encodings. it requires blob content in the request body and returns blob details, including url and sha, upon success.
Action Parameters
Action Response
GITHUB_GET_PENDING_DEPLOYMENTS_FOR_A_WORKFLOW_RUN
This endpoint retrieves deployment environments awaiting protection rule clearance in a workflow run, accessible to anyone with repository read access. for private repositories, oauth and classic personal access tokens require the repo scope.
Action Parameters
Action Response
GITHUB_SET_PUBLIC_ORGANIZATION_MEMBERSHIP_FOR_THE_AUTHENTICATED_USER
Users can publicize only their own memberships. when using this endpoint, set the content-length to zero. for more, see github’s http method guide.
Action Parameters
Action Response
GITHUB_LIST_COMMITS_ON_A_PULL_REQUEST
For pull requests with over 250 commits, use the “list commits” endpoint for a complete list. supports custom media types like raw, text, html markdown, and diff. see github docs for more on media types and handling corrupt diffs.
Action Parameters
Action Response
GITHUB_CREATE_A_GITHUB_PAGES_SITE
Summary: configures a github pages site, requiring the user to be a repository admin, maintainer, or have specific permission. oauth app and classic personal access tokens need the repo scope.
Action Parameters
Action Response
GITHUB_CREATE_A_PUBLIC_SSH_KEY_FOR_THE_AUTHENTICATED_USER
Adds a public ssh key to the authenticated user’s github account. oauth app tokens and personal access tokens (classic) need the write:gpg key scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_COMMIT_COMMENTS_FOR_A_REPOSITORY
This endpoint lists commit comments for a repository in ascending id order, supporting media types for different comment formats, including raw markdown, text, html, and a combination of all.
Action Parameters
Action Response
GITHUB_ENABLE_PRIVATE_VULNERABILITY_REPORTING_FOR_A_REPOSITORY
This feature allows secure vulnerability reporting for repositories by users with admin access. for details, visit the github guide on private vulnerability reporting.
Action Parameters
Action Response
GITHUB_UPDATE_A_REPOSITORY
note: to edit a repository’s topics, use the replace all repository topics endpoint.
Action Parameters
Action Response
GITHUB_FETCH_PUBLIC_KEY_FOR_SECRET_ENCRYPTION
Gets your public key, which you need to encrypt secrets. you need to encrypt a secret before you can create or update secrets. oauth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_GPG_KEYS_FOR_THE_AUTHENTICATED_USER
Lists the current user’s gpg keys. oauth app tokens and personal access tokens (classic) need the read:gpg key scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_USERS
The text describes a feature listing github users by signup order, including individuals and organizations, with pagination managed via the since parameter and the link header for navigating pages.
Action Parameters
Action Response
GITHUB_REMOVE_A_REPOSITORY_FROM_AN_APP_INSTALLATION
Remove a single repository from an installation. the authenticated user must have admin access to the repository. the installation must have the repository selection of selected.
Action Parameters
Action Response
GITHUB_SET_LABELS_FOR_AN_ISSUE
Removes any previous labels and sets the new labels for an issue.
Action Parameters
Action Response
GITHUB_REMOVE_REPO_FROM_ORG_SECRET_WITH_SELECTED_VISIBILITY
Removes a repository from an organization secret with “selected” visibility, set during secret creation/update. requires admin:org scope for oauth app and classic tokens to access endpoint.
Action Parameters
Action Response
GITHUB_LIST_PUBLIC_ORGANIZATION_EVENTS
This github api endpoint lists public events for organizations, like watch and push events. it supports pagination and requires the organization name. useful for monitoring activities in org repositories.
Action Parameters
Action Response
GITHUB_LIST_ORGANIZATION_INVITATION_TEAMS
List all teams associated with an invitation. in order to see invitations in an organization, the authenticated user must be an organization owner.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_TAGS
This endpoint lists a github repository’s tags, requiring its owner and name. offers optional pagination parameters per page (max 100) and page. detailed documentation is at github’s official site.
Action Parameters
Action Response
GITHUB_CONVERT_AN_ORGANIZATION_MEMBER_TO_OUTSIDE_COLLABORATOR
Converting an organization member to an outside collaborator restricts access to only those repositories allowed by current team membership, removing them from the organization. this action may be limited by enterprise administrators.
Action Parameters
Action Response
GITHUB_ADD_CUSTOM_LABELS_TO_A_SELF_HOSTED_RUNNER_FOR_AN_ORGANIZATION
This endpoint allows adding custom labels to a self-hosted runner within an organization. requires admin access and an oauth or personal access token with admin:org scope.
Action Parameters
Action Response
GITHUB_GET_A_WORKFLOW_RUN
Gets 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 repo scope to use this endpoint with a private repository.
Action Parameters
Action Response
GITHUB_DELETE_A_DISCUSSION_LEGACY
The teams api’s endpoint for deleting discussions is deprecated. it advises users to switch to the new “delete a discussion” endpoint. required oauth or classic tokens need the write:discussion scope.
Action Parameters
Action Response
GITHUB_DELETE_A_THREAD_SUBSCRIPTION
Mutes conversation notifications until you comment or are @mentioned, but still alerts if watching the repository. use the ‘set a thread subscription’ endpoint with ignore true to mute while watching a repository.
Action Parameters
Action Response
GITHUB_LIST_PUBLIC_REPOSITORIES
This endpoint lists all public repositories by creation order. on github enterprise server, it shows only universally accessible repositories. pagination relies on the since parameter, with the next page url in the link header.
Action Parameters
Action Response
GITHUB_CREATE_A_GIST
Allows you to add a new gist with one or more files. note: don’t name your files “gistfile” with a numerical suffix. this is the format of the automatic naming scheme that gist uses internally.
Action Parameters
Action Response
GITHUB_DELETE_A_PACKAGE_VERSION_FOR_THE_AUTHENTICATED_USER
Deletes specific package version owned by the user. if public and has greater than 5,000 downloads, contact github support. requires admin permissions, read:packages, delete:packages, and potentially repo scope for certain registries.
Action Parameters
Action Response
GITHUB_REMOVE_ORG_SECRET_BY_NAME
Deletes a secret in an organization using the secret name. oauth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Action Parameters
Action Response
GITHUB_DELETE_A_PENDING_REVIEW_FOR_A_PULL_REQUEST
Deletes unsubmitted pull request reviews. submitted ones can’t be deleted. supports custom media types for different data formats in the response. see github docs for more on media types.
Action Parameters
Action Response
GITHUB_UPDATE_AN_ISSUE
Issue owners and users with push access can edit issues. the endpoint supports different media types for markdown formatting, including raw, text, html representations, and a combination of all.
Action Parameters
Action Response
GITHUB_LIST_SECRETS_FOR_THE_AUTHENTICATED_USER
Endpoint lists a user’s codespaces development environment secrets without showing encrypted values. user must have codespaces access, and oauth or personal access tokens require codespace or codespace:secrets scope.
Action Parameters
Action Response
GITHUB_GET_A_COMMIT
The api provides commit content with read access, supports pagination for over 300 diffs up to 3000 files, and custom media types. large diffs may time out. includes signature status in a verification object.
Action Parameters
Action Response
GITHUB_GET_TOP_REFERRAL_SOURCES
Get the top 10 referrers over the last 14 days.
Action Parameters
Action Response
GITHUB_CREATE_CONFIGURATION_FOR_A_JUST_IN_TIME_RUNNER_FOR_A_REPOSITORY
Generates a configuration that can be passed to the runner application at startup. the authenticated user must have admin access to the repository. oauth tokens and personal access tokens (classic) need therepo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_CODE_SCANNING_ANALYSES_FOR_A_REPOSITORY
Api endpoint summary: lists up to 30 code scanning analyses per repository page, detailing rules run. older analyses may lack data. the tool name field is deprecated for tool. access requires specific oauth scopes.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_EVENTS
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.
Action Parameters
Action Response
GITHUB_CREATE_OR_UPDATE_FILE_CONTENTS
This endpoint creates or replaces a file in a repository but cannot be used concurrently with the “delete a file” endpoint to avoid errors. it requires repo and, for modifying .github/workflows, workflow scopes in oauth or personal access tokens.
Action Parameters
Action Response
GITHUB_LIST_ACCEPTED_ASSIGNMENTS_FOR_AN_ASSIGNMENT
Lists any assignment repositories that have been created by students accepting a github classroom assignment. accepted assignments will only be returned if the current user is an administrator of the github classroom for the assignment.
Action Parameters
Action Response
GITHUB_GET_THE_LEVEL_OF_ACCESS_FOR_WORKFLOWS_OUTSIDE_OF_THE_REPOSITORY
This endpoint determines access levels for workflows outside a private repository to its actions and reusable workflows. relevant for private repositories, requiring repo scope for oauth and classic personal access tokens.
Action Parameters
Action Response
GITHUB_DELETE_BRANCH_PROTECTION
Protected branches are available in public repos with github free/org, and in both public/private repos with github pro, team, enterprise cloud, and server. for details, see github’s products documentation.
Action Parameters
Action Response
GITHUB_ISSUES_CREATE
Pull access users can create issues unless disabled. api may return 410 gone if issues off. excessive endpoint use can trigger rate limiting. it supports raw, text, html formats for return data.(DEPRECATED use create_an_issue)
Action Parameters
Action Response
GITHUB_SEARCH_REPO_S
Search for github repositories by criteria, returning up to 100 results per page. search includes text match metadata for names and descriptions. example: find popular tetris repositories in assembly, sorted by stars.(DEPRECATED use search_repositories)
Action Parameters
Action Response
GITHUB_DELETE_AN_APP_TOKEN
Owners of oauth or github apps can revoke a specific token using basic authentication with the app’s client id and client secret.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_SECRETS_WITHOUT_DECRYPTING
Lists all secrets available in a repository without revealing their encrypted values. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_SECRET_SCANNING_ALERTS_FOR_AN_ENTERPRISE
This endpoint provides secret scanning alerts for enterprise repositories, focusing on new alerts in organizations where the user holds ownership or security management roles. access requires proper membership and either repo or security events scope.
Action Parameters
Action Response
GITHUB_GET_ALL_CUSTOM_PROPERTIES_FOR_AN_ORGANIZATION
Gets all custom properties defined for an organization. organization members can read these properties.
Action Parameters
Action Response
GITHUB_CREATE_A_DISCUSSION
New endpoint allows creating posts on a team’s page, triggering notifications. excessive use may lead to rate limiting. supports specifying teams by org id and team id. requires write:discussion scope for oauth and personal access tokens.
Action Parameters
Action Response
GITHUB_UPDATE_TOKEN_ORG_ACCESS
Updates the access an organization member has to organization resources via a fine-grained personal access token. limited to revoking the token’s existing access. limited to revoking a token’s existing access. only github apps can use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_REACTIONS_FOR_A_PULL_REQUEST_REVIEW_COMMENT
List the reactions to a pull request review comment.
Action Parameters
Action Response
GITHUB_GET_COMMIT_AUTHORS
Different source control systems have varied author identification methods, leading to inaccuracies in author mapping. github importer tries to fix this, but will be deprecated by april 12, 2024, due to low usage. an endpoint for accurate mapping exists.
Action Parameters
Action Response
GITHUB_LIST_WORKFLOW_RUN_ARTIFACTS
Lists artifacts for a workflow run. anyone 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 endpoint with a private repository.
Action Parameters
Action Response
GITHUB_DELETE_ACCESS_RESTRICTIONS
Protected branches are available across various github plans, including free, pro, team, and enterprise versions, in both public and private repositories. they block unauthorized users from pushing to the branch.
Action Parameters
Action Response
GITHUB_DELETE_A_PULL_REQUEST_COMMENT_REACTION
This route allows deleting a reaction from a pull request review comment by specifying repository id, comment id, and reaction id.
Action Parameters
Action Response
GITHUB_GET_A_DISCUSSION
Access a discussion on a team’s page via get /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}“. use oauth or personal access tokens with read:discussion scope.
Action Parameters
Action Response
GITHUB_LIST_REACTIONS_FOR_A_COMMIT_COMMENT
List the reactions to a commit comment.
Action Parameters
Action Response
GITHUB_GET_BRANCH_PROTECTION
Protected branches are available in public repositories with github free, across all repos for organizations, github pro, team, enterprise cloud, and server. details are in github’s product documentation.
Action Parameters
Action Response
GITHUB_CREATE_OR_UPDATE_AN_ORGANIZATION_SECRET
This text explains how to create or update an organization secret by encrypting it with libsodium. it mentions the necessity for users to have collaborator access and the required scopes for oauth and personal access tokens.
Action Parameters
Action Response
GITHUB_ADD_A_SECURITY_MANAGER_TEAM
This text outlines how to add a team as a security manager in an organization. the user must be an admin and use tokens with write:org scope. more info is available in the provided github link.
Action Parameters
Action Response
GITHUB_RETRIEVE_REPO_PUBLIC_KEY_FOR_ENCRYPTION
This endpoint retrieves the public key for encrypting secrets in a repository, accessible to users with read access. for private repositories, oauth and personal access tokens with the repo scope are needed.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_NOTIFICATIONS_FOR_THE_AUTHENTICATED_USER
Lists all notifications for the current user in the specified repository.
Action Parameters
Action Response
GITHUB_MOVE_A_PROJECT_COLUMN
The endpoint enables moving a project column to positions like ‘first’, ‘last’, or after a specified column id, needing a column id and position. see more at github api docs.
Action Parameters
Action Response
GITHUB_STAR_A_GIST
Note that you’ll need to set content-length to zero when calling out to this endpoint. for more information, see “http method.”
Action Parameters
Action Response
GITHUB_REMOVE_TEAM_ACCESS_RESTRICTIONS
Protected branches are available in various github plans, including free and paid versions. they restrict team push access to specific branches, with options for managing access levels, including for child teams.
Action Parameters
Action Response
GITHUB_CHECK_IF_A_USER_CAN_BE_ASSIGNED
Checks if a user has permission to be assigned to an issue in this repository. if the assignee can be assigned to issues in the repository, a 204 header with no content is returned. otherwise a 404 status code is returned.
Action Parameters
Action Response
GITHUB_PULLS_LIST
Draft pull requests are available across various github plans. the endpoint supports custom media types like raw, text, html, diff, and patch representations. for more details, refer to github’s products and media types documentation.(DEPRECATED use list_pull_requests)
Action Parameters
Action Response
GITHUB_GET_A_PACKAGE_VERSION_FOR_A_USER
Fetch a specific public package version with an oauth or classic token having read:packages scope. if package type is in a registry needing repository-scoped permissions, repo scope is needed. see github for registry details.
Action Parameters
Action Response
GITHUB_LIST_RUNNER_APPLICATIONS_FOR_A_REPOSITORY
Lists binaries for the runner application that you can download and run. authenticated users must have admin access to the repository to use this endpoint. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_GET_A_DEPLOYMENT_STATUS
Users with pull access can view a deployment status for a deployment:
Action Parameters
Action Response
GITHUB_ADD_OR_UPDATE_TEAM_PROJECT_PERMISSIONS
To add or update a team’s project, the user needs ‘admin’ rights. projects and teams must belong to the same organization. a team can be specified by org id and team id via put request.
Action Parameters
Action Response
GITHUB_FIND_CONFLICTING_PACKAGES_FOR_DOCKER_MIGRATION
This endpoint lists user-specific packages with migration conflicts accessible to the requester, requiring read:packages scope via oauth or classic tokens.
Action Parameters
Action Response
GITHUB_GIST_S_LIST_PUBLIC
Public gists can be listed from most to least recently updated, with pagination allowing up to 3000 gists retrieval, e.g., 100 pages of 30 gists or 30 pages of 100 gists.(DEPRECATED use list_public_gists)
Action Parameters
Action Response
GITHUB_UPDATE_A_DISCUSSION
This endpoint allows editing titles and bodies of discussion posts. updates are made with specific parameters. for team-specific discussions, use the route with org id and team id. oauth and personal tokens require write:discussion scope.
Action Parameters
Action Response
GITHUB_CREATE_A_REGISTRATION_TOKEN_FOR_AN_ORGANIZATION
Get a token for the config script from this endpoint; it expires in an hour. use it to configure self-hosted runners with admin access required. oauth and personal tokens need admin:org and repo scopes for private repos.
Action Parameters
Action Response
GITHUB_UPDATE_A_MILESTONE
Update a milestone in a github repo by specifying its number. supports changing its title, state, description, and due date. refer to github docs for more.
Action Parameters
Action Response
GITHUB_GET_A_LABEL
Gets a label using the given name.
Action Parameters
Action Response
GITHUB_DELETE_A_GIST
This endpoint deletes a gist using its id. it returns a 204 on success and error statuses like 404, 304, or 403 for issues. more info at github docs.
Action Parameters
Action Response
GITHUB_LIST_REACTIONS_FOR_AN_ISSUE
List the reactions to an issue.
Action Parameters
Action Response
GITHUB_PULLS_CREATE_REVIEW
This api endpoint enables creation of pull request reviews and notifications. rapid usage may cause rate limiting. use pending for draft reviews. calculate diff position for comments. supports various response content types.(DEPRECATED use create_a_review_for_a_pull_request)
Action Parameters
Action Response
GITHUB_ASSIGN_AN_ORGANIZATION_ROLE_TO_A_USER
This text explains how to assign organization roles to members, requiring administrator access and admin:org scope for oauth or personal tokens. more info at github docs on managing access with roles.
Action Parameters
Action Response
GITHUB_EMO_J_IS_GET
Lists all the emojis available to use on github.(DEPRECATED use get_emojis)
Action Parameters
Action Response
GITHUB_LIST_FOLLOWERS_OF_A_USER
Lists the people following the specified user.
Action Parameters
Action Response
GITHUB_LIST_DISCUSSION_COMMENTS
Retrieve all comments from a team discussion by using the endpoint get /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments. you need read:discussion scope on oauth or personal tokens for access.
Action Parameters
Action Response
GITHUB_REMOVE_A_SELECTED_REPOSITORY_FROM_A_USER_SECRET
This endpoint removes a repository from a user’s dev environment secret, requiring codespaces access, and oauth or classic tokens with specific scopes.
Action Parameters
Action Response
GITHUB_SET_GITHUB_ACTIONS_PERMISSIONS_FOR_A_REPOSITORY
Sets the github actions permissions policy for enabling github actions and allowed actions and reusable workflows in the repository. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_COMMIT_STATUSES_FOR_A_REFERENCE
Users with pull access can see commit statuses for a sha, branch, or tag in reverse order, with the latest first. it’s accessible through a legacy route.
Action Parameters
Action Response
GITHUB_CHECK_IF_A_PERSON_IS_FOLLOWED_BY_THE_AUTHENTICATED_USER
The /user/following/{username}“ endpoint checks if the authenticated user follows a specific github user, returning 204 if followed, 404 if not, and error details for other statuses. see api docs for further details.
Action Parameters
Action Response
GITHUB_LIST_SELF_HOSTED_RUNNERS_FOR_AN_ORGANIZATION
This endpoint lists an organization’s self-hosted runners, accessible only to admins with admin:org scope (oauth app/personal access tokens). for private repositories, the repo scope is also necessary.
Action Parameters
Action Response
GITHUB_LIST_AVAILABLE_MACHINE_TYPES_FOR_A_REPOSITORY
List the machine types available for a given repository based on its configuration. oauth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
Action Parameters
Action Response
GITHUB_CREATE_A_CUSTOM_ORGANIZATION_ROLE
Custom organization roles allow for tailored permissions, requiring admin status or certain permissions to access. oauth tokens must have admin:org scope. for more, see github’s documentation on managing these roles.
Action Parameters
Action Response
GITHUB_LIST_GITHUB_PAGES_BUILDS
Lists builts of a github pages site. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_SSH_SIGNING_KEYS_FOR_THE_AUTHENTICATED_USER
Lists the ssh signing keys for the authenticated user’s github account. oauth app tokens and personal access tokens (classic) need the read:ssh signing key scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_ALL_COPILOT_SEAT_ASSIGNMENTS_FOR_AN_ORGANIZATION
This beta endpoint displays the status of billed copilot seats within an organization, accessible only to owners with the manage billing:copilot scope, for managing/viewing copilot business/enterprise subscriptions.
Action Parameters
Action Response
GITHUB_UPDATE_A_DISCUSSION_COMMENT_LEGACY
Deprecated teams api endpoint for editing discussion comments will be removed. users should switch to the new “update a discussion comment” endpoint. oauth and classic tokens require write:discussion scope.
Action Parameters
Action Response
GITHUB_CHECK_IF_A_USER_IS_BLOCKED_BY_AN_ORGANIZATION
Returns a 204 if the given user is blocked by the given organization. returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by github.
Action Parameters
Action Response
GITHUB_GET_A_DEPENDABOT_ALERT
Oauth app tokens and personal access tokens (classic) need the security events scope to use this endpoint. if this endpoint is only used with public repositories, the token can use the public repo scope instead.
Action Parameters
Action Response
GITHUB_ENABLE_REPO_FORGITHUB_ACTIONS
This endpoint allows adding a repository to those enabled for github actions in an organization, requiring the enabled repositories policy set to selected and admin:org scope for oauth/personal access tokens.
Action Parameters
Action Response
GITHUB_CREATE_AN_ORGANIZATION_PROJECT
Creates an organization project board. returns 410 gone if projects are disabled or absent in the organization, and 401 unauthorized or 410 gone if the user lacks sufficient privileges.
Action Parameters
Action Response
GITHUB_LIST_REACTIONS_FOR_AN_ISSUE_COMMENT
List the reactions to an issue comment.
Action Parameters
Action Response
GITHUB_ADD_OR_UPDATE_TEAM_MEMBERSHIP_FOR_A_USER_LEGACY
The deprecated teams api for member updates now has a new endpoint for adding members with considerations for synced teams. invites work upon acceptance, allowing role updates within github enterprise cloud limits, post-authentication.
Action Parameters
Action Response
GITHUB_LIST_CHECK_RUNS_FOR_A_GIT_REFERENCE
Endpoint identifies check runs for sha, branch, or tag within the same repo; excludes forks, capped at 1000 suites per ref. full list via specific endpoints. repo scope needed for private repositories.
Action Parameters
Action Response
GITHUB_CHECK_IF_A_GIST_IS_STARRED
This endpoint determines if a gist is starred by id, returning 204 if yes, 404 if not found, 304 if unchanged, and 403 if access is denied. more information is available in the github docs.
Action Parameters
Action Response
GITHUB_ISSUES_LIST_ASSIGN_EES
Lists the available assignees for issues in a repository.(DEPRECATED use list_assignees)
Action Parameters
Action Response
GITHUB_GET_A_DIFF_OF_THE_DEPENDENCIES_BETWEEN_COMMITS
Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.
Action Parameters
Action Response
GITHUB_GET_A_CODE_OF_CONDUCT
Returns information about the specified github code of conduct.
Action Parameters
Action Response
GITHUB_UPDATE_AN_EXISTING_PROJECT_CARD
Update an existing project card by specifying its unique id. allows modifying notes and the archival status. returns updated card details. for more info, visit: https://docs.github.com/rest/projects/cards#update-an-existing-project-card
Action Parameters
Action Response
GITHUB_SUBMIT_A_REVIEW_FOR_A_PULL_REQUEST
Submits a review for a pull request with options for custom media types including raw markdown, text only, html rendered, and full representations. see docs for detailed info on creating reviews and media types.
Action Parameters
Action Response
GITHUB_CHECK_A_TOKEN
This api method enables oauth/github apps to verify token validity without facing login rate limits, using basic authentication with client id and client secret. invalid tokens return a 404 not found.
Action Parameters
Action Response
GITHUB_CREATE_A_DEPLOY_KEY
You can create a read-only deploy key.
Action Parameters
Action Response
GITHUB_GET_AN_ENVIRONMENT_VARIABLE
Gets a specific variable in an environment. authenticated users must have collaborator access to a repository to create, update, or read variables. oauth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_UPDATE_A_DEPLOYMENT_BRANCH_POLICY
Updates a deployment branch or tag policy for an environment. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_REPO_S_GET_CODE_FREQUENCY_STATS
The endpoint provides weekly aggregates of additions and deletions for repositories with fewer than 10,000 commits. repositories exceeding this limit return a 422 status code.(DEPRECATED use get_the_weekly_commit_activity)
Action Parameters
Action Response
GITHUB_LIST_DEPLOYMENT_BRANCH_POLICIES
Lists the deployment branch policies for an environment. anyone 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 endpoint with a private repository.
Action Parameters
Action Response
GITHUB_UPDATE_AN_IMPORT
Api enables updating imports with credentials or project selection. without parameters, it restarts imports. for multi-project servers, use project choices. the endpoint will be deprecated after april 12, 2024. check changelog for more info.
Action Parameters
Action Response
GITHUB_REMOVE_ALL_LABELS_FROM_AN_ISSUE
Removes all labels from an issue.
Action Parameters
Action Response
GITHUB_GET_A_CLASSROOM
Gets a github classroom classroom for the current user. classroom will only be returned if the current user is an administrator of the github classroom.
Action Parameters
Action Response
GITHUB_GET_THE_REVIEW_HISTORY_FOR_A_WORKFLOW_RUN
Anyone 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 endpoint with a private repository.
Action Parameters
Action Response
GITHUB_LIST_GIST_COMMITS
This endpoint fetches a list of gist commits using gist id, offering pagination via per page & page. it provides details like commit url, version, user info, and date. check the documentation for more.
Action Parameters
Action Response
GITHUB_LIST_REACTIONS_FOR_A_TEAM_DISCUSSION_LEGACY
The teams api endpoint for listing team discussion reactions is deprecated. users are advised to migrate to the new “list reactions for a team discussion” endpoint. oauth tokens require the read:discussion scope.
Action Parameters
Action Response
GITHUB_UPDATE_AN_ORGANIZATION_WEBHOOK
Updating an organization’s webhook could reset its secret. supply the same or new secret to prevent deletion. use a designated endpoint for config changes. user role and oauth app abilities restrict webhook management.
Action Parameters
Action Response
GITHUB_LIST_STARGAZERS
This endpoint lists the people who have starred a repository and supports custom media types, including one that adds a timestamp for when the star was created. see github’s media types documentation for more details.
Action Parameters
Action Response
GITHUB_CREATE_A_MILESTONE
Creates a milestone.
Action Parameters
Action Response
GITHUB_GET_A_PACKAGE_VERSION_FOR_AN_ORGANIZATION
Fetching a specific package version in an organization requires read:packages scope and potentially repo scope for certain package types, as per github’s documentation.
Action Parameters
Action Response
GITHUB_DELETE_A_TAG_PROTECTION_STATE_FOR_A_REPOSITORY
This deletes a tag protection state for a repository. this endpoint is only available to repository administrators.
Action Parameters
Action Response
GITHUB_SET_THE_LEVEL_OF_ACCESS_FOR_WORKFLOWS_OUTSIDE_OF_THE_REPOSITORY
This endpoint controls the access level for external workflows to actions and reusable workflows in private repositories. it requires repo scope for oauth and classic personal access tokens. for details, refer to github documentation.
Action Parameters
Action Response
GITHUB_SET_CUSTOM_LABELS_FOR_A_SELF_HOSTED_RUNNER_FOR_A_REPOSITORY
To remove existing and set new custom labels for a self-hosted runner in a repository, admin access is needed. oauth and classic personal tokens require repo scope.
Action Parameters
Action Response
GITHUB_REMOVE_AN_ORGANIZATION_ROLE_FROM_A_TEAM
This endpoint allows organization administrators to remove a role from a team, requiring admin:org scope for oauth or personal access tokens. for details on organization roles, visit github’s documentation.
Action Parameters
Action Response
GITHUB_ENABLE_A_WORKFLOW
Activates a workflow with workflow id or filename (e.g., main.yaml), requiring the repo scope for oauth or classic personal access tokens.
Action Parameters
Action Response
GITHUB_LIST_ISSUE_COMMENTS_FOR_A_REPOSITORY
The rest api lists comments on repository issues and pull requests, treating all pull requests as issues but not vice versa. comments are sorted by id, with different media types available for response formats, including raw markdown, text, and html.
Action Parameters
Action Response
GITHUB_LIST_REVIEW_COMMENTS_IN_A_REPOSITORY
This endpoint lists all pull request review comments in a repository, sorted by id. it supports custom media types for different content formats: raw markdown, text, html, or all formats. for details on media types, visit github’s documentation.
Action Parameters
Action Response
GITHUB_LIST_CHECK_SUITES_FOR_A_GIT_REFERENCE
The text outlines an api feature that lists check suites for commits identified by sha, branch, or tag. forked repository pushes are not detected. access to private repositories needs repo scope on oauth or personal tokens.
Action Parameters
Action Response
GITHUB_GET_AN_ORGANIZATION_MIGRATION_STATUS
The text describes a migration status check, where the state can be pending (not started), exporting (in progress), exported (completed successfully), or failed (unsuccessful).
Action Parameters
Action Response
GITHUB_GET_A_SECRET_FOR_THE_AUTHENTICATED_USER
This service allows authenticated users with codespace access to integrate development environment secrets into codespaces without exposing encrypted values, requiring codespace or codespace:secrets scope for oauth or classic tokens.
Action Parameters
Action Response
GITHUB_LIST_GISTS_FOR_A_USER
Lists public gists for the specified user:
Action Parameters
Action Response
GITHUB_DELETE_AN_ISSUE_REACTION
note: you can also specify a repository by repository id using the route delete /repositories/:repository id/issues/:issue number/reactions/:reaction id. delete a reaction to an issue.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_VARIABLES
Lists all repository variables. authenticated users must have collaborator access to a repository to create, update, or read variables. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_CREATE_A_GIST_COMMENT
This endpoint allows comments on gists and supports media types for raw markdown or base64-encoded content. see github’s “media types” for more info.
Action Parameters
Action Response
GITHUB_ISSUES_LIST_EVENTS_FOR_REPO
Lists events for a repository.(DEPRECATED use list_issue_events_for_a_repository)
Action Parameters
Action Response
GITHUB_LIST_CHECK_RUNS_IN_A_CHECK_SUITE
The endpoint lists check runs for a check suite by its id, only detecting pushes in the original repository, not forks. to access it in private repositories, oauth app tokens and personal access tokens require the repo scope.
Action Parameters
Action Response
GITHUB_GIST_S_CREATE
Allows you to add a new gist with one or more files. note: don’t name your files “gistfile” with a numerical suffix. this is the format of the automatic naming scheme that gist uses internally.(DEPRECATED use create_a_gist)
Action Parameters
Action Response
GITHUB_CHECK_TEAM_PERMISSIONS_FOR_A_REPOSITORY_LEGACY
The endpoint for checking repositories via teams api is deprecated. users should switch to the “check team permissions for a repository” endpoint, where you can also see team permissions for a specific repository by using a custom media type.
Action Parameters
Action Response
GITHUB_DELETE_AN_ISSUE_COMMENT_REACTION
You can delete a reaction to an issue comment by specifying repository id using the route delete /repositories/:repository id/issues/comments/:comment id/reactions/:reaction id.
Action Parameters
Action Response
GITHUB_DELETE_A_TEAM_LEGACY
The endpoint route is deprecated; use the delete a team endpoint instead. organizational owners or team maintainers can delete teams, and deleting a parent team removes all its child teams.
Action Parameters
Action Response
GITHUB_UPDATE_A_REPOSITORY_SECURITY_ADVISORY
To update a repository security advisory using its ghsa id, the user must have specific repository roles or be a collaborator with appropriate oauth or personal access token scopes (repo or repository advisories:write).
Action Parameters
Action Response
GITHUB_LIST_ORG_REPOS_WITHGITHUB_ACTIONS_ENABLED
This endpoint lists repos enabled for github actions in an org, requiring the enabled repositories set to selected and admin:org scope for oauth/personal tokens. see docs for setting permissions.
Action Parameters
Action Response
GITHUB_DELETE_A_PROJECT_COLUMN
Deletes a project column.
Action Parameters
Action Response
GITHUB_LIST_ORGANIZATION_ISSUES_ASSIGNED_TO_THE_AUTHENTICATED_USER
Github’s rest api shows both issues & prs for users, marking prs with pull request key. for pr ids, check “list pull requests” link. it also supports different media types for issue content.
Action Parameters
Action Response
GITHUB_LIST_CHILD_TEAMS_LEGACY
deprecation notice: this endpoint route is deprecated and will be removed from the teams api. we recommend migrating your existing code to use the new list child teams endpoint.
Action Parameters
Action Response
GITHUB_DELETE_A_COMMIT_COMMENT
Deletes a specific commit comment in a github repo using owner, repo, and comment id. successful deletion returns 204, failure returns 404. more info at github’s api documentation.
Action Parameters
Action Response
GITHUB_UPDATE_A_DEPENDABOT_ALERT
Access to security alerts for a repository requires authenticated user access and specific token scopes (security events or public repo for public repositories). for more, see github docs on granting security alerts access.
Action Parameters
Action Response
GITHUB_REMOVE_TEAM_MEMBERSHIP_FOR_A_USER_LEGACY
The teams api endpoint is deprecated and will be removed. users should switch to the “remove team membership for a user” endpoint. admin permissions are required for removal. note: errors occur if changes are attempted on a team synced with an idp.
Action Parameters
Action Response
GITHUB_REMOVE_SELECTED_REPOSITORY_FROM_AN_ORGANIZATION_SECRET
Removes a repo from an org secret when visibility is set to ‘selected’. users need collaborator access or ‘admin:org’ scope with oauth tokens. for private repos, ‘repo’ scope is needed.
Action Parameters
Action Response
GITHUB_GITHUB_API_ROOT
Get hypermedia links to resources accessible in github’s rest api
Action Parameters
Action Response
GITHUB_REMOVE_A_SECURITY_MANAGER_TEAM
Removes the security manager role from a team in an organization. administrators with admin:org scope via oauth or personal access tokens can use this endpoint. for more, visit github docs on managing security managers.
Action Parameters
Action Response
GITHUB_UPDATE_A_LABEL
Updates a label using the given label name.
Action Parameters
Action Response
GITHUB_REMOVE_A_REPOSITORY_FROM_A_TEAM_LEGACY
The teams api endpoint is deprecated; use “remove a repository from a team” instead. org owners or team maintainers can remove repos; admin access required for members. repo not deleted by this action.
Action Parameters
Action Response
GITHUB_GET_DEFAULT_ATTRIBUTES_FOR_A_CODESPACE
Gets the default attributes for codespaces created by the user with the repository. oauth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
Action Parameters
Action Response
GITHUB_REPO_S_GET_CONTRIBUTORS_STATS
The endpoint shows the total commits authored by a contributor, a weekly summary (weeks array) of additions, deletions, and commits, starting from a unix timestamp. for repositories with 10,000+ commits, addition and deletion counts will return 0.(DEPRECATED use get_all_contributor_commit_activity)
Action Parameters
Action Response
GITHUB_LIST_SELECTED_REPOS_FOR_SECRET_ACCESS
Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected. oauth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Action Parameters
Action Response
GITHUB_GET_ALL_AUTOLINKS_OF_A_REPOSITORY
Gets all autolinks that are configured for a repository. information about autolinks are only available to repository administrators.
Action Parameters
Action Response
GITHUB_REPO_S_LIST_FOR_USER
Lists public repositories for the specified user.(DEPRECATED use list_repositories_for_a_user)
Action Parameters
Action Response
GITHUB_GET_THE_COMBINED_STATUS_FOR_A_SPECIFIC_REFERENCE
Users with pull access can view combined commit statuses for a sha, branch, or tag in a repository. a state is also returned, indicating failure, pending, or success based on the context reports.
Action Parameters
Action Response
GITHUB_USERS_LIST_FOLLOWERS_FOR_AUTHENTICATED_USER
Lists the people following the authenticated user.(DEPRECATED use list_followers_of_the_authenticated_user)
Action Parameters
Action Response
GITHUB_GET_INFORMATION_ABOUT_A_SARIF_UPLOAD
The text outlines how to obtain saroc upload details, like status and analysis url, via a specific endpoint, emphasizing the need for oauth and access token scopes for both private and public repository access.
Action Parameters
Action Response
GITHUB_ADD_REPO_TO_ORG_SECRET_WITH_SELECTED_VISIBILITY
This text explains how to add a repository to an organization secret with “selected” visibility by creating or updating it via a specific github documentation link. oauth and personal access tokens require admin:org scope for access.
Action Parameters
Action Response
GITHUB_DOWNLOAD_WORKFLOW_RUN_LOGS
This service provides a temporary url to download a workflow run’s log archive, expiring in 1 minute. accessible to users with read access, private repos require oauth or classic tokens with repo scope.
Action Parameters
Action Response
GITHUB_GET_A_GIST_COMMENT
This endpoint lets you comment on a gist with options for media types: raw markdown (default) and base64-encoded content. for more, visit github’s media types documentation.
Action Parameters
Action Response
GITHUB_CREATE_A_GITHUB_PAGES_DEPLOYMENT
Create a github pages deployment for a repository. the authenticated user must have write permission to the repository.
Action Parameters
Action Response
GITHUB_LIST_BRANCHES_FOR_HEAD_COMMIT
Protected branches are accessible in both public and private repositories across various github plans including free, pro, team, and enterprise versions. they identify branches having the latest commit designated by a specific commit sha.
Action Parameters
Action Response
GITHUB_UNBLOCK_A_USER
Unblocks the given user and returns a 204.
Action Parameters
Action Response
GITHUB_CHECK_IF_A_USER_FOLLOWS_ANOTHER_USER
Endpoint checks if a user follows another on github. pass ‘username’ & ‘target user’ in path. response: 204 if follows, 404 if not. supports github apps. api docs
Action Parameters
Action Response
GITHUB_SET_ADMIN_BRANCH_PROTECTION
Protected branches in github, available across free, pro, team, and enterprise plans for both public and private repositories, require admin or owner permissions for enforcement due to enabled branch protection.
Action Parameters
Action Response
GITHUB_REPO_S_LIST_COLLABORATORS
The endpoint lists all collaborators in organization-owned repositories, including various organization members, and requires users with push access, and tokens with read:org and repo scopes to access. team member lists extend to child teams.(DEPRECATED use list_repository_collaborators)
Action Parameters
Action Response
GITHUB_GET_DETAILS_ABOUT_A_CODESPACE_EXPORT
Gets information about an export of a codespace. oauth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
Action Parameters
Action Response
GITHUB_START_A_CODESPACE_FOR_THE_AUTHENTICATED_USER
Starts a user’s codespace. oauth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
Action Parameters
Action Response
GITHUB_ENABLE_GITHUB_ACTIONS_IN_SELECTED_REPOSITORIES
This endpoint allows replacing enabled github actions repositories in an organization, requiring selected permission policy and admin:org scope for oauth or personal tokens. see documentation for setting permissions.
Action Parameters
Action Response
GITHUB_GET_AN_ISSUE_COMMENT
The rest api allows fetching comments on issues and prs, noting that not all issues are prs. it supports several media types for different markdown representations: raw, text, html, and a full version combining all.
Action Parameters
Action Response
GITHUB_CANCEL_A_GITHUB_PAGES_DEPLOYMENT
Cancels a github pages deployment. the authenticated user must have write permissions for the github pages site.
Action Parameters
Action Response
GITHUB_ADD_LABELS_TO_AN_ISSUE
Adds labels to an issue. if you provide an empty array of labels, all labels are removed from the issue.
Action Parameters
Action Response
GITHUB_LIST_COMMENTS_FOR_A_PULL_REQUEST_REVIEW
This endpoint lists comments for a pull request review, supporting custom media types for raw markdown, text-only, html, or full representation (raw, text, and html) of the comment body.
Action Parameters
Action Response
GITHUB_GET_AN_AUTOLINK_REFERENCE_OF_A_REPOSITORY
This returns a single autolink reference by id that was configured for the given repository. information about autolinks are only available to repository administrators.
Action Parameters
Action Response
GITHUB_LIST_THE_PEOPLE_THE_AUTHENTICATED_USER_FOLLOWS
Lists the people who the authenticated user follows.
Action Parameters
Action Response
GITHUB_GET_A_DISCUSSION_COMMENT
To get a specific comment from a team discussion, use get /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}“. ensure oauth or personal access tokens have read:discussion scope.
Action Parameters
Action Response
GITHUB_REMOVE_OUTSIDE_COLLABORATOR_FROM_AN_ORGANIZATION
Removing a user from this list will remove them from all the organization’s repositories.
Action Parameters
Action Response
GITHUB_ISSUES_LIST
Fetches issues assigned to the user across all repos, using filters to customize the fetch. issues and pull requests are included, discernible by the pull request key. supports various media types for responses. visit github docs for more info.(DEPRECATED use list_issues_assigned_to_the_authenticated_user)
Action Parameters
Action Response
GITHUB_GET_ALLOWED_ACTIONS_AND_REUSABLE_WORKFLOWS_FOR_AN_ORGANIZATION
This endpoint retrieves actions and reusable workflows permitted in an organization, requiring the allowed actions policy to be set to selected. it mandates admin:org scope for oauth and classic personal access tokens.
Action Parameters
Action Response
GITHUB_ACCEPT_A_REPOSITORY_INVITATION
Accept a repo invitation with invitation id. responses: 204 (accepted), 403 (forbidden), 409 (conflict), 404 (not found), 304 (not modified). see docs: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation
Action Parameters
Action Response
GITHUB_GET_GITHUB_ACTIONS_PERMISSIONS_FOR_A_REPOSITORY
The text outlines retrieving the github actions permissions policy for a repository, highlighting the enabled status, allowed actions/workflows, and the requirement for repo scope in oauth and classic personal access tokens to access this endpoint.
Action Parameters
Action Response
GITHUB_CREATE_A_REMOVE_TOKEN_FOR_AN_ORGANIZATION
Generates a token for removing a self-hosted runner from an organization, expiring in one hour. requires admin:org scope for public repos, plus repo scope for private ones. admin access is needed.
Action Parameters
Action Response
GITHUB_LIST_USER_MIGRATIONS
Lists all migrations a user has started.
Action Parameters
Action Response
GITHUB_REMOVE_APP_ACCESS_RESTRICTIONS
Protected branches can be used in various github plans, restricting app push access to those installed on the repository with write access. more info at github’s products documentation.
Action Parameters
Action Response
GITHUB_CREATE_REACTION_FOR_A_COMMIT_COMMENT
Create a reaction to a commit comment. a response with an http 200 status means that you already added the reaction type to this commit comment.
Action Parameters
Action Response
GITHUB_REMOVE_AN_ORGANIZATION_MEMBER
Removing a user from this list will remove them from all teams and they will no longer have any access to the organization’s repositories.
Action Parameters
Action Response
GITHUB_GET_REPO_DEV_ENV_SECRET
Gets a single repository development environment secret without revealing its encrypted value. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_TEAM_PROJECTS
Lists the organization projects for a team. note: you can also specify a team by org id and team id using the route get /organizations/{org_id}/team/{team_id}/projects.
Action Parameters
Action Response
GITHUB_UPDATE_GIT_LFS_PREFERENCE
Import repositories with files over 100mb from svn, mercurial, and tfs using git lfs. note: this feature will be deprecated on april 12, 2024. more details and alternatives are in the changelog.
Action Parameters
Action Response
GITHUB_LIST_ORG_RESOURCE_ACCESS_TOKENS
Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. only github apps can use this endpoint.
Action Parameters
Action Response
GITHUB_GET_A_CHECK_SUITE
The checks api, used to retrieve a check suite by id, detects pushes in origin repositories only, not forks, resulting in empty pull requests and a null head branch for forks. oauth and personal tokens need repo scope for private repos.
Action Parameters
Action Response
GITHUB_REMOVE_A_PROJECT_FROM_A_TEAM_LEGACY
The teams api endpoint for removing organization projects from a team is deprecated. use the new endpoint instead. only team maintainers or org owners can remove projects, unless users have specific access rights. removal doesn’t delete the project.
Action Parameters
Action Response
GITHUB_LIST_ISSUE_COMMENTS
The rest api enables listing comments on issues & pull requests, distinguishing between them. comments are id-sorted. it supports various response formats like markdown, text, html, or mixed.
Action Parameters
Action Response
GITHUB_DISABLE_REPOSITORY_ACTIONS_IN_ORG
This endpoint removes a repo from those selected for github actions in an org, requiring enabled repositories set to selected and admin:org scope for oauth/personal access tokens.
Action Parameters
Action Response
GITHUB_GET_PAGE_VIEWS
Get the total number of views and breakdown per day or week for the last 14 days. timestamps are aligned to utc midnight of the beginning of the day or week. week begins on monday.
Action Parameters
Action Response
GITHUB_LIST_REPO_SECRETS_WITHOUT_VALUES
Lists all development environment secrets available in a repository without revealing their encrypted values. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_RE_RUN_A_JOB_FROM_A_WORKFLOW_RUN
Re-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.
Action Parameters
Action Response
GITHUB_CREATE_A_REPLY_FOR_A_REVIEW_COMMENT
Use this endpoint to respond to primary comments on pull requests, enabling notifications. avoid quick, multiple replies to bypass rate limits. supports various content formats; refer to github documentation for specific rate limits and api guidelines.
Action Parameters
Action Response
GITHUB_CLEAR_REPOSITORY_CACHE_BY_KEY
The text outlines the process of deleting github actions caches for a repository via a full cache key, offering an option to use a git ref for precise removals. it mentions that oauth and personal access tokens need the repo scope for access.
Action Parameters
Action Response
GITHUB_LIST_SECRET_SCANNING_ALERTS_FOR_A_REPOSITORY
This endpoint lists secret scanning alerts for repositories, requiring the user to be an administrator and to use tokens with repo, security events, or public repo (for public repositories) scopes.
Action Parameters
Action Response
GITHUB_REMOVE_TEAMS_FROM_THE_COPILOT_SUBSCRIPTION_FOR_AN_ORGANIZATION
Endpoint cancels github copilot seat assignments for specified teams, ending access after the billing cycle without further charges. only owners can configure. oauth and personal tokens require manage billing:copilot scope for access.
Action Parameters
Action Response
GITHUB_CREATE_A_REVIEW_COMMENT_FOR_A_PULL_REQUEST
To comment on a pull request diff, use parameters line, side, start line, and start side. avoid using the deprecated position. triggering notifications, beware of rate limits. supports custom media types for comment formatting.
Action Parameters
Action Response
GITHUB_GET_A_CUSTOM_PROPERTY_FOR_AN_ORGANIZATION
Gets a custom property that is defined for an organization. organization members can read these properties.
Action Parameters
Action Response
GITHUB_UPDATE_AN_ORGANIZATION_MEMBERSHIP_FOR_THE_AUTHENTICATED_USER
Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.
Action Parameters
Action Response
GITHUB_ACTIVITY_LIST_STARGAZERS_FOR_REPO
This endpoint lists the people who have starred a repository and supports custom media types, including one that adds a timestamp for when the star was created. see github’s media types documentation for more details.(DEPRECATED use list_stargazers)
Action Parameters
Action Response
GITHUB_DELETE_A_PACKAGE_FOR_AN_ORGANIZATION
To delete an organization’s package, you must be an admin. you can’t delete public packages with over 5,000 downloads (contact support). requires read:packages and delete:packages scopes, and repo scope for certain registries.
Action Parameters
Action Response
GITHUB_DISABLE_PRIVATE_VULNERABILITY_REPORTING_FOR_A_REPOSITORY
Disabling private vulnerability reporting requires admin access to the repository. for more info, refer to the github guide on privately reporting security issues.
Action Parameters
Action Response
GITHUB_LIST_BRANCHES
This api endpoint returns a repository’s branch list, allows filtering by protection status, supports pagination (30 results/page), and is detailed in github’s documentation.
Action Parameters
Action Response
GITHUB_GET_GITHUB_PACKAGES_BILLING_FOR_A_USER
The text provides information on tracking free and paid github packages storage in gb, noting paid storage is for private repos. it links to billing management and mentions oauth tokens need the user scope.
Action Parameters
Action Response
GITHUB_SECURITY_ADVISORIES_LIST_GLOBAL_ADVISORIES
The text describes how to find global security advisories with specific parameters. by default, it excludes malware advisories, which can be included by setting the type parameter to malware. more on advisory types at github docs.(DEPRECATED use list_global_security_advisories)
Action Parameters
Action Response
GITHUB_DELETE_A_REPOSITORY_VARIABLE
Deletes a repository variable using the variable name. authenticated users must have collaborator access to a repository to create, update, or read variables. oauth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_RELEASES
The text explains that the provided list only includes releases, not all git tags, advising to use the repository tags api for those. published releases are public, while draft releases info is restricted to users with push access.
Action Parameters
Action Response
GITHUB_LIST_REACTIONS_FOR_A_TEAM_DISCUSSION_COMMENT_LEGACY
The teams api endpoint for listing team discussion comment reactions is deprecated. use the new endpoint instead. oauth tokens require read:discussion scope.
Action Parameters
Action Response
GITHUB_LIST_DEPLOYMENT_STATUSES
Users with pull access can view deployment statuses for a deployment:
Action Parameters
Action Response
GITHUB_DELETE_A_REVIEW_COMMENT_FOR_A_PULL_REQUEST
Deletes a review comment.
Action Parameters
Action Response
GITHUB_LIST_USERS_THAT_ARE_ASSIGNED_TO_AN_ORGANIZATION_ROLE
This text describes an api endpoint for listing organization members by role, requiring administrator access and the admin:org scope for oauth or classic tokens. more details on roles are available in a linked github doc.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_SECURITY_ADVISORIES_FOR_AN_ORGANIZATION
This endpoint lists security advisories for an organization, accessible only by its owners or security managers. oauth and personal tokens require the repo or repository advisories:write scope.
Action Parameters
Action Response
GITHUB_BLOCK_A_USER
Blocks the given user and returns a 204. if the authenticated user cannot block the given user a 422 is returned.
Action Parameters
Action Response
GITHUB_LIST_DISCUSSIONS
Access all discussions on a team’s page via get /organizations/{org_id}/team/{team_id}/discussions, needing oauth or classic tokens with read:discussion scope.
Action Parameters
Action Response
GITHUB_LIST_EVENTS_RECEIVED_BY_THE_AUTHENTICATED_USER
These 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. otherwise, you’ll only see public events.
Action Parameters
Action Response
GITHUB_GET_ALL_CODES_OF_CONDUCT
Returns array of all github’s codes of conduct.
Action Parameters
Action Response
GITHUB_REMOVE_A_PROJECT_FROM_A_TEAM
An organization owner or a team maintainer can remove a project from a team. organization members need read or admin access to do so. the action doesn’t delete the project. teams can also be specified by org id and team id.
Action Parameters
Action Response
GITHUB_GET_LARGE_FILES
This endpoint, listing files over 100mb from imports, is deprecated due to low use and alternatives. it’ll be discontinued on april 12, 2024. details at changelog.
Action Parameters
Action Response
GITHUB_ISSUES_LIST_FOR_REPO
Github’s “issues” endpoint lists only open issues but may include pull requests, identifiable by the pull request key. use “list pull requests” for pr ids. supports various media types for markdown representation.(DEPRECATED use list_repository_issues)
Action Parameters
Action Response
GITHUB_LIST_TEAMS_FOR_THE_AUTHENTICATED_USER
This endpoint lists all teams across organizations for the authenticated user, requiring user, repo, or read:org scope. for fine-grained tokens, it shows teams from the token owner’s organization only.
Action Parameters
Action Response
GITHUB_MARK_NOTIFICATIONS_AS_READ
Marks all notifications as “read” for the user. if too many to process at once, a 202 accepted status is received, and it’s handled asynchronously. check remaining “unread” with a specific github endpoint and all=false query.
Action Parameters
Action Response
GITHUB_DELETE_TEAM_DISCUSSION_REACTION
Use route delete /organizations/:org id/team/:team id/discussions/:discussion number/reactions/:reaction id to remove a reaction from team discussions. required write:discussion scope for oauth and personal access tokens.
Action Parameters
Action Response
GITHUB_GET_AN_ORGANIZATION_ROLE
This text explains how to get an organization role, requiring the user to be an admin or have specific permissions. for details, see github’s documentation on managing access with roles. oauth app tokens need admin:org scope.
Action Parameters
Action Response
GITHUB_GET_A_GIST_REVISION
This endpoint fetches a specific gist revision, supporting custom media types for raw markdown or base64-encoded content. for details, see github’s media types documentation.
Action Parameters
Action Response
GITHUB_GET_AN_ASSIGNMENT
Gets a github classroom assignment. assignment will only be returned if the current user is an administrator of the github classroom for the assignment.
Action Parameters
Action Response
GITHUB_CHECK_IF_AUTOMATED_SECURITY_FIXES_ARE_ENABLED_FOR_A_REPOSITORY
This text outlines the ability to check if automated security fixes are enabled, disabled, or paused for a repository, which requires the user to have admin read access. for details, visit the provided github documentation link.
Action Parameters
Action Response
GITHUB_CANCEL_AN_ORGANIZATION_INVITATION
To cancel an organization invitation, the user must be an organization owner. this action also triggers notifications.
Action Parameters
Action Response
GITHUB_UPDATE_A_COMMIT_COMMENT
This endpoint updates commit comments and supports different media types for responses, including raw markdown, text, html, or all. for details, visit the github docs on media types.
Action Parameters
Action Response
GITHUB_GET_DEFAULT_WORKFLOW_PERMISSIONS_FOR_AN_ORGANIZATION
The text outlines how to check default github token workflow permissions and github actions’ ability to submit pull request reviews in organizations. it specifies that admin:org scope is needed for oauth/personual access tokens to use this endpoint.
Action Parameters
Action Response
GITHUB_GET_A_PROJECT_COLUMN
Gets information about a project column.
Action Parameters
Action Response
GITHUB_ADD_REPO_TO_ORG_SECRET_WITH_SELECTED_ACCESS
To add a repo to an org secret with “selected” access, one must have collaborator rights for secret management and either admin:org or repo scope for tokens. details at github docs.
Action Parameters
Action Response
GITHUB_DELETE_A_PROJECT_CARD
Deletes a project card
Action Parameters
Action Response
GITHUB_SET_A_REPOSITORY_SUBSCRIPTION
To manage repository notifications: enable by setting subscribed to true, ignore by setting ignored to true, or stop watching by deleting the repository’s subscription.
Action Parameters
Action Response
GITHUB_CHECK_IF_A_PULL_REQUEST_HAS_BEEN_MERGED
Checks if a pull request has been merged into the base branch. the http status of the response indicates whether or not the pull request has been merged; the response body is empty.
Action Parameters
Action Response
GITHUB_REPO_S_LIST_FOR_AUTHENTICATED_USER
The text outlines that the authenticated user can access repositories they own, collaborate on, or are part of through an organization, given explicit :read, :write, or :admin permissions.(DEPRECATED use list_repositories_for_the_authenticated_user)
Action Parameters
Action Response
GITHUB_DELETE_A_REPOSITORY_SECRET
Deletes a secret in a repository using the secret name. authenticated users must have collaborator access to a repository to create, update, or read secrets. oauth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_REPO_S_CREATE_FORK
Create a fork for the user; it’s asynchronous so wait a bit. if over 5 mins, contact github support. needs github app installed on both source and destination accounts with necessary access.(DEPRECATED use create_a_fork)
Action Parameters
Action Response
GITHUB_LIST_GISTS_FOR_THE_AUTHENTICATED_USER
Lists the authenticated user’s gists or if called anonymously, this endpoint returns all public gists:
Action Parameters
Action Response
GITHUB_MAP_A_COMMIT_AUTHOR
Update an author’s identity in your application before pushing new commits. the endpoint will be deprecated on april 12, 2024, due to low usage. see the changelog for alternatives.
Action Parameters
Action Response
GITHUB_CREATE_A_REPOSITORY_WEBHOOK
Repositories can have multiple webhooks installed. each webhook should have a unique config. multiple webhooks can share the same config as long as those webhooks do not have any events that overlap.
Action Parameters
Action Response
GITHUB_GET_REPOSITORY_PERMISSIONS_FOR_A_USER
The text details checking a collaborator’s repository permission, outlining roles like admin, write, read, none, and correlating maintain with write, triage with read. it suggests using ‘role name’ for roles and ‘permissions’ hash for access levels.
Action Parameters
Action Response
GITHUB_SEARCH_LABELS
Search repository labels by keywords in names or descriptions, with up to 100 results/page. use text-match for highlights in names/descriptions. example: q=bug+defect+enhancement&repository id=64778136.
Action Parameters
Action Response
GITHUB_UPDATE_A_REVIEW_COMMENT_FOR_A_PULL_REQUEST
This endpoint edits review comments, supporting various media types for different markdown representations: raw, text only, html, and a full version including all formats. for more, see github’s media types documentation.
Action Parameters
Action Response
GITHUB_LIST_PUBLIC_ORGANIZATION_MEMBERS
Members of an organization can choose to have their membership publicized or not.
Action Parameters
Action Response
GITHUB_GET_COPILOT_SEAT_ASSIGNMENT_DETAILS_FOR_A_USER
Organization owners can view members’ github copilot seat assignments using oauth or personal access tokens with manage billing:copilot scope. this beta feature requires specific access permissions.
Action Parameters
Action Response
GITHUB_GET_A_REPOSITORY_README
This endpoint retrieves the preferred readme of a repository, supporting two media types: application/vnd.github.raw+json for raw file contents (default) and application/vnd.github.html+json for html rendered readmes using github’s markup library.
Action Parameters
Action Response
GITHUB_UNFOLLOW_A_USER
Oauth app tokens and personal access tokens (classic) need the user:follow scope to use this endpoint.
Action Parameters
Action Response
GITHUB_MANAGE_CUSTOM_PROPERTIES_FOR_ORG_REPOS
Update or create custom properties for up to 30 org. repositories per request. null values remove the property. requires org admin or specific permission.
Action Parameters
Action Response
GITHUB_CREATE_A_DEPLOYMENT_BRANCH_POLICY
Creates a deployment branch or tag policy for an environment. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_MILESTONES
Lists milestones for a repository.
Action Parameters
Action Response
GITHUB_GET_AN_ISSUE
Github api marks issue transfers with 301, restricts access with 404, signals deletions with 410, and tracks updates via the issues webhook. prs are tagged as issues with a pull request key, offering different media response types.
Action Parameters
Action Response
GITHUB_UPDATE_A_CODE_SCANNING_ALERT
This api endpoint updates a single code scanning alert status, requiring security events scope for oauth or classic tokens on private/public repos, or public repo scope for public repos only.
Action Parameters
Action Response
GITHUB_DELETE_A_PACKAGE_FOR_A_USER
Deleting a package requires admin rights. public packages with greater than 5,000 downloads need github support. oauth/personal tokens must have read:packages, delete:packages, and repo scope for some registries.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORIES_FOR_A_USER_MIGRATION
Lists all the repositories for this user migration.
Action Parameters
Action Response
GITHUB_LIST_DISCUSSIONS_LEGACY
This teams api endpoint is being deprecated. users should migrate to the list discussions endpoint for team page discussions. read:discussion scope is required for oauth and classic tokens.
Action Parameters
Action Response
GITHUB_GET_ALL_API_VERSIONS
Get all supported github api versions.
Action Parameters
Action Response
GITHUB_GET_A_WORKFLOW
This endpoint fetches a specific workflow using its file name (e.g., main.yaml) for users with read repository access. access to private repositories needs repo scope for oauth and personal access tokens.
Action Parameters
Action Response
GITHUB_LIST_PROJECT_COLUMNS
Lists the project columns in a project.
Action Parameters
Action Response
GITHUB_EXPORT_A_CODESPACE_FOR_THE_AUTHENTICATED_USER
Exports a specified codespace, providing a url and id to track its status. if unable to push to the repository, changes are pushed to a fork. oauth and classic tokens require codespace scope to access this endpoint.
Action Parameters
Action Response
GITHUB_RESTORE_PACKAGE_VERSION_FOR_A_USER
Users can restore a deleted package within 30 days if the namespace/version is available and not reused. admin permissions might be needed, and specific oauth or personal access tokens are required depending on the package registry’s permissions.
Action Parameters
Action Response
GITHUB_RESTORE_A_PACKAGE_FOR_A_USER
A deleted github package can be restored within 30 days, provided the namespace/version are unchanged and admin rights with specific permissions are available. oauth/personal tokens need read:packages and write:packages scopes.
Action Parameters
Action Response
GITHUB_UPDATE_PULL_REQUEST_REVIEW_PROTECTION
Protected branches are supported in various github plan repositories. updating pull review enforcement needs admin/owner permissions and branch protection. adding new users and teams arrays overwrites old values.
Action Parameters
Action Response
GITHUB_GET_PUBLIC_KEY_FOR_SECRET_ENCRYPTION
This endpoint allows users with read access to a repository to get a public key for encrypting secrets. for private repositories, oauth and classic personal access tokens require the repo scope.
Action Parameters
Action Response
GITHUB_GET_A_CODESPACE_FOR_THE_AUTHENTICATED_USER
Gets information about a user’s codespace. oauth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
Action Parameters
Action Response
GITHUB_GET_A_DNS_HEALTH_CHECK_FOR_GITHUB_PAGES
This endpoint verifies the dns cname record for github pages, initially responding with 202 accepted and then 200 ok. access is restricted to users with the right permissions, needing repo scope for oauth and classic tokens.
Action Parameters
Action Response
GITHUB_DELETE_AN_ISSUE_COMMENT
You can use the rest api to delete comments on issues and pull requests. every pull request is an issue, but not every issue is a pull request.
Action Parameters
Action Response
GITHUB_SET_INTERACTION_RESTRICTIONS_FOR_AN_ORGANIZATION
Temporarily restricts interactions in public repositories to specific github users in an organization. only organization owners can set these limits, which override individual repository settings.
Action Parameters
Action Response
GITHUB_UPDATE_AN_ORGANIZATION
Github is updating to allow distinct permissions for different repository types, replacing members allowed repository creation type. only owners with proper token scopes can make these changes, affecting all and enterprise organizations.
Action Parameters
Action Response
GITHUB_LIST_PUBLIC_EVENTS
We delay the public events feed by five minutes, which means the most recent event returned by the public events api actually occurred at least five minutes ago.
Action Parameters
Action Response
GITHUB_BLOCK_A_USER_FROM_AN_ORGANIZATION
Blocks the given user on behalf of the specified organization and returns a 204. if the organization cannot block the given user a 422 is returned.
Action Parameters
Action Response
GITHUB_GET_AN_ENVIRONMENT
For deploying, refer to deployment branch policy details at a specified link. this is accessible to those with repository read access. private repository access requires oauth or personal tokens with repo scope.
Action Parameters
Action Response
GITHUB_UPDATE_A_CODE_SCANNING_DEFAULT_SETUP_CONFIGURATION
The updated code scanning configuration requires repo scope for oauth and classic personal access tokens for both private and public repositories, and public repo scope for public repositories only.
Action Parameters
Action Response
GITHUB_GET_AN_ORGANIZATION_VARIABLE
To access a specific variable within an organization, users need collaborator access. for creating, updating, or reading variables, oauth or personal access tokens with admin:org scope are required, and repo scope is needed for private repositories.
Action Parameters
Action Response
GITHUB_STAR_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER
Star a github repository for given repo and owner
Action Parameters
Action Response
GITHUB_CREATE_A_REPOSITORY_VARIABLE
To create, update, or read variables in a github actions workflow, authenticated collaborators need repo scope on oauth/personal access tokens.
Action Parameters
Action Response
GITHUB_UPDATE_A_GIST_COMMENT
This endpoint allows updating a gist comment and supports two custom media types: application/vnd.github.raw+json for raw markdown (default), and application/vnd.github.base64+json for base64-encoded content, useful for invalid utf-8 sequences.
Action Parameters
Action Response
GITHUB_GET_THE_AUTHENTICATED_USER
Oauth app tokens and personal access tokens (classic) need the user scope in order for the response to include private profile information.
Action Parameters
Action Response
GITHUB_CREATE_OR_UPDATE_REPO_SECRET_WITH_ENCRYPTED_VALUE
This text explains how to create or update a repository secret with an encrypted value using libsodium. it highlights that oauth app and personal access tokens require the repo scope. for encryption details, visit github’s rest api guide.
Action Parameters
Action Response
GITHUB_LIST_CLASSROOMS
Lists github classroom classrooms for the current user. classrooms will only be returned if the current user is an administrator of one or more github classrooms.
Action Parameters
Action Response
GITHUB_LIST_ORGANIZATIONS_FOR_A_USER
This method lists only public organization memberships for a specified user. to access both public and private memberships for an authenticated user, use the list organizations api.
Action Parameters
Action Response
GITHUB_GET_COPILOT_SEAT_INFORMATION_AND_SETTINGS_FOR_AN_ORGANIZATION
This beta endpoint provides details on an organization’s copilot subscription, including seat breakdown and code policies. accessible only by org owners via github settings. requires manage billing:copilot scope for oauth and classic tokens.
Action Parameters
Action Response
GITHUB_GET_GITHUB_ACTIONS_CACHE_USAGE_FOR_AN_ORGANIZATION
This api provides the total github actions cache usage for an organization, refreshing data roughly every 5 minutes. oauth and personal access tokens require read:org scope for access.
Action Parameters
Action Response
GITHUB_CHECK_PRIVATE_VULNERABILITY_REPORTING_STATUS
This text describes a function that checks if private vulnerability reporting is enabled in a repository, with a link to github’s documentation for evaluating repository security settings.
Action Parameters
Action Response
GITHUB_GET_GITHUB_PACKAGES_BILLING_FOR_AN_ORGANIZATION
Github packages tracks free and paid storage usage in gb. paid storage is for private repos only. oauth or personal access tokens with repo or admin:org scope are needed. details at github docs.
Action Parameters
Action Response
GITHUB_GET_DEFAULT_WORKFLOW_PERMISSIONS_FOR_A_REPOSITORY
This document details the default workflow permissions of the github token and its ability to approve pull requests in repositories. it also notes that oauth and personal access tokens need repo scope. for more, visit github’s documentation.
Action Parameters
Action Response
GITHUB_CREATE_A_DISCUSSION_LEGACY
Deprecated teams api endpoint for creating discussion posts will be removed. use the new create a discussion endpoint. triggering notifications, subject to rate limits. requires write:discussion scope.
Action Parameters
Action Response
GITHUB_MOVE_A_PROJECT_CARD
This endpoint moves a project card to a specified column position using post with card id, column id, and position (top, bottom, or after another card). authentication needed.
Action Parameters
Action Response
GITHUB_ADD_OR_UPDATE_TEAM_MEMBERSHIP_FOR_A_USER
Organization owners or team maintainers can add members, with non-members receiving email invites. team sync is available for github enterprise cloud, allowing idp to manage memberships. use org id and team id for team updates.
Action Parameters
Action Response
GITHUB_GET_FEEDS
Github offers authenticated users feeds like public/private timelines, user/organization timelines, & security advisories in json/atom formats. private feeds need basic auth.
Action Parameters
Action Response
GITHUB_DISABLE_A_CUSTOM_PROTECTION_RULE_FOR_AN_ENVIRONMENT
Disables a custom deployment protection rule for an environment. requires admin or owner permissions and oauth app or personal access tokens with ‘repo’ scope.
Action Parameters
Action Response
GITHUB_GET_A_LICENSE
Gets information about a specific license. for more information, see “licensing a repository .”
Action Parameters
Action Response
GITHUB_LIST_ENVIRONMENT_VARIABLES
Lists all environment variables. authenticated users must have collaborator access to a repository to create, update, or read variables. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_DELETE_GITHUB_ACTIONS_CACHE_BY_ID
Deletes 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.
Action Parameters
Action Response
GITHUB_SEARCH_ISSUES_AND_PULL_REQUESTS
This method finds issues by state and keyword, returning up to 100 results/page with titles and comments. it filters queries like ‘open python bugs on windows’. github apps should avoid mixing issue and pull request searches to avoid http 422 errors.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORIES_IN_AN_ORGANIZATION_MIGRATION
List all the repositories for this organization migration.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_SECRETS
This endpoint lists all secrets in a repository without showing encrypted values. it requires users to be collaborators and oauth app tokens or classic personal access tokens with repo scope.
Action Parameters
Action Response
GITHUB_CREATE_AN_ISSUE
Pull access users can create issues unless disabled. api may return 410 gone if issues off. excessive endpoint use can trigger rate limiting. it supports raw, text, html formats for return data.
Action Parameters
Action Response
GITHUB_START_AN_IMPORT
Use github importer for source imports to a repository. if the repository has github actions, the import will fail with a 422 error. this feature is deprecated and will be removed on april 12, 2024, due to low usage and available alternatives.
Action Parameters
Action Response
GITHUB_USERS_GET_AUTHENTICATED
Oauth app tokens and personal access tokens (classic) need the user scope in order for the response to include private profile information.(DEPRECATED use get_the_authenticated_user)
Action Parameters
Action Response
GITHUB_GET_A_GITHUB_PAGES_SITE
Gets information about a github pages site. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_SET_SELECTED_REPOSITORIES_FOR_AN_ORGANIZATION_VARIABLE
The text explains replacing organization variables in chosen repositories, needing the visibility field as selected and user access including collaborator or admin:org and repo scopes for private repositories.
Action Parameters
Action Response
GITHUB_LIST_USERS_BLOCKED_BY_AN_ORGANIZATION
List the users blocked by an organization.
Action Parameters
Action Response
GITHUB_CREATE_A_TAG_OBJECT
Creating an annotated git tag involves making a tag object and a refs/tags/[tag] reference. lightweight tags need only the reference. the verification object shows if the signature is verified and why.
Action Parameters
Action Response
GITHUB_REQUEST_A_CVE_FOR_A_REPOSITORY_SECURITY_ADVISORY
To get a cve number for a project’s security vulnerability, request it via github for public repositories only. the requester must be a security manager or administrator with specific oauth or personal access tokens. see more on github’s documentation.
Action Parameters
Action Response
GITHUB_GET_STATUS_CHECKS_PROTECTION
Protected branches are available in public repos with github free, github free for organizations, and in both public and private repos with github pro, team, enterprise cloud, and server. more info is in github’s documentation.
Action Parameters
Action Response
GITHUB_LIST_OWNED_PACKAGE_VERSIONS
This endpoint lists versions of a user-owned package, requiring read:packages scope with oauth or classic tokens. for certain registries, repo scope is also needed. details on permissions can be found in the github packages documentation.
Action Parameters
Action Response
GITHUB_REMOVE_ASSIGNEES_FROM_AN_ISSUE
Removes one or more assignees from an issue.
Action Parameters
Action Response
GITHUB_CREATE_A_REPOSITORY_RULESET
Create a ruleset for a repository.
Action Parameters
Action Response
GITHUB_LIST_COMMIT_COMMENTS
An endpoint lists commit comments, supporting custom media types for responses: raw markdown, text only, html rendered markdown, or all formats. see github docs for more.
Action Parameters
Action Response
GITHUB_LIST_NOTIFICATIONS_FOR_THE_AUTHENTICATED_USER
List all notifications for the current user, sorted by most recently updated.
Action Parameters
Action Response
GITHUB_CHECK_ORGANIZATION_MEMBERSHIP_FOR_A_USER
Check if a user is, publicly or privately, a member of the organization.
Action Parameters
Action Response
GITHUB_DELETE_A_DISCUSSION
To remove a team discussion, use delete /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}“ specifying org id and team id. oauth and classic tokens require write:discussion scope.
Action Parameters
Action Response
GITHUB_GET_PUBLIC_KEY_FOR_THE_AUTHENTICATED_USER
This endpoint allows users with codespaces access to encrypt secrets using a public key. users must encrypt secrets prior to creation or update. oauth app tokens and personal access tokens need codespace or codespace:secrets scope for access.
Action Parameters
Action Response
GITHUB_CREATE_COMMIT_SIGNATURE_PROTECTION
Protected branches can be used in various github plans, including free, pro, and enterprise, for both public and private repositories. they allow admins or owners to require signed commits on a branch, provided branch protection is enabled.
Action Parameters
Action Response
GITHUB_ADD_OR_UPDATE_TEAM_PROJECT_PERMISSIONS_LEGACY
This teams api endpoint for adding a project to a team is deprecated. switch to the new endpoint for adding/updating team project permissions. admin rights required, and both project and team must belong to the same organization.
Action Parameters
Action Response
GITHUB_LIST_SECURITY_MANAGER_TEAMS
The text explains managing security in an organization, stating administrators or security managers need oauth or tokens with read:org scope. details are on github.
Action Parameters
Action Response
GITHUB_UPDATE_INFORMATION_ABOUT_A_GITHUB_PAGES_SITE
Updates github pages site info require the user to be an admin, maintainer, or have specific permission, with oauth or personal access tokens needing ‘repo’ scope.
Action Parameters
Action Response
GITHUB_GET_A_REPOSITORY_WEBHOOK
Returns a webhook configured in a repository. to get only the webhook config properties, see “get a webhook configuration for a repository.”
Action Parameters
Action Response
GITHUB_CREATE_A_REPOSITORY_PROJECT
This text outlines the process of creating a repository project board. it notes that a 410 gone status appears if projects are disabled or if there are no classic projects. a lack of privileges results in a 401 unauthorized or 410 gone status.
Action Parameters
Action Response
GITHUB_GET_A_REPOSITORY
In a forked repository, parent is the direct source it was forked from, and source is the original network source. viewing security and analysis requires admin, owner, or security manager permissions.
Action Parameters
Action Response
GITHUB_DELETE_A_CODESPACE_FROM_THE_ORGANIZATION
Deletes a user’s codespace. oauth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Action Parameters
Action Response
GITHUB_UPDATE_RESOURCE_ACCESS_WITH_TOKENS
Updates the access organization members have to organization resources via fine-grained personal access tokens. limited to revoking a token’s existing access. only github apps can use this endpoint.
Action Parameters
Action Response
GITHUB_RESET_A_TOKEN
This api method lets oauth and github apps auto-reset valid oauth tokens. apps must save the “token” from the response. basic authentication with app credentials is needed. invalid tokens return a 404 not found.
Action Parameters
Action Response
GITHUB_LIST_CUSTOM_PROPERTY_VALUES_FOR_ORGANIZATION_REPOSITORIES
Lists organization repositories with all of their custom property values. organization members can read these properties.
Action Parameters
Action Response
GITHUB_LIST_EMAIL_ADDRESSES_FOR_THE_AUTHENTICATED_USER
Lists all of your email addresses, and specifies which one is visible to the public. oauth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
Action Parameters
Action Response
GITHUB_GET_ALL_CONTRIBUTOR_COMMIT_ACTIVITY
The endpoint shows the total commits authored by a contributor, a weekly summary (weeks array) of additions, deletions, and commits, starting from a unix timestamp. for repositories with 10,000+ commits, addition and deletion counts will return 0.
Action Parameters
Action Response
GITHUB_RENAME_A_BRANCH
Renames a branch in a repository; process may not be instant and pushing to the old name is disabled during this. user needs push access, and additional admin or owner permissions for default branches, including administration:write for tokens.
Action Parameters
Action Response
GITHUB_GET_THE_LAST_YEAR_OF_COMMIT_ACTIVITY
Returns the last year of commit activity grouped by week. the days array is a group of commits per day, starting on sunday.
Action Parameters
Action Response
GITHUB_UPDATE_AN_ORGANIZATION_REPOSITORY_RULESET
Update a ruleset for an organization.
Action Parameters
Action Response
GITHUB_DELETE_A_GIST_COMMENT
To delete a gist comment, use the gist and comment ids. possible responses: 204 (deleted), 304 (not modified), 404 (not found), 403 (forbidden). details at github api docs.
Action Parameters
Action Response
GITHUB_SET_ALLOWED_ACTIONS_AND_REUSABLE_WORKFLOWS_FOR_AN_ORGANIZATION
This endpoint configures allowed actions and workflows in an organization, requiring selected permission policy and admin:org scope for access. see documentation for more on github actions permissions.
Action Parameters
Action Response
GITHUB_LIST_ENVIRONMENTS
Lists the environments for a repository. anyone 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 endpoint with a private repository.
Action Parameters
Action Response
GITHUB_GET_INTERACTION_RESTRICTIONS_FOR_A_REPOSITORY
Shows which type of github user can interact with this repository and when the restriction expires. if there are no restrictions, you will see an empty response.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORIES_ACCESSIBLE_TO_THE_USER_ACCESS_TOKEN
Auth users can access repos they own, collaborate on, or are in their org with permissions (:read, :write, :admin) detailed under permissions key for an installation.
Action Parameters
Action Response
GITHUB_GET_GITHUB_PAGES_BUILD
Gets information about a github pages build. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_CHECK_IF_VULNERABILITY_ALERTS_ARE_ENABLED_FOR_A_REPOSITORY
This text explains that a user can check if dependency alerts are enabled or disabled for a repository, provided they have admin read access. it also links to a page for more information on security alerts for vulnerable dependencies.
Action Parameters
Action Response
GITHUB_LIST_ORGANIZATION_SECRETS
This text outlines a system allowing authed users with collaborator access to list all org secrets without showing encrypted values. oauth and personal tokens with admin:org and repo scope for private repos are necessary for access.
Action Parameters
Action Response
GITHUB_ADD_A_REPOSITORY_TO_AN_APP_INSTALLATION
Add a single repository to an installation. the authenticated user must have admin access to the repository.
Action Parameters
Action Response
GITHUB_GET_ACCESS_RESTRICTIONS
Protected branches are available in all github plans, including free and paid options, and restrict access in organization-owned repositories. more information can be found on github’s documentation page.
Action Parameters
Action Response
GITHUB_DELETE_A_REPOSITORY_RULESET
Delete a ruleset for a repository.
Action Parameters
Action Response
GITHUB_SET_APP_ACCESS_RESTRICTIONS
Protected branches are supported across various github plans, including free and pro versions, and control app push access, limiting it to authorized github apps with write access.
Action Parameters
Action Response
GITHUB_LIST_FORKS
This endpoint displays github repo forks by ‘owner/repo’, sorted by ‘newest’, ‘oldest’, ‘stargazers’, ‘watchers’; defaults to ‘newest’. supports pagination (‘per page’, ‘page’; default 30 results, page 1). for details, check github docs.
Action Parameters
Action Response
GITHUB_CHECK_IF_A_REPOSITORY_IS_STARRED_BY_THE_AUTHENTICATED_USER
Whether the authenticated user has starred the repository.
Action Parameters
Action Response
GITHUB_DISABLE_VULNERABILITY_ALERTS
Disabling dependency alerts and the graph for a repository requires admin access. for details, see github’s guide on security alerts for vulnerable dependencies.
Action Parameters
Action Response
GITHUB_LIST_TEAM_PROJECTS_LEGACY
The list organization projects for a team endpoint is deprecated and will be removed from the teams api. users are advised to switch to the list team projects endpoint for future needs.
Action Parameters
Action Response
GITHUB_CHECK_IF_A_USER_IS_BLOCKED_BY_THE_AUTHENTICATED_USER
Returns a 204 if the given user is blocked by the authenticated user. returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by github.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_ORGANIZATION_SECRETS
This text outlines that authorized users with collaborator access can manage organization secrets linked to a repository, without seeing their encrypted values. oauth or personal access tokens with repo scope are required for access.
Action Parameters
Action Response
GITHUB_UPDATE_A_CUSTOM_ORGANIZATION_ROLE
Updates an existing custom org role, affecting all assignees. requires administrator status or specific permissions. oauth and personal access tokens need admin:org scope for access. more details at github docs on managing access with roles.
Action Parameters
Action Response
GITHUB_CREATE_REACTION_FOR_AN_ISSUE_COMMENT
Create a reaction to an issue comment. a response with an http 200 status means that you already added the reaction type to this issue comment.
Action Parameters
Action Response
GITHUB_REQUEST_REVIEWERS_FOR_A_PULL_REQUEST
This endpoint requests pull request reviews from users/teams, triggering notifications. fast usage may cause rate limiting. see github’s api rate limits and usage best practices for more information.
Action Parameters
Action Response
GITHUB_UPDATE_AN_ENVIRONMENT_VARIABLE
To create, update, or read environment variables in a github actions workflow, authenticated collaborators need repo scope on oauth or classic tokens.
Action Parameters
Action Response
GITHUB_GET_A_COMMIT_COMMENT
This endpoint retrieves a specific commit comment, offering custom media types for different representations: raw markdown (default), text-only, html, or a full version that includes all formats. see github’s media types documentation for details.
Action Parameters
Action Response
GITHUB_REPO_S_LIST_FOR_ORG
Lists repositories for an organization. viewing security and analysis requires admin permissions for the repository or being an organization owner or security manager. more info on managing security managers available.(DEPRECATED use list_organization_repositories)
Action Parameters
Action Response
GITHUB_GET_APPS_WITH_ACCESS_TO_THE_PROTECTED_BRANCH
Protected branches are supported in both free and paid github plans, with varying access across public and private repositories. they ensure only authorized github apps with write access can push to these branches.
Action Parameters
Action Response
GITHUB_LIST_GITHUB_ACTIONS_CACHES_FOR_A_REPOSITORY
Lists the github actions caches for a repository. oauth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_DELETE_A_RELEASE_ASSET
Delete a specified release asset from a github repository by providing the owner, repo, and asset id. access the detailed api documentation at https://docs.github.com/rest/releases/assets#delete-a-release-asset.
Action Parameters
Action Response
GITHUB_GET_A_PACKAGE_FOR_THE_AUTHENTICATED_USER
To access a user-owned package, oauth and classic tokens need read:packages scope. for certain github packages, repo scope is also necessary. details on permissions at github’s documentation.
Action Parameters
Action Response
GITHUB_LIST_TEAM_MEMBERS_LEGACY
The endpoint in the teams api is deprecated and will be removed. users should migrate to the new list team members endpoint, which now includes child team members.
Action Parameters
Action Response
GITHUB_USERS_GET_CONTEXT_FOR_USER
This hovercard feature provides detailed info about someone’s involvement in pull requests, issues, repositories, and organizations, using subject type and subject id for context. oauth tokens require repo scope to access this endpoint.(DEPRECATED use get_contextual_information_for_a_user)
Action Parameters
Action Response
GITHUB_LIST_DOCKER_MIGRATION_CONFLICTS
This endpoint lists packages in a specific organization, readable by the user, that had conflicts during docker migration. it requires oauth app tokens or classic personal access tokens with the read:packages scope.
Action Parameters
Action Response
GITHUB_GET_A_GIST
This endpoint fetches a gist with options for raw markdown (default) or base64-encoded content, supporting custom media types detailed at github docs.
Action Parameters
Action Response
GITHUB_DISMISS_A_REVIEW_FOR_A_PULL_REQUEST
To dismiss a pull request review on a protected branch, you must be an admin or authorized. the endpoint supports multiple media types for returning different formats of the review body.
Action Parameters
Action Response
GITHUB_LIST_PENDING_TEAM_INVITATIONS
The return hash from an organization invitation includes a role field with values like direct member, admin, etc. the login field is null if the invitee isn’t a github member. optionally, specify a team with org id and team id.
Action Parameters
Action Response
GITHUB_GET_A_PACKAGE_VERSION_FOR_THE_AUTHENTICATED_USER
This endpoint retrieves a specific package version for packages owned by the authenticated user. it requires read:packages scope and, for certain registries, repo scope for access, based on package type and registry permissions.
Action Parameters
Action Response
GITHUB_GET_ALLOWED_ACTIONS_AND_REUSABLE_WORKFLOWS_FOR_A_REPOSITORY
This endpoint retrieves settings for allowed actions and workflows in a repository with allowed actions set to selected. requires repo scope for oauth/personal access tokens. see guide for setting permissions.
Action Parameters
Action Response
GITHUB_UPDATE_AN_EXISTING_PROJECT_COLUMN
Update an existing github project column by id. requires column id in the path and a json request body with column’s new name. supports renaming project columns. refer to official documentation for more details.
Action Parameters
Action Response
GITHUB_GET_AN_ORGANIZATION_RULE_SUITE
The text provides details on obtaining data about various rule evaluations in an organization, guiding users to manage rulesets for repositories. for further info, visit github’s documentation on managing rulesets.
Action Parameters
Action Response
GITHUB_CHECK_PUBLIC_ORGANIZATION_MEMBERSHIP_FOR_A_USER
Check if the provided user is a public member of the organization.
Action Parameters
Action Response
GITHUB_DELETE_PACKAGE_VERSION_FOR_AN_ORGANIZATION
To remove a package version with greater than 5,000 downloads in an organization, an admin must contact github support and have the right admin permissions and tokens with read:packages, delete:packages, and repo scopes for some registries.
Action Parameters
Action Response
GITHUB_REREQUEST_A_CHECK_SUITE
This endpoint reinitiates a check suite without new code pushes, triggering a check suite webhook with rerequested action, resetting its status and clearing its conclusion. not accessible by oauth apps and personal access tokens.
Action Parameters
Action Response
GITHUB_LIST_REACTIONS_FOR_A_RELEASE
List the reactions to a release.
Action Parameters
Action Response
GITHUB_LIST_APP_INSTALLATIONS_FOR_AN_ORGANIZATION
This endpoint provides a list of all github apps installed on repositories within an organization, viewable by organization owners. oauth and personal access tokens require admin:read scope.
Action Parameters
Action Response
GITHUB_ADD_PROJECT_COLLABORATOR
Adds a collaborator to an organization project and sets their permission level. you must be an organization owner or a project admin to add a collaborator.
Action Parameters
Action Response
GITHUB_REMOVE_TEAM_MEMBER_LEGACY
The “remove team member” endpoint is deprecated; use “remove team membership for a user” instead, requiring admin rights. it’s available for github enterprise cloud with some limits on idp-synced teams.
Action Parameters
Action Response
GITHUB_CREATE_A_REPOSITORY_SECURITY_ADVISORY
To create a draft repository security advisory, the user must be a security manager or admin of the repository. oauth app and classic personal access tokens require repo or repository advisories:write scope.
Action Parameters
Action Response
GITHUB_DELETE_A_RELEASE_REACTION
You can delete a reaction to a github release by using the route delete /repositories/:repository id/releases/:release id/reactions/:reaction id, specifying the repository by repository id.
Action Parameters
Action Response
GITHUB_GENERATE_RELEASE_NOTES_CONTENT_FOR_A_RELEASE
Release notes, named and formatted in markdown, detail changes since the last release and contributors. intended for creating new releases, they are not stored but generated as needed.
Action Parameters
Action Response
GITHUB_LIST_TEAMS
Lists all teams in an organization that are visible to the authenticated user.
Action Parameters
Action Response
GITHUB_CREATE_A_CHECK_SUITE
The text describes how to manually create a check suite when auto-creation is disabled. it mentions that the checks api functions solely within the original repository, not forks, and is inaccessible to oauth apps and personal tokens.
Action Parameters
Action Response
GITHUB_GET_OCTOCAT
Get the octocat as ascii art
Action Parameters
Action Response
GITHUB_ENCRYPT_ORG_SECRETS_USING_PUBLIC_KEY
To encrypt secrets for an organization, you must first obtain its public key. this process requires an oauth or personal access token with admin:org scope.
Action Parameters
Action Response
GITHUB_DELETE_A_DEPLOYMENT_BRANCH_POLICY
Deletes a deployment branch or tag policy for an environment. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_TEAM_MEMBERS
Team members will include the members of child teams. to list members in a team, the team must be visible to the authenticated user.
Action Parameters
Action Response
GITHUB_GET_A_REPOSITORY_RULESET
Get a ruleset for a repository.
Action Parameters
Action Response
GITHUB_UPDATE_A_TEAM_LEGACY
The teams api endpoint is deprecated; switch to the “update a team” endpoint. only organization owners or team maintainers can edit teams. parent teams in nested setups can’t be set to “secret.”
Action Parameters
Action Response
GITHUB_GET_A_TEAM_LEGACY
deprecation notice: this endpoint route is deprecated and will be removed from the teams api. we recommend migrating your existing code to use the get a team by name endpoint.
Action Parameters
Action Response
GITHUB_LIST_PUBLIC_SSH_KEYS_FOR_THE_AUTHENTICATED_USER
Lists the public ssh keys for the authenticated user’s github account. oauth app tokens and personal access tokens (classic) need the read:public key scope to use this endpoint.
Action Parameters
Action Response
GITHUB_CREATE_A_GITHUB_APP_FROM_A_MANIFEST
This endpoint is for the handshake in the github app manifest flow, allowing retrieval of app id, pem (private key), and webhook secret with a temporary code after app creation.
Action Parameters
Action Response
GITHUB_LIST_JOBS_FOR_A_WORKFLOW_RUN
The text outlines an endpoint to list workflow run jobs with filter options. it’s open to users with read access to the repository, but private repos need ‘repo’ scope for oauth and classic tokens.
Action Parameters
Action Response
GITHUB_SET_USER_ACCESS_RESTRICTIONS
Protected branches are accessible in both free and paid github plans, including private repositories for paid plans. they allow specifying a limited list of users (up to 100) who can push, replacing any previous push permissions.
Action Parameters
Action Response
GITHUB_LIST_DISCUSSION_COMMENTS_LEGACY
The teams api’s endpoint for listing team discussion comments is deprecated. switch to the new endpoint for this purpose. oauth and classic tokens require the read:discussion scope.
Action Parameters
Action Response
GITHUB_REMOVE_A_CUSTOM_PROPERTY_FOR_AN_ORGANIZATION
This endpoint deletes an organization’s custom property. it requires the user to be an organization admin or a user/team with the custom properties org definitions manager permission.
Action Parameters
Action Response
GITHUB_FORCE_CANCEL_A_WORKFLOW_RUN
This endpoint cancels a workflow run, overriding any conditions like always() that would continue execution. it’s for unresponsive workflows. use requires repo scope on oauth or personal access tokens.
Action Parameters
Action Response
GITHUB_ENCRYPT_AND_UPDATE_DEV_SECRET
Creates/updates a repo dev environment secret using an encrypted value via libsodium. requires repo scope for oauth/personal tokens. see github docs for encryption details.
Action Parameters
Action Response
GITHUB_DELETE_A_RELEASE
Users with push access to the repository can delete a release.
Action Parameters
Action Response
GITHUB_DELETE_AN_EMAIL_ADDRESS_FOR_THE_AUTHENTICATED_USER
Oauth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
Action Parameters
Action Response
GITHUB_SEARCH_TOPICS
Search for topics with criteria, getting up to 100 results per page, sorted by best match. use text-match for metadata in search, e.g., q=ruby+is:featured for featured ruby topics. see guides on pagination and text match for details.
Action Parameters
Action Response
GITHUB_CREATE_REACTION_FOR_A_TEAM_DISCUSSION_LEGACY
The teams api endpoint for creating team discussion reactions is deprecated. use the “create reaction for a team discussion” endpoint instead. http 200 means the reaction was added. requires write:discussion scope for oauth and personal tokens.
Action Parameters
Action Response
GITHUB_GET_ADMIN_BRANCH_PROTECTION
Github free allows protected branches in public repos and for organizations; github pro, team, enterprise cloud, and server expands this to private repos as well. further details in github help documentation.
Action Parameters
Action Response
GITHUB_ADD_OR_UPDATE_TEAM_REPOSITORY_PERMISSIONS
To modify a team’s repo permissions, admin access is needed along with team visibility. repos must be owned or forked by the org. follow specific conditions and set content-length to zero for empty parameters to avoid errors.
Action Parameters
Action Response
GITHUB_GET_INTERACTION_RESTRICTIONS_FOR_YOUR_PUBLIC_REPOSITORIES
Shows which type of github user can interact with your public repositories and when the restriction expires.
Action Parameters
Action Response
GITHUB_GET_SINGLE_ORG_SECRET_WITHOUT_DECRYPTION
Gets a single organization secret without revealing its encrypted value. oauth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Action Parameters
Action Response
GITHUB_UPDATE_A_CODESPACE_FOR_THE_AUTHENTICATED_USER
This endpoint updates a user’s codespace, modifying its machine type and recent folders. changes apply upon next start. oauth app tokens and personal access tokens with ‘codespace’ scope are required.
Action Parameters
Action Response
GITHUB_LIST_GPG_KEYS_FOR_A_USER
Lists the gpg keys for a user. this information is accessible by anyone.
Action Parameters
Action Response
GITHUB_SET_CUSTOM_LABELS_FOR_A_SELF_HOSTED_RUNNER_FOR_AN_ORGANIZATION
Authenticated users with admin access can reset custom labels on a specific self-hosted runner in an organization. oauth and classic tokens require admin:org scope; private repos also need repo scope.
Action Parameters
Action Response
GITHUB_GET_A_REPOSITORY_PUBLIC_KEY
This endpoint allows users with read access to obtain a public key for encrypting secrets. for private repositories, oauth or personal access tokens with repo scope are required.
Action Parameters
Action Response
GITHUB_CREATE_A_REGISTRATION_TOKEN_FOR_A_REPOSITORY
This endpoint provides a registration token for configuring a self-hosted runner, which expires in 1 hour. it requires admin access to the repository and oauth or personal access tokens with repo scope.
Action Parameters
Action Response
GITHUB_CREATE_OR_UPDATE_A_CUSTOM_PROPERTY_FOR_AN_ORGANIZATION
This endpoint allows creating or updating an organization’s custom property. it requires the user to be an administrator or have specific permission (custom properties org definitions manager).
Action Parameters
Action Response
GITHUB_USERS_LIST_SOCIAL_ACCOUNTS_FOR_USER
Lists social media accounts for a user. this endpoint is accessible by anyone.(DEPRECATED use list_social_accounts_for_a_user)
Action Parameters
Action Response
GITHUB_MANAGE_ACCESS_CONTROL_FOR_ORGANIZATION_CODESPACES
This text outlines how to manage user access to codespaces in an organization by adjusting permissions, and specifies that oauth app tokens and personal access tokens (classic) require the admin:org scope to access this endpoint.
Action Parameters
Action Response
GITHUB_GET_A_SECRET_SCANNING_ALERT
To fetch a secret scanning alert, a user must be an admin of the repo or its organization, and use tokens with repo, security events, or public repo (for public repositories) scopes.
Action Parameters
Action Response
GITHUB_GET_AN_ORGANIZATION_MEMBERSHIP_FOR_THE_AUTHENTICATED_USER
This endpoint returns the membership status of an authenticated user in an organization unless the user is unaffiliated or the request is from a blocked github app, resulting in a 404 or 403 error respectively.
Action Parameters
Action Response
GITHUB_MANAGE_SECRETS_IN_SELECTED_REPOSITORIES_WITH_PROPER_ACCESS
With ‘selected’ access, only chosen repositories appear. users need collaborator status and admin:org, repo scopes for managing secrets in private repositories using oauth and personal access tokens.
Action Parameters
Action Response
GITHUB_UNBLOCK_A_USER_FROM_AN_ORGANIZATION
Unblocks the given user on behalf of the specified organization.
Action Parameters
Action Response
GITHUB_GET_ORG_DEV_ENVIRONMENT_SECRET_SAFELY
Gets an organization development environment secret without revealing its encrypted value. oauth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Action Parameters
Action Response
GITHUB_UNLOCK_AN_ISSUE
Users with push access can unlock an issue’s conversation.
Action Parameters
Action Response
GITHUB_GET_A_COMMIT_OBJECT
Github’s commit object includes a verification object summarizing the result of the commit’s signature verification, detailing if it was verified, the reason, signature, and signed value. descriptions for possible verification reasons are provided.
Action Parameters
Action Response
GITHUB_LIST_ISSUE_EVENTS
Lists all events for an issue.
Action Parameters
Action Response
GITHUB_REPO_S_LIST_COMMITS
The verification object in a commit includes the verified status, reason, signature, and payload. failure can result from key issues, service errors, unsigned commits, unrecognized signatures, email issues, or invalid signatures. (DEPRECATED use list_commits)
Action Parameters
Action Response
GITHUB_LIST_REACTIONS_FOR_A_TEAM_DISCUSSION
Access reactions to a team discussion via get request, specifying by org id and team id. oauth and personal access tokens with read:discussion scope are necessary.
Action Parameters
Action Response
GITHUB_GET_A_GLOBAL_SECURITY_ADVISORY
Gets a global security advisory using its github security advisory (ghsa) identifier.
Action Parameters
Action Response
GITHUB_GET_WORKFLOW_RUN_USAGE
Github bills minutes for private repo workflows, tracking job re-runs and milliseconds but excludes os multipliers. requires read permissions and certain token scopes. a further document is available for details.
Action Parameters
Action Response
GITHUB_UPDATE_A_TEAM
To edit a team, the authenticated user must either be an organization owner or a team maintainer. note: you can also specify a team by org id and team id using the route patch /organizations/{org_id}/team/{team_id}“.
Action Parameters
Action Response
GITHUB_DELETE_A_CODESPACE_FOR_THE_AUTHENTICATED_USER
Deletes a user’s codespace. oauth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
Action Parameters
Action Response
GITHUB_DELETE_ADMIN_BRANCH_PROTECTION
Protected branches are accessible in both free and paid github public/private repositories. removing admin enforcement needs admin/owner rights and branch protection activation.
Action Parameters
Action Response
GITHUB_LIST_INSTANCES_OF_A_CODE_SCANNING_ALERT
This endpoint lists all code scanning alerts, requiring security events scope for oauth app and classic tokens in private/public repos and public repo scope for public repos only.
Action Parameters
Action Response
GITHUB_GET_A_REPOSITORY_SUBSCRIPTION
Gets information about whether the authenticated user is subscribed to the repository.
Action Parameters
Action Response
GITHUB_CREATE_A_PULL_REQUEST
Draft pull requests on github support various plans, need write access or organization membership to modify, may trigger notifications, are rate-limited, and allow custom media types for markdown representations.
Action Parameters
Action Response
GITHUB_DOWNLOAD_WORKFLOW_RUN_ATTEMPT_LOGS
This endpoint guides users to a url to download a workflow run’s logs, expiring in 1 minute, found in the location: header, accessible to those with repo read access. private repos need oauth or personal access tokens with repo scope.
Action Parameters
Action Response
GITHUB_REMOVE_SELECTED_REPOSITORY_FROM_AN_ORGANIZATION_VARIABLE
Removes a repository from an org variable with visibility set to selected. authenticated users need collaborator access for variable actions. oauth and classic tokens require admin:org scope, and repo scope for private repositories.
Action Parameters
Action Response
GITHUB_GET_USERS_WITH_ACCESS_TO_THE_PROTECTED_BRANCH
Protected branches are available in public and private repositories across various github plans, including free, pro, team, and enterprise versions. they restrict who can push to the branch. for details, see github’s products documentation.
Action Parameters
Action Response
GITHUB_DELETE_A_DEPLOYMENT
To delete a deployment, it must be inactive in multi-deployment repos. make a deployment inactive by replacement or marking it non-successful. use repo or repo deployment scope tokens. refer to github docs for creating deployments and statuses.
Action Parameters
Action Response
GITHUB_DELETE_AN_ORGANIZATION_MIGRATION_ARCHIVE
Deletes a previous migration archive. migration archives are automatically deleted after seven days.
Action Parameters
Action Response
GITHUB_GET_A_RELEASE
The public release is accessible with a given release id, providing an upload url for asset uploads. this url is a hypermedia resource, detailed in github’s rest api guide.
Action Parameters
Action Response
GITHUB_LIST_CHECK_RUN_ANNOTATIONS
Lists 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 private repository.
Action Parameters
Action Response
GITHUB_CREATE_A_DISCUSSION_COMMENT_LEGACY
Deprecated teams api endpoint for creating team discussion comments will be removed. migrate to the new endpoint. trigger notifications; avoid rapid content creation to prevent rate limiting. requires write:discussion scope.
Action Parameters
Action Response
GITHUB_GET_THE_LATEST_RELEASE
The latest published release for a repository is the most recent non-prerelease, non-draft version, ordered by the created at date, which is the commit date, not the drafting or publishing date.
Action Parameters
Action Response
GITHUB_PULLS_CREATE
Draft pull requests on github support various plans, need write access or organization membership to modify, may trigger notifications, are rate-limited, and allow custom media types for markdown representations.(DEPRECATED use create_a_pull_request)
Action Parameters
Action Response
GITHUB_CREATE_A_LABEL
Creates a label for the specified repository with the given name and color. the name and color parameters are required. the color must be a valid hexadecimal color code.
Action Parameters
Action Response
GITHUB_REPO_S_GET_CONTENT
This api endpoint fetches contents of files or directories in various formats, uniquely manages directories, symlinks, and submodules, and supports up to 1,000 files per directory with size constraints on features.(DEPRECATED use get_repository_content)
Action Parameters
Action Response
GITHUB_ADD_TEAMS_TO_THE_COPILOT_SUBSCRIPTION_FOR_AN_ORGANIZATION
The beta endpoint enables organization owners with copilot business or enterprise subscriptions to buy copilot seats for teams, charging the organization. access requires a manage billing:copilot scope. for prices and setup, see github docs.
Action Parameters
Action Response
GITHUB_CHECK_IF_A_USER_CAN_BE_ASSIGNED_TO_A_ISSUE
Checks if a user has permission to be assigned to a specific issue. if the assignee can be assigned to this issue, a 204 status code with no content is returned. otherwise a 404 status code is returned.
Action Parameters
Action Response
GITHUB_AUTH_USER_DOCKER_CONFLICT_PACKAGES_LIST
Lists all packages that are owned by the authenticated user within the user’s namespace, and that encountered a conflict during a docker migration. oauth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint.
Action Parameters
Action Response
GITHUB_REPO_S_CREATE_OR_UPDATE_FILE_CONTENTS
This endpoint creates or replaces a file in a repository but cannot be used concurrently with the “delete a file” endpoint to avoid errors. it requires repo and, for modifying .github/workflows, workflow scopes in oauth or personal access tokens.(DEPRECATED use create_or_update_file_contents)
Action Parameters
Action Response
GITHUB_LIST_ENVIRONMENT_SECRETS
This endpoint allows users with collaborator access to list all secrets in an environment, without showing their encrypted values. oauth app and personal access tokens with repo scope are required.
Action Parameters
Action Response
GITHUB_GET_ASSIGNMENT_GRADES
Gets grades for a github classroom assignment. grades will only be returned if the current user is an administrator of the github classroom for the assignment.
Action Parameters
Action Response
GITHUB_REMOVE_CUSTOM_LABEL_FROM_SELF_HOSTED_RUNNER
Removes a custom label from an organization’s self-hosted runner, returning remaining labels. requires admin:org scope and repo scope for private repositories. a 404 status appears if the label is missing. admin access is required.
Action Parameters
Action Response
GITHUB_GET_A_DISCUSSION_COMMENT_LEGACY
This teams api endpoint for getting team discussion comments is deprecated and will be removed. switch to the new endpoint. oauth and personal tokens need read:discussion scope.
Action Parameters
Action Response
GITHUB_SEARCH_CODE
This method supports searching content and paths, offering up to 100 results/page with text match data. limited to default branch, files less than 384kb, and requires a search term. authentication and a 10 requests/minute limit are mandatory.
Action Parameters
Action Response
GITHUB_MARK_REPOSITORY_NOTIFICATIONS_AS_READ
Marks repository notifications as “read” for a user. a 202 accepted status signals the start of marking notifications. to check remaining unread notifications, use the list repository notifications endpoint with all=false.
Action Parameters
Action Response
GITHUB_GET_A_TREE
Fetches a tree by sha1 or ref name. if truncated is true, the tree exceeds limits (100,000 entries, 7 mb with recursive). fetch more items by getting sub-trees non-recursively.
Action Parameters
Action Response
GITHUB_DELETE_A_REPOSITORY_INVITATION
Delete a repository invitation by specifying the repo’s owner, repository name, and invitation id. for detailed api usage, visit: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation
Action Parameters
Action Response
GITHUB_RESTORE_PACKAGE_VERSION_FOR_AN_ORGANIZATION
A deleted organizational package can be restored within 30 days unless its namespace and version are reused. admin permissions and appropriate oauth scopes for github packages are needed.
Action Parameters
Action Response
GITHUB_GET_REPOSITORY_SECRET_SECURELY
Gets a single repository secret without revealing its encrypted value. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_PENDING_ORGANIZATION_INVITATIONS
The return hash includes a role field indicating the organization invitation role (values: direct member, admin, billing manager, hiring manager). if non-github member, login field is null.
Action Parameters
Action Response
GITHUB_GET_COMMIT_SIGNATURE_PROTECTION
Protected branches are supported across various github plans. admins or owners can check if a branch requires signed commits via a specific endpoint. branch protection must be enabled to require signed commits. for more, visit github’s documentation.
Action Parameters
Action Response
GITHUB_REDELIVER_A_DELIVERY_FOR_AN_ORGANIZATION_WEBHOOK
To redeliver a webhook delivery in an organization, you must be the owner. use admin:org hook scope with oauth or personal access tokens. oauth apps can’t interact with non-owned webhooks, nor can users with those created by oauth apps.
Action Parameters
Action Response
GITHUB_LIST_ORGANIZATION_PROJECTS
Lists the projects in an organization. returns a 404 not found status if projects are disabled in the organization. if you do not have sufficient privileges to perform this action, a 401 unauthorized or 410 gone status is returned.
Action Parameters
Action Response
GITHUB_DELETE_A_FILE
The text explains deleting a file in a repository, mentioning how committer or author details can be specified but default to the user. it advises against using this method with “create or update file contents” to avoid errors.
Action Parameters
Action Response
GITHUB_PULLS_GET
Github supports draft pull requests in various plans, including free, pro, team, and enterprise. it tests mergeability without branch changes, using mergeable and merge commit sha attributes, and allows for specific media types in data retrieval.(DEPRECATED use get_a_pull_request)
Action Parameters
Action Response
GITHUB_MARK_A_THREAD_AS_DONE
Marks a thread as “done.” marking a thread as “done” is equivalent to marking a notification in your notification inbox on github as done: https://github.com/notifications.
Action Parameters
Action Response
GITHUB_GET_A_DEPLOYMENT_BRANCH_POLICY
Gets a deployment branch or tag policy for an environment. anyone 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 endpoint with a private repository.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORIES_ACCESSIBLE_TO_THE_APP_INSTALLATION
List repositories that an app installation can access.
Action Parameters
Action Response
GITHUB_SYNC_A_FORK_BRANCH_WITH_THE_UPSTREAM_REPOSITORY
Sync a branch of a forked repository to keep it up-to-date with the upstream repository.
Action Parameters
Action Response
GITHUB_DOWNLOAD_AN_ARTIFACT
This endpoint provides a temporary url to download a repository archive in zip format, expiring after 1 minute. check the location: in the response for the url. requires repo scope for oauth and personal access tokens.
Action Parameters
Action Response
GITHUB_CREATE_A_TEAM
In {org}, authenticated users can create teams if they’re members or owners, with all members having default creation rights. owners can limit this ability. creators automatically become team maintainers. for permissions and more, check github docs.
Action Parameters
Action Response
GITHUB_SET_SELECTED_REPOSITORIES_FOR_A_USER_SECRET
This endpoint allows selecting repositories for a user’s development environment secret, requiring codespaces access, oauth app tokens, or personal access tokens with codespace or codespace:secrets scope.
Action Parameters
Action Response
GITHUB_CREATE_AN_ORGANIZATION_REPOSITORY_RULESET
Create a repository ruleset for an organization.
Action Parameters
Action Response
GITHUB_REREQUEST_A_CHECK_RUN
This endpoint rerequests an existing github check run without new code, triggering a check run webhook with rerequested action, resetting its status to queued and clearing its conclusion. not usable with oauth apps or personal tokens.
Action Parameters
Action Response
GITHUB_LIST_PUBLIC_EVENTS_RECEIVED_BY_A_USER
This endpoint displays a github user’s public events, including event type and repository, with pagination and event type filtering. it integrates with github apps and requires a username. visit github docs for details.
Action Parameters
Action Response
GITHUB_GET_THE_STATUS_OF_A_GITHUB_PAGES_DEPLOYMENT
Gets the current status of a github pages deployment. the authenticated user must have read permission for the github pages site.
Action Parameters
Action Response
GITHUB_DELETE_A_SECRET_FOR_THE_AUTHENTICATED_USER
Deletes a codespaces development environment secret by name, removing access from all authorized codespaces. requires codespaces access, and oauth or personal access tokens with codespace or codespace:secrets scope.
Action Parameters
Action Response
GITHUB_REMOVE_STATUS_CHECK_PROTECTION
Protected branches are accessible in public repos with github free and for organizations, as well as in both public and private repos with github pro, team, enterprise cloud, and server. further details are on github’s documentation.
Action Parameters
Action Response
GITHUB_GET_A_CHECK_RUN
The checks api fetches a check run using its id from the created repository, not working with forked branches (shows empty pull requests). access to private repositories needs repo scope on oauth/personal tokens.
Action Parameters
Action Response
GITHUB_DELETE_A_REPOSITORY_SUBSCRIPTION
This endpoint is for stopping repository watch. use it to cease getting updates. for notification preferences, manually adjust the repository’s subscription.
Action Parameters
Action Response
GITHUB_LIST_PUBLIC_EVENTS_FOR_A_NETWORK_OF_REPOSITORIES
The “list public events for a network of repositories” endpoint lets users explore public repo network activities by {owner}`/`{repo}, with pagination and page filtering options. more info at github’s documentation website.
Action Parameters
Action Response
GITHUB_LIST_SOCIAL_ACCOUNTS_FOR_A_USER
Lists social media accounts for a user. this endpoint is accessible by anyone.
Action Parameters
Action Response
GITHUB_GET_THE_LICENSE_FOR_A_REPOSITORY
This method fetches a repository’s license content, if detected. it supports custom media types for returning the license either as raw text or html. more details on media types at github’s documentation.
Action Parameters
Action Response
GITHUB_GET_A_PUBLIC_SSH_KEY_FOR_THE_AUTHENTICATED_USER
View extended details for a single public ssh key. oauth app tokens and personal access tokens (classic) need the read:public key scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_CODE_QL_DATABASES_FOR_A_REPOSITORY
This endpoint lists codeql databases in a repository. for access, oauth and classic tokens require security events scope for private/public repos, or public repo scope for public repos only.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_ORGANIZATION_VARIABLES
This text outlines that to create, update, or read organization variables shared with a repository, authenticated users need collaborator access. using the endpoint requires oauth or classic personal access tokens with repo scope.
Action Parameters
Action Response
GITHUB_GET_A_CODE_SCANNING_ALERT
To use the endpoint for code scanning alerts, oauth and classic tokens require security events scope for both private/public repos, and public repo scope for public ones only.
Action Parameters
Action Response
GITHUB_REMOVE_CUSTOM_LABELS_FROM_SELF_HOSTED_REPOSITORY_RUNNER
This endpoint removes custom labels from a self-hosted runner in a repository, returning any read-only labels. admin access is required, and oauth or personal access tokens need repo scope.
Action Parameters
Action Response
GITHUB_GET_PULL_REQUEST_REVIEW_PROTECTION
Protected branches can be used in public repos for github free users and organizations, and in both public and private repos with github pro, team, enterprise cloud, and server. more info is in github’s documentation.
Action Parameters
Action Response
GITHUB_ADD_APP_ACCESS_RESTRICTIONS
Protected branches are supported in both free and paid github plans, allowing push access only to specific github apps with write access. for details, visit github’s products documentation.
Action Parameters
Action Response
GITHUB_LIST_WATCHERS
Lists the people watching the specified repository.
Action Parameters
Action Response
GITHUB_SET_ORGANIZATION_MEMBERSHIP_FOR_A_USER
Only organization owners can add or update members’ roles; new invites and role changes prompt email notifications. invitation limits are 50 or 500 per day based on the organization’s age and plan.
Action Parameters
Action Response
GITHUB_CREATE_A_CHECK_RUN
Creates a new check run for a repository commit using a github app. github limits identical check run names to 1000 in a suite, deleting older ones beyond this. checks api doesn’t detect forked repository pushes.
Action Parameters
Action Response
GITHUB_GET_A_USER_MIGRATION_STATUS
This text describes the process of fetching a user migration, detailing the possible states: pending, exporting, exported, and failed. it notes that a successful (exported) migration allows for the download of the migration archive.
Action Parameters
Action Response
GITHUB_LIST_TIMELINE_EVENTS_FOR_AN_ISSUE
List all timeline events for an issue.
Action Parameters
Action Response
GITHUB_EXPORT_A_SOFTWARE_BILL_OF_MATERIALS_SBOM_FOR_A_REPOSITORY
Exports the software bill of materials (sbom) for a repository in spdx json format.
Action Parameters
Action Response
GITHUB_SEARCH_USERS
This method searches for users by criteria, returning a max of 100 results/page with metadata for login, email, and name. it supports public user searches based on name, repo count, and followers. for private user searches, the graphql api is required.
Action Parameters
Action Response
GITHUB_LIST_ASSIGNEES
Lists the available assignees for issues in a repository.
Action Parameters
Action Response
GITHUB_CREATE_A_PROJECT_COLUMN
Creates a new project column.
Action Parameters
Action Response
GITHUB_CREATE_A_CUSTOM_DEPLOYMENT_PROTECTION_RULE_ON_AN_ENVIRONMENT
Enable a custom deployment protection rule for an environment; requires admin or owner permissions. see [get /apps/{app_slug}] documentation for details. oauth app tokens and personal access tokens need repo scope.
Action Parameters
Action Response
GITHUB_DELETE_COMMIT_SIGNATURE_PROTECTION
Protected branches are available with various github plans. admins or owners can disable required signed commits on protected branches. see github’s products for more info.
Action Parameters
Action Response
GITHUB_GET_AN_IMPORT_STATUS
The import endpoint will be deprecated on april 12, 2024, due to low usage. it involves steps from detecting to completion and reports issues like auth failed. for alternatives, see the changelog.
Action Parameters
Action Response
GITHUB_GET_A_DEPLOY_KEY
Get details of a github repository deploy key by supplying owner, repo, and key id. documentation available at github’s rest api page. supports json format for key data and metadata.
Action Parameters
Action Response
GITHUB_LIST_USER_ACCOUNT_ISSUES_ASSIGNED_TO_THE_AUTHENTICATED_USER
Github’s rest api shows issues and pull requests assigned to the user across owned/member repos. pull requests are identified with a pull request key. use “list pull requests” for pr ids. supports media types for different content representations.
Action Parameters
Action Response
GITHUB_REPLACE_ORG_SECRET_VISIBILITY_TO_SELECTED
When setting an organization secret’s visibility to selected, it replaces all repositories. requires the admin:org scope for oauth and personal access tokens to use this endpoint.
Action Parameters
Action Response
GITHUB_PING_AN_ORGANIZATION_WEBHOOK
Triggering a ping event requires being an organization owner and the admin:org hook scope for oauth or classic tokens. oauth apps can’t interact with non-self-created webhooks, nor can users with those created by oauth apps.
Action Parameters
Action Response
GITHUB_LIST_CHILD_TEAMS
Lists the child teams of the team specified by {team_slug}. note: you can also specify a team by org id and team id using the route get /organizations/{org_id}/team/{team_id}/teams.
Action Parameters
Action Response
GITHUB_LIST_INSTALLATION_REQUESTS_FOR_THE_AUTHENTICATED_APP
Lists all the pending installation requests for the authenticated github app.
Action Parameters
Action Response
GITHUB_CREATE_REACTION_FOR_A_TEAM_DISCUSSION
Adding a reaction to a team discussion via github api returns http 200 if the reaction exists. use post with org id and team id for specific teams. oauth tokens require write:discussion scope.
Action Parameters
Action Response
GITHUB_LIST_DEPLOY_KEYS
This github endpoint lists a repository’s deploy keys, identified by owner and repo, with pagination supported through per page and page. it provides key details like id, content, and creation date. see documentation for more.
Action Parameters
Action Response
GITHUB_UPDATE_A_SECRET_SCANNING_ALERT
This endpoint lets admins of repositories or their organizations update the status of secret scanning alerts. it requires oauth or personal access tokens with repo or security events scope for private, and public repo for public repositories.
Action Parameters
Action Response
GITHUB_LIST_PROJECT_COLLABORATORS
The project’s collaborators list encompasses outside participants, direct collaborators, team members, those with default permissions, and org owners. only org owners or project admins can view this list.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_ACTIVITIES
This text details how to view a repository’s history, including pushes, merges, and branch changes linked to commits/users. for more, see github’s guide on viewing repository activity.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_CONTRIBUTORS
The github api endpoint shows repo contributors in descending commit order. it may show outdated info due to caching. only the top 500 contributors are linked to user accounts; others are anonymous.
Action Parameters
Action Response
GITHUB_LIST_PACKAGES_FOR_THE_AUTHENTICATED_USER_S_NAMESPACE
This endpoint lists packages owned by the user, requiring read:packages scope, and repo scope for certain registry types. see github documentation for registry-specific permissions.
Action Parameters
Action Response
GITHUB_SET_DEFAULT_WORKFLOW_PERMISSIONS_FOR_A_REPOSITORY
Defines default github token permissions and control over github actions’ ability to authorize pull requests. requires repo scope for oauth or personal tokens. details at github docs.
Action Parameters
Action Response
GITHUB_ADD_SOCIAL_ACCOUNTS_FOR_THE_AUTHENTICATED_USER
Add one or more social accounts to the authenticated user’s profile. oauth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
Action Parameters
Action Response
GITHUB_UPDATE_A_REVIEW_FOR_A_PULL_REQUEST
This api endpoint updates review summary comments and supports custom media types for different representations: raw markdown, text-only, html, and full (includes all formats). see github docs for more details.
Action Parameters
Action Response
GITHUB_GET_A_CODE_SCANNING_DEFAULT_SETUP_CONFIGURATION
The default setup for code scanning requires repo scope for both oauth app and classic personal access tokens for accessing private/public repositories, and public repo scope for public repositories only.
Action Parameters
Action Response
GITHUB_LIST_ORGANIZATION_REPOSITORIES
Lists repositories for an organization. viewing security and analysis requires admin permissions for the repository or being an organization owner or security manager. more info on managing security managers available.
Action Parameters
Action Response
GITHUB_DELETE_AN_ORGANIZATION_WEBHOOK
To use this endpoint, you must be an organization owner and have tokens with admin:org hook scope. oauth apps can’t manage webhooks they didn’t create, nor can users manage those created by oauth apps.
Action Parameters
Action Response
GITHUB_UPDATE_A_RELEASE_ASSET
Users with push access to the repository can edit a release asset.
Action Parameters
Action Response
GITHUB_CREATE_A_CODESPACE_FROM_A_PULL_REQUEST
Creates a codespace owned by the authenticated user for the specified pull request. oauth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
Action Parameters
Action Response
GITHUB_CREATE_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER
Creates a new repository for the authenticated user. oauth app tokens and personal access tokens (classic) need the public repo or repo scope to create a public repository, and repo scope to create a private repository.
Action Parameters
Action Response
GITHUB_REPLACE_REPO_ACCESS_ON_ORG_DEV_ENV_SECRET_SET
When setting an org development environment secret to selected visibility, replace all repo access. requires admin:org scope for oauth app and personal access tokens.
Action Parameters
Action Response
GITHUB_GET_REPOSITORY_CLONES
Get the total number of clones and breakdown per day or week for the last 14 days. timestamps are aligned to utc midnight of the beginning of the day or week. week begins on monday.
Action Parameters
Action Response
GITHUB_GET_A_RELEASE_ASSET
To download an asset, set the accept header to application/octet-stream. the api may redirect (302) or stream directly (200), so clients should support both responses.
Action Parameters
Action Response
GITHUB_GET_AN_ISSUE_EVENT
Gets a single event by the event id.
Action Parameters
Action Response
GITHUB_UPDATE_A_DISCUSSION_LEGACY
This teams api endpoint is deprecated and will be removed. users should switch to the new update a discussion endpoint. it allows editing the title and body of a discussion, requiring write:discussion scope for oauth and personal tokens.
Action Parameters
Action Response
GITHUB_LIST_TAG_PROTECTION_STATES_FOR_A_REPOSITORY
This returns the tag protection states of a repository. this information is only available to repository administrators.
Action Parameters
Action Response
GITHUB_DELETE_DEPENDEBOT_SECRET_BY_NAME
Deletes a secret in a repository using the secret name. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_ADD_SELECTED_REPOSITORY_TO_AN_ORGANIZATION_SECRET
Adds a repo to an org’s dev environment secret when its access is ‘selected’. set during secret creation/update. oauth and classic tokens require admin:org scope.
Action Parameters
Action Response
GITHUB_CREATE_OR_UPDATE_AN_ENVIRONMENT_SECRET
This text explains how to create or update encrypted environment secrets with libsodium for github’s rest api, requiring collaborator access and repo scope on tokens.
Action Parameters
Action Response
GITHUB_USERS_GET_BY_USERNAME
Github discloses publicly set user email information and offers an emails api for email visibility control. this access necessitates github authentication.(DEPRECATED use get_a_user)
Action Parameters
Action Response
GITHUB_DELETE_A_LABEL
Deletes a label using the given label name.
Action Parameters
Action Response
GITHUB_ADD_A_SELECTED_REPOSITORY_TO_A_USER_SECRET
This endpoint adds a repository to a user’s development environment secret, requiring codespaces access and the codespace or codespace:secrets scope for oauth or personal access tokens.
Action Parameters
Action Response
GITHUB_SET_ALLOWED_ACTIONS_AND_REUSABLE_WORKFLOWS_FOR_A_REPOSITORY
This endpoint configures allowed actions and workflows in a repository, requiring the repo scope for oauth and classic tokens. the allowed actions policy must be set to selected. see documentation for setting github actions permissions.
Action Parameters
Action Response
GITHUB_LIST_ORG_LEVEL_CODESPACES_SECRETS
Lists all codespaces development environment secrets available at the organization-level without revealing their encrypted values. oauth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Action Parameters
Action Response
GITHUB_PING_A_REPOSITORY_WEBHOOK
This will trigger a ping event to be sent to the hook.
Action Parameters
Action Response
GITHUB_ADD_USERS_TO_THE_COPILOT_SUBSCRIPTION_FOR_AN_ORGANIZATION
This beta endpoint allows organization owners with a copilot business or enterprise subscription to purchase github copilot seats, billed accordingly. oauth tokens require the manage billing:copilot scope. see docs for pricing and setup details.
Action Parameters
Action Response
GITHUB_LIST_SELECTED_REPOSITORIES_FOR_AN_ORGANIZATION_SECRET
Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected. oauth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Action Parameters
Action Response
GITHUB_CREATE_OR_UPDATE_CUSTOM_PROPERTY_VALUES_FOR_A_REPOSITORY
This api endpoint allows repository admins and users with specific permissions to create or update repository custom property values; setting a value to null removes that property.
Action Parameters
Action Response
GITHUB_LIST_MACHINE_TYPES_FOR_A_CODESPACE
List the machine types a codespace can transition to use. oauth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_SELECTED_REPOSITORIES_FOR_A_USER_SECRET
To list repositories with access to a user’s dev environment secret, the user must have codespaces access. oauth or classic personal tokens with codespace or codespace:secrets scope are required.
Action Parameters
Action Response
GITHUB_ADD_SELECTED_REPOSITORY_TO_AN_ORGANIZATION_VARIABLE
This text describes adding a repo to an org variable with visibility set to selected, accessible only to collaborators. for secret access, admin:org and repo scopes are needed for oauth and personal tokens.
Action Parameters
Action Response
GITHUB_LIST_ORGANIZATION_MEMBERSHIPS_FOR_THE_AUTHENTICATED_USER
Lists all of the authenticated user’s organization memberships.
Action Parameters
Action Response
GITHUB_REMOVE_USERS_FROM_THE_COPILOT_SUBSCRIPTION_FOR_AN_ORGANIZATION
The endpoint cancels github copilot seat assignments for specified users, preventing further billing for those users post-current billing cycle. only organization owners can manage this, requiring manage billing:copilot-scoped tokens.
Action Parameters
Action Response
GITHUB_DELETE_AN_ENVIRONMENT_SECRET
Deletes a secret in an environment using the secret name. authenticated users must have collaborator access to a repository to create, update, or read secrets. oauth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_DEPLOYMENTS
Simple filtering of deployments is available via query parameters:
Action Parameters
Action Response
GITHUB_GET_AN_SSH_SIGNING_KEY_FOR_THE_AUTHENTICATED_USER
Gets extended details for an ssh signing key. oauth app tokens and personal access tokens (classic) need the read:ssh signing key scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_ISSUES
Github’s “issues” endpoint lists only open issues but may include pull requests, identifiable by the pull request key. use “list pull requests” for pr ids. supports various media types for markdown representation.
Action Parameters
Action Response
GITHUB_SET_TEAM_ACCESS_RESTRICTIONS
Protected branches are accessible in various github plans, allowing users to manage push access. reassigning push access replaces all previous team permissions with a new list, including child teams.
Action Parameters
Action Response
GITHUB_GET_A_WORKFLOW_RUN_ATTEMPT
Gets a specific workflow run attempt. anyone 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 endpoint with a private repository.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_COLLABORATORS
The endpoint lists all collaborators in organization-owned repositories, including various organization members, and requires users with push access, and tokens with read:org and repo scopes to access. team member lists extend to child teams.
Action Parameters
Action Response
GITHUB_LIST_RUNNER_APPLICATIONS_FOR_AN_ORGANIZATION
The text outlines an endpoint for downloading runner application binaries. it’s accessible exclusively to users with admin rights and the necessary oauth or personal access tokens (with admin:org, repo scopes) for private repositories.
Action Parameters
Action Response
GITHUB_LIST_SELF_HOSTED_RUNNERS_FOR_A_REPOSITORY
Lists all self-hosted runners configured in a repository. authenticated users must have admin access to the repository to use this endpoint. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_PULL_REQUESTS_FILES
Lists files in a pull request, up to 3000 files with 30 per page by default. supports custom media types for different representations of the markdown body (raw, text, html, full). maximum response: 3000 files.
Action Parameters
Action Response
GITHUB_REVOKE_AN_INSTALLATION_ACCESS_TOKEN
Revoking an installation token invalidates it, preventing its use for authentication and access. a new token must be created for other endpoints requiring it, via the specified github documentation link.
Action Parameters
Action Response
GITHUB_CREATE_AN_ORGANIZATION_REPOSITORY
A new repository can be created in a specific organization by a member. oauth and personal access tokens require public repo or repo scope for public, and repo scope for private repositories.
Action Parameters
Action Response
GITHUB_DELETE_A_REPOSITORY
Deleting a repository needs admin rights. if prevented by an organization owner, a 403 forbidden response occurs. oauth app tokens and classic personal access tokens require the delete repo scope for this action.
Action Parameters
Action Response
GITHUB_GET_A_DEPLOYMENT
This endpoint details a repository’s specific deployment, including url, sha, environment, creator, timestamps, and more, essential for deploying refs, as per github api docs.
Action Parameters
Action Response
GITHUB_LIST_ORGANIZATION_FINE_GRAINED_PERMISSIONS_FOR_AN_ORGANIZATION
Guidance on using fine-grained permissions for custom organization and repository roles, including required user status and tokens with admin:org scope. for more, visit github docs on organization access management and endpoint usage.
Action Parameters
Action Response
GITHUB_LIST_ORGANIZATIONS_FOR_THE_AUTHENTICATED_USER
This api displays organizations for authenticated users, needing user or read:org scope. it limits visibility to organizations the user can operate on, rejecting inadequate scope with a 403 forbidden.
Action Parameters
Action Response
GITHUB_LIST_REPOS_WITH_GHACTIONS_CACHE_USAGE
This api lists github actions cache usage for organizations, refreshing data every ~5 minutes. oauth and classic personal access tokens must have read:org scope for access.
Action Parameters
Action Response
GITHUB_GET_A_BLOB
The endpoint returns blob data, offering raw data or json with base64 encoded content. supports files up to 100mb. more on media types at github docs.
Action Parameters
Action Response
GITHUB_GET_ALL_GITIGNORE_TEMPLATES
List all templates available to pass as an option when creating a repository.
Action Parameters
Action Response
GITHUB_LIST_DELIVERIES_FOR_AN_ORGANIZATION_WEBHOOK
This endpoint lists webhook deliveries for an organization’s webhook, accessible to organization owners with admin:org hook scope. oauth apps can only manage their own webhooks.
Action Parameters
Action Response
GITHUB_LIST_LABELS_FOR_A_SELF_HOSTED_RUNNER_FOR_AN_ORGANIZATION
This endpoint lists labels for self-hosted runners in an organization, accessible by admins with admin:org scope for oauth or classic tokens. for private repositories, repo scope is also needed.
Action Parameters
Action Response
GITHUB_DISABLE_A_WORKFLOW
Disables a workflow, setting its state to disabled manually, by replacing workflow id with the workflow file name, e.g., main.yaml. requires repo scope for oauth and classic personal access tokens to access this endpoint.
Action Parameters
Action Response
GITHUB_LIST_REPO_ACCESS_BY_TOKEN
Lists the repositories a fine-grained personal access token request is requesting access to. only github apps can use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_RULE_SUITES
This text discusses managing repository-level rule evaluations, including insights. for details, visit the provided github documentation link.
Action Parameters
Action Response
GITHUB_REPO_S_GET_COMMIT
The api provides commit content with read access, supports pagination for over 300 diffs up to 3000 files, and custom media types. large diffs may time out. includes signature status in a verification object.(DEPRECATED use get_a_commit)
Action Parameters
Action Response
GITHUB_GET_A_REVIEW_FOR_A_PULL_REQUEST
Api endpoint retrieves pull request reviews by id, supporting custom media types for different formats (raw, text, html, full) of the review’s markdown body. see github’s “media types” for details.
Action Parameters
Action Response
GITHUB_RE_RUN_FAILED_JOBS_FROM_A_WORKFLOW_RUN
Re-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 (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_SET_STATUS_CHECK_CONTEXTS
Protected branches are accessible in github free public repos and for organizations, as well as in both public/private repos with github pro, team, enterprise cloud, and server. for details, refer to github’s products guide.
Action Parameters
Action Response
GITHUB_LIST_CODESPACES_FOR_A_USER_IN_ORGANIZATION
Lists the codespaces that a member of an organization has for repositories in that organization. oauth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Action Parameters
Action Response
GITHUB_CREATE_A_SCOPED_ACCESS_TOKEN
Create a repo or permission-scoped token using a non-scoped token, specifying accessible repositories and permissions. invalid tokens yield a 404 error. use basic authentication with the github app’s client credentials.
Action Parameters
Action Response
GITHUB_CREATE_REACTION_FOR_AN_ISSUE
Create a reaction to an issue. a response with an http 200 status means that you already added the reaction type to this issue.
Action Parameters
Action Response
GITHUB_CREATE_OR_UPDATE_A_SECRET_FOR_THE_AUTHENTICATED_USER
This text explains how to create or update a secret for a codespace via api, using libsodium for encryption. users need codespaces access and appropriate oauth scopes (codespace or codespace:secrets) to use this endpoint.
Action Parameters
Action Response
GITHUB_REMOVE_AN_ORGANIZATION_ROLE_FROM_A_USER
To remove a user’s org role, admins must use the admin:org endpoint with oauth or personal tokens. see github documentation for more.
Action Parameters
Action Response
GITHUB_UPDATE_AN_ISSUE_COMMENT
The rest api lets you update comments on issues and prs; prs are issues, but not all issues are prs. it supports media types for different representations of markdown: raw, text, html, or all.
Action Parameters
Action Response
GITHUB_GET_AN_ARTIFACT
Gets 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 personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_GET_WORKFLOW_USAGE
The text details billing for github private repo workflows by os, excluding macos/windows adjustments, and recommends using workflow id for file names. it mentions needing read access and repo scope for tokens. for more, see github documentation.
Action Parameters
Action Response
GITHUB_UPDATE_A_GIST
Edit a gist by updating its description or files, where unchanged files remain as is. editing requires at least a description or file change. supports media types for raw or base64-encoded content.
Action Parameters
Action Response
GITHUB_CREATE_A_TEMPORARY_PRIVATE_FORK
Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. note: forking a repository happens asynchronously. you may have to wait up to 5 minutes before you can access the fork.
Action Parameters
Action Response
GITHUB_UPDATE_A_REFERENCE
Updates the provided reference to point to a new sha. for more information, see “git references” in the git documentation.
Action Parameters
Action Response
GITHUB_GET_TEAM_MEMBERSHIP_FOR_A_USER_LEGACY
The teams api’s endpoint route is deprecated; use get team membership for a user instead. it shows membership state and role, with organization owners as maintainers.
Action Parameters
Action Response
GITHUB_UNLOCK_AN_ORGANIZATION_REPOSITORY
Unlocks a repository that was locked for migration. you should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.
Action Parameters
Action Response
GITHUB_DELETE_AN_SSH_SIGNING_KEY_FOR_THE_AUTHENTICATED_USER
Deletes an ssh signing key from the authenticated user’s github account. oauth app tokens and personal access tokens (classic) need the admin:ssh signing key scope to use this endpoint.
Action Parameters
Action Response
GITHUB_UNSTAR_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER
Unstar a repository that the authenticated user has previously starred.
Action Parameters
Action Response
GITHUB_UPDATE_A_WEBHOOK_CONFIGURATION_FOR_A_REPOSITORY
This text explains how to update a repository’s webhook configuration, including its active state and events, by using a specific update endpoint. oauth or classic tokens with write:repo hook or repo scope are required.
Action Parameters
Action Response
GITHUB_REMOVE_REQUESTED_REVIEWERS_FROM_A_PULL_REQUEST
Removes review requests from a pull request for a given set of users and/or teams.
Action Parameters
Action Response
GITHUB_DELETE_A_PACKAGE_FOR_THE_AUTHENTICATED_USER
Authenticated users can delete their package unless it’s public with over 5,000 downloads; then, contact github support. oauth and classic tokens need read:packages and delete:packages scopes, and possibly repo if the package type requires.
Action Parameters
Action Response
GITHUB_REMOVE_INTERACTION_RESTRICTIONS_FROM_YOUR_PUBLIC_REPOSITORIES
Removes any interaction restrictions from your public repositories.
Action Parameters
Action Response
GITHUB_GET_A_REFERENCE
Fetches a git reference using a formatted url for branches (heads/) or tags (tags/). returns a 404 if not found. for pull request mergeability, a separate request is needed.
Action Parameters
Action Response
GITHUB_GET_ALL_REQUESTED_REVIEWERS_FOR_A_PULL_REQUEST
This text outlines how to get reviewers for a pull request. requested reviewers are listed until they submit a review, after which their reviews can be found via the “list reviews for a pull request” operation.
Action Parameters
Action Response
GITHUB_DELETE_SOCIAL_ACCOUNTS_FOR_THE_AUTHENTICATED_USER
Deletes one or more social accounts from the authenticated user’s profile. oauth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
Action Parameters
Action Response
GITHUB_REPO_S_CREATE_FOR_AUTHENTICATED_USER
Creates a new repository for the authenticated user. oauth app tokens and personal access tokens (classic) need the public repo or repo scope to create a public repository, and repo scope to create a private repository.(DEPRECATED use create_a_repository_for_the_authenticated_user)
Action Parameters
Action Response
GITHUB_CONFIGURE_OIDCSUBJECT_CLAIM_TEMPLATE
Creates or updates the customization template for an openid connect (oidc) subject claim. oauth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Action Parameters
Action Response
GITHUB_SET_PRIMARY_EMAIL_VISIBILITY_FOR_THE_AUTHENTICATED_USER
Sets the visibility for your primary email addresses.
Action Parameters
Action Response
GITHUB_REMOVE_STATUS_CHECK_CONTEXTS
Protected branches are accessible in public repos with github free, in both public and private repos with github pro, team, enterprise cloud, and enterprise server. more details are on github’s product documentation page.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_PROJECTS
Lists the projects in a repository. returns a 404 not found status if projects are disabled in the repository. if you do not have sufficient privileges to perform this action, a 401 unauthorized or 410 gone status is returned.
Action Parameters
Action Response
GITHUB_REMOVE_ALL_ORGANIZATION_ROLES_FOR_A_TEAM
This endpoint removes all organization roles from a team, requiring an admin user with admin:org scope via oauth or personal access tokens. for details on roles, check github’s documentation.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_SECURITY_ADVISORIES
Users with certain roles and ‘repo’ or ‘repository advisories:read’ scope via oauth or classic tokens can access both published and unpublished security advisories in private repositories.
Action Parameters
Action Response
GITHUB_CREATE_A_SNAPSHOT_OF_DEPENDENCIES_FOR_A_REPOSITORY
Create a new snapshot of a repository’s dependencies. the authenticated user must have access to the repository. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_DELETE_A_PUBLIC_SSH_KEY_FOR_THE_AUTHENTICATED_USER
Removes a public ssh key from the authenticated user’s github account. oauth app tokens and personal access tokens (classic) need the admin:public key scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_THE_PEOPLE_A_USER_FOLLOWS
Lists the people who the specified user follows.
Action Parameters
Action Response
GITHUB_DOWNLOAD_A_REPOSITORY_ARCHIVE_TAR
Generate a redirect url to download a tar archive of a repository’s default branch or a specified ref. ensure http framework follows redirects or use the location header for a second request. links for private repositories expire after 5 minutes.
Action Parameters
Action Response
GITHUB_ADD_STATUS_CHECK_CONTEXTS
Protected branches are accessible in public repositories with github free, and in both public and private repositories with github pro, team, enterprise cloud, and server. more info is in github’s documentation.
Action Parameters
Action Response
GITHUB_LIST_SELECTED_REPOSITORIES_FOR_AN_ORGANIZATION_VARIABLE
To access an organization variable, authenticated users need collaborator access. creating, updating, or reading variables requires admin:org scope for oauth app and personal tokens, and repo scope for private repos.
Action Parameters
Action Response
GITHUB_REMOVE_ORG_DEV_ENV_SECRET_BY_NAME
Deletes an organization development environment secret using the secret name. oauth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Action Parameters
Action Response
GITHUB_DELETE_AN_ENVIRONMENT
Oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_CREATE_OR_UPDATE_CUSTOM_PROPERTIES_FOR_AN_ORGANIZATION
The endpoint allows creating or updating custom properties for an organization in bulk, accessible to organization administrators or users with the custom properties org definitions manager permission.
Action Parameters
Action Response
GITHUB_GET_RULES_FOR_A_BRANCH
The text details a feature returning all active rules for a branch, real or hypothetical, at any configuration level. rules in “evaluate” or “disabled” status are excluded.
Action Parameters
Action Response
GITHUB_DELETE_AN_AUTOLINK_REFERENCE_FROM_A_REPOSITORY
This deletes a single autolink reference by id that was configured for the given repository. information about autolinks are only available to repository administrators.
Action Parameters
Action Response
GITHUB_LIST_PULL_REQUESTS_ASSOCIATED_WITH_A_COMMIT
Specifies how to find pull requests linked to a commit: returns merged prs if the commit is in the default branch, and only open prs otherwise. use commit sha to list prs for a branch.
Action Parameters
Action Response
GITHUB_CREATE_A_DISCUSSION_COMMENT
The endpoint enables comment creation on team discussions with notifications; usage may be rate limited. requires oauth or tokens with write:discussion scope. an alternate route exists for team id.
Action Parameters
Action Response
GITHUB_LIST_ISSUE_EVENTS_FOR_A_REPOSITORY
Lists events for a repository.
Action Parameters
Action Response
GITHUB_GET_A_GPG_KEY_FOR_THE_AUTHENTICATED_USER
View extended details for a single gpg key. oauth app tokens and personal access tokens (classic) need the read:gpg key scope to use this endpoint.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORIES_FOR_A_USER
Lists public repositories for the specified user.
Action Parameters
Action Response
GITHUB_REPO_S_LIST_CONTRIBUTORS
The github api endpoint shows repo contributors in descending commit order. it may show outdated info due to caching. only the top 500 contributors are linked to user accounts; others are anonymous.(DEPRECATED use list_repository_contributors)
Action Parameters
Action Response
GITHUB_LIST_ORGANIZATION_VARIABLES
Authenticated users need collaborator access to manage organization variables. to use this endpoint, oauth apps and classic personal access tokens require admin:org scope; repo scope is also needed for private repositories.
Action Parameters
Action Response
GITHUB_LIST_PACKAGE_VERSIONS_FOR_A_PACKAGE_OWNED_BY_AN_ORGANIZATION
This endpoint displays organization-owned package versions, requiring repo scope for access if the package is in a github packages registry with repository-scoped permissions only. visit github docs for more on registry specifics.
Action Parameters
Action Response
GITHUB_CREATE_A_REVIEW_FOR_A_PULL_REQUEST
This api endpoint enables creation of pull request reviews and notifications. rapid usage may cause rate limiting. use pending for draft reviews. calculate diff position for comments. supports various response content types.
Action Parameters
Action Response
GITHUB_GET_A_CODE_SCANNING_ANALYSIS_FOR_A_REPOSITORY
This api endpoint scans code, providing details like git ref, commit details, tool name, and alert counts, some older scans may not include rule counts. it supports sarif v2.1.0 data format and requires specific scopes.
Action Parameters
Action Response
GITHUB_GET_TOP_REFERRAL_PATHS
Get the top 10 popular contents over the last 14 days.
Action Parameters
Action Response
GITHUB_RESTORE_A_PACKAGE_FOR_THE_AUTHENTICATED_USER
Authenticated users can restore deleted packages within 30 days if the namespace and version are available, provided they have the necessary oauth or personal access token scopes, including read:packages, write:packages, and possibly repo.
Action Parameters
Action Response
GITHUB_DELETE_A_GPG_KEY_FOR_THE_AUTHENTICATED_USER
Removes a gpg key from the authenticated user’s github account. oauth app tokens and personal access tokens (classic) need the admin:gpg key scope to use this endpoint.
Action Parameters
Action Response
GITHUB_ADD_USERS_TO_CODESPACES_ACCESS_FOR_AN_ORGANIZATION
Organization codespaces billing is applied to specified users. access requires selected members setting and admin:org scope for oauth or personal tokens. see docs for access control management.
Action Parameters
Action Response
GITHUB_GET_EMOJIS
Lists all the emojis available to use on github.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_TEAMS
The text explains that listing of teams with repository access depends on the repository’s visibility and the type of access token used, with specific scopes required for oauth and personal tokens.
Action Parameters
Action Response
GITHUB_REMOVE_ORGANIZATION_MEMBERSHIP_FOR_A_USER
To remove a user from an organization, the actioner must be an owner. this process ejects active members or cancels pending invitations, with the specified user notified by email.
Action Parameters
Action Response
GITHUB_CREATE_A_TREE
The tree creation api allows for nested entries and modifying trees, where changes require committing and updating branches. using this api can add, delete, or modify files but returns an error for deleting non-existent files.
Action Parameters
Action Response
GITHUB_CREATE_A_REPOSITORY_FROM_AN_UNPUBLISHED_CODESPACE
Publishing an unpublished codespace creates a new repository, granting the codespace’s token write permissions. publishing fails for codespaces already linked to a repository. oauth and classic tokens require codespace scope for this operation.
Action Parameters
Action Response
GITHUB_LIST_CODEOWNERS_ERRORS
The text instructs to identify and list syntax errors in the codeowners file, referencing github’s documentation for correct syntax guidelines.
Action Parameters
Action Response
GITHUB_GET_GITHUB_META_INFORMATION
The api provides metadata on github, including its ip addresses (ipv4 and ipv6) and domain names. refer directly for current values; not all features support ipv6. more info at github’s documentation.
Action Parameters
Action Response
GITHUB_LIST_FOLLOWERS_OF_THE_AUTHENTICATED_USER
Lists the people following the authenticated user.
Action Parameters
Action Response
GITHUB_GET_A_JOB_FOR_A_WORKFLOW_RUN
Gets 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 personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_GET_AN_ORGANIZATION_SECRET
This text outlines accessing a single organization secret without showing its encrypted value. the user must be a collaborator with the admin:org scope for oauth/personal tokens. private repos require an additional repo scope.
Action Parameters
Action Response
GITHUB_ADD_TEAM_MEMBER_LEGACY
Github enterprise cloud’s “add team member” endpoint is deprecated, replaced by “add or update team membership for a user”. org owners/maintainers can sync teams; api errors might occur. use idp for auto sync with content-length set to 0.
Action Parameters
Action Response
GITHUB_GET_A_GITIGNORE_TEMPLATE
This endpoint retrieves the contents of a .gitignore template, supporting custom media types including application/vnd.github.raw+json for raw content. more on media types at github docs.
Action Parameters
Action Response
GITHUB_LIST_DEPENDABOT_ALERTS_FOR_AN_ENTERPRISE
The endpoint lists dependabot alerts for enterprise-owned repositories, accessible only to enterprise members who are organization owners or security managers. oauth tokens require repo or security events scope.
Action Parameters
Action Response
GITHUB_GET_A_THREAD_SUBSCRIPTION_FOR_THE_AUTHENTICATED_USER
This text explains how to verify if a user is subscribed to a thread, noting subscriptions occur only if the user actively participates or manually subscribes.
Action Parameters
Action Response
GITHUB_LIST_REPOSITORY_INVITATIONS_FOR_THE_AUTHENTICATED_USER
When authenticating as a user, this endpoint will list all currently open repository invitations for that user.
Action Parameters
Action Response
GITHUB_LIST_CODESPACES_FOR_THE_AUTHENTICATED_USER
Lists the authenticated user’s codespaces. oauth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
Action Parameters
Action Response
GITHUB_UPLOAD_AN_ANALYSIS_AS_SARIF_DATA
Sarif data can be uploaded to github for prs/branches, viewed in pr checks/security tab. data must be gzip/base64 encoded, with entry and size limits. requires security events or public repo oauth scopes.
Action Parameters
Action Response
GITHUB_GET_A_SELF_HOSTED_RUNNER_FOR_A_REPOSITORY
Gets a specific self-hosted runner configured in a repository. authenticated users must have admin access to the repository to use this endpoint. oauth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Action Parameters
Action Response
GITHUB_START_AN_ORGANIZATION_MIGRATION
Initiates the generation of a migration archive.
Action Parameters
Action Response
GITHUB_LIST_PACKAGE_VERSIONS_FOR_A_PACKAGE_OWNED_BY_A_USER
This endpoint lists a user’s public package versions, needing read:packages scope. for registry-specific packages, repo scope is also required. refer to github’s packages permissions for more.
Action Parameters
Action Response
GITHUB_CREATE_A_DEPLOYMENT
Github’s deployment feature offers versatile verification across environments like ‘production’ and ‘staging’, with parameters like ref, environment, and task, ensuring safety and traceability with defaults.
Action Parameters
Action Response
GITHUB_GET_A_DELIVERY_FOR_A_REPOSITORY_WEBHOOK
Returns a delivery for a webhook configured in a repository.
Action Parameters
Action Response
GITHUB_SEARCH_COMMITS
Search commits on the default branch using criteria with up to 100 results per page. include text-match media type for message metadata. example search: q=repo:octocat/spoon-knife+css.
Action Parameters
Action Response
GITHUB_REVIEW_PENDING_DEPLOYMENTS_FOR_A_WORKFLOW_RUN
Approve or reject pending deployments needing reviewer approval. reviewers with read access and oauth or classic tokens with repo scope can use this endpoint.
Action Parameters
Action Response