Access levels
Each GitHub account has an access level: Read-only, Read + write code, and Full access. Squad refuses any agent action outside that level. You can also narrow or block single agents under Per-agent access.| Level | The connect window describes this level as | Actions agents can use |
|---|---|---|
| Read-only | ”Read repos, PRs, issues. Cannot write code or create.” | 449 of 793 |
| Read + write code (recommended) | “Full repo access — code, PRs, issues.” | 666 of 793 |
| Full access | ”Above plus GitHub Actions, org admin, webhooks, gists.” | 793 of 793 |
What agents can do at each level
Each level opens with a short summary in plain tasks, then lists every action it adds, grouped by what the action works on. You do not need to name actions. Ask in plain words, and the agent searches for the matching action.Read-only
Read-only
- View comments
- View and search repositories
- View keys
- View events
- View and search code
- View roles and permissions
- View and search commits
- View and search users
- View variables
- View versions
- View and search labels
- View members
Account details (2)
Account details (2)
| Action | What it does | Slug |
|---|---|---|
| List social accounts for a user | GITHUB_LIST_SOCIAL_ACCOUNTS_FOR_A_USER | |
| List social accounts for the authenticated user | GITHUB_LIST_SOCIAL_ACCOUNTS_FOR_THE_AUTHENTICATED_USER |
Activities (4)
Activities (4)
| Action | What it does | Slug |
|---|---|---|
| Get all contributor commit activity | Retrieves commit activity (total commits, weekly additions/deletions/commits) for all contributors to a repository. | GITHUB_GET_ALL_CONTRIBUTOR_COMMIT_ACTIVITY |
| Get the last year of commit activity | Fetches weekly commit totals and daily commit counts for the last 52 weeks for a specified GitHub repository. | GITHUB_GET_THE_LAST_YEAR_OF_COMMIT_ACTIVITY |
| Get the weekly commit activity | Fetches the weekly commit activity (additions and deletions per week) for a repository over the past year. | GITHUB_GET_THE_WEEKLY_COMMIT_ACTIVITY |
| List repository activities | GITHUB_LIST_REPOSITORY_ACTIVITIES |
Addresses (1)
Addresses (1)
| Action | What it does | Slug |
|---|---|---|
| List email addresses for the authenticated user | Lists all email addresses for the authenticated user, including their primary status, verification status, and visibility. | GITHUB_LIST_EMAIL_ADDRESSES_FOR_THE_AUTHENTICATED_USER |
Alerts (5)
Alerts (5)
| Action | What it does | Slug |
|---|---|---|
| Get code scanning alert | Retrieves a specific code scanning alert, which identifies potential code vulnerabilities or errors, by its number from the specified GitHub repository. | GITHUB_GET_CODE_SCANNING_ALERT |
| List code scanning alerts for a repository | Lists code scanning alerts for a repository, optionally filtering by tool (which must have produced scan results for the repository), Git reference, state, or severity. | GITHUB_LIST_CODE_SCANNING_ALERTS_FOR_A_REPOSITORY |
| List code scanning alerts for an organization | Lists code scanning alerts for a GitHub organization. | GITHUB_LIST_CODE_SCANNING_ALERTS_FOR_AN_ORGANIZATION |
| List instances of a code scanning alert | GITHUB_LIST_INSTANCES_OF_A_CODE_SCANNING_ALERT | |
| List repository Dependabot alerts | GITHUB_LIST_REPOSITORY_DEPENDABOT_ALERTS |
Apps (2)
Apps (2)
| Action | What it does | Slug |
|---|---|---|
| Get an app | Retrieves publicly available information for an existing GitHub App, identified by its unique URL-friendly app_slug. | GITHUB_GET_AN_APP |
| List apps with access to the protected branch | Lists GitHub Apps with push access to a repository’s protected branch. | GITHUB_LIST_APPS_WITH_ACCESS_TO_THE_PROTECTED_BRANCH |
Artifacts (4)
Artifacts (4)
| Action | What it does | Slug |
|---|---|---|
| Download an artifact | Downloads a GitHub Actions workflow artifact as a ZIP file. | GITHUB_DOWNLOAD_AN_ARTIFACT |
| Get an artifact | Gets a specific artifact for a repository by artifact_id. | GITHUB_GET_AN_ARTIFACT |
| List artifacts for a repository | Lists GitHub Actions workflow artifacts for a specified repository, which must exist. | GITHUB_LIST_ARTIFACTS_FOR_A_REPOSITORY |
| List workflow run artifacts | GITHUB_LIST_WORKFLOW_RUN_ARTIFACTS |
Assets (2)
Assets (2)
| Action | What it does | Slug |
|---|---|---|
| Get a release asset | Gets metadata for a specific release asset in a GitHub repository, including a browser_download_url for downloading the asset. | GITHUB_GET_A_RELEASE_ASSET |
| List release assets | GITHUB_LIST_RELEASE_ASSETS |
Assignees (1)
Assignees (1)
| Action | What it does | Slug |
|---|---|---|
| List assignees | Lists users who can be assigned to issues in a repository, typically those with push access. | GITHUB_LIST_ASSIGNEES |
Attributes (1)
Attributes (1)
| Action | What it does | Slug |
|---|---|---|
| Get default attributes for a codespace | Get pre-flight data (e.g., default location, devcontainer path) for creating a Codespace in a given repository (must exist and be accessible), optionally for a specific Git ref. | GITHUB_GET_DEFAULT_ATTRIBUTES_FOR_A_CODESPACE |
Audit logs (1)
Audit logs (1)
| Action | What it does | Slug |
|---|---|---|
| Get organization audit log | Retrieve an organization’s audit log events for security and compliance investigations. | GITHUB_GET_ORGANIZATION_AUDIT_LOG |
Branch protection (6)
Branch protection (6)
| Action | What it does | Slug |
|---|---|---|
| Get admin branch protection | Checks if repository administrators are subject to the branch protection rules on a specific branch. | GITHUB_GET_ADMIN_BRANCH_PROTECTION |
| Get branch protection | Retrieves branch protection settings for a specific, existing, and accessible branch in a GitHub repository. | GITHUB_GET_BRANCH_PROTECTION |
| Get commit signature protection | Gets the commit signature protection status for a branch in a repository. | GITHUB_GET_COMMIT_SIGNATURE_PROTECTION |
| Get pull request review protection | Retrieves the pull request review protection settings for a specific branch in a GitHub repository, if such protection is configured. | GITHUB_GET_PULL_REQUEST_REVIEW_PROTECTION |
| Get status checks protection | Retrieves the status check protection settings for a specific branch in a GitHub repository, if status check protection is enabled for it. | GITHUB_GET_STATUS_CHECKS_PROTECTION |
| List tag protection states for a repository | GITHUB_LIST_TAG_PROTECTION_STATES_FOR_A_REPOSITORY |
Branches (3)
Branches (3)
| Action | What it does | Slug |
|---|---|---|
| Get a branch | Retrieves detailed information for a specified branch within a GitHub repository. | GITHUB_GET_A_BRANCH |
| List branches | Lists branches for an existing GitHub repository, with an option to filter by protection status. | GITHUB_LIST_BRANCHES |
| List branches for head commit | Lists branches in an accessible repository where the provided commit SHA is the head, useful for identifying development lines based on that commit. | GITHUB_LIST_BRANCHES_FOR_HEAD_COMMIT |
Cards (2)
Cards (2)
| Action | What it does | Slug |
|---|---|---|
| Get a project card | Retrieves all details of a specific project card, given its unique card_id. | GITHUB_GET_A_PROJECT_CARD |
| List project cards | GITHUB_LIST_PROJECT_CARDS |
Catalog (1)
Catalog (1)
| Action | What it does | Slug |
|---|---|---|
| Get catalog models | Retrieve the list of AI models available in the GitHub Models catalog. | GITHUB_GET_CATALOG_MODELS |
Change history (1)
Change history (1)
| Action | What it does | Slug |
|---|---|---|
| List comment changes | List issue and PR comment changes across an organization’s repositories efficiently. | GITHUB_LIST_COMMENT_CHANGES |
Chats (1)
Chats (1)
| Action | What it does | Slug |
|---|---|---|
| Create inference chat completions | Create chat completions using GitHub Models inference API. | GITHUB_CREATE_INFERENCE_CHAT_COMPLETIONS |
Check runs (6)
Check runs (6)
| Action | What it does | Slug |
|---|---|---|
| Get check run | Retrieves detailed information for a specific check run within a GitHub repository. | GITHUB_GET_CHECK_RUN |
| Get check suite | Retrieves a specific check suite (a collection of check runs) by its ID from a repository accessible to the authenticated user. | GITHUB_GET_CHECK_SUITE |
| List check run annotations | Lists annotations for a specific check run in a GitHub repository, detailing issues like errors or warnings on particular code lines. | GITHUB_LIST_CHECK_RUN_ANNOTATIONS |
| List check runs for a ref | List GitHub check runs for a commit SHA, branch, or tag to assess CI status and conclusions. | GITHUB_LIST_CHECK_RUNS_FOR_A_REF |
| List check runs in a check suite | Lists check runs for a specific check suite in a GitHub repository, optionally filtering by check name or status. | GITHUB_LIST_CHECK_RUNS_IN_A_CHECK_SUITE |
| List check suites for a Git reference | Lists check suites for a Git reference (commit SHA, branch, or tag) in a repository, optionally filtering by GitHub App ID or check run name. | GITHUB_LIST_CHECK_SUITES_FOR_A_GIT_REFERENCE |
Code (13)
Code (13)
| Action | What it does | Slug |
|---|---|---|
| Get a blob | Retrieves the raw, typically Base64-encoded, content of a file (blob) from a GitHub repository using its SHA hash, if the repository and blob SHA exist. | GITHUB_GET_A_BLOB |
| Get a repository README | Fetches the README file (if it exists and is accessible) from a specified GitHub repository, returning its Base64-encoded content and metadata. | GITHUB_GET_A_REPOSITORY_README |
| Get a repository README for a directory | Retrieves the README file from a specified directory within a GitHub repository, optionally at a given commit, branch, or tag. | GITHUB_GET_A_REPOSITORY_README_FOR_A_DIRECTORY |
| Get a tree | Browse and list all files/directories in a GitHub repository. | GITHUB_GET_A_TREE |
| Get code of conduct | Retrieves the full details of a specific GitHub code of conduct using its unique key. | GITHUB_GET_CODE_OF_CONDUCT |
| Get code of conduct graph ql | Look up a code of conduct by its key using GitHub’s GraphQL API. | GITHUB_GET_CODE_OF_CONDUCT_GRAPH_QL |
| Get code scanning analysis | Retrieves detailed information for a specific code scanning analysis on an accessible repository, identified by its analysis_id. | GITHUB_GET_CODE_SCANNING_ANALYSIS |
| Get code scanning default setup | Gets the default setup configuration for code scanning in a repository, including state, languages, query suite, and schedule for a repository if it exists. | GITHUB_GET_CODE_SCANNING_DEFAULT_SETUP |
| Get dependency diff | Gets the dependency diff between two Git revisions in a repository, where ‘basehead’ specifies the revisions and ‘name’ can optionally scope to a specific manifest file. | GITHUB_GET_DEPENDENCY_DIFF |
| List code scanning analyses for a repository | Lists code scanning analyses for an existing repository, optionally filtering by tool (name or GUID), Git reference, or SARIF ID. | GITHUB_LIST_CODE_SCANNING_ANALYSES_FOR_A_REPOSITORY |
| List codes of conduct | Retrieves all available codes of conduct from GitHub, often used to select one for a repository. | GITHUB_LIST_CODES_OF_CONDUCT |
| List codes of conduct GraphQL | Fetch all available codes of conduct using GitHub’s GraphQL API. | GITHUB_LIST_CODES_OF_CONDUCT_GRAPHQL |
| Search code | GITHUB_SEARCH_CODE |
Codespaces (5)
Codespaces (5)
| Action | What it does | Slug |
|---|---|---|
| Get codespace | Call to retrieve detailed information for a codespace_name belonging to the authenticated user, ensuring the codespace exists and is accessible. | GITHUB_GET_CODESPACE |
| List codespaces for a user in organization | Lists all GitHub Codespaces owned by a specified member of a given organization. | GITHUB_LIST_CODESPACES_FOR_A_USER_IN_ORGANIZATION |
| List codespaces for the authenticated user | Lists GitHub Codespaces for the authenticated user, optionally filtering by repository ID and supporting pagination. | GITHUB_LIST_CODESPACES_FOR_THE_AUTHENTICATED_USER |
| List codespaces for the organization | Lists active/pending GitHub Codespaces for an existing organization. | GITHUB_LIST_CODESPACES_FOR_THE_ORGANIZATION |
| List repo codespaces | GITHUB_LIST_REPO_CODESPACES |
Collaborators (4)
Collaborators (4)
| Action | What it does | Slug |
|---|---|---|
| Check if user is repository collaborator | Checks if a user is a collaborator on a specified GitHub repository, returning a 204 status if they are, or a 404 status if they are not or if the repository/user does not exist. | GITHUB_CHECK_IF_USER_IS_REPOSITORY_COLLABORATOR |
| List outside collaborators for an organization | GITHUB_LIST_OUTSIDE_COLLABORATORS_FOR_AN_ORGANIZATION | |
| List project collaborators | GITHUB_LIST_PROJECT_COLLABORATORS | |
| List repository collaborators | GITHUB_LIST_REPOSITORY_COLLABORATORS |
Columns (2)
Columns (2)
| Action | What it does | Slug |
|---|---|---|
| Get a project column | Retrieves detailed information for a specific project column from GitHub Projects (classic). | GITHUB_GET_A_PROJECT_COLUMN |
| List project columns | GITHUB_LIST_PROJECT_COLUMNS |
Comments (15)
Comments (15)
Commits (11)
Commits (11)
| Action | What it does | Slug |
|---|---|---|
| Compare two commits | Compares two commit points (commits, branches, tags, or SHAs) within a repository or across forks, using BASE…HEAD or OWNER:REF…OWNER:REF format for the basehead parameter. | GITHUB_COMPARE_TWO_COMMITS |
| Get a commit | Retrieves a specific commit from a repository by its owner, name, and a valid commit reference (SHA, branch, or tag), supporting pagination for large diffs. | GITHUB_GET_A_COMMIT |
| Get commit authors | Fetches commit authors identified during a repository import, used to map authors from an external VCS to GitHub accounts. | GITHUB_GET_COMMIT_AUTHORS |
| Get commit statuses | List all statuses for a commit reference (SHA, branch, or tag) in reverse chronological order. | GITHUB_GET_COMMIT_STATUSES |
| Get the hourly commit count for each day | Retrieves the ‘punch card’ data, showing hourly commit counts for each day of the week for an existing and accessible repository. | GITHUB_GET_THE_HOURLY_COMMIT_COUNT_FOR_EACH_DAY |
| Get the weekly commit count | Retrieves the weekly commit count for a repository, detailing commits by the owner and all contributors over the last 52 weeks. | GITHUB_GET_THE_WEEKLY_COMMIT_COUNT |
| List commits | Lists commits for a GitHub repository. | GITHUB_LIST_COMMITS |
| List commits on a pull request | Lists commits for a pull request. | GITHUB_LIST_COMMITS_ON_A_PULL_REQUEST |
| List gist commits | Lists all commits for a specified gist. | GITHUB_LIST_GIST_COMMITS |
| Search commits | GITHUB_SEARCH_COMMITS | |
| Search commits by author | GITHUB_SEARCH_COMMITS_BY_AUTHOR |
Content (2)
Content (2)
| Action | What it does | Slug |
|---|---|---|
| Get raw repository content | Fetch raw file content from a GitHub repository. | GITHUB_GET_RAW_REPOSITORY_CONTENT |
| Get repository content | Retrieves a file’s Base64 encoded content or lists a directory’s contents from a GitHub repository. | GITHUB_GET_REPOSITORY_CONTENT |
Contributors (1)
Contributors (1)
| Action | What it does | Slug |
|---|---|---|
| List repository contributors | GITHUB_LIST_REPOSITORY_CONTRIBUTORS |
Databases (2)
Databases (2)
| Action | What it does | Slug |
|---|---|---|
| Get CodeQL database | Gets an existing CodeQL database (including a download URL) for a specified language in an accessible repository, if one has been successfully built for that language. | GITHUB_GET_CODEQL_DATABASE |
| List CodeQL databases for a repository | Lists all CodeQL databases for a repository where CodeQL analysis has been previously run and completed. | GITHUB_LIST_CODEQL_DATABASES_FOR_A_REPOSITORY |
Dependencies (2)
Dependencies (2)
| Action | What it does | Slug |
|---|---|---|
| List issue dependencies blocked by | GITHUB_LIST_ISSUE_DEPENDENCIES_BLOCKED_BY | |
| List issue dependencies blocking | GITHUB_LIST_ISSUE_DEPENDENCIES_BLOCKING |
Deployments (6)
Deployments (6)
| Action | What it does | Slug |
|---|---|---|
| Get deployment | Gets a specific deployment by ID from a repository, provided the repository and deployment ID exist. | GITHUB_GET_DEPLOYMENT |
| Get deployment status | Retrieves a specific deployment status by its ID for a given deployment within a GitHub repository. | GITHUB_GET_DEPLOYMENT_STATUS |
| Get pending deployments for a workflow run | Retrieves pending deployment environments for a specific workflow run that are awaiting approval due to protection rules. | GITHUB_GET_PENDING_DEPLOYMENTS_FOR_A_WORKFLOW_RUN |
| Get the status of a GitHub pages deployment | Retrieves the status of a specific GitHub Pages deployment for a repository, which must have GitHub Pages enabled. | GITHUB_GET_THE_STATUS_OF_A_GITHUB_PAGES_DEPLOYMENT |
| List deployment statuses | Lists all statuses for a given deployment in a repository. | GITHUB_LIST_DEPLOYMENT_STATUSES |
| List deployments | Lists deployments for a specified repository. | GITHUB_LIST_DEPLOYMENTS |
Discussions (2)
Discussions (2)
| Action | What it does | Slug |
|---|---|---|
| Get discussion | Fetches a specific discussion by its number from a team within an organization. | GITHUB_GET_DISCUSSION |
| List discussions | Lists discussions for a specific team within an organization, with options for sorting, pagination, and filtering by pinned status. | GITHUB_LIST_DISCUSSIONS |
Documents (1)
Documents (1)
| Action | What it does | Slug |
|---|---|---|
| Render a markdown document | GITHUB_RENDER_A_MARKDOWN_DOCUMENT |
Domains (1)
Domains (1)
| Action | What it does | Slug |
|---|---|---|
| Get pages DNS health check | Retrieves the DNS health check status (e.g., CNAME/A records, HTTPS) for a GitHub Pages site. | GITHUB_GET_PAGES_DNS_HEALTH_CHECK |
Emails (1)
Emails (1)
| Action | What it does | Slug |
|---|---|---|
| List public emails for auth user | GITHUB_LIST_PUBLIC_EMAILS_FOR_AUTH_USER |
Environments (2)
Environments (2)
| Action | What it does | Slug |
|---|---|---|
| Get an environment | Retrieves the details of a specific deployment environment for a given repository, including its name, configurations, and current status. | GITHUB_GET_AN_ENVIRONMENT |
| List environments | Retrieves all deployment environments for a specified repository, which are used to configure protection rules and secrets for different software lifecycle stages. | GITHUB_LIST_ENVIRONMENTS |
Errors (1)
Errors (1)
| Action | What it does | Slug |
|---|---|---|
| List codeowners errors | Lists syntax errors in a repository’s CODEOWNERS file, which must be located at the root, .github/, or docs/ directory for the specified ref. | GITHUB_LIST_CODEOWNERS_ERRORS |
Events (14)
Events (14)
| Action | What it does | Slug |
|---|---|---|
| Get an issue event | Fetches details of a specific issue event for a given repository and event ID. | GITHUB_GET_AN_ISSUE_EVENT |
| List events for the authenticated user | Lists public events for the specified GitHub user, or private events if authenticated as that user, in reverse chronological order. | GITHUB_LIST_EVENTS_FOR_THE_AUTHENTICATED_USER |
| List events for user | GITHUB_LIST_EVENTS_FOR_USER | |
| List events received by the authenticated user | Lists events a specific GitHub user received from followed users and watched repositories. | GITHUB_LIST_EVENTS_RECEIVED_BY_THE_AUTHENTICATED_USER |
| List issue events | GITHUB_LIST_ISSUE_EVENTS | |
| List issue events for a repository | GITHUB_LIST_ISSUE_EVENTS_FOR_A_REPOSITORY | |
| List organization events for the authenticated user | GITHUB_LIST_ORGANIZATION_EVENTS_FOR_THE_AUTHENTICATED_USER | |
| List public events | GITHUB_LIST_PUBLIC_EVENTS | |
| List public events for a network of repositories | GITHUB_LIST_PUBLIC_EVENTS_FOR_A_NETWORK_OF_REPOSITORIES | |
| List public events for a user | GITHUB_LIST_PUBLIC_EVENTS_FOR_A_USER | |
| List public events received by a user | GITHUB_LIST_PUBLIC_EVENTS_RECEIVED_BY_A_USER | |
| List public organization events | GITHUB_LIST_PUBLIC_ORGANIZATION_EVENTS | |
| List repository events | GITHUB_LIST_REPOSITORY_EVENTS | |
| List timeline events for an issue | GITHUB_LIST_TIMELINE_EVENTS_FOR_AN_ISSUE |
Exports (1)
Exports (1)
| Action | What it does | Slug |
|---|---|---|
| Get details about a codespace export | Retrieves detailed information about a specific export of a codespace. | GITHUB_GET_DETAILS_ABOUT_A_CODESPACE_EXPORT |
Fields (1)
Fields (1)
| Action | What it does | Slug |
|---|---|---|
| List project fields for user | GITHUB_LIST_PROJECT_FIELDS_FOR_USER |
Files (3)
Files (3)
| Action | What it does | Slug |
|---|---|---|
| Get information about a SARIF upload | Retrieves detailed information, including processing status and results URL, about a specific SARIF (Static Analysis Results Interchange Format) upload for a repository, uniquely identified by its sarif_id. | GITHUB_GET_INFORMATION_ABOUT_A_SARIF_UPLOAD |
| Get large files | Lists files larger than 100MB identified during a previous source import for the specified repository. | GITHUB_GET_LARGE_FILES |
| List pull requests files | GITHUB_LIST_PULL_REQUESTS_FILES |
Followers (4)
Followers (4)
| Action | What it does | Slug |
|---|---|---|
| Check following | GITHUB_CHECK_FOLLOWING | |
| List followers of a user | Lists followers for a specified, existing GitHub user. | GITHUB_LIST_FOLLOWERS_OF_A_USER |
| List followers of the authenticated user | Lists users following the authenticated GitHub user, returning an empty list if the user has no followers. | GITHUB_LIST_FOLLOWERS_OF_THE_AUTHENTICATED_USER |
| List following for user | GITHUB_LIST_FOLLOWING_FOR_USER |
Forks (2)
Forks (2)
| Action | What it does | Slug |
|---|---|---|
| List forks | Lists forks for a specified repository, which must exist, with options for sorting and pagination. | GITHUB_LIST_FORKS |
| List gist forks | Lists all forks for a given GitHub gist ID. | GITHUB_LIST_GIST_FORKS |
Gists (6)
Gists (6)
| Action | What it does | Slug |
|---|---|---|
| Check if gist is starred | Checks if a gist is starred by the authenticated user. | GITHUB_CHECK_IF_GIST_IS_STARRED |
| Get gist | Fetches a specific GitHub gist by its gist_id, returning comprehensive details if the gist exists. | GITHUB_GET_GIST |
| List gists for a user | GITHUB_LIST_GISTS_FOR_A_USER | |
| List gists for the authenticated user | GITHUB_LIST_GISTS_FOR_THE_AUTHENTICATED_USER | |
| List public gists | GITHUB_LIST_PUBLIC_GISTS | |
| List starred gists | GITHUB_LIST_STARRED_GISTS |
History (1)
History (1)
| Action | What it does | Slug |
|---|---|---|
| Get the review history for a workflow run | Retrieves the detailed approval history for a specific workflow run in a GitHub repository, detailing each review’s environment, state, reviewer, and comments, to track the approval process for workflows, particularly automated deployments. | GITHUB_GET_THE_REVIEW_HISTORY_FOR_A_WORKFLOW_RUN |
Installed apps (2)
Installed apps (2)
| Action | What it does | Slug |
|---|---|---|
| List app installations | Lists GitHub App installations accessible to the authenticated user via their access token, including installation details, permissions, and repository access. | GITHUB_LIST_APP_INSTALLATIONS |
| List installation requests for the authenticated app | GITHUB_LIST_INSTALLATION_REQUESTS_FOR_THE_AUTHENTICATED_APP |
Interactions (3)
Interactions (3)
| Action | What it does | Slug |
|---|---|---|
| Get interaction restrictions for a repository | Retrieves active interaction restrictions for a repository, detailing which user groups are limited from activities like commenting or creating pull requests, and when these restrictions expire. | GITHUB_GET_INTERACTION_RESTRICTIONS_FOR_A_REPOSITORY |
| Get interaction restrictions for an organization | Retrieves interaction restrictions for an organization, showing which GitHub user types can interact with its public repositories and when restrictions expire. | GITHUB_GET_INTERACTION_RESTRICTIONS_FOR_AN_ORGANIZATION |
| Get interaction restrictions for public repos | Retrieves currently active interaction restrictions for the authenticated user’s public repositories. | GITHUB_GET_INTERACTION_RESTRICTIONS_FOR_PUBLIC_REPOS |
Invitations (5)
Invitations (5)
| Action | What it does | Slug |
|---|---|---|
| Get enterprise member invitation | Look up a pending enterprise unaffiliated member invitation by invitee and enterprise. | GITHUB_GET_ENTERPRISE_MEMBER_INVITATION |
| List pending team invitations | GITHUB_LIST_PENDING_TEAM_INVITATIONS | |
| List repo invitations for auth user | GITHUB_LIST_REPO_INVITATIONS_FOR_AUTH_USER | |
| List repository invitations | GITHUB_LIST_REPOSITORY_INVITATIONS | |
| Lookup enterprise administrator invitation | GITHUB_LOOKUP_ENTERPRISE_ADMINISTRATOR_INVITATION |
Issues (7)
Issues (7)
| Action | What it does | Slug |
|---|---|---|
| Get an issue | Retrieves detailed information about a specific issue in a repository using the owner, repository name, and issue number. | GITHUB_GET_AN_ISSUE |
| List issues assigned to the authenticated user | GITHUB_LIST_ISSUES_ASSIGNED_TO_THE_AUTHENTICATED_USER | |
| List org issues for the authenticated user | GITHUB_LIST_ORG_ISSUES_FOR_THE_AUTHENTICATED_USER | |
| List repository issues | GITHUB_LIST_REPOSITORY_ISSUES | |
| List sub issues | GITHUB_LIST_SUB_ISSUES | |
| Search issues | GITHUB_SEARCH_ISSUES | |
| Search issues and pull requests | GITHUB_SEARCH_ISSUES_AND_PULL_REQUESTS |
Items (5)
Items (5)
| Action | What it does | Slug |
|---|---|---|
| Get organization project item | Get an item from an organization-owned GitHub Projects V2 project. | GITHUB_GET_ORGANIZATION_PROJECT_ITEM |
| Get user project item | Get an item from a user-owned project in GitHub Projects V2. | GITHUB_GET_USER_PROJECT_ITEM |
| List org project view items | GITHUB_LIST_ORG_PROJECT_VIEW_ITEMS | |
| List project items for user | GITHUB_LIST_PROJECT_ITEMS_FOR_USER | |
| List project view items for user | GITHUB_LIST_PROJECT_VIEW_ITEMS_FOR_USER |
Jobs (3)
Jobs (3)
| Action | What it does | Slug |
|---|---|---|
| Get workflow run job | Retrieves detailed information for a specific job within a GitHub Actions workflow run, given its job_id which must be valid for the specified repository’s workflow. | GITHUB_GET_WORKFLOW_RUN_JOB |
| List jobs for a workflow run | GITHUB_LIST_JOBS_FOR_A_WORKFLOW_RUN | |
| List jobs for a workflow run attempt | GITHUB_LIST_JOBS_FOR_A_WORKFLOW_RUN_ATTEMPT |
Keys (13)
Keys (13)
| Action | What it does | Slug |
|---|---|---|
| Get a repository public key | Gets a repository’s public key for encrypting secrets to be used in GitHub Actions, if the repository exists and is accessible. | GITHUB_GET_A_REPOSITORY_PUBLIC_KEY |
| Get an environment public key | Retrieves the public key for a specified GitHub repository environment, used to encrypt secrets for GitHub Actions. | GITHUB_GET_AN_ENVIRONMENT_PUBLIC_KEY |
| Get an organization public key | Action for GetAnOrganizationPublicKey. | GITHUB_GET_AN_ORGANIZATION_PUBLIC_KEY |
| Get deploy key | Gets a specific deploy key, identified by its key_id, for the GitHub repository specified by owner and repo. | GITHUB_GET_DEPLOY_KEY |
| Get organization public key | Retrieves an organization’s public key, which must be used to encrypt secret values before they are configured for Codespaces. | GITHUB_GET_ORGANIZATION_PUBLIC_KEY |
| Get organization public key for Dependabot | Retrieves the public key for an existing GitHub organization, required for encrypting Dependabot secrets. | GITHUB_GET_ORGANIZATION_PUBLIC_KEY_FOR_DEPENDABOT |
| Get public key for secret encryption | Retrieves a repository’s public key for encrypting GitHub Codespaces secrets. | GITHUB_GET_PUBLIC_KEY_FOR_SECRET_ENCRYPTION |
| Get public key for the authenticated user | Retrieves the authenticated user’s public key for encrypting GitHub Codespaces secrets. | GITHUB_GET_PUBLIC_KEY_FOR_THE_AUTHENTICATED_USER |
| Get repository public key for encryption | Gets a repository’s public key, used to encrypt secrets for Dependabot. | GITHUB_GET_REPOSITORY_PUBLIC_KEY_FOR_ENCRYPTION |
| List deploy keys | Lists deploy SSH keys for a specified repository. | GITHUB_LIST_DEPLOY_KEYS |
| List GPG keys for a user | GITHUB_LIST_GPG_KEYS_FOR_A_USER | |
| List public keys for a user | GITHUB_LIST_PUBLIC_KEYS_FOR_A_USER | |
| List SSH signing keys for a user | GITHUB_LIST_SSH_SIGNING_KEYS_FOR_A_USER |
Labels (7)
Labels (7)
| Action | What it does | Slug |
|---|---|---|
| Get label | Retrieves a specific label by its name from a specified GitHub repository. | GITHUB_GET_LABEL |
| List labels for a repository | GITHUB_LIST_LABELS_FOR_A_REPOSITORY | |
| List labels for a self hosted runner for a repository | GITHUB_LIST_LABELS_FOR_A_SELF_HOSTED_RUNNER_FOR_A_REPOSITORY | |
| List labels for an issue | GITHUB_LIST_LABELS_FOR_AN_ISSUE | |
| List labels for issues in a milestone | GITHUB_LIST_LABELS_FOR_ISSUES_IN_A_MILESTONE | |
| List labels for self hosted runner org | GITHUB_LIST_LABELS_FOR_SELF_HOSTED_RUNNER_ORG | |
| Search labels | GITHUB_SEARCH_LABELS |
Languages (1)
Languages (1)
| Action | What it does | Slug |
|---|---|---|
| List repository languages | GITHUB_LIST_REPOSITORY_LANGUAGES |
Licenses (5)
Licenses (5)
| Action | What it does | Slug |
|---|---|---|
| Get license | Retrieve comprehensive details for a specific software license recognized by GitHub, using its unique license key. | GITHUB_GET_LICENSE |
| Get license graph ql | Look up an open source license by its SPDX ID using GitHub’s GraphQL API. | GITHUB_GET_LICENSE_GRAPH_QL |
| Get the license for a repository | Retrieves the license file and its details for a repository, optionally from a specific Git reference (branch, tag, or commit SHA). | GITHUB_GET_THE_LICENSE_FOR_A_REPOSITORY |
| List commonly used licenses | Retrieves a list of commonly used software licenses from GitHub, optionally filtering for ‘featured’ licenses whose specific selection criteria by GitHub may vary. | GITHUB_LIST_COMMONLY_USED_LICENSES |
| List licenses graph ql | GITHUB_LIST_LICENSES_GRAPH_QL |
Logs (3)
Logs (3)
| Action | What it does | Slug |
|---|---|---|
| Download job logs for a workflow run | Downloads logs for a specific job in a GitHub Actions workflow run, contingent on the repository’s existence and the job ID being valid and having produced logs. | GITHUB_DOWNLOAD_JOB_LOGS_FOR_A_WORKFLOW_RUN |
| Download workflow run attempt logs | Downloads a ZIP archive of logs for a specific workflow run attempt. | GITHUB_DOWNLOAD_WORKFLOW_RUN_ATTEMPT_LOGS |
| Download workflow run logs | Downloads logs for a specific GitHub Actions workflow run as a ZIP archive containing log files for each job in the workflow. | GITHUB_DOWNLOAD_WORKFLOW_RUN_LOGS |
Members (7)
Members (7)
| Action | What it does | Slug |
|---|---|---|
| Check public organization membership for user | Check if a user is a public member of an organization. | GITHUB_CHECK_PUBLIC_ORGANIZATION_MEMBERSHIP_FOR_USER |
| Get team members | GITHUB_GET_TEAM_MEMBERS | |
| Get team membership for a user | Retrieves a user’s role and membership status within a specific team in an organization. | GITHUB_GET_TEAM_MEMBERSHIP_FOR_A_USER |
| List organization members | GITHUB_LIST_ORGANIZATION_MEMBERS | |
| List organization memberships for the authenticated u | GITHUB_LIST_ORGANIZATION_MEMBERSHIPS_FOR_THE_AUTHENTICATED_U | |
| List public organization members | GITHUB_LIST_PUBLIC_ORGANIZATION_MEMBERS | |
| List team members | GITHUB_LIST_TEAM_MEMBERS |
Milestones (2)
Milestones (2)
| Action | What it does | Slug |
|---|---|---|
| Get a milestone | Retrieves detailed information for a specific milestone within a GitHub repository by its number. | GITHUB_GET_A_MILESTONE |
| List milestones | GITHUB_LIST_MILESTONES |
Notifications (3)
Notifications (3)
| Action | What it does | Slug |
|---|---|---|
| List notifications | GITHUB_LIST_NOTIFICATIONS | |
| List notifications for the authenticated user | GITHUB_LIST_NOTIFICATIONS_FOR_THE_AUTHENTICATED_USER | |
| List repo notifications for auth user | GITHUB_LIST_REPO_NOTIFICATIONS_FOR_AUTH_USER |
Objects (1)
Objects (1)
| Action | What it does | Slug |
|---|---|---|
| Get commit object | Retrieves detailed information (including author, committer, message, tree, parents, verification) for a specific commit in a GitHub repository, identified by its SHA. | GITHUB_GET_COMMIT_OBJECT |
Organizations (7)
Organizations (7)
| Action | What it does | Slug |
|---|---|---|
| Get an organization | GITHUB_GET_AN_ORGANIZATION | |
| Get org allowed actions | Gets the list of allowed actions and reusable workflows for an organization when the ‘allowed_actions’ policy is set to ‘selected’. | GITHUB_GET_ORG_ALLOWED_ACTIONS |
| List organizations | GITHUB_LIST_ORGANIZATIONS | |
| List organizations for a user | GITHUB_LIST_ORGANIZATIONS_FOR_A_USER | |
| List organizations for the authenticated user | GITHUB_LIST_ORGANIZATIONS_FOR_THE_AUTHENTICATED_USER | |
| List organizations for user | GITHUB_LIST_ORGANIZATIONS_FOR_USER | |
| Lookup organization graph ql | GITHUB_LOOKUP_ORGANIZATION_GRAPH_QL |
Owners (1)
Owners (1)
| Action | What it does | Slug |
|---|---|---|
| Get repository owner | Lookup a repository owner (User or Organization) by login using GitHub’s GraphQL API. | GITHUB_GET_REPOSITORY_OWNER |
Packages (6)
Packages (6)
| Action | What it does | Slug |
|---|---|---|
| Get a package for a user | Retrieves metadata for a specific package owned by a GitHub user, using package type, name, and username as identifiers. | GITHUB_GET_A_PACKAGE_FOR_A_USER |
| Get a package for an organization | Retrieves a specific package (by type and name) from an organization, if both the package and organization exist. | GITHUB_GET_A_PACKAGE_FOR_AN_ORGANIZATION |
| Get a package for the authenticated user | Retrieves detailed information for a specific package owned by the authenticated user. | GITHUB_GET_A_PACKAGE_FOR_THE_AUTHENTICATED_USER |
| List packages for a user | GITHUB_LIST_PACKAGES_FOR_A_USER | |
| List packages for an organization | GITHUB_LIST_PACKAGES_FOR_AN_ORGANIZATION | |
| List packages for the authenticated user | GITHUB_LIST_PACKAGES_FOR_THE_AUTHENTICATED_USER |
Pages (4)
Pages (4)
| Action | What it does | Slug |
|---|---|---|
| Get GitHub pages build | Retrieves detailed information about a specific GitHub Pages build for a repository, which must have GitHub Pages enabled. | GITHUB_GET_GITHUB_PAGES_BUILD |
| Get latest pages build | Retrieves information about the most recent GitHub Pages build for a repository, which must exist, be accessible, have GitHub Pages enabled, and have at least one prior build. | GITHUB_GET_LATEST_PAGES_BUILD |
| List GitHub pages builds | GITHUB_LIST_GITHUB_PAGES_BUILDS | |
| Search code all pages | GITHUB_SEARCH_CODE_ALL_PAGES |
People (1)
People (1)
| Action | What it does | Slug |
|---|---|---|
| Check person followed by auth user | Checks if the authenticated GitHub user follows a target GitHub user. | GITHUB_CHECK_PERSON_FOLLOWED_BY_AUTH_USER |
Policies (2)
Policies (2)
| Action | What it does | Slug |
|---|---|---|
| Get deployment branch policy | Retrieves a specific deployment branch policy for an environment in a repository, identified by its unique ID. | GITHUB_GET_DEPLOYMENT_BRANCH_POLICY |
| List deployment branch policies | Lists all deployment branch policies for a specified environment in a GitHub repository. | GITHUB_LIST_DEPLOYMENT_BRANCH_POLICIES |
Projects (6)
Projects (6)
| Action | What it does | Slug |
|---|---|---|
| Get a project | Retrieves detailed information for a specific GitHub project (V2) using its project number and owner. | GITHUB_GET_A_PROJECT |
| Get users projects v2 | List GitHub Projects v2 for a specified user. | GITHUB_GET_USERS_PROJECTS_V2 |
| List organization projects | GITHUB_LIST_ORGANIZATION_PROJECTS | |
| List repository projects | GITHUB_LIST_REPOSITORY_PROJECTS | |
| List team projects | GITHUB_LIST_TEAM_PROJECTS | |
| List user projects | GITHUB_LIST_USER_PROJECTS |
Properties (4)
Properties (4)
| Action | What it does | Slug |
|---|---|---|
| Get organization custom property | Retrieves the definition (schema) of a specific, existing custom property for an organization. | GITHUB_GET_ORGANIZATION_CUSTOM_PROPERTY |
| List custom properties for an organization | Gets the schema definitions for all custom properties configured for an organization, not the specific values assigned to repositories. | GITHUB_LIST_CUSTOM_PROPERTIES_FOR_AN_ORGANIZATION |
| List custom property values for a repository | Gets all custom property values for a repository. | GITHUB_LIST_CUSTOM_PROPERTY_VALUES_FOR_A_REPOSITORY |
| List custom property values for org repos | Lists repositories in an organization with their custom property values. | GITHUB_LIST_CUSTOM_PROPERTY_VALUES_FOR_ORG_REPOS |
Pull requests (7)
Pull requests (7)
| Action | What it does | Slug |
|---|---|---|
| Check if pull request has been merged | Checks if a specified GitHub pull request has been merged, indicated by a 204 HTTP status (merged) or 404 (not merged/found). | GITHUB_CHECK_IF_PULL_REQUEST_HAS_BEEN_MERGED |
| Check if pull request merged | GITHUB_CHECK_IF_PULL_REQUEST_MERGED | |
| Find pull requests | Primary tool to find and search pull requests. | GITHUB_FIND_PULL_REQUESTS |
| Get a pull request | Retrieves a specific pull request from a GitHub repository using its owner, repository name, and pull request number. | GITHUB_GET_A_PULL_REQUEST |
| Get pull requests | GITHUB_GET_PULL_REQUESTS | |
| List pull requests | GITHUB_LIST_PULL_REQUESTS | |
| List pull requests associated with a commit | GITHUB_LIST_PULL_REQUESTS_ASSOCIATED_WITH_A_COMMIT |
Reactions (7)
Reactions (7)
| Action | What it does | Slug |
|---|---|---|
| List reactions for a commit comment | GITHUB_LIST_REACTIONS_FOR_A_COMMIT_COMMENT | |
| List reactions for a pull request review comment | GITHUB_LIST_REACTIONS_FOR_A_PULL_REQUEST_REVIEW_COMMENT | |
| List reactions for a release | GITHUB_LIST_REACTIONS_FOR_A_RELEASE | |
| List reactions for a team discussion | GITHUB_LIST_REACTIONS_FOR_A_TEAM_DISCUSSION | |
| List reactions for a team discussion comment | GITHUB_LIST_REACTIONS_FOR_A_TEAM_DISCUSSION_COMMENT | |
| List reactions for an issue | GITHUB_LIST_REACTIONS_FOR_AN_ISSUE | |
| List reactions for an issue comment | GITHUB_LIST_REACTIONS_FOR_AN_ISSUE_COMMENT |
Releases (4)
Releases (4)
| Action | What it does | Slug |
|---|---|---|
| Get a release | Gets a specific release from a GitHub repository, provided the repository is accessible and the release exists. | GITHUB_GET_A_RELEASE |
| Get a release by tag name | Gets a release from a GitHub repository by its tag name. | GITHUB_GET_A_RELEASE_BY_TAG_NAME |
| Get the latest release | Fetches the latest official (non-prerelease, non-draft) release for a GitHub repository. | GITHUB_GET_THE_LATEST_RELEASE |
| List releases | GITHUB_LIST_RELEASES |
Reports (1)
Reports (1)
| Action | What it does | Slug |
|---|---|---|
| Get community profile metrics | Retrieves a repository’s community profile metrics, including health percentage and the presence of key community files (e.g., README, LICENSE). | GITHUB_GET_COMMUNITY_PROFILE_METRICS |
Repositories (32)
Repositories (32)
| Action | What it does | Slug |
|---|---|---|
| Check if repo starred by auth user | GITHUB_CHECK_IF_REPO_STARRED_BY_AUTH_USER | |
| Check repository starred | GITHUB_CHECK_REPOSITORY_STARRED | |
| Download a repository archive tar | Downloads a repository’s source code as a tarball (.tar.gz) archive for a specific Git reference, if the repository is accessible. | GITHUB_DOWNLOAD_A_REPOSITORY_ARCHIVE_TAR |
| Download a repository archive ZIP | Downloads a repository’s source code as a ZIP archive for a specific Git reference (branch, tag, or commit SHA). | GITHUB_DOWNLOAD_A_REPOSITORY_ARCHIVE_ZIP |
| Find repositories | AI-optimized repository search with smart filtering by language, stars, topics, and ownership. | GITHUB_FIND_REPOSITORIES |
| Get a repository | Retrieves detailed information about an existing and accessible GitHub repository. | GITHUB_GET_A_REPOSITORY |
| Get an autolink reference of a repository | Retrieves a specific autolink reference (which automatically hyperlinks text like ‘JIRA-123’ to an external system) for a repository using its unique ID. | GITHUB_GET_AN_AUTOLINK_REFERENCE_OF_A_REPOSITORY |
| Get repo allowed actions | Gets the settings for allowed actions and reusable workflows in a repository. | GITHUB_GET_REPO_ALLOWED_ACTIONS |
| Get repos attestations | Retrieve attestations by subject digest from a GitHub repository. | GITHUB_GET_REPOS_ATTESTATIONS |
| Get repository clones | Retrieves the total number of clones and a breakdown of clone activity (daily or weekly) for a specified repository over the preceding 14 days. | GITHUB_GET_REPOSITORY_CLONES |
| Get repository graph ql | Lookup a repository by owner and name using GitHub’s GraphQL API. | GITHUB_GET_REPOSITORY_GRAPH_QL |
| Is repository starred by the user | Use to determine if the authenticated user has starred a specific GitHub repository, which is confirmed by an HTTP 204 status (resulting in an empty dictionary in the response data). | GITHUB_IS_REPOSITORY_STARRED_BY_THE_USER |
| List accessible repositories | Lists repositories that the authenticated user can access through a specific GitHub App installation. | GITHUB_LIST_ACCESSIBLE_REPOSITORIES |
| List attestation repositories | List attestation repositories for an organization. | GITHUB_LIST_ATTESTATION_REPOSITORIES |
| List GitHub actions caches for a repository | GITHUB_LIST_GITHUB_ACTIONS_CACHES_FOR_A_REPOSITORY | |
| List org repos with GitHub actions enabled | GITHUB_LIST_ORG_REPOS_WITH_GITHUB_ACTIONS_ENABLED | |
| List organization repositories | GITHUB_LIST_ORGANIZATION_REPOSITORIES | |
| List public repositories | GITHUB_LIST_PUBLIC_REPOSITORIES | |
| List repositories | GITHUB_LIST_REPOSITORIES | |
| List repositories accessible to the app installation | GITHUB_LIST_REPOSITORIES_ACCESSIBLE_TO_THE_APP_INSTALLATION | |
| List repositories for a user | GITHUB_LIST_REPOSITORIES_FOR_A_USER | |
| List repositories for the authenticated user | GITHUB_LIST_REPOSITORIES_FOR_THE_AUTHENTICATED_USER | |
| List repositories starred by a user | GITHUB_LIST_REPOSITORIES_STARRED_BY_A_USER | |
| List repositories starred by the authenticated user | GITHUB_LIST_REPOSITORIES_STARRED_BY_THE_AUTHENTICATED_USER | |
| List repositories watched by a user | GITHUB_LIST_REPOSITORIES_WATCHED_BY_A_USER | |
| List repositories watched by the authenticated user | GITHUB_LIST_REPOSITORIES_WATCHED_BY_THE_AUTHENTICATED_USER | |
| List repositories with GitHub actions cache usage | GITHUB_LIST_REPOSITORIES_WITH_GITHUB_ACTIONS_CACHE_USAGE | |
| List repository autolinks | GITHUB_LIST_REPOSITORY_AUTOLINKS | |
| List repository topics | GITHUB_LIST_REPOSITORY_TOPICS | |
| List starred repositories for user | GITHUB_LIST_STARRED_REPOSITORIES_FOR_USER | |
| List team repositories | GITHUB_LIST_TEAM_REPOSITORIES | |
| Search repositories | GITHUB_SEARCH_REPOSITORIES |
Resources (1)
Resources (1)
| Action | What it does | Slug |
|---|---|---|
| Lookup GitHub resource | GITHUB_LOOKUP_GITHUB_RESOURCE |
Reviewers (1)
Reviewers (1)
| Action | What it does | Slug |
|---|---|---|
| List requested reviewers for a pull request | GITHUB_LIST_REQUESTED_REVIEWERS_FOR_A_PULL_REQUEST |
Reviews (2)
Reviews (2)
| Action | What it does | Slug |
|---|---|---|
| Get a review for a pull request | Retrieves a specific review for a pull request using its owner, repository, pull request number, and review ID. | GITHUB_GET_A_REVIEW_FOR_A_PULL_REQUEST |
| List reviews for a pull request | GITHUB_LIST_REVIEWS_FOR_A_PULL_REQUEST |
Roles and permissions (10)
Roles and permissions (10)
| Action | What it does | Slug |
|---|---|---|
| Check team permissions for a project | Checks if a team has ‘read’, ‘write’, or ‘admin’ permissions for an organization’s specific classic project, returning the project’s details if access is confirmed. | GITHUB_CHECK_TEAM_PERMISSIONS_FOR_A_PROJECT |
| Check team permissions for a repository | Checks a team’s permissions for a specific repository within an organization, including permissions inherited from parent teams. | GITHUB_CHECK_TEAM_PERMISSIONS_FOR_A_REPOSITORY |
| Get an organization role | Retrieves a specific GitHub organization role by its ID. | GITHUB_GET_AN_ORGANIZATION_ROLE |
| Get default workflow permissions for a repository | Gets the default workflow permissions (read or write) for the GITHUB_TOKEN and whether it can approve pull request reviews in an existing and accessible repository. | GITHUB_GET_DEFAULT_WORKFLOW_PERMISSIONS_FOR_A_REPOSITORY |
| Get default workflow permissions for an organization | Gets the default GITHUB_TOKEN workflow permissions and settings for a GitHub organization. | GITHUB_GET_DEFAULT_WORKFLOW_PERMISSIONS_FOR_AN_ORGANIZATION |
| Get GitHub actions permissions for a repository | Gets the GitHub Actions permissions policy for a repository, including its enabled status and the scope of allowed actions. | GITHUB_GET_GITHUB_ACTIONS_PERMISSIONS_FOR_A_REPOSITORY |
| Get GitHub actions permissions for an organization | Gets the GitHub Actions permissions for a specified organization, detailing repository enablement and allowed actions policies. | GITHUB_GET_GITHUB_ACTIONS_PERMISSIONS_FOR_AN_ORGANIZATION |
| Get project permission for a user | Retrieves permission information for a GitHub project (classic) collaborator. | GITHUB_GET_PROJECT_PERMISSION_FOR_A_USER |
| Get repository permissions for a user | Retrieves a specific user’s permission level (‘admin’, ‘write’, ‘read’, or ‘none’) for a given repository, where ‘maintain’ role is reported as ‘write’ and ‘triage’ as ‘read’. | GITHUB_GET_REPOSITORY_PERMISSIONS_FOR_A_USER |
| List organization roles for an organization | GITHUB_LIST_ORGANIZATION_ROLES_FOR_AN_ORGANIZATION |
Rules (6)
Rules (6)
| Action | What it does | Slug |
|---|---|---|
| Get a repository rule suite | Gets detailed information for a specific repository rule suite by its ID, including its evaluation status and the results of its individual rules. | GITHUB_GET_A_REPOSITORY_RULE_SUITE |
| Get all deployment protection rules for env | Lists all enabled custom deployment protection rules for a specific environment in a repository. | GITHUB_GET_ALL_DEPLOYMENT_PROTECTION_RULES_FOR_ENV |
| Get custom deployment protection rule | Retrieves a specific custom deployment protection rule (used by GitHub Apps for external validation or manual approval of deployments) for a given environment in a repository. | GITHUB_GET_CUSTOM_DEPLOYMENT_PROTECTION_RULE |
| Get rules for a branch | Retrieves all active rules for a specific branch in a GitHub repository, excluding rules in ‘evaluate’ or ‘disabled’ status. | GITHUB_GET_RULES_FOR_A_BRANCH |
| List environment custom deployment rules | Lists all custom deployment protection rule integrations for a repository environment. | GITHUB_LIST_ENVIRONMENT_CUSTOM_DEPLOYMENT_RULES |
| List repository rule suites | GITHUB_LIST_REPOSITORY_RULE_SUITES |
Rulesets (2)
Rulesets (2)
| Action | What it does | Slug |
|---|---|---|
| Get a repository ruleset | Retrieves a specific repository ruleset by its ID. | GITHUB_GET_A_REPOSITORY_RULESET |
| List repository rulesets | GITHUB_LIST_REPOSITORY_RULESETS |
Runners (6)
Runners (6)
| Action | What it does | Slug |
|---|---|---|
| Get a self hosted runner for a repository | Gets a specific self-hosted runner for a repository by its unique ID. | GITHUB_GET_A_SELF_HOSTED_RUNNER_FOR_A_REPOSITORY |
| Get a self hosted runner for an organization | Retrieves detailed information about a specific self-hosted runner registered within a GitHub organization. | GITHUB_GET_A_SELF_HOSTED_RUNNER_FOR_AN_ORGANIZATION |
| List runner applications for a repository | GITHUB_LIST_RUNNER_APPLICATIONS_FOR_A_REPOSITORY | |
| List runner applications for an organization | GITHUB_LIST_RUNNER_APPLICATIONS_FOR_AN_ORGANIZATION | |
| List self hosted runners for a repository | GITHUB_LIST_SELF_HOSTED_RUNNERS_FOR_A_REPOSITORY | |
| List self hosted runners for an organization | GITHUB_LIST_SELF_HOSTED_RUNNERS_FOR_AN_ORGANIZATION |
Runs (4)
Runs (4)
| Action | What it does | Slug |
|---|---|---|
| Get a workflow run | Gets a specific workflow run by its ID from a GitHub repository. | GITHUB_GET_A_WORKFLOW_RUN |
| Get a workflow run attempt | Retrieves detailed information for a specific attempt of a workflow run in a GitHub repository, including its status, conclusion, and timings. | GITHUB_GET_A_WORKFLOW_RUN_ATTEMPT |
| List workflow runs for a repository | GITHUB_LIST_WORKFLOW_RUNS_FOR_A_REPOSITORY | |
| List workflow runs for a workflow | GITHUB_LIST_WORKFLOW_RUNS_FOR_A_WORKFLOW |
Secrets (6)
Secrets (6)
| Action | What it does | Slug |
|---|---|---|
| Get a repository secret | Gets metadata (name, creation/update timestamps) for an existing repository secret, excluding its encrypted value. | GITHUB_GET_A_REPOSITORY_SECRET |
| Get a secret for the authenticated user | Retrieves metadata (name, timestamps, visibility. | GITHUB_GET_A_SECRET_FOR_THE_AUTHENTICATED_USER |
| Get an organization secret | Gets an organization secret’s metadata (e.g., name, creation/update dates, visibility), but not its encrypted value. | GITHUB_GET_AN_ORGANIZATION_SECRET |
| Get org dev environment secret safely | Retrieves metadata for a specific secret available to an organization’s GitHub Codespaces without exposing its encrypted value. | GITHUB_GET_ORG_DEV_ENVIRONMENT_SECRET_SAFELY |
| Get repository secret securely | Retrieves metadata for an existing Dependabot secret in a repository, without exposing its encrypted value. | GITHUB_GET_REPOSITORY_SECRET_SECURELY |
| List environment secrets | Lists the names and metadata (not values) of secrets for a specified, existing environment within an existing GitHub repository. | GITHUB_LIST_ENVIRONMENT_SECRETS |
Security advisories (7)
Security advisories (7)
| Action | What it does | Slug |
|---|---|---|
| Check private vulnerability reporting status | Checks if private vulnerability reporting is enabled for the specified repository. | GITHUB_CHECK_PRIVATE_VULNERABILITY_REPORTING_STATUS |
| Get global security advisory | Retrieve a global GitHub security advisory by its GHSA identifier. | GITHUB_GET_GLOBAL_SECURITY_ADVISORY |
| Get repository security advisory | Retrieve a repository security advisory using its GHSA identifier. | GITHUB_GET_REPOSITORY_SECURITY_ADVISORY |
| List global security advisories | GITHUB_LIST_GLOBAL_SECURITY_ADVISORIES | |
| List repository security advisories | GITHUB_LIST_REPOSITORY_SECURITY_ADVISORIES | |
| List security advisories GraphQL | GITHUB_LIST_SECURITY_ADVISORIES_GRAPHQL | |
| List security vulnerabilities | GITHUB_LIST_SECURITY_VULNERABILITIES |
Settings (3)
Settings (3)
| Action | What it does | Slug |
|---|---|---|
| Get a webhook configuration for a repository | Returns the configuration for an existing webhook on the specified repository. | GITHUB_GET_A_WEBHOOK_CONFIGURATION_FOR_A_REPOSITORY |
| Get a webhook configuration for an organization | Retrieves the configuration for a specific webhook associated with a GitHub organization. | GITHUB_GET_A_WEBHOOK_CONFIGURATION_FOR_AN_ORGANIZATION |
| List repo dev container configs for user | GITHUB_LIST_REPO_DEV_CONTAINER_CONFIGS_FOR_USER |
Sites (1)
Sites (1)
| Action | What it does | Slug |
|---|---|---|
| Get pages site | Retrieves information for a GitHub Pages site, which must be enabled for the repository. | GITHUB_GET_PAGES_SITE |
Stars (1)
Stars (1)
| Action | What it does | Slug |
|---|---|---|
| List stargazers | GITHUB_LIST_STARGAZERS |
Subscriptions (4)
Subscriptions (4)
| Action | What it does | Slug |
|---|---|---|
| Get a repository subscription | Gets the authenticated user’s subscription details for a repository, indicating if they receive notifications. | GITHUB_GET_A_REPOSITORY_SUBSCRIPTION |
| Get a thread subscription for the authenticated user | Retrieves the authenticated user’s subscription details for a specific notification thread, identified by thread_id. | GITHUB_GET_A_THREAD_SUBSCRIPTION_FOR_THE_AUTHENTICATED_USER |
| List subscriptions for the authenticated user | GITHUB_LIST_SUBSCRIPTIONS_FOR_THE_AUTHENTICATED_USER | |
| List subscriptions for the authenticated user stubbed | GITHUB_LIST_SUBSCRIPTIONS_FOR_THE_AUTHENTICATED_USER_STUBBED |
Tags (2)
Tags (2)
| Action | What it does | Slug |
|---|---|---|
| Get a tag | Retrieves detailed information for a specific Git tag object from a GitHub repository, using the SHA of the tag object itself. | GITHUB_GET_A_TAG |
| List repository tags | GITHUB_LIST_REPOSITORY_TAGS |
Teams (8)
Teams (8)
| Action | What it does | Slug |
|---|---|---|
| Get a team by name | Retrieves a GitHub team by its slug from a specific organization. | GITHUB_GET_A_TEAM_BY_NAME |
| Get organization teams | GITHUB_GET_ORGANIZATION_TEAMS | |
| Get teams with access to the protected branch | Lists teams with explicit push access to a protected branch, provided team restrictions are configured in the branch’s protection settings. | GITHUB_GET_TEAMS_WITH_ACCESS_TO_THE_PROTECTED_BRANCH |
| List child teams | Lists the immediate child teams of a parent team within an organization. | GITHUB_LIST_CHILD_TEAMS |
| List repository teams | GITHUB_LIST_REPOSITORY_TEAMS | |
| List teams | GITHUB_LIST_TEAMS | |
| List teams for the authenticated user | GITHUB_LIST_TEAMS_FOR_THE_AUTHENTICATED_USER | |
| List teams that are assigned to an organization role | GITHUB_LIST_TEAMS_THAT_ARE_ASSIGNED_TO_AN_ORGANIZATION_ROLE |
Templates (4)
Templates (4)
| Action | What it does | Slug |
|---|---|---|
| Get gitignore template | Retrieves a specific .gitignore template from GitHub by its name, which must be an existing template in GitHub’s collection. | GITHUB_GET_GITIGNORE_TEMPLATE |
| Get oidc subject claim template | Retrieves the OpenID Connect (OIDC) subject claim customization template for a repository, which defines the sub claim structure in OIDC tokens for GitHub Actions workflows. | GITHUB_GET_OIDC_SUBJECT_CLAIM_TEMPLATE |
| Get org oidc subject claim template | Retrieves the OpenID Connect (OIDC) subject claim customization template for a GitHub organization, which defines how the sub claim in OIDC tokens for workflows is constructed. | GITHUB_GET_ORG_OIDC_SUBJECT_CLAIM_TEMPLATE |
| List gitignore templates | GITHUB_LIST_GITIGNORE_TEMPLATES |
Threads (1)
Threads (1)
| Action | What it does | Slug |
|---|---|---|
| Get a thread | Retrieves a specific GitHub notification thread using its unique thread_id. | GITHUB_GET_A_THREAD |
Types (3)
Types (3)
| Action | What it does | Slug |
|---|---|---|
| List available machine types for a repository | Lists machine types available for GitHub Codespaces in a repository, optionally using a Git ref to check compatibility based on prebuild availability and devcontainer configurations. | GITHUB_LIST_AVAILABLE_MACHINE_TYPES_FOR_A_REPOSITORY |
| List issue types | GITHUB_LIST_ISSUE_TYPES | |
| List machine types for a codespace | GITHUB_LIST_MACHINE_TYPES_FOR_A_CODESPACE |
Usage (7)
Usage (7)
| Action | What it does | Slug |
|---|---|---|
| Get GitHub actions cache usage for a repository | Retrieves the total count of active GitHub Actions caches and their combined size in bytes for a specified repository. | GITHUB_GET_GITHUB_ACTIONS_CACHE_USAGE_FOR_A_REPOSITORY |
| Get GitHub actions cache usage for an organization | Retrieves total GitHub Actions cache usage statistics for an organization, including active cache count and size across all repositories. | GITHUB_GET_GITHUB_ACTIONS_CACHE_USAGE_FOR_AN_ORGANIZATION |
| Get GitHub billing usage summary for user | Retrieve billing usage summary for a GitHub user account. | GITHUB_GET_GITHUB_BILLING_USAGE_SUMMARY_FOR_USER |
| Get GraphQL rate limit | Retrieve the authenticated client’s GitHub GraphQL API rate limit information. | GITHUB_GET_GRAPHQL_RATE_LIMIT |
| Get rate limit status for the authenticated user | Retrieves the authenticated user’s current GitHub API rate limit status, including usage and limits across different resource categories. | GITHUB_GET_RATE_LIMIT_STATUS_FOR_THE_AUTHENTICATED_USER |
| Get workflow run usage | Gets the billable time, in milliseconds, for a specific workflow run, detailing time spent on various operating systems. | GITHUB_GET_WORKFLOW_RUN_USAGE |
| Get workflow usage | Gets the billable time (in milliseconds, broken down by runner OS) for a specific workflow within a repository for the current billing cycle. | GITHUB_GET_WORKFLOW_USAGE |
Users (20)
Users (20)
| Action | What it does | Slug |
|---|---|---|
| Check if user can be assigned | Verifies if a GitHub user can be assigned to issues in a repository. | GITHUB_CHECK_IF_USER_CAN_BE_ASSIGNED |
| Check if user can be assigned to issue | Checks if a specified GitHub user can be assigned to a given issue within a repository. | GITHUB_CHECK_IF_USER_CAN_BE_ASSIGNED_TO_ISSUE |
| Check if user follows another user | Checks if a GitHub user username follows target_user. | GITHUB_CHECK_IF_USER_FOLLOWS_ANOTHER_USER |
| Check if user is blocked by authenticated user | Checks if the specified GitHub user is blocked by the authenticated user. | GITHUB_CHECK_IF_USER_IS_BLOCKED_BY_AUTHENTICATED_USER |
| Check if user is blocked by organization | Checks if a GitHub user is blocked by an organization. | GITHUB_CHECK_IF_USER_IS_BLOCKED_BY_ORGANIZATION |
| Get a user | Retrieves the public profile information for an existing GitHub user, specified by their username. | GITHUB_GET_A_USER |
| Get billing usage report user | Retrieves the billing usage report for a specified GitHub user. | GITHUB_GET_BILLING_USAGE_REPORT_USER |
| Get contextual information for a user | Gets contextual hovercard information for a GitHub user. | GITHUB_GET_CONTEXTUAL_INFORMATION_FOR_A_USER |
| Get GitHub billing premium request usage report user | Get billing premium request usage report for a GitHub user. | GITHUB_GET_GITHUB_BILLING_PREMIUM_REQUEST_USAGE_REPORT_USER |
| Get the authenticated user | Gets the profile information for the currently authenticated GitHub user, including potentially private details based on user settings. | GITHUB_GET_THE_AUTHENTICATED_USER |
| Get user by ID | Retrieves a GitHub user’s profile information by their unique numeric account ID. | GITHUB_GET_USER_BY_ID |
| Get users attestations | Get attestations by subject digest for a GitHub user. | GITHUB_GET_USERS_ATTESTATIONS |
| Get users with access to the protected branch | Lists users with explicit push access to a protected branch, provided its protection rule restricts pushes to specific users. | GITHUB_GET_USERS_WITH_ACCESS_TO_THE_PROTECTED_BRANCH |
| List the people a user follows | GITHUB_LIST_THE_PEOPLE_A_USER_FOLLOWS | |
| List the people the authenticated user follows | GITHUB_LIST_THE_PEOPLE_THE_AUTHENTICATED_USER_FOLLOWS | |
| List users | GITHUB_LIST_USERS | |
| List users blocked by an organization | GITHUB_LIST_USERS_BLOCKED_BY_AN_ORGANIZATION | |
| List users blocked by the authenticated user | GITHUB_LIST_USERS_BLOCKED_BY_THE_AUTHENTICATED_USER | |
| List users that are assigned to an organization role | GITHUB_LIST_USERS_THAT_ARE_ASSIGNED_TO_AN_ORGANIZATION_ROLE | |
| Search users | GITHUB_SEARCH_USERS |
Variables (8)
Variables (8)
| Action | What it does | Slug |
|---|---|---|
| Get a repository variable | Gets a specific GitHub Actions variable by name from an accessible repository. | GITHUB_GET_A_REPOSITORY_VARIABLE |
| Get an environment variable | Retrieves a specific environment variable from a GitHub Actions environment by repository owner, repository name, environment name, and variable name. | GITHUB_GET_AN_ENVIRONMENT_VARIABLE |
| Get an organization variable | Retrieves details (name, value, visibility, timestamps) of a specific, existing variable for an existing GitHub organization. | GITHUB_GET_AN_ORGANIZATION_VARIABLE |
| List environment variables | Lists all environment variables, which are plaintext key-value pairs for GitHub Actions workflows, for a specified environment within a GitHub repository. | GITHUB_LIST_ENVIRONMENT_VARIABLES |
| List organization variables | GITHUB_LIST_ORGANIZATION_VARIABLES | |
| List repository organization variables | GITHUB_LIST_REPOSITORY_ORGANIZATION_VARIABLES | |
| List repository variables | GITHUB_LIST_REPOSITORY_VARIABLES | |
| List selected repos org variable | GITHUB_LIST_SELECTED_REPOS_ORG_VARIABLE |
Versions (8)
Versions (8)
| Action | What it does | Slug |
|---|---|---|
| Get a package version for a user | Retrieves a specific public package version associated with a GitHub user. | GITHUB_GET_A_PACKAGE_VERSION_FOR_A_USER |
| Get a package version for an organization | Retrieves detailed information for a specific version of a package within an organization. | GITHUB_GET_A_PACKAGE_VERSION_FOR_AN_ORGANIZATION |
| Get a package version for the authenticated user | Retrieves detailed information for an existing specific package version associated with the authenticated user, identified by its type, name, and version ID. | GITHUB_GET_A_PACKAGE_VERSION_FOR_THE_AUTHENTICATED_USER |
| Get all API versions | Retrieves all officially supported, date-based (e.g., “2022-11-28”) versions of the GitHub REST API from the /versions endpoint. | GITHUB_GET_ALL_API_VERSIONS |
| Get gist revision | Retrieves a specific revision of a gist. | GITHUB_GET_GIST_REVISION |
| List org package versions | GITHUB_LIST_ORG_PACKAGE_VERSIONS | |
| List owned package versions | GITHUB_LIST_OWNED_PACKAGE_VERSIONS | |
| List package versions for a package owned by a user | GITHUB_LIST_PACKAGE_VERSIONS_FOR_A_PACKAGE_OWNED_BY_A_USER |
Views (1)
Views (1)
| Action | What it does | Slug |
|---|---|---|
| Get page views | Retrieves page view statistics for a repository over the last 14 days, including total views, unique visitors, and a daily or weekly breakdown. | GITHUB_GET_PAGE_VIEWS |
Watchers (1)
Watchers (1)
| Action | What it does | Slug |
|---|---|---|
| List watchers | GITHUB_LIST_WATCHERS |
Webhooks (6)
Webhooks (6)
| Action | What it does | Slug |
|---|---|---|
| Get a repository webhook | Returns the configuration of an existing webhook for a given repository. | GITHUB_GET_A_REPOSITORY_WEBHOOK |
| Get a webhook delivery for an organization webhook | Returns detailed information for a specific delivery attempt of a webhook configured for the specified GitHub organization. | GITHUB_GET_A_WEBHOOK_DELIVERY_FOR_AN_ORGANIZATION_WEBHOOK |
| Get an organization webhook | Retrieves the full configuration, including subscribed events and delivery settings, for an existing organization webhook. | GITHUB_GET_AN_ORGANIZATION_WEBHOOK |
| Get repository webhook delivery | Retrieves a specific delivery for a repository webhook, identified by its hook_id and delivery_id. | GITHUB_GET_REPOSITORY_WEBHOOK_DELIVERY |
| List deliveries for a repository webhook | Retrieves delivery attempts for a specific repository webhook to inspect its history. | GITHUB_LIST_DELIVERIES_FOR_A_REPOSITORY_WEBHOOK |
| List deliveries for an organization webhook | Retrieves a list of webhook deliveries for a specific webhook in an organization, allowing inspection of delivery history and details. | GITHUB_LIST_DELIVERIES_FOR_AN_ORGANIZATION_WEBHOOK |
Workflows (3)
Workflows (3)
| Action | What it does | Slug |
|---|---|---|
| Get a workflow | Retrieves detailed information for a specific GitHub Actions workflow in a repository, identified by either its numeric ID or its filename. | GITHUB_GET_A_WORKFLOW |
| Get workflow external access | Gets the access level settings for a private repository, determining how workflows outside this repository can use its actions and reusable workflows. | GITHUB_GET_WORKFLOW_EXTERNAL_ACCESS |
| List repository workflows | GITHUB_LIST_REPOSITORY_WORKFLOWS |
Other actions (28)
Other actions (28)
| Action | What it does | Slug |
|---|---|---|
| API root | Retrieves a map of all top-level GitHub REST API resource URLs and their templates. | GITHUB_API_ROOT |
| Create inference embeddings | Create inference embeddings using GitHub’s AI models. | GITHUB_CREATE_INFERENCE_EMBEDDINGS |
| Get a reference | Retrieves a specific Git reference (e.g., a branch, tag, or fully qualified like ‘heads/main’) from a GitHub repository. | GITHUB_GET_A_REFERENCE |
| Get access restrictions | Lists users, teams, and GitHub Apps with push access to a branch. | GITHUB_GET_ACCESS_RESTRICTIONS |
| Get an assignment | Retrieves detailed information for a specific GitHub Classroom assignment if the authenticated user is an administrator of the classroom. | GITHUB_GET_AN_ASSIGNMENT |
| Get assignment grades | Retrieves all grades for an existing GitHub Classroom assignment. | GITHUB_GET_ASSIGNMENT_GRADES |
| Get classroom | Retrieves details for a specific GitHub Classroom. | GITHUB_GET_CLASSROOM |
| Get emojis | Lists all emojis available for use on GitHub, including custom and Unicode emojis. | GITHUB_GET_EMOJIS |
| Get feeds | Fetches a list of available GitHub feed URLs for the authenticated user. | GITHUB_GET_FEEDS |
| Get GitHub meta information | Fetches GitHub’s publicly available metadata, useful for configuring network security policies or IP allow-listing. | GITHUB_GET_GITHUB_META_INFORMATION |
| Get GraphQL node | Fetch any GitHub object by its global node ID. | GITHUB_GET_GRAPHQL_NODE |
| Get octocat | Fetches an ASCII art representation of GitHub’s Octocat, suitable for text-based displays. | GITHUB_GET_OCTOCAT |
| Get the combined status for a specific reference | Retrieves the aggregated commit status (e.g., success, failure, pending) from all checks for a specific reference (SHA, branch, or tag) in a GitHub repository. | GITHUB_GET_THE_COMBINED_STATUS_FOR_A_SPECIFIC_REFERENCE |
| Get the zen of GitHub | Retrieves a random quote from GitHub’s ‘Zen of GitHub’ collection, reflecting GitHub’s design philosophies and offering humorous insights, useful for displaying GitHub wisdom or a lighthearted message. | GITHUB_GET_THE_ZEN_OF_GITHUB |
| Get top referral paths | Fetches the top 10 most viewed content paths for a repository from the last 14 days. | GITHUB_GET_TOP_REFERRAL_PATHS |
| Get top referral sources | Fetches the top 10 websites that referred traffic to a repository within the last 14 days. | GITHUB_GET_TOP_REFERRAL_SOURCES |
| Get viewer GraphQL | Retrieve the authenticated user’s profile information via GitHub GraphQL. | GITHUB_GET_VIEWER_GRAPHQL |
| List accepted assignments for an assignment | Lists accepted assignments (student repositories created after acceptance) for an existing GitHub Classroom assignment, identified by its unique assignment_id. | GITHUB_LIST_ACCEPTED_ASSIGNMENTS_FOR_AN_ASSIGNMENT |
| List assignments for a classroom | Lists all assignments for a given GitHub Classroom classroom_id. | GITHUB_LIST_ASSIGNMENTS_FOR_A_CLASSROOM |
| List classrooms | Lists GitHub Classrooms to which the authenticated user has administrative access. | GITHUB_LIST_CLASSROOMS |
| List matching references | GITHUB_LIST_MATCHING_REFERENCES | |
| List sponsorables | GITHUB_LIST_SPONSORABLES | |
| List status check contexts | GITHUB_LIST_STATUS_CHECK_CONTEXTS | |
| Lookup nodes by IDs | GITHUB_LOOKUP_NODES_BY_IDS | |
| Lookup topic by name | GITHUB_LOOKUP_TOPIC_BY_NAME | |
| Render markdown raw | GITHUB_RENDER_MARKDOWN_RAW | |
| Search GitHub GraphQL | GITHUB_SEARCH_GITHUB_GRAPHQL | |
| Search topics | GITHUB_SEARCH_TOPICS |
Read + write code (recommended)
Read + write code (recommended)
- Create, update, and delete comments
- Create and delete reactions
- Create and update issues
- Create, update, and delete labels
- Create and update pull requests
- View and create tokens
- Create and update branches
- Create, start, and stop codespaces
- Create and update projects
- Create, update, delete, and send reviews
- Create, update, and delete assets
- Create and update cards
Account details (2)
Account details (2)
| Action | What it does | Slug |
|---|---|---|
| Add social accounts for authenticated user | Adds one or more social media links (which must be valid, full URLs for platforms supported by GitHub) to the authenticated user’s public GitHub profile. | GITHUB_ADD_SOCIAL_ACCOUNTS_FOR_AUTHENTICATED_USER |
| Who am I | GITHUB_WHO_AM_I |
Addresses (1)
Addresses (1)
| Action | What it does | Slug |
|---|---|---|
| Add email address for authenticated user | Adds one or more email addresses (which will be initially unverified) to the authenticated user’s GitHub account. | GITHUB_ADD_EMAIL_ADDRESS_FOR_AUTHENTICATED_USER |
Apps (2)
Apps (2)
| Action | What it does | Slug |
|---|---|---|
| Add app access restrictions | Adds GitHub Apps to the list of apps allowed to push to a protected branch. | GITHUB_ADD_APP_ACCESS_RESTRICTIONS |
| Create a GitHub app from a manifest | Complete the GitHub App Manifest flow (step 3 of 3) by exchanging the temporary authorization code for the app’s full configuration, including credentials and private key. | GITHUB_CREATE_A_GITHUB_APP_FROM_A_MANIFEST |
Assets (3)
Assets (3)
| Action | What it does | Slug |
|---|---|---|
| Delete a release asset | Deletes a specific release asset from a GitHub repository. | GITHUB_DELETE_A_RELEASE_ASSET |
| Update a release asset | GITHUB_UPDATE_A_RELEASE_ASSET | |
| Upload release asset | GITHUB_UPLOAD_RELEASE_ASSET |
Assignees (2)
Assignees (2)
| Action | What it does | Slug |
|---|---|---|
| Add assignees to an issue | Adds assignees to a GitHub issue. | GITHUB_ADD_ASSIGNEES_TO_AN_ISSUE |
| Remove assignees from an issue | GITHUB_REMOVE_ASSIGNEES_FROM_AN_ISSUE |
Branch protection (2)
Branch protection (2)
| Action | What it does | Slug |
|---|---|---|
| Create a tag protection state for a repository | DEPRECATED: This API was sunset on August 30, 2024. | GITHUB_CREATE_A_TAG_PROTECTION_STATE_FOR_A_REPOSITORY |
| Create commit signature protection | Enables commit signature protection for a specified branch, requiring all new commits to be signed. | GITHUB_CREATE_COMMIT_SIGNATURE_PROTECTION |
Branches (5)
Branches (5)
| Action | What it does | Slug |
|---|---|---|
| Create branch | GITHUB_CREATE_BRANCH | |
| Merge a branch | GITHUB_MERGE_A_BRANCH | |
| Rename a branch | GITHUB_RENAME_A_BRANCH | |
| Sync fork branch with upstream | GITHUB_SYNC_FORK_BRANCH_WITH_UPSTREAM | |
| Update a pull request branch | GITHUB_UPDATE_A_PULL_REQUEST_BRANCH |
Cards (3)
Cards (3)
| Action | What it does | Slug |
|---|---|---|
| Create a project card | Creates a project card in a GitHub project column (classic projects only). | GITHUB_CREATE_A_PROJECT_CARD |
| Move a project card | GITHUB_MOVE_A_PROJECT_CARD | |
| Update project card | GITHUB_UPDATE_PROJECT_CARD |
Check runs (2)
Check runs (2)
| Action | What it does | Slug |
|---|---|---|
| Create a check run | Creates a new check run for a specific commit in a repository, used by external services to report status, detailed feedback, annotations, and images directly within the GitHub UI. | GITHUB_CREATE_A_CHECK_RUN |
| Create a check suite | Creates a new check suite for a specific commit (head_sha) in an original repository (not a fork). | GITHUB_CREATE_A_CHECK_SUITE |
Code (2)
Code (2)
| Action | What it does | Slug |
|---|---|---|
| Create a blob | Creates a Git blob in a repository, requiring content and encoding (‘utf-8’ or ‘base64’). | GITHUB_CREATE_A_BLOB |
| Create a tree | Creates a new Git tree object in a repository, defining file/directory structure by specifying tree entries, optionally building on a base_tree SHA. | GITHUB_CREATE_A_TREE |
Codespaces (6)
Codespaces (6)
| Action | What it does | Slug |
|---|---|---|
| Create a codespace for the authenticated user | Creates a GitHub Codespace for the authenticated user, requiring a JSON request body with either repository_id (integer) or a pull_request object (containing pull_request_number (integer) and repository_id (integer)). | GITHUB_CREATE_A_CODESPACE_FOR_THE_AUTHENTICATED_USER |
| Create a codespace from a pull request | Creates a GitHub Codespace for an open pull request in a Codespaces-enabled repository, with options to customize its configuration. | GITHUB_CREATE_A_CODESPACE_FROM_A_PULL_REQUEST |
| Create a codespace in a repository | Creates a GitHub Codespace for the authenticated user in a specified repository, which must be accessible and use a valid devcontainer.json if devcontainer_path is specified. | GITHUB_CREATE_A_CODESPACE_IN_A_REPOSITORY |
| Export a codespace for the authenticated user | Triggers an export of a user’s specified codespace, automatically stopping it if active, and returns its export status and download URL. | GITHUB_EXPORT_A_CODESPACE_FOR_THE_AUTHENTICATED_USER |
| Start a codespace for the authenticated user | GITHUB_START_A_CODESPACE_FOR_THE_AUTHENTICATED_USER | |
| Stop a codespace for the authenticated user | GITHUB_STOP_A_CODESPACE_FOR_THE_AUTHENTICATED_USER |
Collaborators (2)
Collaborators (2)
| Action | What it does | Slug |
|---|---|---|
| Add a repository collaborator | Adds a GitHub user as a repository collaborator, or updates their permission if already a collaborator. | GITHUB_ADD_A_REPOSITORY_COLLABORATOR |
| Add project collaborator | Adds a specified GitHub user as a collaborator to an existing organization project with a given permission level. | GITHUB_ADD_PROJECT_COLLABORATOR |
Columns (3)
Columns (3)
| Action | What it does | Slug |
|---|---|---|
| Create a project column | Creates a new column in a GitHub project (classic). | GITHUB_CREATE_A_PROJECT_COLUMN |
| Move a project column | GITHUB_MOVE_A_PROJECT_COLUMN | |
| Update project column | GITHUB_UPDATE_PROJECT_COLUMN |
Comments (12)
Comments (12)
| Action | What it does | Slug |
|---|---|---|
| Create a commit comment | Creates a comment on a specific commit, or on a specific line if path and position are provided. | GITHUB_CREATE_A_COMMIT_COMMENT |
| Create a discussion comment | Creates a new comment on an existing team discussion within a GitHub organization. | GITHUB_CREATE_A_DISCUSSION_COMMENT |
| Create a gist comment | Creates a new comment on a specified GitHub gist. | GITHUB_CREATE_A_GIST_COMMENT |
| Create a review comment for a pull request | Creates a review comment on a pull request’s diff, targeting a specific line, range of lines, an entire file, or replying to an existing comment. | GITHUB_CREATE_A_REVIEW_COMMENT_FOR_A_PULL_REQUEST |
| Create an issue comment | Creates a new comment on an existing GitHub issue or pull request within the specified repository. | GITHUB_CREATE_AN_ISSUE_COMMENT |
| Delete a review comment for a pull request | Deletes a specific pull request review comment. | GITHUB_DELETE_A_REVIEW_COMMENT_FOR_A_PULL_REQUEST |
| Delete commit comment | Deletes a specific commit comment, identified by its comment_id, from the specified repository. | GITHUB_DELETE_COMMIT_COMMENT |
| Delete issue comment | Permanently deletes a specific comment by its ID from an issue or pull request, if the repository exists and the comment ID is valid. | GITHUB_DELETE_ISSUE_COMMENT |
| Update a commit comment | GITHUB_UPDATE_A_COMMIT_COMMENT | |
| Update a discussion comment | GITHUB_UPDATE_A_DISCUSSION_COMMENT | |
| Update an issue comment | GITHUB_UPDATE_AN_ISSUE_COMMENT | |
| Update pull request review comment | GITHUB_UPDATE_PULL_REQUEST_REVIEW_COMMENT |
Commits (2)
Commits (2)
| Action | What it does | Slug |
|---|---|---|
| Create a commit | Creates a new commit in a GitHub repository. | GITHUB_CREATE_A_COMMIT |
| Create a commit status | Sets a commit’s status (e.g., error, failure, pending, success from CI/CD) for a given SHA. | GITHUB_CREATE_A_COMMIT_STATUS |
Content (1)
Content (1)
| Action | What it does | Slug |
|---|---|---|
| Create or update file contents | Creates a new file or updates an existing file in a GitHub repository. | GITHUB_CREATE_OR_UPDATE_FILE_CONTENTS |
Dependencies (1)
Dependencies (1)
| Action | What it does | Slug |
|---|---|---|
| Manage issue blocking dependency | GITHUB_MANAGE_ISSUE_BLOCKING_DEPENDENCY |
Deployments (3)
Deployments (3)
| Action | What it does | Slug |
|---|---|---|
| Create a deployment | Creates a GitHub deployment for an existing repository, targeting a specific ref (branch, tag, or SHA) that must also exist within the repository. | GITHUB_CREATE_A_DEPLOYMENT |
| Create a deployment status | Creates a status for an existing deployment, updating its operational state, associated URLs, and description. | GITHUB_CREATE_A_DEPLOYMENT_STATUS |
| Create a GitHub pages deployment | Creates a GitHub Pages deployment for a repository using a specified artifact and OIDC token, provided GitHub Pages is enabled and the artifact (containing static assets) is accessible. | GITHUB_CREATE_A_GITHUB_PAGES_DEPLOYMENT |
Discussions (2)
Discussions (2)
| Action | What it does | Slug |
|---|---|---|
| Create a discussion | Creates a new discussion post on a specific team’s page within an organization. | GITHUB_CREATE_A_DISCUSSION |
| Update a discussion | GITHUB_UPDATE_A_DISCUSSION |
Environments (1)
Environments (1)
| Action | What it does | Slug |
|---|---|---|
| Create or update an environment | Creates a new environment or updates an existing one in a GitHub repository, allowing configuration of deployment protection rules such as wait timers and reviewers. | GITHUB_CREATE_OR_UPDATE_AN_ENVIRONMENT |
Events (2)
Events (2)
| Action | What it does | Slug |
|---|---|---|
| Create a repository dispatch event | Triggers a GitHub Actions workflow or a webhook on a repository by creating a repository dispatch event, allowing programmatic triggering of workflows based on events outside of GitHub. | GITHUB_CREATE_A_REPOSITORY_DISPATCH_EVENT |
| Create a workflow dispatch event | Manually triggers a GitHub Actions workflow identified by workflow_id at a given ref, if the workflow is configured to accept workflow_dispatch events. | GITHUB_CREATE_A_WORKFLOW_DISPATCH_EVENT |
Fields (1)
Fields (1)
| Action | What it does | Slug |
|---|---|---|
| Add field to user project | Add a custom field to a user-owned GitHub Projects V2 project. | GITHUB_ADD_FIELD_TO_USER_PROJECT |
Files (2)
Files (2)
| Action | What it does | Slug |
|---|---|---|
| Commit multiple files | Atomically create, update, or delete multiple files in a GitHub repository as a single commit. | GITHUB_COMMIT_MULTIPLE_FILES |
| Delete a file | Deletes a file by path from a GitHub repository. | GITHUB_DELETE_A_FILE |
Forks (2)
Forks (2)
| Action | What it does | Slug |
|---|---|---|
| Create a fork | Creates a fork of an accessible repository, optionally into a specific organization, with a new name, or copying only the default branch. | GITHUB_CREATE_A_FORK |
| Create a temporary private fork | Creates a temporary private fork of the specified repository to address a security vulnerability, linking the fork to a GHSA ID that must be specifically associated with this repository. | GITHUB_CREATE_A_TEMPORARY_PRIVATE_FORK |
Gists (2)
Gists (2)
| Action | What it does | Slug |
|---|---|---|
| Create a gist | Creates a new gist on GitHub with provided files, an optional description, and public/secret visibility. | GITHUB_CREATE_A_GIST |
| Fork gist | Forks a specified public gist, creating a copy under the authenticated user’s account. | GITHUB_FORK_GIST |
Invitations (1)
Invitations (1)
| Action | What it does | Slug |
|---|---|---|
| Accept repository invitation | Accepts a PENDING repository invitation that has been issued to the authenticated user. | GITHUB_ACCEPT_REPOSITORY_INVITATION |
Issues (7)
Issues (7)
| Action | What it does | Slug |
|---|---|---|
| Add sub issue | Add a sub-issue to a parent GitHub issue using GraphQL. | GITHUB_ADD_SUB_ISSUE |
| Close issue | GITHUB_CLOSE_ISSUE | |
| Create an issue | Creates a new issue in a GitHub repository, requiring the repository to exist and have issues enabled. | GITHUB_CREATE_AN_ISSUE |
| Lock an issue | GITHUB_LOCK_AN_ISSUE | |
| Reopen issue | GITHUB_REOPEN_ISSUE | |
| Unlock an issue | GITHUB_UNLOCK_AN_ISSUE | |
| Update an issue | GITHUB_UPDATE_AN_ISSUE |
Items (3)
Items (3)
| Action | What it does | Slug |
|---|---|---|
| Add item to user project | Add an issue or pull request to a user-owned GitHub project. | GITHUB_ADD_ITEM_TO_USER_PROJECT |
| Create draft item for user project | Creates a draft issue item in a user-owned GitHub ProjectsV2. | GITHUB_CREATE_DRAFT_ITEM_FOR_USER_PROJECT |
| Update user project item | GITHUB_UPDATE_USER_PROJECT_ITEM |
Keys (1)
Keys (1)
| Action | What it does | Slug |
|---|---|---|
| Create a deploy key | Creates a deploy key for a repository. | GITHUB_CREATE_A_DEPLOY_KEY |
Labels (9)
Labels (9)
| Action | What it does | Slug |
|---|---|---|
| Add labels to an issue | Adds labels (provided in the request body) to a repository issue. | GITHUB_ADD_LABELS_TO_AN_ISSUE |
| Add org runner labels | Adds new custom labels to an existing self-hosted runner for an organization. | GITHUB_ADD_ORG_RUNNER_LABELS |
| Add runner labels | Adds and appends custom labels to a self-hosted repository runner, which must be registered and active. | GITHUB_ADD_RUNNER_LABELS |
| Create a label | Creates a new label in a specified GitHub repository, provided the repository exists and the user has write permissions. | GITHUB_CREATE_A_LABEL |
| Delete label | Permanently removes an existing label from a repository. | GITHUB_DELETE_LABEL |
| Remove a label from an issue | GITHUB_REMOVE_A_LABEL_FROM_AN_ISSUE | |
| Remove all labels from an issue | GITHUB_REMOVE_ALL_LABELS_FROM_AN_ISSUE | |
| Set labels for an issue | GITHUB_SET_LABELS_FOR_AN_ISSUE | |
| Update a label | GITHUB_UPDATE_A_LABEL |
Lists (3)
Lists (3)
| Action | What it does | Slug |
|---|---|---|
| Create user list | Create a new user list on GitHub. | GITHUB_CREATE_USER_LIST |
| Update user list | GITHUB_UPDATE_USER_LIST | |
| Update user lists for item | GITHUB_UPDATE_USER_LISTS_FOR_ITEM |
Members (1)
Members (1)
| Action | What it does | Slug |
|---|---|---|
| Convert org member to outside collaborator | Converts an existing organization member, who is not an owner, to an outside collaborator, restricting their access to explicitly granted repositories. | GITHUB_CONVERT_ORG_MEMBER_TO_OUTSIDE_COLLABORATOR |
Milestones (3)
Milestones (3)
| Action | What it does | Slug |
|---|---|---|
| Create a milestone | Creates a milestone in a GitHub repository for tracking progress on issues or pull requests. | GITHUB_CREATE_A_MILESTONE |
| Delete milestone | Deletes the specified milestone if it exists. | GITHUB_DELETE_MILESTONE |
| Update a milestone | GITHUB_UPDATE_A_MILESTONE |
Notes (1)
Notes (1)
| Action | What it does | Slug |
|---|---|---|
| Generate release notes | Generates Markdown release notes content (listing changes, pull requests, and contributors) for a GitHub repository release, customizable via tags and a configuration file. | GITHUB_GENERATE_RELEASE_NOTES |
Notifications (2)
Notifications (2)
| Action | What it does | Slug |
|---|---|---|
| Mark notifications as read | GITHUB_MARK_NOTIFICATIONS_AS_READ | |
| Mark repository notifications as read | GITHUB_MARK_REPOSITORY_NOTIFICATIONS_AS_READ |
Objects (1)
Objects (1)
| Action | What it does | Slug |
|---|---|---|
| Create a tag object | Creates an annotated Git tag object in a repository, pointing to an existing Git object (commit, tree, or blob) defined by its SHA and ensuring the type field correctly specifies the object’s type. | GITHUB_CREATE_A_TAG_OBJECT |
Organizations (3)
Organizations (3)
| Action | What it does | Slug |
|---|---|---|
| Create or update custom properties for an org | Creates new custom property schemas or updates existing ones in bulk for a specified organization. | GITHUB_CREATE_OR_UPDATE_CUSTOM_PROPERTIES_FOR_AN_ORG |
| Create or update custom property org | Creates a new custom property (name must be unique for creation) or updates an existing one for an organization to define metadata for its repositories. | GITHUB_CREATE_OR_UPDATE_CUSTOM_PROPERTY_ORG |
| Follow organization GraphQL | Follow a GitHub organization using GraphQL. | GITHUB_FOLLOW_ORGANIZATION_GRAPHQL |
Packages (1)
Packages (1)
| Action | What it does | Slug |
|---|---|---|
| Auth user docker conflict packages list | List Docker packages with migration conflicts for the authenticated user. | GITHUB_AUTH_USER_DOCKER_CONFLICT_PACKAGES_LIST |
Policies (1)
Policies (1)
| Action | What it does | Slug |
|---|---|---|
| Create a deployment branch policy | Creates a deployment branch or tag policy for an existing environment in a GitHub repository, using a Ruby File.fnmatch pattern (where doesn’t match /) to specify which branches or tags are deployable. | GITHUB_CREATE_A_DEPLOYMENT_BRANCH_POLICY |
Projects (4)
Projects (4)
| Action | What it does | Slug |
|---|---|---|
| Create a repository project | Creates a new GitHub Projects V2 project board linked to a specified repository. | GITHUB_CREATE_A_REPOSITORY_PROJECT |
| Create a user project | Creates a new GitHub Projects V2 project board for the authenticated user to organize and track issues, pull requests, and notes. | GITHUB_CREATE_A_USER_PROJECT |
| Create an organization project | Creates a new classic project board within a specified GitHub organization. | GITHUB_CREATE_AN_ORGANIZATION_PROJECT |
| Update a project | GITHUB_UPDATE_A_PROJECT |
Pull requests (8)
Pull requests (8)
| Action | What it does | Slug |
|---|---|---|
| Close pull request | GITHUB_CLOSE_PULL_REQUEST | |
| Convert pull request to draft | GITHUB_CONVERT_PULL_REQUEST_TO_DRAFT | |
| Create a pull request | Creates a pull request in a GitHub repository, requiring existing base and head branches. | GITHUB_CREATE_A_PULL_REQUEST |
| Dismiss a review for a pull request | Dismisses an APPROVED or CHANGES_REQUESTED review on a pull request with a mandatory explanatory message. | GITHUB_DISMISS_A_REVIEW_FOR_A_PULL_REQUEST |
| Mark pull request ready for review | GITHUB_MARK_PULL_REQUEST_READY_FOR_REVIEW | |
| Merge a pull request | GITHUB_MERGE_A_PULL_REQUEST | |
| Reopen pull request | GITHUB_REOPEN_PULL_REQUEST | |
| Update a pull request | GITHUB_UPDATE_A_PULL_REQUEST |
Reactions (12)
Reactions (12)
| Action | What it does | Slug |
|---|---|---|
| Create reaction for a commit comment | Creates an emoji reaction for a commit comment. | GITHUB_CREATE_REACTION_FOR_A_COMMIT_COMMENT |
| Create reaction for a pull request review comment | Adds a specified reaction to a pull request review comment within a GitHub repository. | GITHUB_CREATE_REACTION_FOR_A_PULL_REQUEST_REVIEW_COMMENT |
| Create reaction for a release | Creates an emoji reaction for a specific, existing release in a GitHub repository. | GITHUB_CREATE_REACTION_FOR_A_RELEASE |
| Create reaction for a team discussion | Creates a reaction for a team discussion within a GitHub organization. | GITHUB_CREATE_REACTION_FOR_A_TEAM_DISCUSSION |
| Create reaction for a team discussion comment | Adds a reaction to a team discussion comment, requiring the specified organization, team, discussion, and comment to exist. | GITHUB_CREATE_REACTION_FOR_A_TEAM_DISCUSSION_COMMENT |
| Create reaction for an issue | Creates a reaction for a specified issue within a GitHub repository. | GITHUB_CREATE_REACTION_FOR_AN_ISSUE |
| Create reaction for an issue comment | Creates a reaction for a specific comment on an issue within a GitHub repository. | GITHUB_CREATE_REACTION_FOR_AN_ISSUE_COMMENT |
| Delete a release reaction | Deletes a reaction from a GitHub release, provided the repository, release, and reaction exist. | GITHUB_DELETE_A_RELEASE_REACTION |
| Delete commit comment reaction | Deletes a reaction from a commit comment in a GitHub repository. | GITHUB_DELETE_COMMIT_COMMENT_REACTION |
| Delete issue comment reaction | Deletes a reaction from an issue comment in a repository. | GITHUB_DELETE_ISSUE_COMMENT_REACTION |
| Delete issue reaction | Permanently removes a specific reaction from an issue in a GitHub repository. | GITHUB_DELETE_ISSUE_REACTION |
| Delete pull request comment reaction | Deletes a specific reaction from a pull request review comment, provided the comment and reaction exist on that comment within the specified repository. | GITHUB_DELETE_PULL_REQUEST_COMMENT_REACTION |
Releases (3)
Releases (3)
| Action | What it does | Slug |
|---|---|---|
| Create a release | Creates a release in a GitHub repository for a specified tag. | GITHUB_CREATE_A_RELEASE |
| Delete a release | Permanently deletes a specific release, its assets, and potentially its associated Git tag from a repository. | GITHUB_DELETE_A_RELEASE |
| Update a release | GITHUB_UPDATE_A_RELEASE |
Replies (1)
Replies (1)
| Action | What it does | Slug |
|---|---|---|
| Create a reply for a review comment | Posts a reply to a specific review comment on a GitHub pull request, requiring the repository, pull request, and original comment to exist, and a non-empty reply body. | GITHUB_CREATE_A_REPLY_FOR_A_REVIEW_COMMENT |
Repositories (14)
Repositories (14)
| Action | What it does | Slug |
|---|---|---|
| Add repo to org secret with selected access | Adds a repository to an existing organization-level GitHub Actions secret that is configured for ‘selected’ repository access. | GITHUB_ADD_REPO_TO_ORG_SECRET_WITH_SELECTED_ACCESS |
| Add repo to org secret with selected visibility | Grants an existing repository access to an existing organization-level Dependabot secret when the secret’s visibility is set to ‘selected’. | GITHUB_ADD_REPO_TO_ORG_SECRET_WITH_SELECTED_VISIBILITY |
| Add repository to app installation | Adds a repository to a GitHub App installation, granting the app access. | GITHUB_ADD_REPOSITORY_TO_APP_INSTALLATION |
| Add selected repository to organization secret | Adds a repository to an organization secret’s access list when the secret’s visibility is ‘selected’. | GITHUB_ADD_SELECTED_REPOSITORY_TO_ORGANIZATION_SECRET |
| Add selected repository to organization variable | Grants a repository access to an organization-level GitHub Actions variable, if that variable’s visibility is set to ‘selected_repositories’. | GITHUB_ADD_SELECTED_REPOSITORY_TO_ORGANIZATION_VARIABLE |
| Add selected repository to user secret | Grants a specified repository access to an authenticated user’s existing Codespaces secret, enabling Codespaces created for that repository to use the secret. | GITHUB_ADD_SELECTED_REPOSITORY_TO_USER_SECRET |
| Create an autolink reference for a repository | Creates a repository autolink to automatically convert text references (e.g., ‘TICKET-123’) into hyperlinks, using a unique key_prefix and a url_template that includes <num>. | GITHUB_CREATE_AN_AUTOLINK_REFERENCE_FOR_A_REPOSITORY |
| Disable repository actions in org | Removes a repository from the list of selected repositories enabled for GitHub Actions in an organization. | GITHUB_DISABLE_REPOSITORY_ACTIONS_IN_ORG |
| Enable GitHub actions in selected repositories | Sets the specific repositories that can use GitHub Actions within an organization by replacing the current list. | GITHUB_ENABLE_GITHUB_ACTIONS_IN_SELECTED_REPOSITORIES |
| Enable private vuln reporting for repo | Enables private vulnerability reporting for a repository, allowing security researchers to privately submit vulnerability reports to maintainers. | GITHUB_ENABLE_PRIVATE_VULN_REPORTING_FOR_REPO |
| Enable repo for GitHub actions | Adds a repository to the list of selected repositories enabled for GitHub Actions in an organization. | GITHUB_ENABLE_REPO_FOR_GITHUB_ACTIONS |
| Export sbom for repo | Exports the software bill of materials (SBOM) in SPDX JSON format for a repository, if its dependency graph is enabled and it has at least one commit. | GITHUB_EXPORT_SBOM_FOR_REPO |
| Replace all repository topics | GITHUB_REPLACE_ALL_REPOSITORY_TOPICS | |
| Star a repository for the authenticated user | GITHUB_STAR_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER |
Reviewers (3)
Reviewers (3)
| Action | What it does | Slug |
|---|---|---|
| Remove requested reviewers from a pull request | GITHUB_REMOVE_REQUESTED_REVIEWERS_FROM_A_PULL_REQUEST | |
| Request reviewers | GITHUB_REQUEST_REVIEWERS | |
| Request reviewers for a pull request | GITHUB_REQUEST_REVIEWERS_FOR_A_PULL_REQUEST |
Reviews (5)
Reviews (5)
| Action | What it does | Slug |
|---|---|---|
| Create a review for a pull request | Creates a pull request review, allowing approval, change requests, or comments. | GITHUB_CREATE_A_REVIEW_FOR_A_PULL_REQUEST |
| Delete pending review | Deletes a pending (unsubmitted) review from a pull request. | GITHUB_DELETE_PENDING_REVIEW |
| Remove review request | GITHUB_REMOVE_REVIEW_REQUEST | |
| Submit a review for a pull request | GITHUB_SUBMIT_A_REVIEW_FOR_A_PULL_REQUEST | |
| Update pull request review | GITHUB_UPDATE_PULL_REQUEST_REVIEW |
Roles and permissions (6)
Roles and permissions (6)
| Action | What it does | Slug |
|---|---|---|
| Add or update team project permissions | Adds a classic project to a team or updates the team’s permission on it. | GITHUB_ADD_OR_UPDATE_TEAM_PROJECT_PERMISSIONS |
| Add or update team repository permissions | Sets or updates a team’s permission level for a repository within an organization. | GITHUB_ADD_OR_UPDATE_TEAM_REPOSITORY_PERMISSIONS |
| Assign organization role to team | Assigns an existing organization-level role (identified by role_id) to a team (identified by team_slug) within a GitHub organization (org), provided the organization, team, and role already exist. | GITHUB_ASSIGN_ORGANIZATION_ROLE_TO_TEAM |
| Assign organization role to user | Assigns a specific organization role to a user who is a member or an outside collaborator in a GitHub organization, using a valid role ID. | GITHUB_ASSIGN_ORGANIZATION_ROLE_TO_USER |
| Create a custom organization role | Creates a custom role with defined permissions within a GitHub organization. | GITHUB_CREATE_A_CUSTOM_ORGANIZATION_ROLE |
| Verify dev container permissions accepted | GITHUB_VERIFY_DEV_CONTAINER_PERMISSIONS_ACCEPTED |
Rules (1)
Rules (1)
| Action | What it does | Slug |
|---|---|---|
| Create deployment protection rule | Enables a custom deployment protection rule for an existing environment in a repository by linking a configured GitHub App (via integration_id) to control deployments. | GITHUB_CREATE_DEPLOYMENT_PROTECTION_RULE |
Rulesets (1)
Rulesets (1)
| Action | What it does | Slug |
|---|---|---|
| Create a repository ruleset | Creates a uniquely named ruleset for a repository, defining rules for branches or tags with specified enforcement, conditions, and bypass actors. | GITHUB_CREATE_A_REPOSITORY_RULESET |
Runners (1)
Runners (1)
| Action | What it does | Slug |
|---|---|---|
| Configure jit runner for org | Generates a JIT configuration for a GitHub organization’s new self-hosted runner to run a single job then unregister. | GITHUB_CONFIGURE_JIT_RUNNER_FOR_ORG |
Runs (1)
Runs (1)
| Action | What it does | Slug |
|---|---|---|
| Approve workflow run for fork pull request | Approves a workflow run from a forked repository’s pull request. | GITHUB_APPROVE_WORKFLOW_RUN_FOR_FORK_PULL_REQUEST |
Secrets (10)
Secrets (10)
| Action | What it does | Slug |
|---|---|---|
| Create or update a repository secret | Creates or updates a GitHub Actions secret within a specific repository. | GITHUB_CREATE_OR_UPDATE_A_REPOSITORY_SECRET |
| Create or update an environment secret | Creates or updates an environment secret with an encrypted_value that was encrypted using the public key identified by key_id for the specified environment. | GITHUB_CREATE_OR_UPDATE_AN_ENVIRONMENT_SECRET |
| Create or update an organization secret | Creates or updates an organization secret for GitHub Actions, requiring its value to be pre-encrypted via LibSodium using the organization’s public key. | GITHUB_CREATE_OR_UPDATE_AN_ORGANIZATION_SECRET |
| Create or update repo secret with encrypted value | Creates or updates a Dependabot secret in a repository using an encrypted_value (pre-encrypted with LibSodium using the repository’s Dependabot public key) and its corresponding key_id. | GITHUB_CREATE_OR_UPDATE_REPO_SECRET_WITH_ENCRYPTED_VALUE |
| Create update org secret with lib sodium | Creates or updates a Dependabot organization secret, requiring the secret value to be pre-encrypted with LibSodium using the organization’s public key obtained from the ‘Get an organization public key’ endpoint. | GITHUB_CREATE_UPDATE_ORG_SECRET_WITH_LIB_SODIUM |
| Encrypt and update dev secret | Creates or updates a repository’s development environment secret using an encrypted_value and its corresponding key_id. | GITHUB_ENCRYPT_AND_UPDATE_DEV_SECRET |
| Encrypt org dev env secret | Creates or updates an organization’s GitHub Codespaces secret using an encrypted value and its corresponding public key ID. | GITHUB_ENCRYPT_ORG_DEV_ENV_SECRET |
| Get an environment secret | Retrieves metadata (name and timestamps) for a single secret in a GitHub Actions environment. | GITHUB_GET_AN_ENVIRONMENT_SECRET |
| Get repo dev env secret | Gets metadata (name, creation/update timestamps) for a specific, existing development environment secret (Codespaces secret) in a repository, without exposing its value. | GITHUB_GET_REPO_DEV_ENV_SECRET |
| Get single org secret without decryption | Gets a single organization Dependabot secret’s metadata (name, timestamps, visibility) without revealing its encrypted value. | GITHUB_GET_SINGLE_ORG_SECRET_WITHOUT_DECRYPTION |
Security advisories (1)
Security advisories (1)
| Action | What it does | Slug |
|---|---|---|
| Privately report a security vulnerability | GITHUB_PRIVATELY_REPORT_A_SECURITY_VULNERABILITY |
Settings (1)
Settings (1)
| Action | What it does | Slug |
|---|---|---|
| Create jit runner config | Generates a temporary Just-In-Time (JIT) configuration for a new self-hosted GitHub Actions runner for a repository. | GITHUB_CREATE_JIT_RUNNER_CONFIG |
Sites (2)
Sites (2)
| Action | What it does | Slug |
|---|---|---|
| Create a GitHub pages site | Configures or updates GitHub Pages for a repository, setting build type and source. | GITHUB_CREATE_A_GITHUB_PAGES_SITE |
| Create or update GitHub pages site | Enable or update GitHub Pages configuration for a repository. | GITHUB_CREATE_OR_UPDATE_GITHUB_PAGES_SITE |
Snapshots (1)
Snapshots (1)
| Action | What it does | Slug |
|---|---|---|
| Create a snapshot of dependencies for a repository | Creates a snapshot of a repository’s dependencies to populate the GitHub dependency graph and enable security alerts. | GITHUB_CREATE_A_SNAPSHOT_OF_DEPENDENCIES_FOR_A_REPOSITORY |
Subscriptions (3)
Subscriptions (3)
| Action | What it does | Slug |
|---|---|---|
| Set a repository subscription | GITHUB_SET_A_REPOSITORY_SUBSCRIPTION | |
| Set a thread subscription | GITHUB_SET_A_THREAD_SUBSCRIPTION | |
| Update subscription | GITHUB_UPDATE_SUBSCRIPTION |
Teams (2)
Teams (2)
| Action | What it does | Slug |
|---|---|---|
| Add team access restrictions | Adds teams to the list of teams with push access to a protected branch. | GITHUB_ADD_TEAM_ACCESS_RESTRICTIONS |
| Create a team | Creates a new team in an organization, optionally with maintainers, repositories, specific privacy, notification settings, or a parent team. | GITHUB_CREATE_A_TEAM |
Templates (1)
Templates (1)
| Action | What it does | Slug |
|---|---|---|
| Configure oidc subject claim template | Sets or updates the OIDC subject claim customization template for an existing GitHub organization by specifying which claims (e.g., ‘repo’, ‘actor’) form the OIDC token’s subject (sub). | GITHUB_CONFIGURE_OIDC_SUBJECT_CLAIM_TEMPLATE |
Threads (2)
Threads (2)
| Action | What it does | Slug |
|---|---|---|
| Mark a thread as done | GITHUB_MARK_A_THREAD_AS_DONE | |
| Mark a thread as read | GITHUB_MARK_A_THREAD_AS_READ |
Tokens (6)
Tokens (6)
| Action | What it does | Slug |
|---|---|---|
| Check token | Checks if a GitHub App or OAuth access_token is valid for the specified client_id and retrieves its details, typically to verify its active status and grants. | GITHUB_CHECK_TOKEN |
| Create a registration token for a repository | Generates a time-limited token required to register a new self-hosted runner with a specific repository. | GITHUB_CREATE_A_REGISTRATION_TOKEN_FOR_A_REPOSITORY |
| Create a registration token for an organization | Generates a temporary (one-hour) registration token to add a new self-hosted runner to an organization for GitHub Actions. | GITHUB_CREATE_A_REGISTRATION_TOKEN_FOR_AN_ORGANIZATION |
| Create a remove token for a repository | Generates a temporary (one-hour validity) token required to unregister and remove a self-hosted runner from a repository. | GITHUB_CREATE_A_REMOVE_TOKEN_FOR_A_REPOSITORY |
| Create a remove token for an organization | Generates a token, valid for one hour, to authenticate removing a self-hosted runner from an organization. | GITHUB_CREATE_A_REMOVE_TOKEN_FOR_AN_ORGANIZATION |
| Create a scoped access token | Exchanges a user-to-server token for a new, fine-grained scoped access token for a GitHub App, requiring client_id, access_token, either target or target_id, and at least one permission. | GITHUB_CREATE_A_SCOPED_ACCESS_TOKEN |
Types (2)
Types (2)
| Action | What it does | Slug |
|---|---|---|
| Create issue type | Create a new issue type for a GitHub organization. | GITHUB_CREATE_ISSUE_TYPE |
| Update issue type | GITHUB_UPDATE_ISSUE_TYPE |
Users (8)
Users (8)
| Action | What it does | Slug |
|---|---|---|
| Add or update team membership for user | Adds a GitHub user to a team or updates their role (member or maintainer), inviting them to the organization if not already a member. | GITHUB_ADD_OR_UPDATE_TEAM_MEMBERSHIP_FOR_USER |
| Add user access restrictions | Adds users to the list of people allowed to push to a protected branch in an organization repository. | GITHUB_ADD_USER_ACCESS_RESTRICTIONS |
| Add users to codespaces access for organization | Adds organization members to the list of users granted Codespaces access billed to the organization. | GITHUB_ADD_USERS_TO_CODESPACES_ACCESS_FOR_ORGANIZATION |
| Create or update a secret for the authenticated user | Creates or updates a Codespaces secret for the authenticated user. | GITHUB_CREATE_OR_UPDATE_A_SECRET_FOR_THE_AUTHENTICATED_USER |
| Follow user | Allows the authenticated user to follow the GitHub user specified by username. | GITHUB_FOLLOW_USER |
| Follow user GraphQL | Follow a GitHub user using GraphQL. | GITHUB_FOLLOW_USER_GRAPHQL |
| Unfollow user | GITHUB_UNFOLLOW_USER | |
| Update user status | GITHUB_UPDATE_USER_STATUS |
Variables (3)
Variables (3)
| Action | What it does | Slug |
|---|---|---|
| Create a repository variable | Creates a new, unencrypted variable in a repository for GitHub Actions workflows. | GITHUB_CREATE_A_REPOSITORY_VARIABLE |
| Create an environment variable | Creates an encrypted environment variable for a pre-existing environment within a GitHub repository. | GITHUB_CREATE_AN_ENVIRONMENT_VARIABLE |
| Create an organization variable | Creates a new, uniquely named GitHub Actions variable for an organization, with configurable repository access visibility (all, private, or selected). | GITHUB_CREATE_AN_ORGANIZATION_VARIABLE |
Views (1)
Views (1)
| Action | What it does | Slug |
|---|---|---|
| Create view for user project | Create a new view in a user-owned GitHub project (Projects V2). | GITHUB_CREATE_VIEW_FOR_USER_PROJECT |
Webhooks (2)
Webhooks (2)
| Action | What it does | Slug |
|---|---|---|
| Create a repository webhook | Creates a webhook for a specified repository. | GITHUB_CREATE_A_REPOSITORY_WEBHOOK |
| Create an organization webhook | Creates a webhook for a GitHub organization to deliver event notifications to a configured URL. | GITHUB_CREATE_AN_ORGANIZATION_WEBHOOK |
Workflows (2)
Workflows (2)
| Action | What it does | Slug |
|---|---|---|
| Disable a workflow | Disables a specified workflow (by ID or filename) in a given GitHub repository, preventing new automatic triggers. | GITHUB_DISABLE_A_WORKFLOW |
| Enable a workflow | Reactivates a currently disabled GitHub Actions workflow within a repository using its workflow ID or filename. | GITHUB_ENABLE_A_WORKFLOW |
Other actions (7)
Other actions (7)
| Action | What it does | Slug |
|---|---|---|
| Add status check contexts | Adds status check contexts to a protected branch’s required status checks. | GITHUB_ADD_STATUS_CHECK_CONTEXTS |
| Create a reference | Creates a NEW Git reference (branch or tag) in a repository. | GITHUB_CREATE_A_REFERENCE |
| Create sponsors tier | Create a new payment tier for your GitHub Sponsors profile using GraphQL. | GITHUB_CREATE_SPONSORS_TIER |
| Create sponsorship | Start a new GitHub sponsorship or reactivate a past sponsorship using GraphQL. | GITHUB_CREATE_SPONSORSHIP |
| Delete a reference | Deletes a Git reference from a repository. | GITHUB_DELETE_A_REFERENCE |
| Update a reference | GITHUB_UPDATE_A_REFERENCE | |
| Validate credential | GITHUB_VALIDATE_CREDENTIAL |
Full access
Full access
- Delete secrets
- Delete branch protection
- Delete members
- Create and delete repositories
- Delete versions
- Update and delete organizations
- Delete packages
- Delete roles and permissions
- Delete and cancel runs
- Update and delete tokens
- Delete variables
- Delete caches
Account details (1)
Account details (1)
| Action | What it does | Slug |
|---|---|---|
| Delete social accounts for the authenticated user | Deletes currently linked social media account URLs from the authenticated user’s GitHub profile. | GITHUB_DELETE_SOCIAL_ACCOUNTS_FOR_THE_AUTHENTICATED_USER |
Addresses (1)
Addresses (1)
| Action | What it does | Slug |
|---|---|---|
| Delete email address | Sends an empty request body to DELETE /user/emails to attempt deletion of user email addresses. | GITHUB_DELETE_EMAIL_ADDRESS |
Apps (2)
Apps (2)
| Action | What it does | Slug |
|---|---|---|
| Delete app authorization | Deletes an OAuth application grant for a user, which revokes ALL OAuth tokens and their associated authorizations for the application. | GITHUB_DELETE_APP_AUTHORIZATION |
| Remove app access restrictions | GITHUB_REMOVE_APP_ACCESS_RESTRICTIONS |
Artifacts (1)
Artifacts (1)
| Action | What it does | Slug |
|---|---|---|
| Delete artifact | Deletes a GitHub artifact by its ID within a repository, typically resulting in an empty response (HTTP 204 No Content) on success. | GITHUB_DELETE_ARTIFACT |
Branch protection (6)
Branch protection (6)
| Action | What it does | Slug |
|---|---|---|
| Delete a tag protection state for a repository | DEPRECATED: This API was sunset on August 30, 2024. | GITHUB_DELETE_A_TAG_PROTECTION_STATE_FOR_A_REPOSITORY |
| Delete admin branch protection | Removes admin enforcement from a protected branch (branch name cannot contain wildcard characters) in a repository. | GITHUB_DELETE_ADMIN_BRANCH_PROTECTION |
| Delete branch protection | Removes all protection rules from a specific branch in a GitHub repository. | GITHUB_DELETE_BRANCH_PROTECTION |
| Delete commit signature protection | Disables GPG commit signature protection for a specific branch in a GitHub repository, meaning commits pushed to this branch no longer require GPG signing. | GITHUB_DELETE_COMMIT_SIGNATURE_PROTECTION |
| Delete pull request review protection | Disables the requirement for pull request reviews before merging for a specific, existing branch in an existing repository. | GITHUB_DELETE_PULL_REQUEST_REVIEW_PROTECTION |
| Remove status check protection | GITHUB_REMOVE_STATUS_CHECK_PROTECTION |
Caches (2)
Caches (2)
| Action | What it does | Slug |
|---|---|---|
| Clear repository cache by key | Deletes GitHub Actions caches from a repository matching a specific key and an optional Git ref, used to manage storage or clear outdated/corrupted caches. | GITHUB_CLEAR_REPOSITORY_CACHE_BY_KEY |
| Delete GitHub actions cache by ID | Deletes a specific GitHub Actions cache from a repository using its unique cache_id. | GITHUB_DELETE_GITHUB_ACTIONS_CACHE_BY_ID |
Cards (1)
Cards (1)
| Action | What it does | Slug |
|---|---|---|
| Delete project card | Deletes a project card from a GitHub ‘Project (classic)’. | GITHUB_DELETE_PROJECT_CARD |
Code (1)
Code (1)
| Action | What it does | Slug |
|---|---|---|
| Delete code scanning analysis | Deletes a specific code scanning analysis by its ID from a repository. | GITHUB_DELETE_CODE_SCANNING_ANALYSIS |
Codespaces (2)
Codespaces (2)
| Action | What it does | Slug |
|---|---|---|
| Delete codespace | Deletes a specific codespace owned by the authenticated user. | GITHUB_DELETE_CODESPACE |
| Delete org codespace | Permanently deletes a specific codespace belonging to a member of the specified organization. | GITHUB_DELETE_ORG_CODESPACE |
Collaborators (2)
Collaborators (2)
| Action | What it does | Slug |
|---|---|---|
| Remove a repository collaborator | GITHUB_REMOVE_A_REPOSITORY_COLLABORATOR | |
| Remove outside collaborator from an organization | GITHUB_REMOVE_OUTSIDE_COLLABORATOR_FROM_AN_ORGANIZATION |
Columns (1)
Columns (1)
| Action | What it does | Slug |
|---|---|---|
| Delete project column | Deletes a project field (column) from a GitHub Projects V2 project using the GraphQL API. | GITHUB_DELETE_PROJECT_COLUMN |
Comments (2)
Comments (2)
| Action | What it does | Slug |
|---|---|---|
| Delete discussion comment | Deletes a specific comment from an existing team discussion within an organization, provided the specified organization, team, discussion, and comment all exist. | GITHUB_DELETE_DISCUSSION_COMMENT |
| Delete gist comment | Deletes a specific comment from a GitHub Gist using its gist_id and comment_id. | GITHUB_DELETE_GIST_COMMENT |
Deployments (2)
Deployments (2)
| Action | What it does | Slug |
|---|---|---|
| Cancel GitHub pages deployment | Cancels an existing, ongoing or queued GitHub Pages deployment for a repository using its pages_deployment_id. | GITHUB_CANCEL_GITHUB_PAGES_DEPLOYMENT |
| Delete deployment | Permanently deletes a specified inactive deployment from a repository. | GITHUB_DELETE_DEPLOYMENT |
Discussions (1)
Discussions (1)
| Action | What it does | Slug |
|---|---|---|
| Delete discussion | Deletes a specific team discussion, identified by its number, from an organization’s team. | GITHUB_DELETE_DISCUSSION |
Environments (1)
Environments (1)
| Action | What it does | Slug |
|---|---|---|
| Delete environment | Deletes an existing deployment environment from an existing repository. | GITHUB_DELETE_ENVIRONMENT |
Fields (1)
Fields (1)
| Action | What it does | Slug |
|---|---|---|
| Clear project v2 item field value | Clear the value of a field for an item in a GitHub Project V2. | GITHUB_CLEAR_PROJECT_V2_ITEM_FIELD_VALUE |
Gists (2)
Gists (2)
| Action | What it does | Slug |
|---|---|---|
| Delete gist | Permanently deletes an existing GitHub gist, specified by its gist_id. | GITHUB_DELETE_GIST |
| Unstar a gist | GITHUB_UNSTAR_A_GIST |
Interactions (3)
Interactions (3)
| Action | What it does | Slug |
|---|---|---|
| Remove interaction restrictions for a repository | GITHUB_REMOVE_INTERACTION_RESTRICTIONS_FOR_A_REPOSITORY | |
| Remove interaction restrictions for an organization | GITHUB_REMOVE_INTERACTION_RESTRICTIONS_FOR_AN_ORGANIZATION | |
| Remove public repo interaction restrictions | GITHUB_REMOVE_PUBLIC_REPO_INTERACTION_RESTRICTIONS |
Invitations (2)
Invitations (2)
| Action | What it does | Slug |
|---|---|---|
| Decline a repository invitation | Declines a specific, pending repository invitation for the authenticated user, identified by its invitation_id. | GITHUB_DECLINE_A_REPOSITORY_INVITATION |
| Delete a repository invitation | Deletes an active repository invitation, permanently revoking a user’s access to collaborate on the specified repository. | GITHUB_DELETE_A_REPOSITORY_INVITATION |
Items (1)
Items (1)
| Action | What it does | Slug |
|---|---|---|
| Delete project item for user | Delete a project item for a user in GitHub Projects V2. | GITHUB_DELETE_PROJECT_ITEM_FOR_USER |
Keys (1)
Keys (1)
| Action | What it does | Slug |
|---|---|---|
| Delete deploy key | Deletes a specific deploy key from a repository. | GITHUB_DELETE_DEPLOY_KEY |
Labels (4)
Labels (4)
| Action | What it does | Slug |
|---|---|---|
| Clear self hosted runner org labels | Removes all custom labels from a self-hosted runner for an organization. | GITHUB_CLEAR_SELF_HOSTED_RUNNER_ORG_LABELS |
| Remove custom label from repo runner | GITHUB_REMOVE_CUSTOM_LABEL_FROM_REPO_RUNNER | |
| Remove custom label from self hosted runner | GITHUB_REMOVE_CUSTOM_LABEL_FROM_SELF_HOSTED_RUNNER | |
| Remove custom labels from self hosted repo runner | GITHUB_REMOVE_CUSTOM_LABELS_FROM_SELF_HOSTED_REPO_RUNNER |
Lists (1)
Lists (1)
| Action | What it does | Slug |
|---|---|---|
| Delete user list | Delete a GitHub user list using GraphQL. | GITHUB_DELETE_USER_LIST |
Logs (1)
Logs (1)
| Action | What it does | Slug |
|---|---|---|
| Delete workflow run logs | Deletes all logs for a specific workflow run in a GitHub repository, provided the repository and run exist. | GITHUB_DELETE_WORKFLOW_RUN_LOGS |
Members (4)
Members (4)
| Action | What it does | Slug |
|---|---|---|
| Remove an organization member | GITHUB_REMOVE_AN_ORGANIZATION_MEMBER | |
| Remove public org membership | GITHUB_REMOVE_PUBLIC_ORG_MEMBERSHIP | |
| Remove team membership | GITHUB_REMOVE_TEAM_MEMBERSHIP | |
| Remove team membership for a user | GITHUB_REMOVE_TEAM_MEMBERSHIP_FOR_A_USER |
Migrations (1)
Migrations (1)
| Action | What it does | Slug |
|---|---|---|
| Abort repository migration | Abort a repository migration that is queued or in progress. | GITHUB_ABORT_REPOSITORY_MIGRATION |
Organizations (4)
Organizations (4)
| Action | What it does | Slug |
|---|---|---|
| Delete organization | Deletes a GitHub organization and its repositories. | GITHUB_DELETE_ORGANIZATION |
| Remove users codespaces access org | GITHUB_REMOVE_USERS_CODESPACES_ACCESS_ORG | |
| Unfollow organization | GITHUB_UNFOLLOW_ORGANIZATION | |
| Update token org access | GITHUB_UPDATE_TOKEN_ORG_ACCESS |
Packages (3)
Packages (3)
| Action | What it does | Slug |
|---|---|---|
| Delete org package | Deletes a specific package in an organization. | GITHUB_DELETE_ORG_PACKAGE |
| Delete package | Permanently deletes a specific package owned by the authenticated user. | GITHUB_DELETE_PACKAGE |
| Delete user package | Deletes a package owned by the specified user, requiring admin permissions for the authenticated user. | GITHUB_DELETE_USER_PACKAGE |
Policies (1)
Policies (1)
| Action | What it does | Slug |
|---|---|---|
| Delete deployment branch policy | Deletes a specific deployment branch or tag policy, identified by its ID, from a given environment within a repository. | GITHUB_DELETE_DEPLOYMENT_BRANCH_POLICY |
Projects (2)
Projects (2)
| Action | What it does | Slug |
|---|---|---|
| Delete project | Deletes the specified GitHub project (Projects V2) using the GraphQL API. | GITHUB_DELETE_PROJECT |
| Remove a project from a team | GITHUB_REMOVE_A_PROJECT_FROM_A_TEAM |
Properties (1)
Properties (1)
| Action | What it does | Slug |
|---|---|---|
| Remove a custom property for an organization | GITHUB_REMOVE_A_CUSTOM_PROPERTY_FOR_AN_ORGANIZATION |
Reactions (2)
Reactions (2)
| Action | What it does | Slug |
|---|---|---|
| Delete team discussion comment reaction | Deletes a reaction from a team discussion comment, given the organization name, team slug, discussion number, comment number, and reaction ID. | GITHUB_DELETE_TEAM_DISCUSSION_COMMENT_REACTION |
| Delete team discussion reaction | Permanently deletes a specific reaction from a team discussion within an organization. | GITHUB_DELETE_TEAM_DISCUSSION_REACTION |
Repositories (14)
Repositories (14)
| Action | What it does | Slug |
|---|---|---|
| Create a repository for the authenticated user | Creates a new repository for the authenticated user, optionally within an organization if team_id is specified. | GITHUB_CREATE_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER |
| Create a repository from an unpublished codespace | Publishes the specified codespace to a new repository, using the codespace’s current state as the initial commit. | GITHUB_CREATE_A_REPOSITORY_FROM_AN_UNPUBLISHED_CODESPACE |
| Create an organization repository | Creates a new repository within a specified GitHub organization, with options for detailed configuration including visibility, features, merge strategies, initial commit, and templates. | GITHUB_CREATE_AN_ORGANIZATION_REPOSITORY |
| Delete a repository | Permanently deletes the specified repository. | GITHUB_DELETE_A_REPOSITORY |
| Disable private vuln reporting for repo | Disables private vulnerability reporting for an existing GitHub repository, preventing direct private vulnerability reports to maintainers via GitHub’s interface for this repository. | GITHUB_DISABLE_PRIVATE_VULN_REPORTING_FOR_REPO |
| Remove a repository from a team | GITHUB_REMOVE_A_REPOSITORY_FROM_A_TEAM | |
| Remove a repository from an app installation | GITHUB_REMOVE_A_REPOSITORY_FROM_AN_APP_INSTALLATION | |
| Remove a selected repository from a user secret | GITHUB_REMOVE_A_SELECTED_REPOSITORY_FROM_A_USER_SECRET | |
| Remove repo from org dev env secret | GITHUB_REMOVE_REPO_FROM_ORG_DEV_ENV_SECRET | |
| Remove repo from org secret with selected visibility | GITHUB_REMOVE_REPO_FROM_ORG_SECRET_WITH_SELECTED_VISIBILITY | |
| Remove selected repo from org secret | GITHUB_REMOVE_SELECTED_REPO_FROM_ORG_SECRET | |
| Remove selected repo from org variable | GITHUB_REMOVE_SELECTED_REPO_FROM_ORG_VARIABLE | |
| Unlock user repository | GITHUB_UNLOCK_USER_REPOSITORY | |
| Unstar repository | GITHUB_UNSTAR_REPOSITORY |
Resources (2)
Resources (2)
| Action | What it does | Slug |
|---|---|---|
| Review resource requests with fine grained tokens | GITHUB_REVIEW_RESOURCE_REQUESTS_WITH_FINE_GRAINED_TOKENS | |
| Update resource access with tokens | GITHUB_UPDATE_RESOURCE_ACCESS_WITH_TOKENS |
Roles and permissions (5)
Roles and permissions (5)
| Action | What it does | Slug |
|---|---|---|
| Delete custom organization role | Deletes a custom organization role (which should not be actively assigned) by its ID. | GITHUB_DELETE_CUSTOM_ORGANIZATION_ROLE |
| Remove all organization roles for a team | GITHUB_REMOVE_ALL_ORGANIZATION_ROLES_FOR_A_TEAM | |
| Remove all organization roles for a user | GITHUB_REMOVE_ALL_ORGANIZATION_ROLES_FOR_A_USER | |
| Remove an organization role from a team | GITHUB_REMOVE_AN_ORGANIZATION_ROLE_FROM_A_TEAM | |
| Remove an organization role from a user | GITHUB_REMOVE_AN_ORGANIZATION_ROLE_FROM_A_USER |
Rules (1)
Rules (1)
| Action | What it does | Slug |
|---|---|---|
| Disable a custom protection rule for an environment | Disables a specific, currently active custom deployment protection rule for an existing environment within a GitHub repository. | GITHUB_DISABLE_A_CUSTOM_PROTECTION_RULE_FOR_AN_ENVIRONMENT |
Rulesets (1)
Rulesets (1)
| Action | What it does | Slug |
|---|---|---|
| Delete a repository ruleset | Permanently deletes a repository ruleset. | GITHUB_DELETE_A_REPOSITORY_RULESET |
Runners (2)
Runners (2)
| Action | What it does | Slug |
|---|---|---|
| Delete a self hosted runner from a repository | Removes a specific self-hosted runner (by runner_id) from a repository, if registered there. | GITHUB_DELETE_A_SELF_HOSTED_RUNNER_FROM_A_REPOSITORY |
| Delete a self hosted runner from an organization | Forces the removal of a self-hosted runner from a GitHub organization. | GITHUB_DELETE_A_SELF_HOSTED_RUNNER_FROM_AN_ORGANIZATION |
Runs (3)
Runs (3)
| Action | What it does | Slug |
|---|---|---|
| Cancel workflow run | Cancels a workflow run in a GitHub repository if it is in a cancellable state (e.g., ‘in_progress’ or ‘queued’). | GITHUB_CANCEL_WORKFLOW_RUN |
| Delete a workflow run | Deletes a specific workflow run from a repository. | GITHUB_DELETE_A_WORKFLOW_RUN |
| Force cancel workflow run | Forcefully cancels a queued or in-progress GitHub Actions workflow run, bypassing conditions like always() that would otherwise continue execution. | GITHUB_FORCE_CANCEL_WORKFLOW_RUN |
Secrets (8)
Secrets (8)
| Action | What it does | Slug |
|---|---|---|
| Delete a repository secret | Deletes a named GitHub Actions secret from a specified repository. | GITHUB_DELETE_A_REPOSITORY_SECRET |
| Delete a secret for the authenticated user | Deletes an existing Codespaces secret for the authenticated user by secret_name. | GITHUB_DELETE_A_SECRET_FOR_THE_AUTHENTICATED_USER |
| Delete dependebot secret by name | Deletes a specific Dependabot secret, identified by its name, from a given repository if both the repository and secret exist. | GITHUB_DELETE_DEPENDEBOT_SECRET_BY_NAME |
| Delete environment secret | Deletes an existing and accessible secret from a specified environment within a GitHub repository, returning an empty dictionary on success or error details otherwise. | GITHUB_DELETE_ENVIRONMENT_SECRET |
| Delete organization secret | Permanently deletes a secret from a GitHub organization, making it inaccessible to GitHub Actions workflows or other tools. | GITHUB_DELETE_ORGANIZATION_SECRET |
| Delete repo codespace secret by name | Deletes a specific Codespace secret from a repository by its name. | GITHUB_DELETE_REPO_CODESPACE_SECRET_BY_NAME |
| Remove org dev env secret by name | GITHUB_REMOVE_ORG_DEV_ENV_SECRET_BY_NAME | |
| Remove org secret by name | GITHUB_REMOVE_ORG_SECRET_BY_NAME |
Sites (1)
Sites (1)
| Action | What it does | Slug |
|---|---|---|
| Delete GitHub pages site | Deletes the GitHub Pages site for the specified repository. | GITHUB_DELETE_GITHUB_PAGES_SITE |
Subscriptions (2)
Subscriptions (2)
| Action | What it does | Slug |
|---|---|---|
| Delete a repository subscription | Deletes the authenticated user’s subscription to a specified repository if it exists, effectively ‘unwatching’ it. | GITHUB_DELETE_A_REPOSITORY_SUBSCRIPTION |
| Delete a thread subscription | Mute a specific notification thread by deleting the user’s subscription. | GITHUB_DELETE_A_THREAD_SUBSCRIPTION |
Teams (2)
Teams (2)
| Action | What it does | Slug |
|---|---|---|
| Delete a team | Deletes a team (and any child teams) from an organization. | GITHUB_DELETE_A_TEAM |
| Remove team access restrictions | GITHUB_REMOVE_TEAM_ACCESS_RESTRICTIONS |
Templates (1)
Templates (1)
| Action | What it does | Slug |
|---|---|---|
| Create a repository using a template | Creates a new repository from an existing template repository. | GITHUB_CREATE_A_REPOSITORY_USING_A_TEMPLATE |
Tokens (4)
Tokens (4)
| Action | What it does | Slug |
|---|---|---|
| Delete app token | Revokes a single OAuth access token for an OAuth App or GitHub App with OAuth authorization. | GITHUB_DELETE_APP_TOKEN |
| Reset a token | GITHUB_RESET_A_TOKEN | |
| Review access with personal token | GITHUB_REVIEW_ACCESS_WITH_PERSONAL_TOKEN | |
| Revoke an installation access token | GITHUB_REVOKE_AN_INSTALLATION_ACCESS_TOKEN |
Users (7)
Users (7)
| Action | What it does | Slug |
|---|---|---|
| Block user | Blocks an existing individual GitHub user (not an organization or your own account), preventing them from interacting with your account and repositories. | GITHUB_BLOCK_USER |
| Block user from organization | Blocks a GitHub user from an organization, preventing their contributions, collaboration, and forking of the organization’s repositories. | GITHUB_BLOCK_USER_FROM_ORGANIZATION |
| Remove user access restrictions | GITHUB_REMOVE_USER_ACCESS_RESTRICTIONS | |
| Remove user as a collaborator | GITHUB_REMOVE_USER_AS_A_COLLABORATOR | |
| Unblock a user | GITHUB_UNBLOCK_A_USER | |
| Unblock user from organization | GITHUB_UNBLOCK_USER_FROM_ORGANIZATION | |
| Unfollow a user | GITHUB_UNFOLLOW_A_USER |
Variables (3)
Variables (3)
| Action | What it does | Slug |
|---|---|---|
| Delete a repository variable | Deletes a named variable (e.g., for GitHub Actions workflows) from a repository. | GITHUB_DELETE_A_REPOSITORY_VARIABLE |
| Delete environment variable | Deletes a named environment variable from a specified, existing environment within a GitHub repository. | GITHUB_DELETE_ENVIRONMENT_VARIABLE |
| Delete organization variable | Deletes a named GitHub Actions variable from a specified organization. | GITHUB_DELETE_ORGANIZATION_VARIABLE |
Versions (4)
Versions (4)
| Action | What it does | Slug |
|---|---|---|
| Delete a package version for the authenticated user | Deletes an existing package version associated with the authenticated user. | GITHUB_DELETE_A_PACKAGE_VERSION_FOR_THE_AUTHENTICATED_USER |
| Delete package version | Delete a package version using GitHub GraphQL API. | GITHUB_DELETE_PACKAGE_VERSION |
| Delete package version for a user | Permanently and irreversibly deletes a specific version of a package owned by the specified user. | GITHUB_DELETE_PACKAGE_VERSION_FOR_A_USER |
| Delete package version for an organization | Deletes a specific package version within an organization. | GITHUB_DELETE_PACKAGE_VERSION_FOR_AN_ORGANIZATION |
Webhooks (2)
Webhooks (2)
| Action | What it does | Slug |
|---|---|---|
| Delete a repository webhook | Deletes a specific webhook from a repository. | GITHUB_DELETE_A_REPOSITORY_WEBHOOK |
| Delete organization webhook | Deletes a specific webhook, identified by hook_id, from an existing organization. | GITHUB_DELETE_ORGANIZATION_WEBHOOK |
Other actions (5)
Other actions (5)
| Action | What it does | Slug |
|---|---|---|
| Cancel sponsorship | Cancel an active GitHub sponsorship using GraphQL. | GITHUB_CANCEL_SPONSORSHIP |
| Delete access restrictions | Removes all user, team, and app-based access restrictions from a protected branch. | GITHUB_DELETE_ACCESS_RESTRICTIONS |
| Delete autolink reference | Deletes a specific autolink reference (which automatically links external resource IDs like JIRA-123 to URLs) from the specified repository. | GITHUB_DELETE_AUTOLINK_REFERENCE |
| Remove status check contexts | GITHUB_REMOVE_STATUS_CHECK_CONTEXTS | |
| Retire sponsors tier | GITHUB_RETIRE_SPONSORS_TIER |
Connect GitHub
Before you start:- You need a GitHub account that you can sign in to.
- Your Squad subscription must be active. Squad does not connect apps while the subscription is not active.
Open Integrations
Add an integration
Find GitHub
Choose an access level
Click Connect GitHub
Sign in to GitHub
Change the access level
- Under YOUR CONNECTIONS, find the GitHub account.
- Open the account menu (⋯) and click Manage scope.
- Under Default scope, choose the new level.
- Click Save access.
Set access for one agent
Every agent uses the account’s level unless you set something else for it. You can narrow one agent to a lower level, or block it.- Under YOUR CONNECTIONS, open the account menu (⋯) on the GitHub account.
- Click Manage scope.
- Under Per-agent access, find the agent.
- Choose the Default option to follow the account’s level, choose a lower level, or choose No access.
- Click Save access.
Use more than one GitHub account
Click + Account on the GitHub card to connect another account. Agents use the primary account unless they are asked to use a specific one.- After you click + Account, follow the connect steps above.
- Each account has its own access level.
- The first account you connect becomes the primary account. It shows ★ PRIMARY.
- To change the primary account, open the account menu (⋯) and click Make primary.
- To tell accounts apart, open the account menu (⋯) and click Rename.
Reconnect or disconnect
Reconnect when the connection has expired, or when you need to change what the account can reach on the GitHub side:- Open the account menu (⋯) and click Reconnect.
- Click Reauthorize on GitHub.
- Sign in to GitHub and approve the request.
Costs
GitHub actions do not use Squad credits. Connected apps never use credits. For what does use credits, see What Squad costs.Troubleshooting
An agent reports that an action is not allowed on this account.- Cause: the action is outside the account’s access level, or outside the level you set for that agent.
- Fix: choose a higher level in Manage scope, or change the agent’s row under Per-agent access.
- Cause: the agent is set to No access under Per-agent access, or the account is not connected.
- Fix: open Manage scope and change the agent’s row. If the account is missing, connect it again.
- Cause: your Squad subscription is not active.
- Fix: resubscribe. See Manage your subscription.
- Cause: the sign-in for that account is no longer valid.
- Fix: use Reconnect on the account.
Common questions
Can I limit what agents can do in GitHub?
Can I limit what agents can do in GitHub?
Can I connect more than one GitHub account?
Can I connect more than one GitHub account?
How do I disconnect GitHub?
How do I disconnect GitHub?
GITHUB_GET_A_REVIEW_COMMENT_FOR_A_PULL_REQUESTGITHUB_GET_AN_ISSUE_COMMENTGITHUB_GET_COMMIT_COMMENTGITHUB_GET_DISCUSSION_COMMENTGITHUB_GET_GIST_COMMENTGITHUB_GET_ISSUE_COMMENTSGITHUB_LIST_COMMENTS_FOR_A_PULL_REQUEST_REVIEWGITHUB_LIST_COMMIT_COMMENTSGITHUB_LIST_COMMIT_COMMENTS_FOR_A_REPOSITORYGITHUB_LIST_DISCUSSION_COMMENTSGITHUB_LIST_GIST_COMMENTSGITHUB_LIST_ISSUE_COMMENTSGITHUB_LIST_ISSUE_COMMENTS_FOR_A_REPOSITORYGITHUB_LIST_REVIEW_COMMENTS_IN_A_REPOSITORYGITHUB_LIST_REVIEW_COMMENTS_ON_A_PULL_REQUEST