Skip to main content
GitHub logo
  • Category: developer tools
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 899
  • Triggers: 46
  • Slug: GITHUB
  • Version: 20261103_00

Frequently Asked Questions

Yes. You can bring your own GitHub App by configuring its client ID and client secret in the GitHub auth config.The GitHub App installation step is separate from the OAuth credential setup. The user still needs to install the GitHub App on the relevant account or organization and grant repository access before GitHub App based tool calls can work. GitHub App permissions come from the app’s GitHub settings and installation grant, not from auth config scopes.Composio does not currently provide the GitHub App installation link automatically during this flow. Provide your GitHub App installation link to the user, have them install the app, then complete the connection. Built-in installation-link handling is being worked on.

Tools

Slug: GITHUB_ABORT_REPOSITORY_MIGRATIONTool to abort a repository migration that is queued or in progress. Use when you need to cancel an ongoing migration operation.

Input Parameters

string
required
The ID of the repository migration to abort. This is the migration ID returned when a migration was queued (e.g., ‘RM_kgDOABCDEF’).
string
A unique identifier for the client performing the mutation. This can be used to track the mutation in logs or for idempotency purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ACCEPT_REPOSITORY_INVITATIONAccepts a PENDING repository invitation that has been issued to the authenticated user.

Input Parameters

integer
required
Unique identifier of the repository invitation sent TO the authenticated user. Get this ID by listing your pending invitations using the ‘List repository invitations for the authenticated user’ action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_APP_ACCESS_RESTRICTIONSAdds GitHub Apps to the list of apps allowed to push to a protected branch. The branch must already have protection rules with restrictions enabled. This endpoint only works for organization repositories, not personal repositories. Apps must be installed on the repository with ‘contents’ write permissions.

Input Parameters

array
required
The list of GitHub App slugs with push access to grant. Apps must be installed on the repository and have ‘contents’ write permissions. The app slug is the URL-friendly name of the GitHub App (e.g., ‘github-actions’, ‘dependabot’).
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The organization name that owns the repository. This field is not case-sensitive. Note: This endpoint only works for organization-owned repositories.
string
required
The name of the branch to which restrictions will be applied. Wildcard characters (e.g., ’*’) are not allowed in the branch name when using this REST API endpoint. For operations involving wildcard branch names, consult the GitHub GraphQL API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_A_REPOSITORY_COLLABORATORAdds a GitHub user as a repository collaborator, or updates their permission if already a collaborator; permission applies to organization-owned repositories (personal ones default to ‘push’ and ignore this field), and an invitation may be created or permissions updated directly.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository. This name is not case sensitive.
string
required
The GitHub handle for the user account to add as a collaborator. Cannot be the same as the repository owner, as owners are automatically collaborators.
string
Permission level for the collaborator. For organization-owned repositories, valid values are pull (read-only), triage (manage issues/PRs), push (read/write), maintain (manage most settings), admin (full control), or a custom repository role name if defined by the owning organization. This parameter is ignored for personal repositories, which grant push access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_ASSIGNEES_TO_AN_ISSUEAdds assignees to a GitHub issue. This action only adds users - it does not remove existing assignees. Changes are silently ignored if the authenticated user lacks push access to the repository.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case sensitive.
string
required
The username of the account or the organization name that owns the repository. This field is not case sensitive.
array
A list of GitHub usernames to add as assignees to the issue. Up to 10 assignees total can be on an issue. NOTE: This endpoint ADDS assignees - it does not replace existing ones. Users already assigned are kept. To remove assignees, use the ‘remove_assignees_from_an_issue’ action instead. The authenticated user must have push access to the repository; otherwise changes are silently ignored.
integer
required
The unique number identifying the issue within the repository. Must be a positive integer (GitHub issue numbers start at 1).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_EMAIL_ADDRESS_FOR_AUTHENTICATED_USERAdds one or more email addresses (which will be initially unverified) to the authenticated user’s GitHub account; use this to associate new emails, noting an email verified for another account will error, while an existing email for the current user is accepted.

Input Parameters

array
required
Array of email addresses to add to the authenticated user account. Must contain at least one email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_FIELD_TO_USER_PROJECTTool to add a custom field to a user-owned GitHub Projects V2 project. Use when you need to add fields like status, priority, or custom data to organize project items.

Input Parameters

string
required
The name of the field to create.
string
required
The handle for the GitHub user account.
string ("text" | "single_select" | "number" | "date" | "iteration")
required
The data type of the field. Use ‘single_select’ for dropdown fields, ‘iteration’ for sprint fields, or other types for simple fields.
integer
required
The project’s number.
array
Options for single select fields. Required when data_type is ‘single_select’.
object
Configuration for iteration fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_ITEM_TO_USER_PROJECTTool to add an issue or pull request to a user-owned GitHub project. Use when you need to add existing repository items to a project board.

Input Parameters

integer
The unique identifier of the issue or pull request to add to the project. Required if owner, repo, and number are not provided.
string
The repository name. Required with owner and number if id is not provided.
string ("Issue" | "PullRequest")
required
The type of item to add to the project. Must be either Issue or PullRequest.
string
The repository owner login. Required with repo and number if id is not provided.
integer
The issue or pull request number. Required with owner and repo if id is not provided.
string
required
The handle for the GitHub user account.
integer
required
The project’s number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_LABELS_TO_AN_ISSUEAdds labels (provided in the request body) to a repository issue; labels that do not already exist are created.

Input Parameters

string
required
Repository name, without the .git extension (case-insensitive).
string
required
Username or organization name owning the repository (case-insensitive).
array
required
Array of label names to add to the issue. Labels that don’t exist will be created automatically.
integer
required
Positive integer that uniquely identifies the issue within the repository. Must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_ORG_RUNNER_LABELSAdds new custom labels to an existing self-hosted runner for an organization; existing labels are not removed, and duplicates are not added.

Input Parameters

string
required
The organization’s name (case-insensitive).
array
required
A list of custom label names to add to the self-hosted runner. Previously applied labels are not removed.
integer
required
Unique identifier of the self-hosted runner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_OR_UPDATE_TEAM_MEMBERSHIP_FOR_USERAdds a GitHub user to a team or updates their role (member or maintainer), inviting them to the organization if not already a member; idempotent, returning current details if no change is made.

Input Parameters

string
required
The name of the GitHub organization. This name is not case-sensitive.
string ("member" | "maintainer")
The role to assign to the user within the team. A ‘maintainer’ has broader permissions than a ‘member’, such as managing team members and settings.
string
required
The GitHub username of the user to add or whose membership to update.
string
required
The slug (URL-friendly version) of the team’s name. Must be lowercase with hyphens instead of spaces (e.g., ‘my-team’ not ‘My Team’). Spaces will be automatically converted to hyphens and text will be lowercased.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_OR_UPDATE_TEAM_PROJECT_PERMISSIONSAdds a classic organization project to a team or updates the team’s permissions. GitHub sunset the Projects (classic) REST API on April 1, 2025; this does not manage Projects V2.

Input Parameters

string
required
The organization name (login) that owns both the team and the classic project. Case-insensitive.
string
required
The team’s URL-friendly slug identifier within the organization. Found in the team’s URL path.
string ("read" | "write" | "admin")
Permission level to grant the team: ‘read’ (view only), ‘write’ (view and edit), or ‘admin’ (full control including settings). If omitted, uses the team’s default permission.
integer
required
The unique numeric ID of the classic project. This is NOT the project number displayed in the UI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_OR_UPDATE_TEAM_REPOSITORY_PERMISSIONSSets or updates a team’s permission level for a repository within an organization; the team must be a member of the organization.

Input Parameters

string
required
Organization name where the team exists (case-insensitive). This is the organization that owns the team, not necessarily the repository owner.
string
required
Repository name, without the .git extension (case-insensitive).
string
required
Account owner of the repository (case-insensitive). This is the user or organization that owns the repository. In most cases, this should match the ‘org’ parameter value.
string
required
The team’s slug (URL-friendly name).
string
Permission level to grant the team. Valid values: ‘pull’ (read-only), ‘triage’ (manage issues/PRs), ‘push’ (read/write), ‘maintain’ (manage repo settings plus push), ‘admin’ (full control). Custom repository role names are also supported if defined by the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_PROJECT_COLLABORATORAdds a GitHub user as a collaborator to an organization project (classic) with a specified permission level. The Projects (classic) REST API was sunset on GitHub.com on April 1, 2025; adding collaborators requires organization-owner or project-admin access.

Input Parameters

string
required
The GitHub username of the user to be added as a collaborator.
string ("read" | "write" | "admin")
Permission level for the collaborator on the project.
integer
required
The unique identifier of the organization project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_REPOSITORY_TO_APP_INSTALLATIONAdds a repository to a GitHub App installation, granting the app access; requires authenticated user to have admin rights for the repository and access to the installation.

Input Parameters

integer
required
The unique identifier of the repository to add to the installation. The authenticated user must have admin permissions for this repository.
integer
required
The unique identifier of the GitHub App installation to which the repository will be added. This installation must be accessible to the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_REPO_TO_ORG_SECRET_WITH_SELECTED_ACCESSAdds a repository to an existing organization-level GitHub Actions secret that is configured for ‘selected’ repository access.

Input Parameters

string
required
The name of the GitHub organization. This field is not case-sensitive.
string
required
The name of the organization secret to which the repository will be added.
integer
required
The unique identifier of the repository to be granted access to the organization secret.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_REPO_TO_ORG_SECRET_WITH_SELECTED_VISIBILITYGrants an existing repository access to an existing organization-level Dependabot secret when the secret’s visibility is set to ‘selected’; the repository must belong to the organization, and the call succeeds without change if access already exists.

Input Parameters

string
required
The organization’s unique handle/name (case-insensitive).
string
required
Name of the Dependabot secret; must be alphanumeric or underscore, no spaces (lowercase auto-converts to uppercase).
integer
required
Unique ID of the repository to be granted access to the secret.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_RUNNER_LABELSAdds and appends custom labels to a self-hosted repository runner, which must be registered and active.

Input Parameters

string
required
Name of the repository, without the .git extension. Case-insensitive.
string
required
Username or organization name of the repository owner. Case-insensitive.
array
required
Custom label names to add. Appended to existing labels. Names are case-insensitive. Empty list means no changes.
integer
required
Unique ID of the self-hosted runner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_SELECTED_REPOSITORY_TO_ORGANIZATION_SECRETAdds a repository to the access list of an organization-level GitHub Codespaces secret with selected visibility.

Input Parameters

string
required
The name of the organization. This name is not case sensitive.
string
required
The name of the secret. Secret names can only contain alphanumeric characters ([A-Z], [a-z], [0-9]) or underscores (). Spaces are not allowed. Secret names cannot start with GITHUB and must be less than 255 characters.
integer
required
The unique identifier of the repository to add to the secret’s access list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_SELECTED_REPOSITORY_TO_ORGANIZATION_VARIABLEGrants a repository access to an organization-level GitHub Actions variable, if that variable’s visibility is set to ‘selected_repositories’.

Input Parameters

string
required
Name of the GitHub organization (case-insensitive).
string
required
Name of the existing organization-level GitHub Actions variable.
integer
required
Unique identifier of the repository to grant access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_SELECTED_REPOSITORY_TO_USER_SECRETGrants a specified repository access to an authenticated user’s existing Codespaces secret, enabling Codespaces created for that repository to use the secret.

Input Parameters

string
required
Name of the user-level Codespaces secret to which repository access is added; this secret must already exist for the authenticated user.
integer
required
The unique identifier of the repository to be granted access to the specified user-level Codespaces secret.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_SOCIAL_ACCOUNTS_FOR_AUTHENTICATED_USERAdds 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.

Input Parameters

array
required
Full URLs for social media profiles to add to the user’s GitHub profile; these will be displayed publicly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_STATUS_CHECK_CONTEXTSAdds status check contexts to a protected branch’s required status checks. This action appends new status check contexts to the existing list of required status checks for a protected branch. The branch must already have branch protection enabled with status checks configured. Note: The ‘contexts’ parameter is deprecated by GitHub in favor of ‘checks’ array. For new implementations, consider using update_status_check_protection with the ‘checks’ parameter instead.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository. This name is not case sensitive.
string
required
The name of the branch to which status check contexts will be added. Branch names cannot contain wildcard characters. To use wildcard characters in branch names, refer to the GraphQL API.
array
required
The status check contexts to add to the protected branch. These are the names of CI/CD jobs or other checks that must pass before merging. Can be provided as a single string or a list of strings. Examples: ‘ci/test’, ‘linter’, ‘continuous-integration/travis-ci’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_SUB_ISSUETool to add a sub-issue to a parent GitHub issue using GraphQL. Use when you need to establish a parent-child relationship between issues. Requires the ‘sub_issues’ GraphQL feature to be enabled.

Input Parameters

string
required
The global node ID of the parent issue (e.g., ‘I_kwDOABCDEFGH’). This is the GraphQL global identifier returned by GitHub’s API.
string
The global node ID of the sub-issue to link to the parent issue. Either sub_issue_id or sub_issue_url must be provided.
string
The URL of the sub-issue to link to the parent issue. Either sub_issue_id or sub_issue_url must be provided.
boolean
If true, replaces the existing parent issue if the sub-issue already has one. If false or omitted, the mutation will fail if the sub-issue already has a parent.
string
A unique identifier for the client performing the mutation. Used to ensure idempotency of mutations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_TEAM_ACCESS_RESTRICTIONSAdds teams to the list of teams with push access to a protected branch. This action grants additional teams push access to a protected branch. Unlike ‘Set team access restrictions’ (PUT), this action adds to the existing list rather than replacing it entirely. Prerequisites: - The repository must be owned by an organization (not a personal account) - The branch must have protection rules enabled - The branch protection must have restrictions configured - The teams must exist in the organization and have repository access

Input Parameters

string
required
The name of the repository, without the .git extension. This value is not case-sensitive.
string
required
The organization name that owns the repository. Team access restrictions only work for organization-owned repositories, not personal repositories. This value is not case-sensitive.
array
required
The list of team slugs to add push access to the protected branch. A team slug is the URL-friendly version of the team name (lowercase, hyphens instead of spaces). The teams must already have access to the repository. This adds teams to the existing list (does not replace the entire list).
string
required
The name of the protected branch to add team restrictions to. The branch must already have branch protection enabled with restrictions configured. Wildcard characters are not supported. For wildcard branch protection, use the GitHub GraphQL API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_USER_ACCESS_RESTRICTIONSAdds users to the list of people allowed to push to a protected branch in an organization repository. Important notes: - This action only works on organization-owned repositories (not personal repos) - The branch must already have protection rules with restrictions enabled - Users must have write access to the repository to be added - The combined total of users, apps, and teams is limited to 100 items

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository (must be an organization for user restrictions). This name is not case-sensitive.
array
required
The list of user logins to grant push access to the protected branch. Users must have write access to the repository. An empty list will remove all user restrictions.
string
required
The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, refer to the GitHub GraphQL API documentation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ADD_USERS_TO_CODESPACES_ACCESS_FOR_ORGANIZATIONAdds organization members to the list of users granted Codespaces access billed to the organization. IMPORTANT: This endpoint requires the organization’s Codespaces billing access to be set to ‘selected_members’ mode. If not already configured, use the GITHUB_MANAGE_ACCESS_CONTROL_FOR_ORGANIZATION_CODESPACES action first to set visibility to ‘selected_members’.

Input Parameters

string
required
Organization’s name (case-insensitive).
array
required
Usernames of organization members to be granted Codespaces access billed to the organization. These users must be members of the specified organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_API_ROOTRetrieves a map of all top-level GitHub REST API resource URLs and their templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_APPROVE_WORKFLOW_RUN_FOR_FORK_PULL_REQUESTApproves a workflow run from a forked repository’s pull request; call this when such a run requires manual approval due to workflow configuration.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The unique identifier of the workflow run requiring approval.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ASSIGN_ORGANIZATION_ROLE_TO_TEAMAssigns 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.

Input Parameters

string
required
The name of the GitHub organization. This field is case-insensitive.
integer
required
Unique identifier of the organization role to assign to the team (obtainable by listing organization roles).
string
required
The slug (URL-friendly version) of the team’s name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ASSIGN_ORGANIZATION_ROLE_TO_USERAssigns a specific organization role to a user who is a member or an outside collaborator in a GitHub organization, using a valid role ID.

Input Parameters

string
required
The organization’s name. This is not case-sensitive.
integer
required
The unique integer identifier for the organization role. This ID can be obtained by listing the organization’s roles.
string
required
The GitHub username of the user to whom the role will be assigned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_AUTH_USER_DOCKER_CONFLICT_PACKAGES_LISTList Docker packages with migration conflicts for the authenticated user. This endpoint lists all Docker packages owned by the authenticated user that encountered namespace conflicts during the Docker-to-GitHub Container Registry (GHCR) migration. Conflicts occur when a package with the same name exists in both the legacy Docker registry and GHCR. IMPORTANT: The Docker registry for GitHub Packages was deprecated on Feb 24, 2025. This endpoint may return a 400 error with message ‘Package migration for docker is no longer supported’ as the migration period has ended. In this case, the action returns an informative response instead of failing. Use case: Identifying packages that require manual migration to GHCR. Required scope: read:packages (for OAuth and personal access tokens).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_BLOCK_USERBlocks an existing individual GitHub user (not an organization or your own account), preventing them from interacting with your account and repositories.

Input Parameters

string
required
The GitHub username (handle) of the user to block. Case-insensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_BLOCK_USER_FROM_ORGANIZATIONBlocks a GitHub user from an organization, preventing contributions, collaboration, and forking of its repositories; requires admin or ‘Blocking users’ organization permission. Certain permission and validation errors return a response with success=false.

Input Parameters

string
required
The organization name (case-insensitive). You must have admin or ‘Blocking users’ permission in this organization.
string
required
The GitHub username (handle) of the account to block from the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CANCEL_GITHUB_PAGES_DEPLOYMENTCancels an existing, ongoing or queued GitHub Pages deployment for a repository using its pages_deployment_id.

Input Parameters

string
required
Repository name, excluding the .git extension. Not case-sensitive.
string
required
Username or organization that owns the repository. Not case-sensitive.
integer
required
Unique numerical ID of the GitHub Pages deployment (not the commit SHA).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CANCEL_SPONSORSHIPTool to cancel an active GitHub sponsorship using GraphQL. Use when you need to terminate a sponsorship relationship between a sponsor and a sponsorable entity. Either sponsor ID/login and sponsorable ID/login must be provided.

Input Parameters

string
The global node ID of the user or organization acting as sponsor (e.g., ‘U_kgDOABCDEF’). Required if sponsor_login is not provided.
string
The username of the sponsoring user or organization. Required if sponsor_id is not provided.
string
The global node ID of the user or organization receiving the sponsorship (e.g., ‘U_kgDOMNOPQR’). Required if sponsorable_login is not provided.
string
The username of the sponsored user or organization. Required if sponsorable_id is not provided.
string
A unique identifier for the client performing the mutation. Used to ensure idempotency of mutations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CANCEL_WORKFLOW_RUNRequests cancellation of a workflow run in a GitHub repository if it is in a cancellable state, such as in progress or queued. Returns an acceptance message when GitHub accepts the request; cancellation may take time to complete.

Input Parameters

string
required
The name of the repository, without the .git extension (not case-sensitive).
string
required
The account owner of the repository (not case-sensitive).
integer
required
Unique identifier of the workflow run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_FOLLOWINGCheck if the authenticated user is following a specified person on GitHub. Use this action when you need to verify whether the currently authenticated user follows another GitHub user. The action returns a boolean status and descriptive message.

Input Parameters

string
required
The handle for the GitHub user account to check if being followed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_IF_GIST_IS_STARREDChecks whether the authenticated user has starred a GitHub gist. Returns true for HTTP 204 or 304 and false for HTTP 404; an unexpected successful status also yields false with a status message.

Input Parameters

string
required
The unique identifier (ID) of the gist to check. Can be found in the URL of the gist (e.g., ‘https://gist.github.com/{user}/{gist_id}’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_IF_PULL_REQUEST_HAS_BEEN_MERGEDChecks if a specified GitHub pull request has been merged, indicated by a 204 HTTP status (merged) or 404 (not merged/found).

Input Parameters

string
required
The name of the repository, without the .git extension (not case sensitive).
string
required
The account owner of the repository (not case sensitive).
integer
required
The number that identifies the pull request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_IF_PULL_REQUEST_MERGEDChecks whether a GitHub pull request has been merged. Returns merged=True for HTTP 204 and merged=False for HTTP 404; a 404 can also mean the pull request does not exist.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The number that identifies the pull request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_IF_REPO_STARRED_BY_AUTH_USERChecks whether the authenticated user has starred a specified GitHub repository. This action is deprecated.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository (e.g., a user or organization). This name is not case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_IF_USER_CAN_BE_ASSIGNEDVerifies if a GitHub user can be assigned to issues in a repository; assignability is confirmed by an HTTP 204 (No Content) response, resulting in an empty ‘data’ field in the response.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository (e.g., a GitHub username or organization name). This name is not case sensitive.
string
required
The GitHub username of the user to check for assignability. This name is not case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_IF_USER_CAN_BE_ASSIGNED_TO_ISSUEChecks if a specified GitHub user can be assigned to a given issue within a repository.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username of the account owning the repository. This field is not case-sensitive.
string
required
The GitHub username of the user to check for assignment permissions.
integer
required
The unique number identifying the issue within the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_IF_USER_FOLLOWS_ANOTHER_USERChecks if a GitHub user username follows target_user; returns a 204 HTTP status if true, 404 if not or if users are invalid.

Input Parameters

string
required
The GitHub username of the user to check.
string
required
The GitHub username of the user to verify if they are followed by the username.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_IF_USER_IS_BLOCKED_BY_AUTHENTICATED_USERChecks whether a specified GitHub user is blocked by the authenticated user. Both a blocked response and a 404 response are returned as an empty result, so the result does not distinguish those cases.

Input Parameters

string
required
The GitHub username (handle) of the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_IF_USER_IS_BLOCKED_BY_ORGANIZATIONChecks whether a GitHub user is blocked by an organization; requires ‘Blocking users’ organization permission (read access). Returns is_blocked=True for HTTP 204, False for HTTP 404, and a null status with an error for HTTP 403.

Input Parameters

string
required
The organization name (case-insensitive). Must be an organization where you have ‘Blocking users’ permission (read access).
string
required
The GitHub username (handle) to check if blocked by the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_IF_USER_IS_REPOSITORY_COLLABORATORChecks whether a user is a collaborator on a GitHub repository, returning a boolean for HTTP 204 or 404; a 404 can also mean the repository or user does not exist. A 403 returns an indeterminate result with a permission error.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository, typically a GitHub username or an organization name. This name is not case sensitive.
string
required
The GitHub username of the user whose collaborator status is being checked. This name is not case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_ORGANIZATION_MEMBERSHIP_FOR_USERCheck whether a user has membership visible to the connected account. GitHub documents 404 as a negative result only when the requester is an organization member. It can otherwise indicate hidden membership, insufficient access, or a missing organization or user.

Input Parameters

string
required
The organization name. The name is not case sensitive.
string
required
The handle for the GitHub user account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_PERSON_FOLLOWED_BY_AUTH_USERChecks if the authenticated GitHub user follows a target GitHub user. Returns a structured response with is_following=True when following (HTTP 204), or is_following=False when not following (HTTP 404).

Input Parameters

string
required
The GitHub username (e.g., ‘octocat’) of the person to check. This is the user’s handle on GitHub.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_PRIVATE_VULNERABILITY_REPORTING_STATUSChecks if private vulnerability reporting is enabled for the specified repository.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_PUBLIC_ORGANIZATION_MEMBERSHIP_FOR_USERCheck whether a user is a public member of a GitHub organization. A 404 is reported as not a public member, but may also indicate that the user or organization does not exist.

Input Parameters

string
required
The organization name. The name is not case sensitive.
string
required
The handle for the GitHub user account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_REPOSITORY_STARREDCheck if a repository is starred by the authenticated user. Use this action when you need to verify whether the authenticated user has starred a specific repository. This is useful for confirming star status before performing star/unstar operations or displaying repository status.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_TEAM_PERMISSIONS_FOR_A_PROJECTChecks 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.

Input Parameters

string
required
The name of the organization. This is case-insensitive.
string
required
The slug (short name) of the team.
integer
required
The unique identifier of the project (classic).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_TEAM_PERMISSIONS_FOR_A_REPOSITORYChecks a team’s permissions for a specific repository within an organization, including permissions inherited from parent teams.

Input Parameters

string
required
The name of the organization. This field is not case-sensitive.
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The organization that owns the repository. For this GitHub API endpoint, this value must be the same as the org parameter. This field is not case-sensitive.
string
required
The URL-friendly slug for the team name. It is unique within the organization and typically all lowercase with hyphens instead of spaces.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CHECK_TOKENChecks 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. NOTE: This endpoint requires Basic Authentication using the OAuth App’s client_id as username and client_secret as password. The access_token parameter must be an OAuth token issued by the specified OAuth App.

Input Parameters

string
required
The unique client ID of your GitHub OAuth App (must match the app that issued the token being checked).
string
required
The OAuth access token issued by your OAuth App that you want to validate. Returns 404 if the token is invalid or not issued by this client_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CLEAR_PROJECT_V2_ITEM_FIELD_VALUETool to clear the value of a field for an item in a GitHub Project V2. Use when you need to remove or reset a field value (text, number, date, assignees, labels, single-select, iteration, or milestone fields).

Input Parameters

string
required
The global node ID of the project item to update (e.g., ‘PVTI_lAHOCNqc1s4BN3oqzgldG_w’). This identifies the specific item within the project whose field value will be cleared.
string
required
The global node ID of the field to clear (e.g., ‘PVTSSF_lAHOCNqc1s4BN3oqzg8vTnA’). Currently supports text, number, date, assignees, labels, single-select, iteration and milestone fields.
string
required
The global node ID of the Project (e.g., ‘PVT_kwHOCNqc1s4BN3oq’). This identifies the project containing the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CLEAR_REPOSITORY_CACHE_BY_KEYDeletes GitHub Actions caches from a repository matching a specific key and an optional Git ref, used to manage storage or clear outdated/corrupted caches; the action succeeds even if no matching caches are found to delete.

Input Parameters

string
required
The exact cache key used to identify specific caches for deletion. This key is often dynamically generated in workflows using expressions (e.g., ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}).
string
The full Git reference for narrowing down the cache deletion. For example, to target caches for a specific branch, use refs/heads/<branch_name>. To target caches for a pull request, use refs/pull/<pull_number>/merge. If omitted, caches matching the key across all refs are considered.
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CLEAR_SELF_HOSTED_RUNNER_ORG_LABELSRemoves all custom labels from a self-hosted runner for an organization; default labels (e.g., ‘self-hosted’, ‘linux’, ‘x64’) will remain.

Input Parameters

string
required
The name of the GitHub organization that owns the self-hosted runner (case-insensitive).
integer
required
Unique numeric identifier of the self-hosted runner. Can be obtained from listing runners for the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CLOSE_ISSUEClose a GitHub issue by setting its state to closed. Use this action when you need to mark an issue as resolved or no longer relevant. Optionally specify a reason for closing (completed or not_planned) to provide context.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The number that identifies the issue.
string ("completed" | "not_planned")
Reason for closing an issue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CLOSE_PULL_REQUESTCloses an open pull request without merging it. The pull request state is set to “closed” and it can be reopened later if needed. Use this action when you want to reject or abandon a pull request without merging the proposed changes into the base branch. You must have write access to the repository to close pull requests.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.
integer
required
The unique number that identifies the pull request within the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_COMMIT_MULTIPLE_FILESCreates, updates, or deletes repository files in a commit, with retries for non-fast-forward branch updates; a new branch in a nonempty repository requires a base branch. Empty repository initialization creates separate commits per file and may also write an initialization file to the default branch.

Input Parameters

string
required
Repository name (without .git extension)
boolean
Force update the branch reference. WARNING: Use with caution as this can overwrite commits. Only use this when you intentionally want to overwrite the branch history.
string
required
Repository owner (username or organization name)
object
Git author or committer information.
string
required
Target branch name to commit to. If this branch doesn’t exist, you MUST provide ‘base_branch’ to create it. For new feature branches (e.g., ‘fix/my-fix’, ‘feature/new-feature’), always set base_branch=‘main’ (or your default branch).
array
List of file paths to delete from the repository. Files must exist in the repository; attempting to delete non-existent files will result in an error. Ensure paths are exact with no leading/trailing whitespace.
string
required
Commit message describing the changes
array
List of files to create or update. Each entry requires path, content, and optional encoding (utf-8 or base64)
object
Git author or committer information.
string
REQUIRED when committing to a new branch that doesn’t exist yet. Specifies the existing branch to create the new branch from (e.g., ‘main’ or ‘master’). Not needed if ‘branch’ already exists in the repository.
integer
Maximum number of retries when encountering race conditions (422 ‘not a fast forward’ errors). The action will refetch the HEAD and rebase changes on each retry. Set to 0 to disable retries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_COMPARE_TWO_COMMITSCompares 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.

Input Parameters

integer
Page number of the results to fetch, for pagination when the number of differences (commits or files) is large.
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
string
required
A string specifying the base and head references to compare, in the format BASE...HEAD. BASE and HEAD can be branch names (e.g., main...develop), tag names (e.g., v1.0.0...v1.1.0), or commit SHAs (abbreviated or full 40-character format). Both abbreviated and full SHAs are accepted; full 40-character SHAs are recommended for reliability in large repositories. Both references must exist in the specified repository. To compare branches across forks in the same network, use the format OWNER:REF...OWNER:REF (e.g., octocat:main...another-user:main). Do NOT pass GitHub URLs - only plain reference strings like ‘main…develop’ are accepted.
integer
Number of results (e.g., files or commits) to return per page, with a maximum of 100, for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CONFIGURE_JIT_RUNNER_FOR_ORGGenerates a JIT configuration for a GitHub organization’s new self-hosted runner to run a single job then unregister; requires admin:org scope and the runner_group_id must exist in the organization.

Input Parameters

string
required
Name of the GitHub organization (case-insensitive).
string
required
Desired name for the new self-hosted runner, visible in the GitHub UI.
array
required
Custom labels to assign to the new self-hosted runner, used by GitHub Actions to route jobs. Minimum items: 1. Maximum items: 100.
string
Path to the working directory on the runner machine where jobs will execute, relative to the runner’s installation directory.
integer
required
ID of the runner group to assign the new self-hosted runner. Must exist in the organization. You can get runner group IDs by calling the ‘List self-hosted runner groups for an organization’ endpoint (GET /orgs/{org}/actions/runner-groups).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CONFIGURE_OIDC_SUBJECT_CLAIM_TEMPLATESets 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). This action customizes which claim keys are included in the OIDC subject claim for the specified organization. It allows for fine-tuning the content of the subject claim based on organizational needs.

Input Parameters

string
required
The GitHub organization name (case-insensitive).
array
required
Array of unique strings, each a valid claim key (e.g., ‘repo’, ‘actor’; alphanumeric/underscores only), to include in the OIDC subject claim (sub).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CONVERT_ORG_MEMBER_TO_OUTSIDE_COLLABORATORConverts a GitHub organization member to an outside collaborator with access restricted to explicitly granted repositories. The conversion can be requested asynchronously; queued and completed responses are both returned as empty results.

Input Parameters

string
required
The organization name (case-insensitive).
boolean
If true, performs the conversion asynchronously (API returns a 202 status when the job is successfully queued).
string
required
The GitHub username of the member to convert.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CONVERT_PULL_REQUEST_TO_DRAFTConverts an open pull request to draft status, indicating it is not ready for review. Use this action when you need to mark a PR as work-in-progress after it has been opened. Draft pull requests cannot be merged until they are marked as ready for review. This action is useful when additional work is needed before the PR can be reviewed or merged.

Input Parameters

string
required
The global Node ID of the pull request to convert to draft. Must be a valid GitHub pull request Node ID in the GraphQL format.
string
A unique identifier for the client performing the mutation. Used to track requests and match responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_BLOBCreates a Git blob in a repository, requiring content and encoding (‘utf-8’ or ‘base64’). Requires write access to the repository.

Input Parameters

string
required
The name of the repository, without the ‘.git’ extension. This field is not case-sensitive. The repository must exist and you must have write access to it.
string
required
The username or organization name that owns the repository. This field is not case-sensitive. You must have write access to the repository.
string
required
The content to be stored in the new blob.
string
The encoding for the ‘content’; “utf-8” or “base64”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_CHECK_RUNCreates 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. NOTE: This endpoint requires GitHub App authentication - OAuth tokens and personal access tokens cannot create check runs.

Input Parameters

string
required
The name of the check to be displayed in the GitHub UI. For example, “Code Coverage” or “Linter”.
string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository. This name is not case sensitive.
string ("queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending")
The current status of the check run. Only GitHub Actions can set status to waiting, pending, or requested.
array
A list of up to three action objects defining interactive buttons displayed on GitHub after the check run completes. Each object needs a label (button text), identifier (unique ID for the action), and description (tooltip). Clicking a button sends a check_run.requested_action webhook to your app.
string
required
The SHA of the commit for which the check run is created.
string ("action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out")
Required if completed_at is provided or if status is completed. Specifies the final outcome of the check (e.g., ‘success’, ‘failure’). Note: Setting conclusion automatically sets status to completed. GitHub alone can set a conclusion to stale.
string
The ISO 8601 timestamp (YYYY-MM-DDTHH:MM:SSZ) indicating when the check run began.
string
The URL of the integrator’s site providing full details of the check. If omitted, the GitHub App’s homepage is used. This URL is available from the check’s UI.
string
A unique identifier for the check run on the integrator’s system. This helps in correlating check runs between GitHub and the external system.
string
The ISO 8601 timestamp (YYYY-MM-DDTHH:MM:SSZ) indicating when the check run finished. Required if status is completed.
string
Detailed textual information about the check run’s output. Supports Markdown. Maximum length: 65,535 characters.
string
A descriptive title for the output of the check run, displayed in the GitHub UI. For example, ‘Linter Scan Summary’.
array
A list of image objects to display in the check run’s output in the GitHub UI. Each object requires alt (alternative text), image_url (URL of the image), and an optional caption.
string
A summary of the check run’s findings. Supports Markdown. Maximum length: 65,535 characters.
array
A list of annotation objects detailing issues at specific code locations. Annotations are visible in the ‘Checks’ and ‘Files changed’ tabs of a pull request. Each annotation object should specify path, start_line, end_line, annotation_level (‘notice’, ‘warning’, or ‘failure’), and message. Optional fields include start_column, end_column, title, and raw_details. Up to 50 annotations per API request; for more, use subsequent ‘Update a check run’ calls. GitHub Actions limits are 10 warnings and 10 errors per step.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_CHECK_SUITECreates a new check suite for a specific commit (head_sha) in an original repository (not a fork). IMPORTANT: This endpoint requires a GitHub App installation access token - OAuth tokens and classic personal access tokens cannot use this endpoint. GitHub dispatches a check_suite webhook event with the requested action upon success.

Input Parameters

string
required
Repository name, without the .git extension (case-insensitive).
string
required
Account owner of the repository (case-insensitive).
string
required
SHA of the commit for which to create the check suite, typically the head commit of a branch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_CODESPACE_FOR_THE_AUTHENTICATED_USERCreates 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)). This action allows users to set up a development environment quickly by creating a codespace from a specified repository or pull request.

Input Parameters

string
Git ref (branch, tag, or commit SHA) to use for the codespace.
object
Pull request to use as the source for the codespace.
integer
ID of the repository to create the codespace from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_CODESPACE_FROM_A_PULL_REQUESTCreates a GitHub Codespace for an open pull request in a Codespaces-enabled repository, with options to customize its configuration.

Input Parameters

string ("EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest")
Geographic area for this codespace (e.g., UsEast, EuropeWest); supersedes location. If unspecified, typically IP-derived.
string
required
The name of the repository, without the .git extension. This is case-insensitive.
string
required
The username of the account that owns the repository. This is case-insensitive.
string
Machine type for this codespace (e.g., standardLinux). Varies by CPU, RAM, storage. Uses default if unspecified.
string
Requested geographic location (e.g., EastUs, WestEurope). This parameter is deprecated; use geo. If unspecified, location may be IP-derived.
string
Client’s public IP address for location auto-detection if proxied and geo or location are not specified.
integer
required
The unique number identifying the pull request.
string
Custom name for the codespace.
string
Path to a devcontainer.json file in the repository that defines the development environment.
string
Working directory for the codespace upon opening. Defaults to the repository root if unspecified.
integer
Minutes of inactivity after which the codespace is automatically stopped. A default timeout applies if unspecified.
integer
Retention period in minutes (0-43200, i.e., up to 30 days) for a stopped codespace. 0 means immediate deletion.
boolean
Set to true to prevent GitHub from requesting additional repository permissions defined in devcontainer.json. Defaults to false (permissions will be requested).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_CODESPACE_IN_A_REPOSITORYCreates 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.

Input Parameters

string ("EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest")
Geographic area for the codespace, replacing location; determined by user IP if not specified.
string
Git reference (e.g., branch name) for the codespace; uses repository’s default branch if not provided.
string
required
Name of the repository, without the .git extension; not case-sensitive.
string
required
Username or organization name owning the repository; not case-sensitive.
string
Machine type (CPU, RAM, storage). See ‘List available machine types for a repository’ action for options; uses a default type if not specified.
string
Requested AWS region (best-effort, may differ); determined by user IP if not provided. Deprecated: use geo.
string
IP address to infer preferred region if location and geo are unspecified; useful for proxied requests.
string
Custom display name for the codespace; a default name is generated if not provided.
string
Path to a devcontainer.json in the repository; uses .devcontainer/devcontainer.json or devcontainer.json at root if not specified.
string
Directory to use as default when codespace opens; uses repository root if not specified.
integer
Minutes of inactivity before codespace auto-stops; uses a default timeout if not specified.
integer
Minutes an idle (stopped) codespace is retained before auto-deletion (0-43200, i.e., up to 30 days); uses a default period if not specified.
boolean
If true, opts out of granting multi-repository permissions from devcontainer.json. If unspecified or false, permissions are granted if requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_COMMITCreates a Git commit object in a GitHub repository using an existing tree SHA and optional existing parent commit SHAs. It does not update a branch reference.

Input Parameters

string
required
Name of the repository, without the .git extension (case-insensitive).
string
required
SHA of the tree object for this commit; must exist in the repository.
string
required
Account owner of the repository (case-insensitive).
string
required
The commit message.
array
SHAs of parent commits; all must exist in the repository. Omit or provide an empty list for a root commit.
string
ASCII-armored detached PGP signature over the commit data. GitHub adds this to the gpgsig header if provided.
string
Timestamp (ISO 8601: YYYY-MM-DDTHH:MM:SSZ) when the commit was authored.
string
Name of the commit’s author. Defaults to authenticated user if not provided.
string
Email of the commit’s author. Defaults to authenticated user if not provided.
string
Timestamp (ISO 8601: YYYY-MM-DDTHH:MM:SSZ) when the commit was committed. Defaults to author_date or current time.
string
Name of the committer. Defaults to author’s name or authenticated user if not provided.
string
Email of the committer. Defaults to author’s email or authenticated user if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_COMMIT_COMMENTCreates a comment on a specific commit, or on a specific line if path and position are provided.

Input Parameters

string
required
The text content of the comment.
integer
Deprecated: Use position instead. Line number in the file to comment on. position takes precedence if both are provided.
string
Relative path of the file to comment on. If specified, position is also required.
string
required
The name of the repository, without the .git extension.
string
required
The username or organization name that owns the repository.
integer
Line number in the diff’s patch to comment on, relative to the commit’s changes. Required if path is specified.
string
required
The SHA identifier of the commit to comment on.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_COMMIT_STATUSSets a commit’s status (e.g., error, failure, pending, success from CI/CD) for a given SHA; max 1000 statuses per SHA/context.

Input Parameters

string
required
SHA hash of the commit.
string
required
Repository name, without the .git extension (case-insensitive).
string
required
Username or organization name of the repository owner (case-insensitive).
string ("error" | "failure" | "pending" | "success")
required
State of the commit status, indicating check outcome or phase.
string
Label to differentiate this status from other systems (e.g., ‘ci/jenkins’); case-insensitive.
string
URL linking to the source of the status (e.g., CI build log), displayed in GitHub UI.
string
Human-readable description of the status, displayed in GitHub UI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_CUSTOM_ORGANIZATION_ROLECreates a custom role with defined permissions within a GitHub organization.

Input Parameters

string
required
Name of the GitHub organization (case-insensitive) where the custom role will be created.
string
required
Unique name for the custom role.
string
Optional short description of the custom role’s purpose or permissions.
array
required
List of fine-grained permission strings defining actions granted by this role. Use the List Organization Fine-Grained Permissions action to get available permissions for your organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_DEPLOY_KEYCreates a deploy key for a repository; the repository must exist and be accessible, and the provided key must be a valid public SSH key.

Input Parameters

string
required
The full public SSH key. Ensure this is the public key, not the private key.
string
required
The name of the repository, without the .git extension. This is not case sensitive.
string
required
The username of the account that owns the repository. This is not case sensitive.
string
A descriptive name for the new deploy key. If not provided, a default name will be generated.
boolean
If true, the deploy key will only have read access. If false (default), the key will have read and write access. Write access grants significant privileges.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_DEPLOYMENTCreates a GitHub deployment for an existing repository, targeting a specific ref (branch, tag, or SHA). By default, it may attempt to merge the default branch into the requested ref if it is behind.

Input Parameters

string
required
The ref to deploy. This can be a branch name, a tag name, or a commit SHA.
string
required
The name of the repository, without the .git extension. This name is not case-sensitive. The repository must exist and the authenticated user must have write access to it.
string
Specifies a task to execute, e.g., deploy or deploy:migrations.
string
required
The account owner of the repository. This name is not case-sensitive. The repository must exist and the authenticated user must have access to it.
string
A JSON string payload providing additional information that a deployment system might need, customizable based on the deployment process.
boolean
Attempts to automatically merge the default branch into the requested ref if the ref is behind the default branch. Set to false to disable.
string
A short description of the deployment. Maximum length of 1000 characters.
string
Name for the target deployment environment (e.g., production, staging, qa).
array
A list of status check contexts to verify against commit status checks before creating the deployment. If omitted or null, GitHub verifies all unique contexts. Pass an empty list [] to bypass all checks.
boolean
Specifies if the given environment is specific to this deployment and will no longer exist at some point in the future (e.g., a staging environment for a pull request). Set to true if the environment is temporary.
boolean
Specifies if the given environment is one that end-users directly interact with.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_DEPLOYMENT_BRANCH_POLICYCreates 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.

Input Parameters

string
required
Name pattern for deployable branches/tags (Ruby File.fnmatch syntax; * won’t match /, e.g., release/*/* for release/feature/login). Refer to Ruby File.fnmatch documentation.
string
required
Name of the repository, without the .git extension (not case sensitive).
string ("branch" | "tag")
Whether the policy targets a Git branch or a tag.
string
required
Account owner of the repository (not case sensitive).
string
required
Name of the target environment; URL-encode special characters (e.g., / as %2F).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_DEPLOYMENT_STATUSCreates a status for an existing deployment, updating its operational state, associated URLs, and description.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
string ("error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success")
required
State of the status. Setting a transient deployment to inactive shows it as destroyed in GitHub.
string
URL for deployment output. Preferred over target_url; setting this also sets target_url to the same value.
string
URL for deployment status updates or output. log_url is generally preferred.
string
Short description of the status (max 140 characters).
string
Name for the target deployment environment (e.g., production, staging). If unset, uses environment from previous status or deployment.
boolean
If true, sets prior successful, non-transient, non-production deployments in the same repository and environment to inactive.
integer
required
The unique identifier of the deployment for which to create a status.
string
URL for accessing the target deployment environment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_DISCUSSIONCreates a new discussion post on a specific team’s page within an organization.

Input Parameters

string
required
Name of the organization (not case-sensitive).
string
required
Main content of the discussion post, typically in markdown.
string
required
Title of the discussion post.
boolean
If true, post is private (visible only to team members, org owners, and team maintainers); false makes it public to all organization members.
string
required
URL-friendly version of the team name (slug).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_DISCUSSION_COMMENTCreates a new comment on an existing team discussion within a GitHub organization.

Input Parameters

string
required
The name of the organization. This name is not case-sensitive.
string
required
The content of the discussion comment. Supports GitHub Flavored Markdown.
string
required
The slug (URL-friendly version) of the team name.
integer
required
The unique number identifying the discussion within the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_FORKCreates a fork of an accessible repository, optionally into a specific organization, with a new name, or copying only the default branch.

Input Parameters

string
The desired name for the newly created fork. If not provided, the new fork will have the same name as the original repository.
string
required
The name of the repository, without the .git extension. This field is not case sensitive.
string
required
The username or organization name that owns the repository. This field is not case sensitive.
string
The GitHub organization name to fork the repository into. If not specified, the fork will be created in the authenticated user’s account.
boolean
Specifies whether to fork only the default branch of the repository. If True, only the default branch is copied. If False or not specified, all branches are copied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_GISTCreates a new gist on GitHub with provided files, an optional description, and public/secret visibility.

Input Parameters

string
required
JSON string representing content for the gist’s files. Dictionary where keys are filenames and values are objects, each having a content key with the file’s raw string data.
boolean
Indicates if the gist is public (true) or secret (false).
string
Optional description for the gist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_GIST_COMMENTCreates a new comment on a specified GitHub gist.

Input Parameters

string
required
The text of the comment to be posted on the gist.
string
required
The unique identifier of the gist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_GITHUB_APP_FROM_A_MANIFESTUse this action to 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. The code is provided via redirect URL after creating the app through GitHub’s web interface and must be used within 1 hour.

Input Parameters

string
required
The temporary authorization code provided by GitHub during the app manifest flow (received as a query parameter in the redirect URL). This single-use code must be exchanged within 1 hour of generation to retrieve the app’s configuration including credentials and private key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_GITHUB_PAGES_DEPLOYMENTCreates 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.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The account owner of the repository (e.g., a GitHub username or organization name). This field is not case-sensitive.
string
required
OIDC token from GitHub Actions for deployment authorization, typically from secrets.GITHUB_TOKEN with id-token: write permission.
integer
Identifier of a GitHub Actions artifact (e.g., .zip or .tar) with static assets for deployment. Artifact must belong to the repository. Either this or artifact_url is required.
string
Target environment for this GitHub Pages deployment. Defaults to github-pages.
string
URL of a GitHub Actions artifact (e.g., .zip or .tar) with static assets for deployment. Artifact must belong to the repository. Either this or artifact_id is required.
string
Unique string identifying the build version for this deployment, typically the Git commit SHA. Defaults to GITHUB_SHA.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_GITHUB_PAGES_SITECreates a GitHub Pages site for a repository, with a choice of build type and source location.

Input Parameters

string
required
The name of the repository, without the ‘.git’ extension. This field is case-insensitive.
string
required
The username or organization name that owns the repository. This field is case-insensitive.
string ("legacy" | "workflow")
Build process for the Pages site: ‘legacy’ (traditional GitHub Pages build) or ‘workflow’ (GitHub Actions). If omitted and source_branch is provided, defaults to ‘legacy’. When ‘workflow’, source_branch and source_path are ignored.
string ("/" | "/docs")
Directory within source_branch for site source files (e.g., ’/’ for root, ‘/docs’). Ignored if build_type is ‘workflow’.
string
The branch for GitHub Pages source (e.g., ‘main’, ‘gh-pages’). Required if build_type is ‘legacy’ or not specified. It is ignored if build_type is ‘workflow’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_LABELCreates a label in a specified GitHub repository, provided the repository exists and the user has write permissions. If the label name already exists, it may return a message instead of creating a label.

Input Parameters

string
required
The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji :strawberry:. For a full list of available emoji and codes, see the “Emoji cheat sheet.”
string
required
The name of the repository, without the .git extension. This is not case sensitive.
string
required
The hexadecimal color code for the label (e.g., f29513), without the leading #. Required parameter.
string
required
The username of the account that owns the repository. This is not case sensitive.
string
A short description of the label. Maximum 100 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_MILESTONECreates a milestone in a GitHub repository for tracking progress on issues or pull requests; requires repository existence and user write permissions.

Input Parameters

string
required
Repository name, without the .git extension (case-insensitive).
string
required
Username of the repository owner (case-insensitive).
string ("open" | "closed")
State of the milestone.
string
required
Title for the new milestone.
string
Due date for the milestone (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ).
string
Detailed description of the milestone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_AN_ENVIRONMENT_VARIABLECreates an encrypted environment variable for a pre-existing environment within a GitHub repository; will fail if the variable name already exists.

Input Parameters

string
required
The name of the environment variable to create (e.g., API_KEY).
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
string
required
The value of the environment variable (e.g., your_secret_token). This value will be encrypted.
string
required
The name of the environment for which to create the variable. The name must be URL encoded if it contains special characters (e.g., slashes / must be replaced with %2F).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_AN_ISSUECreates a new issue in a GitHub repository, requiring the repository to exist and have issues enabled; specific fields like assignees, milestone, or labels may require push access.

Input Parameters

string
The detailed textual contents of the new issue.
string
required
The name of the repository, without the .git extension (case-insensitive). The repository must exist, be accessible, and have issues enabled.
string
required
The GitHub account owner of the repository (case-insensitive). The repository must exist and be accessible to the authenticated user.
string
required
The title for the new issue.
array
Array of label names to associate with this issue (generally case-insensitive). NOTE: Only users with push access can set labels; they are silently dropped otherwise. Pass an empty list to clear all labels.
string
Login for the user to whom this issue should be assigned. NOTE: Only users with push access can set the assignee; it is silently dropped otherwise. This field is deprecated in favor of assignees.
array
GitHub login names for users to assign to this issue. NOTE: Only users with push access can set assignees; they are silently dropped otherwise.
string
The ID of the milestone to associate this issue with (e.g., “5”). NOTE: Only users with push access can set the milestone; it is silently dropped otherwise.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_AN_ISSUE_COMMENTCreates a new comment on an existing GitHub issue or pull request within the specified repository.

Input Parameters

string
required
Comment content in GitHub Flavored Markdown.
string
required
Name of the repository (without .git extension); not case-sensitive.
string
required
Account owner of the repository (username or organization); not case-sensitive.
integer
required
Number identifying the issue or pull request for the comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_AN_ORGANIZATION_PROJECTCreates a classic project board in a specified GitHub organization, with a name and optional description, for organizing project work. DEPRECATED: GitHub.com has disabled new classic project creation and sunset the classic REST API. Use GitHub Projects V2 instead.

Input Parameters

string
required
Name of the organization (not case-sensitive).
string
Body or description for the new project.
string
required
Name for the new project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_AN_ORGANIZATION_REPOSITORYCreates a new repository within a specified GitHub organization, with options for detailed configuration including visibility, features, merge strategies, initial commit, and templates.

Input Parameters

string
required
Name of the organization where the repository will be created (case-insensitive).
string
required
Name of the new repository.
boolean
Whether the repository is private. visibility takes precedence if both are set.
integer
ID of the team to grant access to this repository within the organization.
boolean
Enable wiki for this repository.
string
URL for the repository’s homepage.
boolean
Create an initial commit with an empty README.
boolean
Enable issues for this repository.
string ("public" | "private")
Repository visibility: ‘public’ (visible to everyone) or ‘private’ (visible to collaborators).
string
Short description of the repository.
boolean
Make this repository a template repository.
boolean
Enable projects for this repository. Fails if organization has disabled repository projects and this is true.
boolean
Enable downloads for this repository (deprecated).
boolean
Allow auto-merge on pull requests.
string
License template keyword (e.g., “mit”, “apache-2.0”). See GitHub license documentation for options.
string
JSON string containing custom properties for the repository as a key-value object. Example: ’{“project_lead”: “octocat”, “status”: “alpha”}’
boolean
Allow merging pull requests with a merge commit.
boolean
Allow rebase-merging pull requests.
boolean
Allow squash-merging pull requests.
string
Name of the .gitignore template to apply (e.g., “Python”, “Node”). Refer to the GitHub gitignore template list.
string ("PR_TITLE" | "MERGE_MESSAGE")
Default title for merge commits: ‘PR_TITLE’ or ‘MERGE_MESSAGE’.
string ("PR_BODY" | "PR_TITLE" | "BLANK")
Default message for merge commits: ‘PR_TITLE’, ‘PR_BODY’, or ‘BLANK’.
boolean
Automatically delete head branches when pull requests are merged. Requires organization owner privileges if true.
string ("PR_TITLE" | "COMMIT_OR_PR_TITLE")
Default title for squash merge commits: ‘PR_TITLE’ or ‘COMMIT_OR_PR_TITLE’.
string ("PR_BODY" | "COMMIT_MESSAGES" | "BLANK")
Default message for squash merge commits: ‘PR_BODY’, ‘COMMIT_MESSAGES’, or ‘BLANK’.
boolean
DEPRECATED: Use squash_merge_commit_title. Default to pull request title for squash-merge commits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_AN_ORGANIZATION_VARIABLECreates a new, uniquely named GitHub Actions variable for an organization, with configurable repository access visibility (all, private, or selected).

Input Parameters

string
required
The name of the GitHub organization. This name is not case-sensitive.
string
required
The name of the organization variable. Must be unique at the organization level.
string
required
The value of the organization variable.
string ("all" | "private" | "selected")
required
Controls which repositories in the organization can access the variable. Accepted values are ‘all’ (all repositories), ‘private’ (only private repositories), or ‘selected’ (specific repositories designated by selected_repository_ids).
array
A list of repository integer IDs that can access this organization variable. This field is required and only applicable when visibility is set to ‘selected’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_AN_ORGANIZATION_WEBHOOKCreates a webhook for a GitHub organization to deliver event notifications to a configured URL.

Input Parameters

string
required
The name of the GitHub organization. This name is not case-sensitive.
string
The name of the webhook. Must be “web” for organization webhooks. Defaults to “web”.
boolean
Boolean indicating if the webhook is active. true sends notifications, false does not. Defaults to true.
array
List of event names to trigger the webhook. Use ['*'] for all events. Defaults to ['push'] if not specified. See GitHub docs for event types.
string
required
Required. The target URL for webhook payload delivery. This URL is a mandatory part of the webhook’s config object and will receive POST requests for subscribed events.
string
Optional secret for generating an HMAC hex digest for payload verification (X-Hub-Signature-256 header). If provided, this is used as the key.
string
Password for basic authentication if the webhook endpoint (config_url) requires it, corresponding to config_username.
string
Username for basic authentication if the webhook endpoint (config_url) requires it. Use only if your endpoint is protected by basic auth.
string
The media type for serializing webhook payloads. Supported: json, form. GitHub API defaults to form if this field is not set or is None.
string
Controls SSL certificate verification for config_url. ‘1’ disables verification (not recommended), ‘0’ enables. GitHub API defaults to ‘0’ (verification enabled) if this field is not set or is None.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_PROJECT_CARDCreates a card in a GitHub Projects (classic) column, either as a note or linked to an issue or pull request. DEPRECATED: The Projects (classic) REST API has been sunset, and Projects (classic) was removed from GitHub Enterprise Server 3.17. Use the newer GitHub Projects instead.

Input Parameters

string
The text content for the card. Use this to create a note-only card. Either ‘note’ OR both ‘content_id’ and ‘content_type’ must be provided.
integer
required
The unique identifier of the project column where the card will be created. This value is used as a path parameter in the API request URL (e.g., /projects/columns/{column_id}/cards).
integer
The unique identifier of the issue or pull request to associate with this card. Required when content_type is specified. Get this from the issue/PR details (it’s the numeric ID, not the issue number).
string ("Issue" | "PullRequest")
Type of content to associate with the card.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_PROJECT_COLUMNCreates a named column in a GitHub Projects (classic) project to organize its cards. DEPRECATED: The Projects (classic) REST API has been sunset and this action no longer works on GitHub.com. Use GitHub Projects V2 with its GraphQL API instead.

Input Parameters

string
required
The name for the new project column.
integer
required
The unique identifier of the target GitHub project (classic) where the new column will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_PULL_REQUESTCreates a pull request in a GitHub repository, requiring existing base and head branches; title or issue must be provided.

Input Parameters

string
required
The name of the branch you want the changes pulled into. This must be an existing branch on the current (target) repository. You cannot submit a pull request to one repository that requests a merge to a base branch of another repository.
string
The detailed description or contents of the pull request.
string
required
The name of the branch where your changes are implemented. IMPORTANT: This branch must already exist in the repository (or fork) before calling this action. You must first create the branch and push commits to it (using git or the ‘Create a reference’ action), then create the PR. For cross-repository pull requests, namespace head with the source owner and branch, like username:branch.
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
boolean
Indicates whether the pull request should be created as a draft. Draft pull requests cannot be merged until marked as ready for review.
integer
The number of an existing issue in the repository to convert into a pull request. If provided, the issue’s title and body may be used for the pull request. Required if title is not specified.
string
required
The account owner of the repository. This name is not case-sensitive.
string
The title of the new pull request. Required unless issue is specified.
string
The name of the repository (e.g., ‘octocat/Hello-World’) where the changes in the pull request were made. This field is required for cross-repository pull requests if both the source and target repositories are owned by the same organization but are different repositories.
boolean
Indicates whether maintainers of the upstream repository can modify the pull request. This is primarily relevant for pull requests originating from forks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_REFERENCECreates a NEW Git reference (branch or tag) in a repository. IMPORTANT: This action ONLY creates NEW references - if the reference already exists, it will fail with a 422 ‘Reference already exists’ error. To update an existing reference, use the ‘Update a reference’ (GITHUB_UPDATE_A_REFERENCE) action instead. The repository must not be empty prior to this operation.

Input Parameters

string
required
Fully qualified reference to create (e.g., refs/heads/master, refs/tags/v1.0.0). Must start with refs/ and contain at least two slashes.
string
required
SHA-1 hash of an existing commit in the repository that the new reference will point to.
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_REGISTRATION_TOKEN_FOR_AN_ORGANIZATIONGenerates a temporary (one-hour) registration token to add a new self-hosted runner to an organization for GitHub Actions.

Input Parameters

string
required
The name of the organization. This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_REGISTRATION_TOKEN_FOR_A_REPOSITORYGenerates a time-limited token required to register a new self-hosted runner with a specific repository.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username of the account or the organization name that owns the repository. This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_RELEASECreates a release in a GitHub repository for a specified tag; the tag must be unique for published releases, and if a discussion_category_name is given, it must already exist.

Input Parameters

string
A detailed description of the release. Markdown formatting is supported.
string
The title of the release. If omitted and generate_release_notes is false, it defaults to the tag_name.
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
boolean
Set to true to create an unpublished (draft) release. Defaults to false.
string
required
The account owner of the repository (username or organization name). This field is not case-sensitive.
string
required
The name of the tag for this release. This tag must be unique for published releases.
boolean
Set to true to identify this release as a pre-release. Defaults to false.
string ("true" | "false" | "legacy")
Specifies if this release should be marked as the latest for the repository. Draft releases and prereleases cannot be set as ‘latest’.
string
Specifies the commitish value (e.g., branch name, tag name, or commit SHA) from which the Git tag is created. Defaults to the repository’s default branch if the tag specified in tag_name doesn’t exist yet.
boolean
Set to true to automatically generate the release title (name) and description (body) from the commit history since the last release. Defaults to false.
string
If specified, a new discussion will be created in this category and linked to the release. The category must already exist in the repository’s discussions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_REMOVE_TOKEN_FOR_AN_ORGANIZATIONGenerates a token, valid for one hour, to authenticate removing a self-hosted runner from an organization.

Input Parameters

string
required
The unique identifier or name of the GitHub organization. This name is not case-sensitive. For example, if your organization’s URL is github.com/my-org, ‘my-org’ is the value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_REMOVE_TOKEN_FOR_A_REPOSITORYGenerates a temporary (one-hour validity) token required to unregister and remove a self-hosted runner from a repository.

Input Parameters

string
required
Name of the repository, without the .git extension (not case-sensitive).
string
required
Username of the account owning the repository (not case-sensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_REPLY_FOR_A_REVIEW_COMMENTPosts 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.

Input Parameters

string
required
The text of the reply to the review comment.
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The unique identifier of the top-level review comment to which the reply is being made. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.
integer
required
The number that identifies the pull request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_REPOSITORY_DISPATCH_EVENTTriggers 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.

Input Parameters

string
required
The name of the repository, without the .git extension (not case-sensitive).
string
required
The account owner of the repository (not case-sensitive).
string
required
Custom webhook event name (100 characters or fewer).
string
JSON string containing extra information for the webhook event (max 10 top-level properties), passed to the triggered workflow or action. Example: ’{“ref”: “main”, “sha”: “abc123”}‘

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_REPOSITORY_FOR_THE_AUTHENTICATED_USERCreates a new repository for the authenticated user.

Input Parameters

string
required
The name of the repository. Must be unique within your account. Will be used in the repository URL (github.com/username/repo-name). Can only contain alphanumeric characters, hyphens, underscores, and periods.
boolean
Whether the repository is private (true) or public (false).
integer
The ID of the team to be granted access. Only valid if creating in an organization.
boolean
Whether the wiki is enabled.
string
A URL with more information about the repository.
boolean
Whether to initialize the repository with a README.
boolean
Whether issues are enabled.
string
A short description of the repository.
boolean
Whether this repository is a template repository.
boolean
Whether projects are enabled.
boolean
Whether downloads are enabled (deprecated by GitHub and may not be configurable).
boolean
Whether discussions are enabled.
boolean
Whether to allow auto-merge on pull requests.
string
SPDX license key identifier (lowercase). Examples: ‘mit’, ‘apache-2.0’, ‘gpl-3.0’. Must be one of the GitHub-supported licenses.
boolean
Whether to allow merging pull requests with a merge commit.
boolean
Whether to allow rebase-merging pull requests.
boolean
Whether to allow squash-merging pull requests.
string
Desired .gitignore template (e.g., ‘Python’, ‘Node’).
string ("PR_TITLE" | "MERGE_MESSAGE")
The default title for a merge commit. PR_TITLE uses the pull request’s title. MERGE_MESSAGE uses a classic title like ‘Merge pull request #123 from branch-name’. Required when merge_commit_message is set. Valid combinations: (PR_TITLE, PR_BODY), (PR_TITLE, BLANK), (MERGE_MESSAGE, PR_TITLE).
string ("PR_BODY" | "PR_TITLE" | "BLANK")
The default message for a merge commit. PR_BODY uses the pull request’s body. PR_TITLE uses the pull request’s title. BLANK results in a blank commit message. Valid combinations with merge_commit_title: (PR_TITLE, PR_BODY), (PR_TITLE, BLANK), (MERGE_MESSAGE, PR_TITLE).
boolean
Whether to automatically delete head branches when pull requests are merged.
string ("PR_TITLE" | "COMMIT_OR_PR_TITLE")
The default title for a squash merge commit. PR_TITLE uses the pull request’s title. COMMIT_OR_PR_TITLE uses the commit’s title (if only one commit) or the pull request’s title (if multiple commits).
string ("PR_BODY" | "COMMIT_MESSAGES" | "BLANK")
The default message for a squash merge commit. PR_BODY uses the pull request’s body. COMMIT_MESSAGES uses the branch’s commit messages. BLANK results in a blank commit message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_REPOSITORY_FROM_AN_UNPUBLISHED_CODESPACEPublishes the specified codespace to a new repository, using the codespace’s current state as the initial commit.

Input Parameters

string
The desired name for the new repository to be created from the codespace. If omitted, GitHub might generate a name (e.g., based on the codespace name).
boolean
Specifies the visibility of the new repository. Set to true for a private repository, or false for a public one. Defaults to false (public).
string
required
The unique name of the codespace to be published as a new repository. This codespace must exist, be unpublished, and belong to the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_REPOSITORY_PROJECTCreates a GitHub Projects V2 project owned by the repository owner and linked to the specified repository. A supplied project description is not applied during creation.

Input Parameters

string
An optional detailed description for the project board. Note: GitHub Projects V2 does not support a body/description field during creation, so this field is accepted but not used.
string
required
The name of the project board to be created.
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_REPOSITORY_RULESETCreates a uniquely named ruleset for a repository, defining rules for branches or tags with specified enforcement, conditions, and bypass actors.

Input Parameters

string
required
Unique name for the ruleset.
string
required
Name of the repository, without the .git extension (not case-sensitive).
string
required
Account owner of the repository (not case-sensitive).
string
Array of rule objects as a JSON string to be enforced. Each must have type and may have parameters. Refer to GitHub API docs for available rule types and parameters. Example: ’[{“type”: “creation”}, {“type”: “deletion”}]’
string ("branch" | "tag")
The target of the ruleset, whether it applies to branches or tags.
string ("disabled" | "active" | "evaluate")
required
Enforcement level: disabled (ruleset is not enforced), active (ruleset is enforced), or evaluate (test rules before enforcing; GitHub Enterprise only).
string
Actors that can bypass rules in this ruleset as a JSON string. Each actor object requires actor_id, actor_type (e.g., ‘Team’, ‘Integration’), and bypass_mode (e.g., ‘always’). Example: ’[{“actor_id”: 1, “actor_type”: “Team”, “bypass_mode”: “always”}]’
array
Ref names or patterns to exclude. Condition fails if any pattern matches the ref name.
array
Ref names/patterns to include. Condition passes if one pattern matches the ref name. Use ~DEFAULT_BRANCH for default branch, ~ALL for all branches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_REPOSITORY_USING_A_TEMPLATECreates a new repository from an existing template repository; the authenticated user must have access to the template and, if creating in an organization, repository creation permissions within it.

Input Parameters

string
required
The desired name for the new repository to be created.
string
The username or organization name that will own the new repository. Defaults to the authenticated user if not provided.
boolean
Set to true to create a private repository, or false to create a public repository.
string
A brief summary or description for the new repository.
string
required
The name of the template repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the template repository. This field is not case-sensitive.
boolean
Set to true to copy the directory structure and files from all branches of the template repository, not just the default branch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_REPOSITORY_VARIABLECreates a new, unencrypted variable in a repository for GitHub Actions workflows; fails if a variable with the same name already exists.

Input Parameters

string
required
The name of the variable to create. Variable names are case-sensitive and can only contain alphanumeric characters ([a-z], [A-Z], [0-9]) or underscores (_). They cannot start with the GITHUB_ prefix, and spaces are not allowed.
string
required
The name of the repository, without the .git extension. This field is not case sensitive.
string
required
The username or organization name that owns the repository. This field is not case sensitive.
string
required
The value of the variable. This will be stored as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_REPOSITORY_WEBHOOKCreates a webhook for a specified repository; requires admin permissions on the repository.

Input Parameters

string
Name of the webhook. Use web. This parameter currently only accepts web and defaults to web if not provided.
string
required
The name of the repository without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository. This name is not case sensitive.
boolean
Determines if notifications are sent when the webhook is triggered. true sends notifications (active), false disables them (inactive).
array
List of events to trigger the webhook (e.g., ['push'], ['issues']). See GitHub documentation for ‘webhook event payloads’.
string
The URL to which webhook payloads will be delivered via POST for subscribed events.
string
Optional secret string for HMAC hex digest in delivery signature headers, enhancing security. See GitHub’s ‘delivery signature headers’ documentation for details.
string
Media type for serializing payloads: json or form. Defaults to form if not specified. json delivers JSON, form delivers URL-encoded data.
string
Determines SSL certificate verification for the payload URL: “0” to verify SSL (recommended), or “1” to skip. Defaults to “0” (verify SSL) if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_REVIEW_COMMENT_FOR_A_PULL_REQUESTCreates a review comment on a pull request diff at a specific line or range, using a diff position, or as a reply to an existing review comment.

Input Parameters

string
required
Text content of the review comment.
integer
[LINE-BASED MODE] Line number in the diff for the comment. Required when using line-based mode (must be used with side). For multi-line comments, this is the last line of the range. Do not use with position or in_reply_to parameters.
string
required
Relative path of the file for the comment.
string
required
Repository name without the .git extension (not case sensitive).
string ("LEFT" | "RIGHT")
[LINE-BASED MODE] Side of the diff (LEFT or RIGHT) for the comment. Required when using line-based mode with the line parameter. For multi-line comments, refers to the last line of the range. Do not use with position or in_reply_to parameters. IMPORTANT: Use LEFT only for deletions that appear in red in the diff. Use RIGHT for additions (green) or unchanged context lines (white). Attempting to comment on LEFT side lines that are not visible deletions in the diff will result in a ‘could not be resolved’ error.
string
required
Account owner of the repository (not case sensitive).
integer
[DEPRECATED - Use line-based mode instead] Position in the diff hunk for the comment. When using position mode, do not provide line, side, start_line, start_side, or in_reply_to parameters.
string
required
SHA of the commit for the comment. Using an outdated commit_id can misplace the comment if lines change.
integer
[LINE-BASED MODE - MULTI-LINE] First line in the diff for a multi-line comment. Required when creating a multi-line comment (must be used with start_side, line, and side). Do not use with position or in_reply_to parameters.
string ("LEFT" | "RIGHT" | "side")
[LINE-BASED MODE - MULTI-LINE] Starting side of the diff (LEFT or RIGHT) for a multi-line comment. Required when creating a multi-line comment (must be used with start_line, line, and side). Do not use with position or in_reply_to parameters. IMPORTANT: Use LEFT only for deletions that appear in red in the diff. Use RIGHT for additions (green) or unchanged context lines (white). Attempting to use LEFT for lines that are not visible deletions will result in a ‘could not be resolved’ error.
integer
[REPLY MODE] ID of an existing review comment to reply to. When using reply mode, do not provide position, line, side, start_line, or start_side parameters as they will be ignored.
integer
required
Identifier of the pull request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_REVIEW_FOR_A_PULL_REQUESTCreates a pull request review, allowing approval, change requests, or comments; body is required if event is REQUEST_CHANGES or COMMENT, and omitting event makes the review PENDING.

Input Parameters

string
Review’s main body text; required if event is REQUEST_CHANGES or COMMENT.
string
required
Repository name, without the .git extension (case-insensitive).
string ("APPROVE" | "REQUEST_CHANGES" | "COMMENT")
Review action type (APPROVE, REQUEST_CHANGES, COMMENT); if omitted, review is PENDING and requires later submission.
string
required
Username of the account owning the repository (case-insensitive).
array
Inline draft review comments. Each object requires path (relative file path) and body (comment text). Optionally, specify line (or start_line for multi-line), and side (or start_side) for diff location. position is deprecated; use line. Example: [{'path': 'file.py', 'line': 10, 'body': 'Refactor this.'}]
string
SHA of the commit to review; defaults to the latest pull request commit. Outdated SHAs may lead to stale comments.
integer
required
Identifying number of the pull request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_SCOPED_ACCESS_TOKENCreates a repository-scoped and/or permission-scoped GitHub App user access token from a non-scoped user token. The endpoint requires Basic authentication with the app’s client ID and client secret; repository scope may be specified by names or IDs.

Input Parameters

string
Username or organization name for scoping the new token. Required if target_id is not provided.
string
required
Client ID of the GitHub App.
integer
ID of the user or organization for scoping the new token. Required if target is not provided.
string
required
User-to-server access token to be exchanged for a new scoped token.
array
Repository names to scope the new token to. Cannot be used if repository_ids is specified.
array
Repository IDs to scope the new token to. Cannot be used if repositories is specified.
string ("read" | "write")
Permission for GitHub Pages settings, statuses, configurations, builds, and creating new builds. Applies to target repositories.
string ("read" | "write")
Permission for checks on code (e.g., CI statuses). Applies to target repositories.
string ("read" | "write")
Permission for issues, comments, assignees, labels, and milestones. Applies to target repositories.
string ("read" | "write")
Permission for GitHub Actions workflows, workflow runs, and artifacts. Applies to target repositories.
string ("read" | "write")
Permission for organization members and teams. Applies to target organization.
string ("write")
Permission to manage profile settings for the user account. Applies to target user.
string ("read" | "write")
Permission for repository secrets (e.g., Actions secrets). Applies to target repositories.
string ("read" | "write")
Permission for repository contents, commits, branches, downloads, releases, and merges. Applies to target repositories.
string ("read" | "write")
Read-only permission for repository metadata, search, and collaborator listing. Applies to target repositories.
string ("read" | "write")
Permission for packages in GitHub Packages. Applies to target repositories or organization.
string ("read" | "write")
Permission to list and manage repositories a user is starring. Applies to target user.
string ("read" | "write")
Permission for commit statuses. Applies to target repositories.
string ("read" | "write")
Permission to manage followers for the user account. Applies to target user.
string ("read" | "write")
Permission to view and manage GPG keys for the user account. Applies to target user.
string ("write")
Permission for updating GitHub Actions workflow files. Requires contents: write. Applies to target repositories.
string ("read" | "write")
Permission for Codespaces. Applies to target user/organization if repositories are not specified, otherwise to target repositories.
string ("read" | "write")
Permission for deployments and deployment statuses. Applies to target repositories.
string ("read" | "write")
Permission for repository environments. Applies to target repositories.
string ("read" | "write")
Permission to access specific files in targeted repositories. The file paths must be configured in the GitHub App settings.
string ("read" | "write")
Permission for repository administration (settings, teams, collaborators). Applies to target repositories.
string ("read" | "write")
Permission to manage Git SSH keys for the user account. Applies to target user.
string ("read" | "write")
Permission for pull requests, comments, assignees, labels, milestones, and merges. Applies to target repositories.
string ("read" | "write")
Permission to manage email addresses for the user account. Applies to target user.
string ("read" | "write")
Permission for security events (e.g., code scanning alerts). Applies to target repositories.
string ("read" | "write")
Permission for repository webhooks. Applies to target repositories.
string ("read" | "write")
Permission for team discussions and related comments. Applies to target organization.
string ("read")
Read-only permission for viewing an organization’s billing plan. Applies to target organization.
string ("read" | "write")
Permission for Dependabot secrets for targeted repositories.
string ("read" | "write")
Permission to view and manage interaction limits on a repository. Applies to target repositories or organization.
string ("read" | "write")
Permission for organization webhooks. Applies to target organization.
string ("read")
Read-only permission to view organization audit log events. Applies to target organization.
string ("read" | "write" | "admin")
Permission for repository projects, columns, and cards. Applies to target repositories.
string ("read" | "write")
Permission for organization-level secrets (e.g., Actions secrets). Applies to target organization.
string ("read" | "write")
Permission for Dependabot alerts. Applies to target repositories.
string ("read" | "write")
Permission for organization-level GitHub Packages. Applies to target organization.
string ("read" | "write" | "admin")
Permission for organization projects and projects beta (if available). Applies to target organization.
string ("read" | "write")
Permission for secret scanning alerts. Applies to target repositories.
string ("read" | "write")
Permission for custom repository roles within an organization. Applies to target organization.
string ("read" | "write")
Permission for administrative settings of an organization. Applies to target organization.
string ("read" | "write")
Permission for viewing and managing users blocked by the organization. Applies to target organization.
string ("read" | "write")
Permission to view and edit repository custom properties, if allowed by property definition. Applies to target repositories.
string ("read" | "write")
Permission for custom organization roles. Applies to target organization.
string ("read" | "write" | "admin")
Permission for custom properties for an organization. Applies to target organization.
string ("read" | "write")
Permission to view and manage organization announcement banners. Applies to target organization.
string ("read" | "write")
Permission for GitHub Actions self-hosted runners for an organization. Applies to target organization.
string ("read" | "write")
Permission for fine-grained personal access tokens requested by organization members. Applies to target organization.
string ("write")
Permission for GitHub Copilot seat assignments for organization members (beta). Applies to target organization.
string ("read" | "write")
Permission for requests for fine-grained personal access tokens within an organization. Applies to target organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_SNAPSHOT_OF_DEPENDENCIES_FOR_A_REPOSITORYCreates a snapshot of a repository’s dependencies to populate the GitHub dependency graph and enable security alerts; sha must be a 40-character commit ID, ref a fully qualified Git reference (e.g., refs/heads/main), and scanned an ISO 8601 timestamp.

Input Parameters

string
required
Git reference (fully qualified, e.g., refs/heads/main) of the repository branch/tag that triggered this snapshot.
string
required
Commit SHA (maximum 40 characters) associated with this dependency snapshot.
string
required
Repository name, without .git extension (name is not case-sensitive).
string
required
Account owner of the repository (name is not case-sensitive).
string
Optional external ID of the job that generated this snapshot.
string
required
UTC timestamp (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ) when the snapshot was taken.
integer
required
Version of the dependency snapshot submission, typically of the manifest or lock file format.
string
Optional user-defined metadata as a JSON string for domain-specific information. Limited to 8 keys with scalar values (e.g., string, number, boolean). Example: ’{“key1”: “value1”, “key2”: 123}’
string
Optional collection of package manifests as a JSON string (e.g., package-lock.json, pom.xml). Keys are manifest file names; values detail dependencies. Example: ’{“package-lock.json”: {“name”: ”…”, “resolved”: {…}}}’
string
Optional URL of the detector tool used.
string
Optional name of the tool used to detect dependencies.
string
Optional URL for the job that generated this snapshot.
string
Optional string to group snapshots. For a given job.correlator and detector.name, only the ‘latest’ snapshot is current. Useful to distinguish detection runs (e.g., concatenating GITHUB_WORKFLOW and GITHUB_JOB).
string
Optional version of the detector tool used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_TAG_OBJECTCreates an annotated Git tag object in a repository, pointing to an existing commit, tree, or blob identified by its SHA and specified type.

Input Parameters

string
required
The name of the tag, typically a version identifier (e.g., “v0.0.1”).
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string ("commit" | "tree" | "blob")
required
The type of the Git object being tagged.
string
required
The account owner of the repository. This name is not case-sensitive.
string
required
The SHA of the Git object (commit, tree, or blob) that this tag is pointing to.
string
required
The message associated with the tag.
string
The timestamp for when this object was tagged. This should be in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
string
The name of the person creating the tag.
string
The email address of the person creating the tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_TAG_PROTECTION_STATE_FOR_A_REPOSITORYCreates a legacy tag protection rule for a repository, using a glob pattern to select protected tags. DEPRECATED: GitHub sunset the tag protection API on GitHub.com and says it returns null data; use GITHUB_CREATE_A_REPOSITORY_RULESET to protect tags with repository rulesets instead.

Input Parameters

string
required
The name of the repository without the .git extension. Not case sensitive.
string
required
The account owner of the repository (username or organization name). Not case sensitive.
string
required
Glob pattern to protect tags. Examples: v1.* (protects tags starting with v1.), * (protects all tags).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_TEAMCreates a new team in an organization, optionally with maintainers, repositories, specific privacy, notification settings, or a parent team; if parent_team_id is given, privacy must be ‘closed’.

Input Parameters

string
required
Organization name where the team will be created (not case-sensitive).
string
required
Name of the new team.
string ("secret" | "closed")
Team privacy: ‘secret’ (visible to owners and members) or ‘closed’ (visible to all org members). Defaults to ‘secret’ for non-nested teams; must be ‘closed’ if parent_team_id is set.
string ("pull" | "push")
Deprecated. Default repository permission (‘pull’ for read access, ‘push’ for write access) for the team.
array
Repository full names (e.g., “org-name/repo-name”) for team access; repositories must exist and be accessible to the organization.
string
Team’s purpose or focus.
array
GitHub user handles of organization members to be team maintainers; users must be organization members.
integer
ID of an existing team to be the parent, creating a nested team. If provided, new team privacy must be ‘closed’.
string ("notifications_enabled" | "notifications_disabled")
Notification settings for @mentions: ‘notifications_enabled’ (members notified) or ‘notifications_disabled’ (no one notified). Default: ‘notifications_enabled’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_TEMPORARY_PRIVATE_FORKCreates 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; the fork may take up to 5 minutes to become accessible.

Input Parameters

string
required
Name of the repository, without the .git extension; not case-sensitive.
string
required
Account owner (username or organization) of the repository; not case-sensitive.
string
required
Identifier for the GitHub Security Advisory (e.g., GHSA-rfv9-x7w6-39px) that the fork will address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_TREECreates a new Git tree object in a repository, defining file/directory structure by specifying tree entries, optionally building on a base_tree SHA; all provided SHAs must be valid.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
array
required
Array of objects defining the tree structure. Each object (node) requires path (string), mode (string; e.g., ‘100644’ file, ‘100755’ executable, ‘040000’ subdirectory/tree, ‘160000’ submodule, ‘120000’ symlink), and type (string: ‘blob’, ‘tree’, or ‘commit’). For new/updated blobs, provide content (UTF-8 string). For existing objects or tree/commit types, provide sha (string). To delete, specify path, mode, type, and set sha to null.
string
required
The account owner of the repository. The name is not case sensitive.
string
SHA1 of an existing Git tree object to use as a base. If provided, its entries are combined with tree entries, where tree entries overwrite those from base_tree with the same path. Typically the SHA1 of the latest commit’s tree for new branch changes. If omitted, the new tree is built from tree entries; files from the parent commit’s tree not in tree are treated as deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_USER_PROJECTCreates a GitHub Projects V2 project board for the authenticated user using the GraphQL API. An optional project description is accepted but not applied during creation.

Input Parameters

string
Optional description for the new project. Note: GitHub Projects V2 does not support a body/description field during creation, so this field is accepted but not used.
string
required
Name/title for the new project. This will be displayed as the project board title.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_A_WORKFLOW_DISPATCH_EVENTManually triggers a GitHub Actions workflow identified by workflow_id at a given ref, if the workflow is configured to accept workflow_dispatch events.

Input Parameters

string
required
Git reference (branch or tag) for the workflow.
string
required
Repository name, excluding the .git extension (case-insensitive).
string
required
Owner of the repository (username or organization, case-insensitive).
string
JSON string containing key-value inputs for the workflow, matching on.workflow_dispatch.inputs definitions (max 10); uses workflow defaults if omitted. Example: ’{“actor”: “mona”, “environment”: “production”}’
string
required
Identifier of the workflow: numeric ID or just the filename (e.g., ‘main.yml’). If a full path like ‘.github/workflows/main.yml’ is provided, the prefix is automatically stripped.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_BRANCHCreates a new branch in a GitHub repository pointing to a specified commit. Use this action when you need to create a new branch from an existing commit SHA. IMPORTANT: This action only creates NEW branches. If the branch already exists, it will fail with a 422 ‘Reference already exists’ error. The repository must not be empty (must have at least one commit) before creating a branch.

Input Parameters

string
required
The SHA-1 hash of the commit that the new branch will point to. This must be an existing commit in the repository (40-character hexadecimal string).
string
required
The name of the repository without the .git extension. This field is not case-sensitive.
string
required
The account owner of the repository (username or organization name). This field is not case-sensitive.
string
required
The name of the new branch to create (e.g., ‘feature-branch’, ‘fix-bug-123’). Do not include ‘refs/heads/’ prefix - just provide the branch name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_COMMIT_SIGNATURE_PROTECTIONEnables commit signature protection for a specified branch, requiring all new commits to be signed.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
string
required
The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_DEPLOYMENT_PROTECTION_RULEEnables a custom deployment protection rule for an existing environment in a repository by linking a configured GitHub App (via integration_id) to control deployments.

Input Parameters

string
required
The name of the repository where the environment exists. Do not include the .git extension. This name is not case sensitive.
string
required
The GitHub username or organization name that owns the repository. This name is not case sensitive.
integer
The unique identifier of the GitHub App that provides the custom deployment protection rule. This app must be installed and configured for the repository. Required - use GITHUB_LIST_ENVIRONMENT_CUSTOM_DEPLOYMENT_RULES to find available integration IDs for your environment.
string
required
The name of the environment to which the protection rule will be applied. This name must be URL-encoded if it contains special characters (e.g., slashes / should be replaced with %2F).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_DRAFT_ITEM_FOR_USER_PROJECTCreates a draft issue item in a user-owned GitHub ProjectsV2. Use when you need to add a new draft item to track ideas or tasks in a user’s project.

Input Parameters

string
The body content of the draft issue item to create in the project.
string
required
The title of the draft issue item to create in the project.
string
required
The handle for the GitHub user account.
integer
required
The project’s number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_INFERENCE_CHAT_COMPLETIONSTool to create chat completions using GitHub Models inference API. Use when you need to generate AI-powered text responses using models like GPT-4, Claude, or Llama through GitHub’s inference endpoint.

Input Parameters

integer
If specified, the system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result.
array
Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.
string
required
ID of the specific model to use for the request. Format: {publisher}/{model_name}, e.g., openai/gpt-4o, anthropic/claude-3.5-sonnet.
array
A list of tools (functions) the model may call. The model will choose when and how to call these functions based on the conversation context.
number
An alternative to temperature called nucleus sampling. Range: [0.0, 1.0]. The model considers tokens with top_p probability mass.
boolean
If true, partial message deltas will be sent as data-only server-sent events as they become available.
array
required
The collection of context messages associated with this chat completion request. Each message must have a role (assistant, developer, system, or user) and content.
integer
Maximum number of tokens to generate in the completion. The total length of input tokens and generated tokens is limited by the model’s context length.
array
List of supported modalities for this request. Supported values: text, audio.
number
Controls the apparent creativity of generated completions. Range: [0.0, 1.0]. Lower values make output more deterministic, higher values more random.
string ("auto" | "required" | "none")
Controls which (if any) tool is called by the model.
object
Options for streaming responses.
object
Specifies the format of the model’s output.
number
Influences probability of generated tokens appearing based on whether they appear in the text so far. Range: [-2.0, 2.0]. Positive values increase likelihood of new topics.
number
Influences probability of generated tokens appearing based on their cumulative frequency in the text so far. Range: [-2.0, 2.0]. Positive values decrease likelihood of repetition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_INFERENCE_EMBEDDINGSTool to create inference embeddings using GitHub’s AI models. Use when you need to convert text into vector representations for similarity search, clustering, or other ML tasks.

Input Parameters

string
A unique identifier representing your end-user, which can help monitor and detect abuse.
string
required
Input text to embed, encoded as a string or array of strings. Each string will be converted to an embedding vector.
string
required
ID of the specific model to use for the request. Format: {publisher}/{model_name}
integer
The number of dimensions the resulting output embeddings should have. Must be supported by the model (max 2048).
string
Format for embeddings: ‘float’ (default) or ‘base64’. Float returns arrays of numbers, base64 returns encoded strings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_ISSUE_TYPECreate a new issue type for a GitHub organization. Requires the authenticated user to be an organization administrator. OAuth tokens need admin:org scope.

Input Parameters

string
required
The organization name (case-insensitive).
string
required
The name of the issue type.
string ("gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple")
The color of the issue type.
boolean
required
Whether the issue type is enabled at the organization level.
string
A short description of the issue type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_JIT_RUNNER_CONFIGGenerates a temporary Just-In-Time (JIT) configuration for a new self-hosted GitHub Actions runner for a repository; any specified non-default runner_group_id must be an existing runner group accessible by the repository.

Input Parameters

string
required
The desired name for the new self-hosted runner.
string
required
The name of the repository, without the ‘.git’ extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
array
required
A list of custom labels to assign to the runner. These labels help in targeting specific runners for jobs. Minimum items: 1. Maximum items: 100.
string
The working directory for the runner, relative to its installation path. This is where job execution will take place.
integer
required
The unique identifier of the runner group to which the new runner will be assigned. Use 0 for the default group or the ID of a specific runner group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_OR_UPDATE_AN_ENVIRONMENTCreates a new environment or updates an existing one in a GitHub repository, allowing configuration of deployment protection rules such as wait timers and reviewers; ensure environment_name is URL-encoded if it contains special characters.

Input Parameters

string
required
Name of the repository, without the .git extension (not case-sensitive).
string
required
The username or organization name of the repository owner (not case-sensitive).
string
JSON string containing up to 6 users or teams allowed to review deployments. Reviewers need at least read access; one approval suffices. Each reviewer object requires id and type (‘User’ or ‘Team’). Example: ’[{“id”: 4532, “type”: “User”}]’
integer
Time in minutes to delay a job after it’s triggered (0-43,200, i.e., up to 30 days).
string
required
Name of the environment. URL-encode if it contains special characters (e.g., ’/’ becomes ‘%2F’).
boolean
If true, prevents the user who triggered deployment from approving their own job.
boolean
If true, only branches with existing protection rules can deploy; deployment_branch_policy_custom_branch_policies must then be false.
boolean
If true, deployment is restricted to branches matching custom name patterns; deployment_branch_policy_protected_branches must then be false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_OR_UPDATE_AN_ENVIRONMENT_SECRETCreates or updates an environment secret with an encrypted_value that was encrypted using the public key identified by key_id for the specified environment.

Input Parameters

string
required
The name of the repository. Not case-sensitive.
string
required
The account owner of the repository. Not case-sensitive.
string
required
ID of the public key used for encryption, obtained from the ‘Get an environment public key’ GitHub API endpoint.
string
required
Name of the secret. Case-sensitive.
string
required
Value of the secret, encrypted with LibSodium using the public key obtained from the ‘Get an environment public key’ GitHub API endpoint for the target environment.
string
required
Name of the environment. Case-sensitive; URL-encode special characters (e.g., / becomes %2F).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_OR_UPDATE_AN_ORGANIZATION_SECRETCreates or updates an organization secret for GitHub Actions, requiring its value to be pre-encrypted via LibSodium using the organization’s public key.

Input Parameters

string
required
The organization name. The name is not case sensitive.
string
required
ID of the public key (from ‘Get an organization public key’ endpoint) used for encryption. This is required for both creating and updating secrets.
string ("all" | "private" | "selected")
required
Controls which repositories can access the secret. If ‘selected’, selected_repository_ids must be provided.
string
required
The name of the secret.
string
required
Value for the secret, pre-encrypted using LibSodium with the organization’s public key (obtained from ‘Get an organization public key’ endpoint). This is required for both creating and updating secrets.
array
List of repository IDs that can access this secret. Required and only applicable when visibility is ‘selected’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_OR_UPDATE_A_REPOSITORY_SECRETCreates or updates a GitHub Actions secret within a specific repository; use encrypted_value and key_id to set or change its value.

Input Parameters

string
required
The repository name, without the .git extension (case-insensitive).
string
required
The repository owner’s username or organization name (case-insensitive).
string
ID of the public key used to encrypt encrypted_value (obtained with the public key). Required if encrypted_value is provided.
string
required
The name for the secret being created or updated. Must not start with ‘GITHUB_’ prefix (reserved for GitHub internal secrets).
string
Value for the secret, pre-encrypted with the repository’s public key using LibSodium (public key is obtained via ‘Get a repository public key’ endpoint).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_OR_UPDATE_A_SECRET_FOR_THE_AUTHENTICATED_USERCreates or updates a Codespaces secret for the authenticated user, optionally restricting access to selected repositories. Accepts plaintext and encrypts it using the user’s GitHub public key, or accepts a pre-encrypted value with its key ID.

Input Parameters

string
ID of the public key (from GitHub’s ‘Get public key for the authenticated user’ endpoint) used to encrypt encrypted_value. If not provided, it will be fetched automatically.
string
required
The name of the secret. This name must be unique among the user’s Codespaces secrets.
string
The plaintext value for your secret. This will be automatically encrypted using the user’s Codespaces public key before being sent to GitHub. If you already have an encrypted value, use the encrypted_value parameter instead.
string
Secret’s value, encrypted using LibSodium with the public key (see key_id) obtained from GitHub’s ‘Get public key for the authenticated user’ endpoint.
array
Repository IDs that can access this secret. If omitted or empty, accessible to all user’s Codespaces-enabled repositories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_OR_UPDATE_CUSTOM_PROPERTIES_FOR_AN_ORGCreates new custom property schemas or updates existing ones in bulk for a specified organization; each property definition must include property_name and value_type.

Input Parameters

string
required
The case-insensitive organization name.
string
required
Definitions for custom properties as a JSON string. Each must include a unique property_name (max 75 chars, no spaces) and value_type. Optional: description, required, default_value, allowed_values (for ‘single_select’ type).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_OR_UPDATE_CUSTOM_PROPERTY_ORGCreates a new custom property (name must be unique for creation) or updates an existing one for an organization to define metadata for its repositories.

Input Parameters

string
required
The organization’s unique identifier (case-insensitive).
boolean
If true, property must be set for all repositories and default_value is mandatory.
string ("string" | "single_select" | "multi_select" | "true_false" | "url")
required
Data type of the custom property. Can be ‘string’ (free text), ‘single_select’ (single choice from list), ‘multi_select’ (multiple choices from list), ‘true_false’ (boolean), or ‘url’ (URL format).
string
Explanation of the custom property’s purpose.
string
Default value if property isn’t set. For single_select type, must be one of allowed_values. Can be a string for single values or an array for multi_select.
array
Ordered list of allowed values (up to 200). Required and non-empty if value_type is single_select or multi_select.
string ("org_actors" | "org_and_repo_actors")
Who can edit the values of the property. Can be ‘org_actors’ (organization actors only) or ‘org_and_repo_actors’ (organization and repository actors).
string
required
Name of the custom property (case-sensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_OR_UPDATE_FILE_CONTENTSCreates or updates a file in a GitHub repository with a commit message and supplied content. A missing non-default branch may result in the change being committed to the repository’s default branch. Content may be supplied as plain text or Base64.

Input Parameters

string
The blob SHA of the file being replaced. Automatically fetched if not provided. If a 409 conflict occurs (SHA mismatch due to concurrent modifications), the action will automatically retry up to 5 times with exponential backoff and jitter.
string
required
The full path to the file in the repository, including the filename and extension. Do not include leading slashes.
string
required
The name of the repository (not case sensitive, without the .git extension).
string
required
The account owner of the repository (not case sensitive).
string
The branch name. Defaults to the repository’s default branch if omitted. If a non-existent branch is specified, the action will automatically fall back to the repository’s default branch. For empty repositories, omitting this parameter is recommended to let GitHub initialize with the repository’s configured default branch.
string
required
The new file content. Can be provided as plain text (will be automatically encoded to Base64) or as Base64-encoded text. GitHub API requires Base64 encoding, which this action handles automatically.
string
required
The commit message for this file creation or update.
string
Author’s timestamp (ISO 8601 format). Defaults to committer’s date if author details are provided but date is not.
string
Author’s name. If specified, author_email is also required. Defaults to committer details; if all committer/author details omitted, GitHub uses authenticated user.
string
Author’s email. If specified, author_name is also required. Defaults to committer details; if all committer/author details omitted, GitHub uses authenticated user.
string
Committer’s commit timestamp (ISO 8601 format). Defaults to current time if committer details are provided but date is not.
string
Committer’s name. If specified, committer_email is also required. GitHub uses authenticated user if all committer/author details omitted.
string
Committer’s email. If specified, committer_name is also required. GitHub uses authenticated user if all committer/author details omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_OR_UPDATE_GITHUB_PAGES_SITEEnables or updates GitHub Pages configuration for a repository, including source, custom domain and HTTPS settings. The build type defaults to legacy, which requires a source branch even when updating an existing site.

Input Parameters

string
required
The name of the repository without the .git extension. Not case-sensitive.
string
Custom domain for the Pages site (e.g., ‘example.com’). Set to null to remove custom domain. Only used during updates.
string
required
The account owner of the repository (username or organization). Not case-sensitive.
string ("legacy" | "workflow")
Build process type: ‘legacy’ for traditional GitHub Pages build from a branch, ‘workflow’ for GitHub Actions. When ‘workflow’, source_branch and source_path are ignored.
string ("/" | "/docs")
The directory path within source_branch containing the site files: ’/’ for root or ‘/docs’ for docs folder. Ignored if build_type is ‘workflow’.
string
The repository branch to use for GitHub Pages source (e.g., ‘main’, ‘gh-pages’). Required if build_type is ‘legacy’. Ignored if build_type is ‘workflow’.
boolean
Whether to enforce HTTPS for the Pages site. Only used during updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_OR_UPDATE_REPO_SECRET_WITH_ENCRYPTED_VALUECreates 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. This action allows you to securely manage secrets for a given repository, ensuring that sensitive data remains protected during the update process. By providing the encrypted value alongside the key ID, you can seamlessly maintain the necessary credentials for your repository’s operations.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository (e.g., a GitHub username or organization name). This name is not case-sensitive.
string
The ID of the public key that was used to encrypt the secret value. This ID is retrieved from GitHub along with the public key via the ‘Get a repository public key’ endpoint for Dependabot secrets. If not provided or if an outdated key_id is used, the action will automatically fetch the latest public key from GitHub and retry with the current key_id.
string
required
The name of the Dependabot secret to create or update.
string
Value for your secret. This value must be encrypted with LibSodium, using the public key retrieved from the GitHub API’s ‘Get a repository public key’ endpoint for Dependabot secrets. The resulting encrypted string is typically Base64 encoded.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_REACTION_FOR_A_COMMIT_COMMENTCreates an emoji reaction for a commit comment; if the user has already reacted with the same content, details of the existing reaction are returned.

Input Parameters

string
required
Name of the repository, without the .git extension. Not case-sensitive.
string
required
Username of the repository owner. Not case-sensitive.
string ("+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes")
required
The reaction type to add to the commit comment.
integer
required
Unique ID of the commit comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_REACTION_FOR_AN_ISSUECreates a reaction for a specified issue within a GitHub repository.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case-sensitive.
string
required
The account owner of the repository. The name is not case-sensitive.
string ("+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes")
required
The reaction type to add to the issue. See the GitHub documentation on reactions for full details.
integer
required
The number that identifies the issue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_REACTION_FOR_AN_ISSUE_COMMENTCreates a reaction for a specific comment on an issue within a GitHub repository.

Input Parameters

string
required
Name of the repository, without the .git extension (not case-sensitive).
string
required
Username of the account that owns the repository (not case-sensitive).
string ("+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes")
required
Reaction content to add to the issue comment. Must be one of the values from ContentEnm.
integer
required
Unique identifier of the issue comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_REACTION_FOR_A_PULL_REQUEST_REVIEW_COMMENTAdds a specified reaction to a pull request review comment within a GitHub repository.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is case-insensitive.
string
required
The username or organization name that owns the repository. This field is case-insensitive.
string ("+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes")
required
The reaction to add. See the GitHub API documentation on reactions for more context on reactions.
integer
required
The unique identifier of the pull request review comment to which the reaction will be added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_REACTION_FOR_A_RELEASECreates an emoji reaction for a specific, existing release in a GitHub repository.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username of the account that owns the repository. This field is not case-sensitive.
string ("+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes")
required
The type of reaction to add to the release.
integer
required
The unique identifier (ID) of the release to add a reaction to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_REACTION_FOR_A_TEAM_DISCUSSIONCreates a reaction for a team discussion within a GitHub organization.

Input Parameters

string
required
The name of the GitHub organization. This field is not case-sensitive.
string ("+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes")
required
The reaction content to add to the team discussion.
string
required
The slug (URL-friendly version) of the team name.
integer
required
The unique number identifying the team discussion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_REACTION_FOR_A_TEAM_DISCUSSION_COMMENTAdds a reaction to a team discussion comment, requiring the specified organization, team, discussion, and comment to exist.

Input Parameters

string
required
The organization name on GitHub. This name is not case sensitive.
string ("+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes")
required
The type of reaction to add to the team discussion comment. For more information on reaction types, see the GitHub API documentation on reactions.
string
required
The slug (URL-friendly version) of the team name.
integer
required
The unique number identifying the comment within the discussion.
integer
required
The unique number identifying the team discussion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_REPOSITORYCreates a new repository for the authenticated user. Use this action when you need to create a new GitHub repository under the authenticated user’s account. The repository name must be unique for the user, and various settings can be configured such as visibility (public/private), enabled features (issues, wiki, projects), and merge options.

Input Parameters

string
required
The name of the repository.
boolean
Whether the repository is private. Default is false (public).
boolean
Whether the wiki is enabled. Default is true.
string
A URL with more information about the repository.
boolean
Whether the repository is initialized with a minimal README. Default is false.
boolean
Whether issues are enabled. Default is true.
string
A short description of the repository.
boolean
Whether this repository acts as a template that can be used to generate new repositories. Default is false.
boolean
Whether projects are enabled. Default is true.
boolean
Whether downloads are enabled. Default is true.
boolean
Whether discussions are enabled. Default is false.
boolean
Whether to allow Auto-merge to be used on pull requests. Default is false.
string
The license keyword of the open source license for this repository.
boolean
Whether to allow merge commits for pull requests. Default is true.
boolean
Whether to allow rebase merges for pull requests. Default is true.
boolean
Whether to allow squash merges for pull requests. Default is true.
string
The desired language or platform to apply to the .gitignore.
string
Required when using merge_commit_message. The default value for a merge commit title: PR_TITLE (default to the pull request’s title) or MERGE_MESSAGE (default to the classic title for a merge message).
string
The default value for a merge commit message: PR_BODY (default to the pull request’s body), PR_TITLE (default to the pull request’s title), or BLANK (default to a blank commit message).
boolean
Whether to delete head branches when pull requests are merged. Default is false.
string
Required when using squash_merge_commit_message. The default value for a squash merge commit title: PR_TITLE (default to the pull request’s title) or COMMIT_OR_PR_TITLE (default to the commit’s title if only one commit or the pull request’s title when more than one commit).
string
The default value for a squash merge commit message: PR_BODY (default to the pull request’s body), COMMIT_MESSAGES (default to the branch’s commit messages), or BLANK (default to a blank commit message).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_SPONSORSHIPTool to start a new GitHub sponsorship or reactivate a past sponsorship using GraphQL. Use when you need to sponsor a maintainer through GitHub Sponsors with a specified amount and privacy level.

Input Parameters

integer
required
The amount to sponsor in cents (USD). For example, 500 cents equals $5.00.
string
The global node ID of the user or organization acting as sponsor (e.g., ‘U_kgDOABCDEF’). Required if sponsor_login is not provided.
boolean
Whether the sponsorship is recurring (true) or one-time (false). Note: one-time payments currently have a known bug in the GitHub API and may not work as expected.
string ("PRIVATE" | "PUBLIC")
Privacy level for GitHub sponsorships
string
The username of the sponsoring user or organization. Required if sponsor_id is not provided.
string
The global node ID of the user or organization to sponsor (e.g., ‘U_kgDOMNOPQR’). Required if sponsorable_login is not provided.
string
The username of the user or organization to sponsor. Required if sponsorable_id is not provided.
string
A unique identifier for the client performing the mutation. Used to ensure idempotency of mutations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_SPONSORS_TIERCreate a GitHub Sponsors payment tier for a specified user or organization using GraphQL, with an amount and description.

Input Parameters

integer
required
The monthly sponsorship amount in dollars (USD). This value will be converted to cents internally (e.g., 5 for $5/month becomes 500 cents, 500 for $500/month becomes 50000 cents). Minimum is $1.
string
required
A detailed description of what this sponsorship tier provides. Explain the benefits and perks sponsors will receive at this level. This is a required field.
string
required
The global node ID of the user or organization who will receive sponsorships for this tier (e.g., ‘U_kgDOABCDEF’ for users, ‘O_kgDOGHIJKL’ for organizations). Use the get_viewer_graphql_id action to fetch your own ID.
string
A unique identifier for the client performing the mutation. Used to ensure idempotency of mutations and track request origin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_UPDATE_ORG_SECRET_WITH_LIB_SODIUMCreates 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.

Input Parameters

string
required
The organization name (case-insensitive).
string
ID of the Dependabot public key used for encryption (retrieved from ‘Get an organization public key for Dependabot’ endpoint: GET /orgs/{org}/dependabot/secrets/public-key). Required if encrypted_value is provided.
string ("all" | "private" | "selected")
required
Secret visibility: all (all repositories), private (private repositories), or selected (specific repositories designated by selected_repository_ids).
string
required
The secret name (case-insensitive and unique within the organization).
string
Value of the secret, encrypted using LibSodium and the organization’s Dependabot public key (obtained from the ‘Get an organization public key for Dependabot’ endpoint: GET /orgs/{org}/dependabot/secrets/public-key). Required to create or update the secret’s value.
array
List of repository IDs that can access the secret; required and used only when visibility is selected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_USER_LISTTool to create a new user list on GitHub. Use when you need to organize and group GitHub users for easier tracking and management.

Input Parameters

string
required
The name of the user list to create.
string
A description for the user list to provide context about its purpose.
string
A unique identifier for the client performing the mutation. This can be used to track the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_CREATE_VIEW_FOR_USER_PROJECTTool to create a new view in a user-owned GitHub project (Projects V2). Use when you need to add a customized view with specific layout, filters, and visible fields to organize project items. Note: This action works with GitHub Projects V2. The view can be configured with different layouts (table, board, roadmap) and optional filters. The visible_fields parameter is not applicable to roadmap layouts.

Input Parameters

string
required
The name of the view to be created.
string
The filter query for the view. See GitHub’s filtering projects documentation for syntax details.
string ("table" | "board" | "roadmap")
required
The layout type for the view. Options are ‘table’, ‘board’, or ‘roadmap’.
string
required
The unique identifier of the user who owns the project. This can be the username or user login.
integer
required
The project’s number as displayed in the project URL.
array
List of field IDs that should be visible in the view. Not applicable to roadmap layout. If not provided, default visible fields will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DECLINE_A_REPOSITORY_INVITATIONDeclines a specific, pending repository invitation for the authenticated user, identified by its invitation_id.

Input Parameters

integer
required
Identifier of the pending repository invitation to decline; obtained by listing the user’s pending invitations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_ACCESS_RESTRICTIONSRemoves all user, team, and app-based access restrictions from a protected branch.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The account owner of the repository (username or organization name). This field is not case-sensitive.
string
required
The name of the branch from which to remove access restrictions. Wildcard characters are not supported; for wildcard usage, refer to the GitHub GraphQL API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_ADMIN_BRANCH_PROTECTIONRemoves admin enforcement from a protected branch (branch name cannot contain wildcard characters) in a repository.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
string
required
The name of the branch. Cannot contain wildcard characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_FILEDeletes a file by path from a GitHub repository. The file’s blob SHA is automatically fetched if not provided.

Input Parameters

string
Blob SHA of the file being deleted. Optional - if not provided, it will be automatically fetched from the file at the given path.
string
required
Path to the file to be deleted within the repository.
string
required
The name of the repository, without the .git extension (not case-sensitive).
string
required
The account owner of the repository (not case-sensitive).
string
Branch from which the file will be deleted; defaults to the repository’s default branch.
string
required
Commit message for the deletion.
string
Name of the commit author for the deletion; defaults to the committer’s name.
string
Email address of the commit author for the deletion; defaults to the committer’s email.
string
Name of the user committing the deletion; defaults to the authenticated user’s name.
string
Email address of the user committing the deletion; defaults to the authenticated user’s email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_PACKAGE_VERSION_FOR_THE_AUTHENTICATED_USERDeletes an existing package version associated with the authenticated user.

Input Parameters

string
required
The unique name of the package.
string
required
Type of the package. E.g., maven for GitHub Gradle registry, container for ghcr.io images. The docker type covers images from docker.pkg.github.com (including migrated ones).
integer
required
The unique numeric identifier of the specific package version to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_APP_AUTHORIZATIONDeletes a user’s OAuth application grant, revoking the associated tokens for that application. Identify the grant with an access token issued by the app; GitHub requires the app’s client ID and client secret for Basic Authentication.

Input Parameters

string
required
The client ID of your OAuth App. This must be YOUR OAuth App that you own, as this endpoint requires the app’s client_secret for authentication.
string
required
An OAuth access token that was issued by your OAuth App (specified by client_id). Providing this token will revoke ALL tokens for that user’s grant, not just this single token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_APP_TOKENRevokes a specified OAuth access token issued by an OAuth App or a GitHub App with OAuth authorization. GitHub requires Basic Authentication using the app’s client ID and client secret for this operation.

Input Parameters

string
required
The client ID of the OAuth App or GitHub App with OAuth authorization.
string
required
The OAuth access token to be revoked. Must be a token issued by this OAuth App.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_REFERENCEDeletes a Git reference from a repository. Branch names may be supplied without a prefix; they are treated as branch references.

Input Parameters

string
required
The Git reference to delete. Accepts multiple formats: ‘refs/heads/branch-name’, ‘heads/branch-name’, or just ‘branch-name’ for branches; ‘refs/tags/tag-name’ or ‘tags/tag-name’ for tags. Simple branch names are automatically prefixed with ‘heads/’.
string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository. This name is not case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_RELEASEPermanently deletes a specific release, its assets, and potentially its associated Git tag from a repository.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The account owner of the repository, typically a username or organization name. This field is not case-sensitive.
integer
required
The unique numerical identifier (ID) of the release to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_RELEASE_ASSETDeletes a specific release asset from a GitHub repository; this action is idempotent.

Input Parameters

string
required
The name of the repository, without the .git extension; not case-sensitive.
string
required
The account owner of the repository (username or organization); not case-sensitive.
integer
required
The unique identifier of the release asset to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_RELEASE_REACTIONDeletes a reaction from a GitHub release, provided the repository, release, and reaction exist.

Input Parameters

string
required
The name of the repository, without the .git extension (case-insensitive).
string
required
The account owner of the repository (case-insensitive).
integer
required
Unique identifier of the release.
integer
required
Unique identifier of the reaction to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_REPOSITORYPermanently deletes the specified repository; this is a destructive, irreversible action that requires admin privileges for the repository.

Input Parameters

string
required
The name of the repository, without the .git extension; case-insensitive.
string
required
The account owner of the repository (user or organization); case-insensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_REPOSITORY_INVITATIONDeletes a specified repository invitation.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is case-insensitive.
string
required
The username or organization name that owns the repository. This field is case-insensitive.
integer
required
The unique numerical identifier of the repository invitation to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_REPOSITORY_RULESETPermanently deletes a repository ruleset.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username of the account that owns the repository. This field is not case-sensitive.
integer
required
The unique identifier (ID) of the ruleset to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_REPOSITORY_SECRETDeletes a named GitHub Actions secret from a specified repository; this operation is destructive and idempotent, and requires the repository to exist.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The account owner of the repository. This is typically the username or organization name and is not case-sensitive.
string
required
The name of the secret to delete. This refers to a secret used in GitHub Actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_REPOSITORY_SUBSCRIPTIONDeletes the authenticated user’s subscription to a specified repository if it exists, effectively ‘unwatching’ it.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository (e.g., a GitHub username or organization name). This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_REPOSITORY_VARIABLEDeletes a named variable (e.g., for GitHub Actions workflows) from a repository; the repository and the variable must already exist.

Input Parameters

string
required
The name of the repository variable to delete.
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_REPOSITORY_WEBHOOKDeletes a specific webhook from a repository.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository. This name is not case sensitive.
integer
required
The unique identifier of the webhook. This ID can be found in the X-GitHub-Hook-ID header of a webhook delivery.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_REVIEW_COMMENT_FOR_A_PULL_REQUESTDeletes a specific pull request review comment.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
integer
required
The unique numerical identifier of the pull request review comment to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_ARTIFACTDeletes a GitHub artifact by its ID within a repository, typically resulting in an empty response (HTTP 204 No Content) on success.

Input Parameters

string
required
Name of the repository, without the .git extension; not case-sensitive.
string
required
Account owner of the repository (user or organization); not case-sensitive.
integer
required
Unique ID of the artifact to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_SECRET_FOR_THE_AUTHENTICATED_USERDeletes an existing Codespaces secret for the authenticated user by secret_name. This is a destructive and irreversible operation. Returns 404 if the secret does not exist.

Input Parameters

string
required
Name of the Codespaces secret to delete. Case-sensitive; allows alphanumeric characters or underscores; must not start with GITHUB_ or contain spaces.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_SELF_HOSTED_RUNNER_FROM_AN_ORGANIZATIONRemoves a self-hosted runner from a GitHub organization, including when its machine no longer exists, immediately disconnecting it from GitHub Actions. Requires organization admin access and appropriate authorization; successful deletion returns a success message.

Input Parameters

string
required
Organization name (not case-sensitive).
integer
required
Unique ID of the self-hosted runner to remove (obtainable by listing organization runners).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_SELF_HOSTED_RUNNER_FROM_A_REPOSITORYRemoves a specific self-hosted runner (by runner_id) from a repository, if registered there; this is idempotent.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
Unique identifier of the self-hosted runner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_TAG_PROTECTION_STATE_FOR_A_REPOSITORYAttempts to delete a repository tag protection rule by ID using GitHub’s tag protection API, sunset on August 30, 2024. The response reports the HTTP status and a message, including for 404 and 410 responses.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The unique identifier of the tag protection to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_TEAMDeletes a team (and any child teams) from an organization.

Input Parameters

string
required
The organization’s unique identifier (case-insensitive).
string
required
The team’s URL-friendly slug.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_THREAD_SUBSCRIPTIONCall this to mute a specific notification thread by deleting the user’s subscription; notifications may still occur if the user is @mentioned, comments, or due to repository watch settings.

Input Parameters

integer
required
The unique identifier of the notification thread. This ID is obtained from other API calls, such as when listing notifications (e.g., via the GET /notifications endpoint). Ensure this ID refers to an active thread to which the user is currently subscribed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_A_WORKFLOW_RUNDeletes a specific workflow run from a repository.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The unique identifier of the workflow run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_BRANCH_PROTECTIONRemoves all protection rules from a specific branch in a GitHub repository; the branch must currently have protection rules enabled.

Input Parameters

string
required
The name of the repository, without the .git extension. Not case sensitive.
string
required
The account owner of the repository. Not case sensitive.
string
required
The name of the branch. Wildcard characters are not supported for this REST API endpoint; use the GitHub GraphQL API for wildcard support.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_CODE_SCANNING_ANALYSISDeletes a specific code scanning analysis by its ID from a repository; confirm_delete must be true if it’s the last analysis of its type for a given tool and reference to prevent data loss.

Input Parameters

string
required
Name of the repository without the .git extension (not case sensitive).
string
required
Account owner of the repository (not case sensitive).
integer
required
Unique identifier of the code scanning analysis to delete, typically obtained by listing analyses.
string
Pass the string true to confirm deletion when this is the last analysis of its type for a specific tool and reference. Required to avoid a 400 error when deleting the final analysis in a set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_CODESPACEDeletes a specific codespace owned by the authenticated user; this is a destructive action and the codespace must exist.

Input Parameters

string
required
The unique name of the codespace to be deleted. This can be the system-generated name (e.g., ‘monalisa-octocat-g4v9wxj96hp’) or a user-defined display name if it’s unique for the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_COMMIT_COMMENTDeletes a specific commit comment, identified by its comment_id, from the specified repository; the comment must exist.

Input Parameters

string
required
The name of the repository, excluding the .git extension. This value is not case-sensitive.
string
required
The username or organization name that owns the repository. This value is not case-sensitive.
integer
required
The unique numerical identifier of the commit comment to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_COMMIT_COMMENT_REACTIONDeletes a reaction from a commit comment in a GitHub repository.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The unique identifier of the commit comment from which the reaction will be deleted.
integer
required
The unique identifier of the reaction to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_COMMIT_SIGNATURE_PROTECTIONDisables GPG commit signature protection for a specific branch in a GitHub repository, meaning commits pushed to this branch no longer require GPG signing.

Input Parameters

string
required
The name of the repository, without the .git extension. The name is not case-sensitive.
string
required
The account owner of the repository. This is typically the username of the owner (for personal repositories) or the organization name (for organization-owned repositories). The name is not case-sensitive.
string
required
The name of the branch for which commit signature protection will be disabled. Wildcard characters are not supported in the branch name. To use wildcards, refer to the GitHub GraphQL API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_CUSTOM_ORGANIZATION_ROLEDeletes a custom organization role (which should not be actively assigned) by its ID; a 204 No Content response indicates success.

Input Parameters

string
required
The organization name (not case-sensitive).
integer
required
Unique ID of the custom role to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_DEPENDEBOT_SECRET_BY_NAMEDeletes a specific Dependabot secret, identified by its name, from a given repository if both the repository and secret exist.

Input Parameters

string
required
The name of the repository without the .git extension. This field is not case-sensitive.
string
required
The account owner of the repository (e.g., username or organization name). This field is not case-sensitive.
string
required
The name of the Dependabot secret to delete. Secret names are case-sensitive and can only contain alphanumeric characters ([A-Z], [a-z], [0-9]) or underscores (_); spaces are not allowed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_DEPLOY_KEYDeletes a specific deploy key from a repository; to change a key’s properties or access scope, the existing key must be deleted and a new one created.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository. This name is not case sensitive.
integer
required
The unique identifier (ID) of the deploy key to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_DEPLOYMENTPermanently deletes a specified inactive deployment from a repository.

Input Parameters

string
required
Repository name, without the .git extension (case-insensitive).
string
required
Username of the account owning the repository (case-insensitive).
integer
required
Unique identifier of the deployment to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_DEPLOYMENT_BRANCH_POLICYDeletes a specific deployment branch or tag policy, identified by its ID, from a given environment within a repository.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The unique identifier of the branch policy.
string
required
The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_DISCUSSIONDeletes a specific team discussion, identified by its number, from an organization’s team.

Input Parameters

string
required
Case-insensitive name of the organization.
string
required
URL-friendly version (slug) of the team name.
integer
required
The unique number identifying the discussion to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_DISCUSSION_COMMENTDeletes a specific comment from an existing team discussion within an organization, provided the specified organization, team, discussion, and comment all exist.

Input Parameters

string
required
The organization name (not case sensitive).
string
required
The slug of the team name (URL-friendly version).
integer
required
Unique number identifying the comment.
integer
required
Unique number identifying the discussion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_EMAIL_ADDRESSAttempts to delete specified email addresses from the authenticated user’s GitHub account.

Input Parameters

array
required
Array of email addresses to delete from the authenticated user account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_ENVIRONMENTDeletes an existing deployment environment from an existing repository.

Input Parameters

string
required
The name of the repository, without the .git extension. This is not case sensitive.
string
required
The username or organization name that owns the repository. This is not case sensitive.
string
required
The name of the environment to delete. The name must be URL encoded; for example, slashes (/) should be replaced with %2F.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_ENVIRONMENT_SECRETDeletes an existing and accessible secret from a specified environment within a GitHub repository, returning an empty dictionary on success or error details otherwise.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
string
required
The name of the secret to be deleted. GitHub stores and processes secret names as uppercase (e.g., my_secret becomes MY_SECRET).
string
required
The name of the environment from which the secret will be deleted. This name must be URL-encoded if it contains special characters (e.g., slashes / should be replaced with %2F).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_ENVIRONMENT_VARIABLEDeletes a named environment variable from a specified, existing environment within a GitHub repository.

Input Parameters

string
required
The name of the environment variable to delete.
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
string
required
The name of the environment. Must be URL-encoded if it contains special characters (e.g., slashes / should be %2F).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_GISTPermanently deletes an existing GitHub gist, specified by its gist_id; this action is destructive and cannot be undone.

Input Parameters

string
required
The unique identifier of the gist to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_GIST_COMMENTDeletes a specific comment from a GitHub Gist using its gist_id and comment_id.

Input Parameters

string
required
The unique identifier of the Gist from which the comment will be deleted.
integer
required
The unique identifier of the comment to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_GITHUB_ACTIONS_CACHE_BY_IDDeletes a specific GitHub Actions cache from a repository using its unique cache_id.

Input Parameters

string
required
The name of the repository, without the .git extension.
string
required
The username or organization name that owns the repository.
integer
required
The unique ID of the GitHub Actions cache to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_GITHUB_PAGES_SITEDeletes the GitHub Pages site for the specified repository; completes without error if no site is currently enabled.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository (e.g., a user or organization). This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_ISSUE_COMMENTPermanently deletes a specific comment by its ID from an issue or pull request, if the repository exists and the comment ID is valid.

Input Parameters

string
required
Name of the repository, without the .git extension (case-insensitive).
string
required
Username of the account owning the repository (case-insensitive).
integer
required
Unique identifier of the comment to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_ISSUE_COMMENT_REACTIONDeletes a reaction from an issue comment in a repository; the repository, comment, and reaction must exist.

Input Parameters

string
required
The name of the repository, without the .git extension. This is not case-sensitive.
string
required
The username of the account that owns the repository. This is not case-sensitive.
integer
required
The unique numeric identifier for the issue comment from which the reaction will be deleted.
integer
required
The unique numeric identifier for the reaction to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_ISSUE_REACTIONPermanently removes a specific reaction from an issue in a GitHub repository.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The unique identifier of the reaction to be deleted.
integer
required
The unique number identifying the issue from which the reaction will be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_LABELPermanently removes an existing label from a repository.

Input Parameters

string
required
The name of the label to delete. Label names are case-insensitive. If the label name contains spaces or special characters, ensure it is correctly URL-encoded (e.g., ‘help wanted’ becomes ‘help%20wanted’).
string
required
REQUIRED. The name of the repository, without the .git extension. Must be provided together with ‘owner’ to identify the repository (e.g., for ‘github.com/octocat/Hello-World’, repo is ‘Hello-World’). This field is not case-sensitive.
string
required
REQUIRED. The username or organization name that owns the repository. GitHub repositories are identified by owner/repo (e.g., ‘octocat/Hello-World’), so both ‘owner’ and ‘repo’ must be provided together. This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_MILESTONEDeletes the specified milestone if it exists; this operation is idempotent, typically returning a 404 if the milestone is not found or already deleted.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The username or organization name that owns the repository. This name is not case-sensitive.
integer
required
The unique number that identifies the milestone to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_ORGANIZATIONDeletes a GitHub organization and its repositories; this is a destructive action and the organization name will be unavailable for reuse for approximately 90 days.

Input Parameters

string
required
The unique name of the organization to be deleted. This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_ORGANIZATION_SECRETPermanently deletes a GitHub Actions secret from a GitHub organization, making it unavailable to workflows.

Input Parameters

string
required
The name of the organization. This name is not case-sensitive.
string
required
The name of the secret to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_ORGANIZATION_VARIABLEDeletes a named GitHub Actions variable from a specified organization.

Input Parameters

string
required
The name of the organization. This parameter is not case-sensitive.
string
required
The name of the organization variable to delete. This parameter is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_ORGANIZATION_WEBHOOKDeletes a specific webhook, identified by hook_id, from an existing organization.

Input Parameters

string
required
The name of the organization. This field is not case-sensitive.
integer
required
The unique identifier of the webhook. This ID can be retrieved from the X-GitHub-Hook-ID header in a webhook delivery or by listing organization webhooks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_ORG_CODESPACERequests deletion of a specified organization member’s codespace. A successful response may indicate that deletion was accepted and is still in progress; a not-modified response is also reported as successful.

Input Parameters

string
required
The organization’s name (case-insensitive).
string
required
GitHub username of the user owning the codespace.
string
required
Unique name of the codespace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_ORG_PACKAGEDeletes a specific package in an organization; public packages with over 5,000 downloads cannot be deleted. Authentication, permission and not-found errors can be returned as response messages rather than raised.

Input Parameters

string
required
Name of the organization owning the package (not case-sensitive).
string
required
Unique name of the package to be deleted.
string ("npm" | "maven" | "rubygems" | "docker" | "nuget" | "container")
required
Type of the package to be deleted. Packages in GitHub’s Gradle registry have type maven. Docker images in GitHub’s Container registry (ghcr.io) have type container. Use type docker for images previously in GitHub’s Docker registry (docker.pkg.github.com), even if migrated to the Container registry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_PACKAGEPermanently deletes a specific package owned by the authenticated user; public packages downloaded over 5,000 times cannot be deleted via this API. A 404 is returned with success set to false rather than raised.

Input Parameters

string
required
The unique name of the package to delete. For npm: supports scoped packages like ‘@scope/name’. For maven: use format ‘com.example.package’. For container/docker: use image name like ‘my-app’. The name must match exactly as it appears in the GitHub Packages registry.
string
required
The type of package to delete. Supported types: ‘npm’ (Node.js packages), ‘maven’ (Java/Gradle packages), ‘rubygems’ (Ruby gems), ‘docker’ (legacy Docker images from docker.pkg.github.com), ‘nuget’ (.NET packages), ‘container’ (Docker images from ghcr.io). Note: GitHub Gradle packages use ‘maven’ type; ghcr.io images use ‘container’ type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_PACKAGE_VERSIONTool to delete a package version using GitHub GraphQL API. Use when you need to remove a specific version of a package by its global node ID.

Input Parameters

string
A unique identifier for the client performing the mutation. Used to ensure idempotency of mutations.
string
required
The global node ID of the package version to delete (e.g., ‘MDEyOlBhY2thZ2VWZXJzaW9uMQ==’). This is the GraphQL ID, not the numeric REST API ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_PACKAGE_VERSION_FOR_AN_ORGANIZATIONDeletes a specific package version within an organization; requires admin permissions for packages with over 5,000 downloads.

Input Parameters

string
required
Organization name (case-insensitive).
string
required
Name of the package.
string ("npm" | "maven" | "rubygems" | "docker" | "nuget" | "container")
required
Package ecosystem. Notes: - maven: For GitHub’s Gradle registry packages. - container: For Docker images in GitHub’s Container registry (ghcr.io). - docker: For images originally in GitHub’s Docker registry (docker.pkg.github.com), including migrated ones.
integer
required
Unique ID of the package version to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_PACKAGE_VERSION_FOR_A_USERDeletes a specific version of a package owned by the specified user. The response indicates whether deletion succeeded; authentication, permission, and not-found errors are returned as unsuccessful results.

Input Parameters

string
required
The GitHub username of the account that owns the package.
string
required
The name of the package to which the version belongs.
string
required
The type of the package. Supported types include npm, maven, rubygems, docker, nuget, and container. Packages in GitHub’s Gradle registry use the maven type. Docker images in GitHub’s Container registry (ghcr.io) use the container type. The docker type can be used for images previously in GitHub’s Docker registry (docker.pkg.github.com), even if migrated.
integer
required
The unique identifier of the package version to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_PENDING_REVIEWDeletes a pending (unsubmitted) review from a pull request; this is only possible if the review has not yet been submitted.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.
integer
required
The unique identifier of the pending review to be deleted.
integer
required
The number that identifies the pull request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_PROJECTDeletes the specified GitHub project (Projects V2) using the GraphQL API. Note: This action uses GitHub’s Projects V2 GraphQL API. The legacy Projects (classic) REST API was sunset on April 1, 2025 and is no longer available. The project is permanently deleted and cannot be recovered. The user must have admin permissions for the project to delete it.

Input Parameters

string
required
The unique GraphQL node ID of the project to be deleted (e.g., ‘PVT_kwDOBcMqx84ABdPx’). This is returned from project creation or listing operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_PROJECT_CARDDeletes a project card from a GitHub ‘Project (classic)’; this operation is idempotent. DEPRECATION NOTICE: GitHub Classic Projects (V1) and its REST API were sunset on April 1, 2025. This action may return a 404 error on GitHub.com. For new projects, use GitHub Projects V2 which uses the GraphQL API instead. See: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/

Input Parameters

integer
required
The unique numerical identifier of the project card to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_PROJECT_COLUMNDeletes a project field (column) from a GitHub Projects V2 project using the GraphQL API. IMPORTANT: GitHub Classic Projects REST API was sunset on April 1, 2025. This action now uses the GitHub Projects V2 GraphQL API with the deleteProjectV2Field mutation. Note: The built-in Status field cannot be deleted as it is a core field in GitHub Projects V2. Only custom fields can be deleted.

Input Parameters

string
required
The node ID of the project field to be deleted. This is a GraphQL node ID (e.g., ‘PVTF_…’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_PROJECT_ITEM_FOR_USERTool to delete a project item for a user in GitHub Projects V2. Use when you need to remove an item from a user’s project. Requires the project item’s GraphQL node ID (starts with ‘PVTI_’). Uses the GitHub GraphQL API deleteProjectV2Item mutation.

Input Parameters

string
required
The GraphQL node ID of the project item to delete (e.g. ‘PVTI_lADOBCxhzs4A…’).
string
required
The handle for the GitHub user account.
integer
required
The project’s number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_PULL_REQUEST_COMMENT_REACTIONDeletes a specific reaction from a pull request review comment, provided the comment and reaction exist on that comment within the specified repository.

Input Parameters

string
required
Name of the repository, without the .git extension; not case-sensitive.
string
required
Account owner (username or organization) of the repository; not case-sensitive.
integer
required
Unique ID of the pull request review comment.
integer
required
Unique ID of the reaction to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_PULL_REQUEST_REVIEW_PROTECTIONDisables the requirement for pull request reviews before merging for a specific, existing branch in an existing repository; this action is idempotent and will succeed even if the protection is not currently enabled.

Input Parameters

string
required
Name of the repository, without the .git extension (not case-sensitive).
string
required
Username or organization name of the repository owner (not case-sensitive).
string
required
Name of the branch to remove pull request review protection from (wildcards not supported; use GraphQL API for wildcards).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_REPO_CODESPACE_SECRET_BY_NAMEDeletes a specific Codespace secret from a repository by its name; this action is idempotent and will succeed even if the secret doesn’t exist.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username of the account or the name of the organization that owns the repository. This field is not case-sensitive.
string
required
The name of the Codespace secret to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_SOCIAL_ACCOUNTS_FOR_THE_AUTHENTICATED_USERDeletes currently linked social media account URLs from the authenticated user’s GitHub profile.

Input Parameters

array
required
Absolute URLs of the social media profiles to be unlinked from the GitHub profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_TEAM_DISCUSSION_COMMENT_REACTIONDeletes a reaction from a team discussion comment, given the organization name, team slug, discussion number, comment number, and reaction ID.

Input Parameters

string
required
The organization name. The name is not case sensitive.
string
required
The slug of the team name (URL-friendly version).
integer
required
The unique identifier of the reaction to be deleted.
integer
required
The number that uniquely identifies the comment within the discussion.
integer
required
The number that uniquely identifies the discussion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_TEAM_DISCUSSION_REACTIONPermanently deletes a specific reaction from a team discussion within an organization.

Input Parameters

string
required
The organization name. This name is not case sensitive.
string
required
The slug of the team name, which is a URL-friendly version of the team name.
integer
required
The unique identifier of the reaction to be deleted.
integer
required
The unique number identifying the specific discussion within the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_USER_LISTTool to delete a GitHub user list using GraphQL. Use when you need to remove a user list from a GitHub account.

Input Parameters

string
required
The ID of the user list to delete. This is a GitHub global node ID for the list.
string
A unique identifier for the client performing the mutation. Used to track requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_USER_PACKAGEDeletes a package owned by the specified user, requiring admin permissions for the authenticated user; deletion of public packages with over 5,000 downloads may require GitHub support. A 404 or 422 is returned as an error message rather than raised.

Input Parameters

string
required
The GitHub username of the account that owns the package.
string
required
The unique name of the package to be deleted.
string
required
Ecosystem of the package. Packages in GitHub’s Gradle registry use maven. Docker images pushed to GitHub’s Container registry (ghcr.io) use container. The docker type can find images from the old Docker registry (docker.pkg.github.com), even if migrated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DELETE_WORKFLOW_RUN_LOGSDeletes all logs for a specific workflow run in a GitHub repository, provided the repository and run exist.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The unique identifier of the workflow run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DISABLE_A_CUSTOM_PROTECTION_RULE_FOR_AN_ENVIRONMENTDisables a specific, currently active custom deployment protection rule for an existing environment within a GitHub repository.

Input Parameters

string
required
The name of the repository (without the .git extension). This name is not case sensitive.
string
required
The account owner of the repository (e.g., a user or organization). This name is not case sensitive.
string
required
The name of the environment. This name must be URL encoded; for example, any slashes (/) in the name must be replaced with %2F.
integer
required
The unique integer identifier of the custom deployment protection rule to be disabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DISABLE_A_WORKFLOWDisables a specified workflow (by ID or filename) in a given GitHub repository, preventing new automatic triggers; any in-progress runs will continue.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The account owner of the repository (username or organization name). This field is not case-sensitive.
string
required
The ID of the workflow or the workflow’s file name (e.g., main.yml or ci.yaml). You can obtain the workflow ID by listing workflows in a repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DISABLE_PRIVATE_VULN_REPORTING_FOR_REPODisables private vulnerability reporting for an existing GitHub repository, preventing direct private vulnerability reports to maintainers via GitHub’s interface for this repository.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The account owner of the repository (e.g., a GitHub username or organization name). This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DISABLE_REPOSITORY_ACTIONS_IN_ORGRemoves a repository from the list of selected repositories enabled for GitHub Actions in an organization. Only works when the organization’s enabled_repositories policy is set to selected. Requires admin:org scope.

Input Parameters

string
required
The GitHub organization name (not case-sensitive).
integer
required
The unique identifier of the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DISMISS_A_REVIEW_FOR_A_PULL_REQUESTDismisses an APPROVED or CHANGES_REQUESTED review on a pull request with a mandatory explanatory message. IMPORTANT: Only reviews in APPROVED or CHANGES_REQUESTED state can be dismissed. Reviews in COMMENTED, PENDING, or already DISMISSED state will return a 422 error. To dismiss a review on a protected branch, you must be a repository admin or be authorized to dismiss pull request reviews.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string ("DISMISS")
The event type for dismissing the review. Must be set to DISMISS.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
string
required
The reason for dismissing the review. This is a required field.
integer
required
The unique identifier for the review to be dismissed. The review must be in APPROVED or CHANGES_REQUESTED state.
integer
required
The unique number identifying the pull request within the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DOWNLOAD_AN_ARTIFACTDownloads a GitHub Actions workflow artifact as a ZIP file. Returns the artifact as a downloadable file. Use GITHUB_LIST_ARTIFACTS_FOR_A_REPOSITORY or GITHUB_LIST_WORKFLOW_RUN_ARTIFACTS to get valid artifact IDs first.

Input Parameters

string
required
Repository name, without the .git extension (case-insensitive).
string
required
Username or organization name of the repository owner (case-insensitive).
integer
required
Unique numeric identifier of the artifact. Obtain from GITHUB_LIST_ARTIFACTS_FOR_A_REPOSITORY or GITHUB_LIST_WORKFLOW_RUN_ARTIFACTS actions.
string
Archive format for the download. GitHub API only supports ‘zip’. Defaults to ‘zip’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DOWNLOAD_A_REPOSITORY_ARCHIVE_TARGets a redirect URL for downloading a repository tarball at a specific Git reference. For private repositories, the URL expires after five minutes.

Input Parameters

string
required
A Git reference (e.g., branch name, tag name, or commit SHA) that points to the specific version of the repository content to be downloaded as a tarball archive. For example, main for the main branch, v1.0.0 for a tag, or a full commit SHA.
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DOWNLOAD_A_REPOSITORY_ARCHIVE_ZIPRequests a ZIP archive of a repository at a specific Git reference (branch, tag, or commit SHA) and returns the redirect URL for downloading it. For private repositories, the URL expires after five minutes.

Input Parameters

string
required
The Git reference for the archive. This can be a branch name, a tag name, or a commit SHA.
string
required
The name of the repository, without the .git extension. This is not case-sensitive.
string
required
The username of the account that owns the repository. This is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DOWNLOAD_JOB_LOGS_FOR_A_WORKFLOW_RUNDownloads 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.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository (e.g., user or organization). This name is not case-sensitive.
integer
required
The unique identifier of the job for which to download logs. You can obtain this from the ‘List jobs for a workflow run’ endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DOWNLOAD_WORKFLOW_RUN_ATTEMPT_LOGSDownloads a ZIP archive of logs for a specific workflow run attempt. Returns a downloadable ZIP file containing logs for all jobs and steps in the workflow run.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The unique identifier of the workflow run.
integer
required
The attempt number of the workflow run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_DOWNLOAD_WORKFLOW_RUN_LOGSDownloads logs for a specific GitHub Actions workflow run as a ZIP archive containing log files for each job in the workflow.

Input Parameters

string
required
The name of the repository (e.g., ‘Spoon-Knife’) without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository (e.g., ‘octocat’). This name is not case-sensitive.
integer
required
The unique identifier of the workflow run (e.g., 12345).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ENABLE_A_WORKFLOWReactivates a currently disabled GitHub Actions workflow within a repository using its workflow ID or filename.

Input Parameters

string
required
The name of the repository, without the .git extension. This value is not case-sensitive.
string
required
The username or organization name that owns the repository. This value is not case-sensitive.
string
required
The ID of the workflow to be enabled. You can provide either the numeric workflow ID (e.g., 30433642) or the workflow filename (e.g., ‘ci.yaml’, ‘data.yml’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ENABLE_GITHUB_ACTIONS_IN_SELECTED_REPOSITORIESSets the specific repositories that can use GitHub Actions within an organization by replacing the current list; only applies if the organization’s Actions policy is ‘selected repositories’.

Input Parameters

string
required
Name of the GitHub organization (case-insensitive).
array
required
List of unique repository IDs for which GitHub Actions will be enabled. This list completely replaces the current selection of repositories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ENABLE_PRIVATE_VULN_REPORTING_FOR_REPOEnables private vulnerability reporting for a repository, allowing security researchers to privately submit vulnerability reports to maintainers.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The account owner of the repository. This is typically the username or organization name and is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ENABLE_REPO_FOR_GITHUB_ACTIONSAdds a repository to the list of selected repositories enabled for GitHub Actions in an organization. Requires the organization’s ‘enabled_repositories’ policy to be set to ‘selected’.

Input Parameters

string
required
The name of the GitHub organization. This name is not case-sensitive.
integer
required
The unique numerical identifier of the GitHub repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ENCRYPT_AND_UPDATE_DEV_SECRETCreates or updates a repository’s GitHub Codespaces secret. It accepts a plaintext value for automatic encryption or a value already encrypted with the repository’s Codespaces public key.

Input Parameters

string
required
The name of the repository without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.
string
ID of the public key (retrieved from the GitHub API’s ‘Get a repository public key for Codespaces’ endpoint: GET /repos/{owner}/{repo}/codespaces/secrets/public-key) used to encrypt the secret’s value. If not provided, it will be fetched automatically.
string
required
The name of the development environment secret.
string
The plaintext value for your secret. This will be automatically encrypted using the repository’s Codespaces public key before being sent to GitHub. If you already have an encrypted value, use the encrypted_value parameter instead.
string
Value for your secret, already encrypted using the public key retrieved from the GitHub API’s ‘Get a repository public key for Codespaces’ endpoint (GET /repos/{owner}/{repo}/codespaces/secrets/public-key). Use this if you have pre-encrypted the value yourself.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_ENCRYPT_ORG_DEV_ENV_SECRETCreates or updates an organization’s GitHub Codespaces secret using an encrypted value and its corresponding public key ID.

Input Parameters

string
required
The GitHub organization name (case-insensitive).
string
ID of the public key (from GET /orgs/{org}/codespaces/secrets/public-key) used to encrypt the secret’s value. If not provided, it will be fetched automatically when encrypting.
string ("all" | "private" | "selected")
required
Visibility of the secret. ‘selected’ requires selected_repository_ids.
string
required
Name of the secret to create or update.
string
The plaintext value for your secret. This will be automatically encrypted using the organization’s Codespaces public key before being sent to GitHub. If you already have an encrypted value, use the encrypted_value parameter instead.
string
Encrypted secret value, using the public key from ‘Get an organization public key’ (GET /orgs/{org}/codespaces/secrets/public-key). Use this if you have pre-encrypted the value yourself. If not provided and secret_value is given, encryption will be done automatically.
array
Repository IDs that can access the secret; required if visibility is ‘selected’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_EXPORT_A_CODESPACE_FOR_THE_AUTHENTICATED_USERTriggers an export of the authenticated user’s specified codespace, automatically stopping it if active. Returns the export status and, when available, an export URL.

Input Parameters

string
required
Unique name of the codespace to be exported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_EXPORT_SBOM_FOR_REPOExports 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.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_FIND_PULL_REQUESTSSearches pull requests by repository, author, state, labels, merge status, and other filters; without a repository or owner, it searches public repositories by default or PRs involving the authenticated user when requested. Search results are capped at approximately 1,000; creation and update date filters do not filter merge dates.

Input Parameters

integer
Page number of results to fetch.
string
Filter by specific repository. Can be provided in ‘owner/repo’ format (e.g., ‘facebook/react’), or as just the repo name when used with the owner parameter. When owner and repo are both provided and have the same value, they are combined as ‘owner/repo’. When omitted along with owner, search scope is determined by for_authenticated_user flag. The repository must exist and be accessible with your token. Prefer ‘owner/repo’ format; bare repo name without the owner parameter causes invalid repository format errors.
string ("comments" | "reactions" | "interactions" | "created" | "updated")
Field to sort results by. Set explicitly to ‘updated’ with order=desc when recency matters; default behavior may return best-match relevance ordering instead.
string
Filter by label name.
string ("desc" | "asc")
Sort order (ascending or descending).
string
Filter by repository owner (user or organization). Can be used alone to search all repositories for an owner, or combined with repo parameter to specify owner and repo separately. When both owner and repo are provided, the search is scoped to ‘owner/repo’. When omitted along with repo, search scope is determined by for_authenticated_user flag. The owner must exist and repositories must be accessible with your token.
string
Optional search query for PR title, description, or commit messages. Supports GitHub search syntax including label filters (e.g., ‘label:bug’), logical operators (AND, OR, NOT), and text search. If not provided, PRs will be listed based on other filter parameters. Type qualifiers (type:pr, is:pr, is:issue, type:issue) are automatically normalized. When using logical operators with qualifiers like labels, the query is automatically grouped for proper parsing. When omitting query, ensure at least one structured filter parameter is provided; passing no query and no filters may cause validation errors. Prefer dedicated parameters (label, state, author) over embedding qualifiers in the query string. Exact title matching is not supported; post-filter on title client-side if needed.
string
Filter by PR state: ‘open’, ‘closed’, or ‘all’.
string
Filter by PR author username. Must be a valid GitHub username (alphanumeric characters and hyphens only, cannot start or end with hyphen). No dots or other special characters allowed.
string
Filter by PR assignee username. Use ‘@me’ for current user. Must be a valid GitHub username (alphanumeric characters and hyphens only, cannot start or end with hyphen). No dots or other special characters allowed.
string
Filter by programming language.
string
Filter by username mentioned in PR. Must be a valid GitHub username (alphanumeric characters and hyphens only, cannot start or end with hyphen). No dots or other special characters allowed.
integer
Number of results per page (maximum 100). GitHub caps total search results at ~1000 items; iterate page until results fewer than per_page are returned, and add repo, label, or date filters when totals approach 1000.
boolean
Filter by merge status. True for merged PRs, False for unmerged, None for all.
string
Filter by base branch name.
string
Filter by head branch name.
string
Filter PRs created after this date (ISO 8601 format). Provide as UTC ISO 8601 timestamp to avoid off-by-one-day errors at range boundaries. Does not filter on merged_at.
string
Filter PRs updated after this date (ISO 8601 format).
string ("minimal" | "full")
Level of detail in the response. ‘minimal’ (default) returns an optimized response for AI agents. ‘full’ returns the complete GitHub API response.
boolean
Include private repositories accessible to the authenticated user in search results. When True without repo/owner, searches PRs involving you (author, assignee, mentions, commenter) across all accessible repos. When False without repo/owner, restricts to public repos only. When repo/owner is specified, this flag has no effect on scope. Set to True when searching private repositories; False searches all of GitHub and produces large noisy result sets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_FIND_REPOSITORIESSearch GitHub repositories by keywords, language, stars, topics, and ownership, returning paginated results. Repository qualifiers are reduced to owner filters, an owner with no public repositories can yield an immediate empty result, and OR expressions are limited to six terms; check incomplete_results for non-exhaustive results.

Input Parameters

integer
Page number of results to fetch.
string ("stars" | "forks" | "help-wanted-issues" | "updated")
Field to sort results by.
string ("desc" | "asc")
Sort order (ascending or descending).
string
Filter by specific user or organization. Do NOT use this parameter if your ‘query’ already contains ‘user:’, ‘org:’, or ‘repo:’ qualifiers - they will conflict. Use either ‘owner’ parameter OR search qualifiers in ‘query’, not both.
string
required
Search query for repository name, description, or README content. Accepts both ‘query’ and ‘q’ as parameter names. Supports OR operator for alternatives (e.g., ‘bug OR error’). Multi-word phrases in OR expressions are automatically quoted. GitHub limits OR expressions to 6 terms maximum; queries exceeding this limit are truncated. If using GitHub qualifiers like ‘repo:’, ‘user:’, or ‘org:’, they must be properly formatted (e.g., ‘repo:owner/name’, ‘user:username’, ‘org:orgname’). Note: ‘owner:’ is not a valid GitHub qualifier; if used, it will be automatically transformed to ‘user:’. Must be non-empty; blank strings trigger a ‘Search query cannot be empty’ validation error.
string
Filter by repository topic/tag.
boolean
Filter by archived status. None means include both.
string
Filter by programming language.
integer
Number of results per page (maximum 100). GitHub caps total results at ~1000 per query; for exhaustive searches, split by language, topic, min_stars/max_stars, or owner.
integer
Maximum number of stars the repository should have.
integer
Minimum number of forks the repository should have.
integer
Minimum number of stars the repository should have.
string
How to handle forks: ‘include’ (include forks), ‘exclude’ (exclude forks), ‘only’ (only forks).
string ("minimal" | "full")
Level of detail in the response. ‘minimal’ (default) returns an optimized response for AI agents. ‘full’ returns the complete GitHub API response.
boolean
Search only in repositories accessible to the authenticated user (including private repos). Requires token scopes repo/read:org; sparse results compared to GitHub UI typically indicate insufficient token scopes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_FOLLOW_ORGANIZATION_GRAPHQLTool to follow a GitHub organization using GraphQL. Use when you need to make the authenticated user follow an organization.

Input Parameters

string
required
The global GraphQL node ID of the organization to follow. Must be a valid organization node ID.
string
A unique identifier for the client performing the mutation. Used to track requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_FOLLOW_USERAllows the authenticated user to follow the GitHub user specified by username; this action is idempotent and the user cannot follow themselves.

Input Parameters

string
required
The GitHub username (handle) of the user to be followed by the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_FOLLOW_USER_GRAPHQLTool to follow a GitHub user using GraphQL. Use when you need to make the authenticated user follow another user.

Input Parameters

string
required
The global Node ID of the user to follow. Must be a valid GitHub user ID in the format ‘MDQ6VXNlcjU4MzIzMQ==’.
string
A unique identifier for the client performing the mutation. Used to track requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_FORCE_CANCEL_WORKFLOW_RUNRequests force cancellation of a queued or in-progress GitHub Actions workflow run, bypassing conditions such as always(), when standard cancellation fails. A successful response means the request was accepted for asynchronous processing; completed runs cannot be canceled, and repository write permissions are required.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The unique identifier of the workflow run. Note: Only workflow runs with status ‘queued’ or ‘in_progress’ can be canceled. Completed workflow runs cannot be canceled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_FORK_GISTForks a specified public gist, creating a copy under the authenticated user’s account.

Input Parameters

string
required
The unique identifier of the gist to be forked.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GENERATE_RELEASE_NOTESGenerates Markdown release notes content (listing changes, pull requests, and contributors) for a GitHub repository release, customizable via tags and a configuration file.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
string
required
The tag name for which the release notes are to be generated. This can be an existing tag or a new tag name.
string
Specifies the commitish value (e.g., a branch name, tag name, or commit SHA) that will be the target for the release’s tag. This is required if the tag_name does not reference an existing tag. It is ignored if tag_name already exists.
string
The name of the previous tag to use as the starting point for the release notes. This manually specifies the range of changes to be included. If omitted, GitHub will attempt to automatically determine the previous release.
string
Specifies a path to a configuration file in the repository (e.g., .github/release.yml) containing settings for generating release notes. If unspecified, GitHub looks for a configuration file at “.github/release.yml” or “.github/release.yaml”. If no such file is found, default settings are used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_BLOBRetrieves 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.

Input Parameters

string
required
The name of the repository, without the ‘.git’ extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
string
required
The SHA-1 hash of the file (blob) to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_BRANCHRetrieves detailed information for a specified branch within a GitHub repository.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
string
required
The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API. If ‘HEAD’ is provided, it will be resolved to the repository’s default branch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_ACCESS_RESTRICTIONSRetrieves user, team, and GitHub App push restrictions for a protected branch. A 404 is returned as a message indicating that restrictions were not found; it can also mean the branch does not exist or is not protected.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository (e.g., username or organization name). This name is not case-sensitive.
string
required
The name of the branch. Wildcard characters are not supported in this field. To manage branch protections with wildcard patterns, please refer to the GitHub GraphQL API documentation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_COMMITRetrieves a specific commit from a repository by its owner, name, and a valid commit reference (SHA, branch, or tag), supporting pagination for large diffs.

Input Parameters

string
required
The commit reference. Can be a commit SHA (e.g., ‘sha’), a branch name (e.g., ‘heads/BRANCH_NAME’ or simply ‘BRANCH_NAME’), or a tag name (e.g., ‘tags/TAG_NAME’). For more information, see “Git References” in the Git documentation.
integer
Page number for paginating the commit’s diff if it’s too large. For more information, see “Using pagination in the REST API.”
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
integer
Number of results per page when paginating the commit’s diff (max 100). For more information, see “Using pagination in the REST API.”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_ADMIN_BRANCH_PROTECTIONChecks if repository administrators are subject to the branch protection rules on a specific branch.

Input Parameters

string
required
Name of the repository, without the .git extension (case-insensitive).
string
required
Account owner of the repository (case-insensitive).
string
required
Name of the branch (wildcard characters not allowed; use GraphQL API for wildcard support).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_ALL_API_VERSIONSRetrieves all officially supported, date-based (e.g., “2022-11-28”) versions of the GitHub REST API from the /versions endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_ALL_CONTRIBUTOR_COMMIT_ACTIVITYRetrieves commit activity (total commits, weekly additions/deletions/commits) for all contributors to a repository; may require a retry if GitHub returns 202 while preparing data.

Input Parameters

string
required
Repository name, excluding .git (case-insensitive).
string
required
Username of the repository owner (case-insensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_ALL_DEPLOYMENT_PROTECTION_RULES_FOR_ENVLists all enabled custom deployment protection rules for a specific environment in a repository; the environment must exist and be configured for deployments.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
string
required
The name of the environment. This name must be URL-encoded. For instance, if the environment name contains slashes (/), they should be replaced with %2F.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_MILESTONERetrieves detailed information for a specific milestone within a GitHub repository by its number.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username of the account that owns the repository. This field is not case-sensitive.
integer
required
The unique sequential number identifying the milestone within the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_AN_APPRetrieves publicly available information for an existing GitHub App, identified by its unique URL-friendly app_slug.

Input Parameters

string
required
The app’s unique, URL-friendly, lowercase, hyphenated identifier, derived from its name (e.g., ‘my-awesome-app’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_AN_ARTIFACTGets a specific artifact for a repository by artifact_id. This action retrieves the details of a specific artifact from a GitHub repository using the artifact’s unique identifier. It allows users to access information about artifacts stored in the repository.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
integer
required
The unique identifier (ID) of the artifact to retrieve. This ID can be obtained from other API calls that list artifacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_AN_ASSIGNMENTRetrieves detailed information for a specific GitHub Classroom assignment if the authenticated user is an administrator of the classroom.

Input Parameters

integer
required
The unique identifier of the GitHub Classroom assignment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_AN_ENVIRONMENTRetrieves the details of a specific deployment environment for a given repository, including its name, configurations, and current status.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The username of the account that owns the repository. This name is not case-sensitive.
string
required
The name of the deployment environment. The name must be URL-encoded; for example, any slashes / must be replaced with %2F.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_AN_ENVIRONMENT_PUBLIC_KEYRetrieves the public key for a specified GitHub repository environment, used to encrypt secrets for GitHub Actions.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
string
required
The name of the environment. The name must be URL encoded. For example, any slashes (/) in the name must be replaced with %2F.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_AN_ENVIRONMENT_SECRETRetrieves metadata (name and timestamps) for a single secret in a GitHub Actions environment. Note: The actual secret value is never returned by this API for security reasons.

Input Parameters

string
required
Name of the repository, without the .git extension (not case-sensitive).
string
required
Username or organization name of the repository owner (not case-sensitive).
string
required
Name of the secret to retrieve.
string
required
Name of the environment (must be URL-encoded if it contains special characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_AN_ENVIRONMENT_VARIABLERetrieves a specific environment variable from a GitHub Actions environment by repository owner, repository name, environment name, and variable name.

Input Parameters

string
required
The name of the specific environment variable to retrieve.
string
required
The name of the repository, without the .git extension. This is not case-sensitive.
string
required
The username or organization name that owns the repository. This is not case-sensitive.
string
required
The name of the GitHub Actions environment. If the name contains special characters (e.g., slashes /), it must be URL-encoded (e.g., staging/feature becomes staging%2Ffeature).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_AN_ISSUERetrieves detailed information about a specific issue in a repository using the owner, repository name, and issue number.

Input Parameters

string
required
Name of the repository (without .git extension). Not case-sensitive.
string
required
Username of the account owning the repository. Not case-sensitive.
integer
required
The identifying number of the issue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_AN_ISSUE_COMMENTAction to get an issue comment.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case sensitive.
string
required
The username of the account that owns the repository. This field is not case sensitive.
integer
required
The unique identifier of the issue comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_AN_ISSUE_EVENTFetches details of a specific issue event for a given repository and event ID.

Input Parameters

string
required
Name of the repository, without the .git extension. Not case-sensitive.
string
required
Username of the account owning the repository. Not case-sensitive.
integer
required
Unique identifier for the issue event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_AN_ORGANIZATIONGet an organization

Input Parameters

string
required
The name of the organization. This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_AN_ORGANIZATION_PUBLIC_KEYRetrieves a GitHub organization’s Actions secrets public key for encrypting organization secrets.

Input Parameters

string
required
Organization name (case-insensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_AN_ORGANIZATION_ROLERetrieves a specific GitHub organization role by its ID.

Input Parameters

string
required
The name of the GitHub organization. This name is not case-sensitive.
integer
required
The unique numerical identifier of the role within the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_AN_ORGANIZATION_SECRETGets an organization secret’s metadata (e.g., name, creation/update dates, visibility), but not its encrypted value.

Input Parameters

string
required
Organization name (case-insensitive).
string
required
Name of the secret.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_AN_ORGANIZATION_VARIABLERetrieves details (name, value, visibility, timestamps) of a specific, existing variable for an existing GitHub organization.

Input Parameters

string
required
Name of the organization (case-insensitive).
string
required
Name of the organization variable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_AN_ORGANIZATION_WEBHOOKRetrieves the full configuration, including subscribed events and delivery settings, for an existing organization webhook.

Input Parameters

string
required
The name of the GitHub organization. This field is not case-sensitive.
integer
required
The unique identifier of the webhook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_PACKAGE_FOR_AN_ORGANIZATIONRetrieves a specific package (by type and name) from an organization, if both the package and organization exist.

Input Parameters

string
required
Name of the GitHub organization (case-insensitive).
string
required
The unique name of the package.
string ("npm" | "maven" | "rubygems" | "docker" | "nuget" | "container")
required
Type of the package. GitHub Gradle packages use maven type. Images from ghcr.io (Container registry) use container type. Use docker for images from docker.pkg.github.com (Docker registry), even if migrated to the Container registry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_PACKAGE_FOR_A_USERRetrieves metadata for a specific package owned by a GitHub user, using package type, name, and username as identifiers.

Input Parameters

string
required
GitHub username of the package owner.
string
required
Unique name of the package on GitHub Packages.
string
required
Specifies the package’s type. Note: Gradle packages use ‘maven’; ghcr.io images use ‘container’; ‘docker’ can find images migrated from docker.pkg.github.com to the Container registry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_PACKAGE_FOR_THE_AUTHENTICATED_USERRetrieves detailed information for a specific package owned by the authenticated user.

Input Parameters

string
required
The unique name of the package as it appears in the registry.
string
required
Type of the package. ‘maven’ for GitHub’s Gradle registry; ‘container’ for Docker images in GitHub’s Container registry (ghcr.io); ‘docker’ for images from GitHub’s Docker registry (docker.pkg.github.com), including those migrated to the Container registry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_PACKAGE_VERSION_FOR_AN_ORGANIZATIONRetrieves detailed information for a specific version of a package within an organization.

Input Parameters

string
required
Organization name (case-insensitive).
string
required
Unique package name.
string
required
Package type. maven for GitHub Gradle registry. container for GitHub Container registry (ghcr.io) images. docker for images from GitHub Docker registry (docker.pkg.github.com), including migrated ones.
integer
required
Unique ID of the package version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_PACKAGE_VERSION_FOR_A_USERRetrieves a specific public package version associated with a GitHub user.

Input Parameters

string
required
The GitHub username of the account that owns the package.
string
required
The name of the package.
string ("npm" | "maven" | "rubygems" | "docker" | "nuget" | "container")
required
The type of package. ‘maven’ is used for Gradle packages. ‘container’ is for images in GitHub’s Container registry (ghcr.io). ‘docker’ can be used for images previously in GitHub’s Docker registry (docker.pkg.github.com).
integer
required
The unique numeric identifier of the specific package version. Obtain this ID by first listing package versions using the ‘list_package_versions_for_a_package_owned_by_a_user’ action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_PACKAGE_VERSION_FOR_THE_AUTHENTICATED_USERRetrieves detailed information for an existing specific package version associated with the authenticated user, identified by its type, name, and version ID.

Input Parameters

string
required
The name of the package, which can be case-sensitive depending on the package type.
string
required
The package type. Note: GitHub’s Gradle registry packages use ‘maven’; ghcr.io images use ‘container’; ‘docker’ can refer to images from docker.pkg.github.com.
integer
required
The unique numerical identifier (ID) of the specific package version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_PROJECTRetrieves detailed information for a specific GitHub project (V2) using its project number and owner. Note: This action uses GitHub’s Projects V2 REST API. The legacy Projects (classic) REST API was sunset on April 1, 2025. The project is identified by its number (visible in the project URL) and owner (either a username or organization name). If no owner is specified, the authenticated user is assumed.

Input Parameters

string
The organization that owns the project. If provided, this takes precedence over username.
string
The GitHub username who owns the project. If not provided, defaults to the authenticated user.
integer
required
The project’s sequential number (e.g., 1, 2, 3). This is displayed in the project URL as https://github.com/users/&#123;username&#125;/projects/&#123;project_number&#125;.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_PROJECT_CARDRetrieves a GitHub Projects (classic) card by ID to inspect its details, such as its note or linked content and project column. DEPRECATED: The Projects (classic) REST API has been sunset on GitHub.com. Use GitHub Projects V2 instead.

Input Parameters

integer
required
The unique identifier of the project card.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_PROJECT_COLUMNRetrieves detailed information for a specific project column from GitHub Projects (classic). DEPRECATION NOTICE: GitHub Classic Projects (V1) and its REST API were sunset on April 1, 2025. This action will return 404 for most requests on GitHub.com. However, it may still work on GitHub Enterprise Server instances where classic projects are enabled. For new projects, use GitHub Projects V2 which uses the GraphQL API instead. See: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ Returns column details including: id, name, url, project_url, cards_url, node_id, created_at, and updated_at timestamps.

Input Parameters

integer
required
The unique integer identifier of the project column to retrieve. This ID can be obtained from the ‘list_project_columns’ action or from the column’s API URL (e.g., /projects/columns/12345).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_PULL_REQUESTRetrieves a specific pull request from a GitHub repository using its owner, repository name, and pull request number.

Input Parameters

string
required
The name of the repository, without the .git extension. This value is not case sensitive.
string
required
The username of the account that owns the repository. This value is not case sensitive.
integer
required
The number that identifies the specific pull request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_REFERENCERetrieves a specific Git reference (e.g., a branch, tag, or fully qualified like ‘heads/main’) from a GitHub repository. The reference must exist in the repository; use ‘list_matching_references’ first if unsure what references are available.

Input Parameters

string
required
The Git reference to retrieve. Must be formatted as heads/<branch_name> for branches, tags/<tag_name> for tags, or pull/<number>/head (or pull/<number>/merge) for pull requests. Simple branch names (e.g., main) are automatically converted to heads/<name>. The reference must exist in the repository; a 404 error is returned if not found. If unsure which references exist, use ‘list_matching_references’ or ‘get_a_branch’ first. Note: Commit SHAs are not supported by this endpoint; use commit-specific endpoints instead. Not all repositories use ‘master’; many now use ‘main’ as the default branch.
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_RELEASEGets a specific release from a GitHub repository, provided the repository is accessible and the release exists.

Input Parameters

string
required
The name of the repository, without the ‘.git’ extension. This field is not case-sensitive.
string
required
The username of the account that owns the repository. This field is not case-sensitive.
integer
required
The unique numerical identifier for the release.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_RELEASE_ASSETGets metadata for a specific release asset in a GitHub repository, including a browser_download_url for downloading the asset.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository (GitHub username or organization name). This name is not case sensitive.
integer
required
The unique numeric identifier of the release asset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_RELEASE_BY_TAG_NAMEGets a release from a GitHub repository by its tag name; the repository and a release with this tag must already exist.

Input Parameters

string
required
Tag identifying the release to fetch.
string
required
Name of the repository, without the .git extension (not case sensitive).
string
required
Account owner of the repository (not case sensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_REPOSITORYRetrieves detailed information about an existing and accessible GitHub repository.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is case-insensitive.
string
required
The username of the account that owns the repository. This field is case-insensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_REPOSITORY_PUBLIC_KEYGets a repository’s public key for encrypting secrets to be used in GitHub Actions, if the repository exists and is accessible.

Input Parameters

string
required
Name of the repository without the .git extension (case-insensitive).
string
required
Account owner of the repository (case-insensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_REPOSITORY_READMEFetches the README file (if it exists and is accessible) from a specified GitHub repository, returning its Base64-encoded content and metadata.

Input Parameters

string
The specific git reference (branch name, tag name, or commit SHA) to retrieve the README from. If omitted, the repository’s default branch is used.
string
required
The name of the repository, excluding the .git extension. This name is not case-sensitive.
string
required
The GitHub account owner of the repository. This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_REPOSITORY_README_FOR_A_DIRECTORYRetrieves the README file from a specified directory within a GitHub repository, optionally at a given commit, branch, or tag.

Input Parameters

string
required
Path to the directory containing the README file.
string
Commit, branch, or tag name; defaults to the repository’s default branch if not provided.
string
required
Name of the repository, without the .git extension (not case sensitive).
string
required
Username of the account owning the repository (not case sensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_REPOSITORY_RULESETRetrieves a specific repository ruleset by its ID; if includes_parents is true, the search for this ruleset_id also extends to rulesets from parent organizations.

Input Parameters

string
required
Repository name, excluding .git extension; case-insensitive.
string
required
Account owner of the repository (username or organization); case-insensitive.
integer
required
Unique identifier of the ruleset.
boolean
If true, also returns rulesets configured at higher levels (e.g., organization) that apply to this repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_REPOSITORY_RULE_SUITEGets detailed information for a specific repository rule suite by its ID, including its evaluation status and the results of its individual rules.

Input Parameters

string
required
The name of the repository, excluding the .git extension. This name is not case-sensitive.
string
required
The username of the account or the name of the organization that owns the repository. This name is not case-sensitive.
integer
required
The unique identifier of the rule suite. To obtain this ID, you can list rule suites for the repository (e.g., via GET /repos/{owner}/{repo}/rulesets/rule-suites) or organization (e.g., via GET /orgs/{org}/rulesets/rule-suites).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_REPOSITORY_SECRETGets metadata (name, creation/update timestamps) for an existing repository secret, excluding its encrypted value.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
string
required
The name of the secret to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_REPOSITORY_SUBSCRIPTIONGets the authenticated user’s subscription details for a repository, indicating if they receive notifications.

Input Parameters

string
required
The name of the repository, without the .git extension. This is not case-sensitive.
string
required
The username of the account that owns the repository. This is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_REPOSITORY_VARIABLEGets a specific GitHub Actions variable by name from an accessible repository.

Input Parameters

string
required
The name of the GitHub Actions variable to retrieve.
string
required
The name of the repository, without the .git extension.
string
required
The username or organization that owns the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_REPOSITORY_WEBHOOKReturns the configuration of an existing webhook for a given repository.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case-sensitive.
string
required
The account owner of the repository (e.g., a user or organization). The name is not case-sensitive.
integer
required
The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_REVIEW_COMMENT_FOR_A_PULL_REQUESTRetrieves a specific pull request review comment by its ID, provided the repository exists, is accessible, and the comment ID is valid.

Input Parameters

string
required
The name of the repository (without the .git extension). Not case-sensitive.
string
required
The account owner of the repository (GitHub username or organization name). Not case-sensitive.
integer
required
Unique identifier of the pull request review comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_REVIEW_FOR_A_PULL_REQUESTRetrieves a specific review for a pull request using its owner, repository, pull request number, and review ID.

Input Parameters

string
required
The name of the repository, without the .git extension. This is not case sensitive.
string
required
The username of the account that owns the repository. This is not case sensitive.
integer
required
The unique numeric identifier of the review.
integer
required
The numeric identifier of the pull request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_SECRET_FOR_THE_AUTHENTICATED_USERRetrieves metadata (name, timestamps, visibility; not the value) for a specific, existing development environment secret associated with the authenticated user’s GitHub Codespaces.

Input Parameters

string
required
The name of the secret to retrieve. This is case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_SELF_HOSTED_RUNNER_FOR_AN_ORGANIZATIONRetrieves detailed information about a specific self-hosted runner registered within a GitHub organization.

Input Parameters

string
required
The login name of the GitHub organization. This name is not case-sensitive.
integer
required
Unique identifier (ID) of the self-hosted runner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_SELF_HOSTED_RUNNER_FOR_A_REPOSITORYGets a specific self-hosted runner for a repository by its unique ID.

Input Parameters

string
required
The name of the repository, without the .git extension. This is not case-sensitive.
string
required
The username of the account that owns the repository. This is not case-sensitive.
integer
required
The unique identifier (ID) of the self-hosted runner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_ASSIGNMENT_GRADESRetrieves all grades for an existing GitHub Classroom assignment.

Input Parameters

integer
required
The unique identifier of the classroom assignment. This can be obtained from the list_assignments_for_a_classroom action or from the assignment’s URL in GitHub Classroom.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_TAGRetrieves detailed information for a specific Git tag object from a GitHub repository, using the SHA of the tag object itself.

Input Parameters

string
required
Name of the repository, without the .git extension (case-insensitive).
string
required
Username or organization that owns the repository (case-insensitive).
string
required
SHA of the Git tag object to retrieve; this is the SHA of the tag object, not the commit it may point to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_TEAM_BY_NAMERetrieves a GitHub team by its slug from a specific organization.

Input Parameters

string
required
The organization’s name (case-insensitive).
string
required
The slug (URL-friendly version) of the team name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_THREADRetrieves a specific GitHub notification thread using its unique thread_id.

Input Parameters

integer
required
The unique identifier of the notification thread, typically obtained from a list of notifications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_THREAD_SUBSCRIPTION_FOR_THE_AUTHENTICATED_USERRetrieves the authenticated user’s subscription details for a specific notification thread, identified by thread_id.

Input Parameters

integer
required
The unique identifier of the notification thread. This ID corresponds to the id field returned when retrieving notifications, for example, through the ‘List notifications for the authenticated user’ (GET /notifications) operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_TREEBrowse a GitHub repository’s tree at a specified branch, tag, commit or tree SHA. Recursive mode lists nested entries in one request, but results can be truncated; check the returned truncation flag.

Input Parameters

string
required
Repository name without owner or .git extension (e.g., for github.com/kubernetes/kubernetes, repo is ‘kubernetes’).
string
required
Repository owner username or organization name (e.g., for github.com/kubernetes/kubernetes, owner is ‘kubernetes’).
string
required
Branch name (e.g., ‘main’, ‘master’), tag name (e.g., ‘v1.0.0’), commit SHA, or tree SHA. Directory paths are NOT supported - use a branch/tag to get the full tree, then extract the directory’s SHA from results.
string
Set to True (or ‘1’/‘true’) to fetch the ENTIRE repository file tree recursively (all files and directories in one call). Set to False or leave empty to fetch only the top-level files/folders. For browsing or analyzing the full repository structure, use recursive=True.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_USERRetrieves the public profile information for an existing GitHub user, specified by their username.

Input Parameters

string
required
The GitHub username (handle) of the user to retrieve. This is case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_AUTHENTICATED_USER_ORGANIZATION_MEMBERSHIPRetrieve the connected user’s membership in one GitHub organization.

Input Parameters

string
required
The organization name. The name is not case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_WEBHOOK_CONFIGURATION_FOR_AN_ORGANIZATIONRetrieves the configuration for a specific webhook associated with a GitHub organization.

Input Parameters

string
required
The GitHub organization’s name (case-insensitive).
integer
required
Unique ID of the webhook (see X-GitHub-Hook-ID header in webhook deliveries).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_WEBHOOK_CONFIGURATION_FOR_A_REPOSITORYReturns the configuration for an existing webhook on the specified repository.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_WEBHOOK_DELIVERY_FOR_AN_ORGANIZATION_WEBHOOKReturns detailed information for a specific delivery attempt of a webhook configured for the specified GitHub organization.

Input Parameters

string
required
The name of the GitHub organization. This field is not case-sensitive.
integer
required
The unique identifier of the organization webhook. This ID can be found in the X-GitHub-Hook-ID header of a webhook delivery.
integer
required
The unique identifier of the specific webhook delivery attempt.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_WORKFLOWRetrieves detailed information for a specific GitHub Actions workflow in a repository, identified by either its numeric ID or its filename.

Input Parameters

string
required
Name of the repository, without the .git extension (case-insensitive).
string
required
Username or organization name owning the repository (case-insensitive).
integer
Unique numeric identifier of the workflow; use this or workflow_name.
string
Full name of the workflow file (e.g., ci.yml); use this or workflow_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_WORKFLOW_RUNGets a specific workflow run by its ID from a GitHub repository.

Input Parameters

string
required
Name of the repository (case-insensitive, without .git extension).
string
required
The username or organization name that owns the repository (not case-sensitive).
integer
required
Unique ID of the workflow run.
boolean
If true, excludes pull request data; the pull_requests array in the response will be empty.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_A_WORKFLOW_RUN_ATTEMPTRetrieves detailed information for a specific attempt of a workflow run in a GitHub repository, including its status, conclusion, and timings.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository, such as a GitHub username or organization name. This name is not case sensitive.
integer
required
The unique identifier (ID) of the workflow run. This ID is specific to a repository and can be obtained from API calls that list workflow runs.
integer
required
The attempt number of the specific workflow run. Each re-run of a workflow creates a new attempt number, starting from 1.
boolean
If true, excludes pull request data from the API response; the pull_requests array in the response will then be empty.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_BILLING_USAGE_REPORT_USERRetrieves the billing usage report for a specified GitHub user. Use when you need to analyze billing costs and usage patterns.

Input Parameters

integer
If specified, only return results for a single day. The value of day is an integer between 1 and 31. If no year or month is specified, the default year and month are used.
integer
If specified, only return results for a single year. The value of year is an integer with four digits representing a year. For example, 2025. Default value is the current year.
integer
If specified, only return results for a single month. The value of month is an integer between 1 and 12. If no year is specified the default year is used.
string
required
The handle for the GitHub user account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_BRANCH_PROTECTIONRetrieves branch protection settings for a specific accessible branch in a GitHub repository, such as required status checks, review requirements, and push restrictions. Availability varies by GitHub product plan; fine-grained tokens require repository Administration read permission. The branch name cannot contain wildcards.

Input Parameters

string
required
Name of the repository, without the .git extension; not case-sensitive.
string
required
Account owner of the repository (username or organization name); not case-sensitive.
string
required
Name of the branch; wildcard characters are not supported (use GitHub GraphQL API for wildcard matching).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_CATALOG_MODELSTool to retrieve the list of AI models available in the GitHub Models catalog. Use when you need to discover available models, their capabilities, token limits, and supported modalities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_CHECK_RUNRetrieves detailed information for a specific check run within a GitHub repository.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username of the account that owns the repository. This field is not case-sensitive.
integer
required
The unique numerical identifier of the check run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_CHECK_SUITERetrieves a specific check suite (a collection of check runs) by its ID from a repository accessible to the authenticated user.

Input Parameters

string
required
The name of the repository, without the .git extension. This value is not case sensitive.
string
required
The username of the account that owns the repository. This value is not case sensitive.
integer
required
The unique identifier of the check suite.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_CLASSROOMRetrieves details for a specific GitHub Classroom. Requires the authenticated user to be an administrator of the classroom.

Input Parameters

integer
required
The unique identifier of the classroom.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_CODE_OF_CONDUCTRetrieves the full details of a specific GitHub code of conduct using its unique key.

Input Parameters

string
required
Unique key for a specific code of conduct.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_CODE_OF_CONDUCT_GRAPH_QLTool to look up a code of conduct by its key using GitHub’s GraphQL API. Use when you need to fetch code of conduct details as part of a GraphQL workflow.

Input Parameters

string
required
The unique key identifier for the code of conduct to retrieve. Common keys include ‘contributor_covenant’, ‘citizen_code_of_conduct’, and ‘django’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_CODEQL_DATABASEGets 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.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.
string
required
The programming language of the CodeQL database to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_CODE_SCANNING_ALERTRetrieves a specific code scanning alert, which identifies potential code vulnerabilities or errors, by its number from the specified GitHub repository.

Input Parameters

string
required
Repository name, without the .git extension (case-insensitive).
string
required
Username of the account owning the repository (case-insensitive).
integer
required
Unique number identifying the code scanning alert (must be >= 1), found in the alert’s URL or API responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_CODE_SCANNING_ANALYSISRetrieves detailed information for a specific code scanning analysis on an accessible repository, identified by its analysis_id.

Input Parameters

string
required
Name of the repository, without the .git extension (not case-sensitive).
string
required
Username or organization name owning the repository (not case-sensitive).
integer
required
Unique ID of the code scanning analysis, obtained by listing all analyses for the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_CODE_SCANNING_DEFAULT_SETUPGets the default setup configuration for code scanning in a repository, including state, languages, query suite, and schedule for a repository if it exists.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_CODESPACECall to retrieve detailed information for a codespace_name belonging to the authenticated user, ensuring the codespace exists and is accessible.

Input Parameters

string
required
Unique name or identifier of the codespace, typically auto-generated upon creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_COMMIT_AUTHORSFetches commit authors identified during a repository import, used to map authors from an external VCS to GitHub accounts. NOTE: This endpoint has been deprecated by GitHub as of April 12, 2024, and is no longer available. The Source Imports REST API has been retired due to very low usage levels. Please use the GitHub Importer tool at https://github.com/new/import for repository imports.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The username of the account that owns the repository. This name is not case-sensitive.
integer
An optional author ID. If provided, only authors with an ID greater than this specified ID will be returned. This ID refers to the id field of an author object in the response, and can be used for paginating through the list of authors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_COMMIT_COMMENTRetrieves the full details of a specific commit comment in a GitHub repository, using its unique identifier.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.
integer
required
The unique identifier of the commit comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_COMMIT_OBJECTRetrieves detailed information (including author, committer, message, tree, parents, verification) for a specific commit in a GitHub repository, identified by its SHA.

Input Parameters

string
required
Name of the repository without the .git extension. The name is not case sensitive.
string
required
Account owner of the repository. The name is not case sensitive.
string
required
SHA identifier of the commit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_COMMIT_SIGNATURE_PROTECTIONGets the commit signature protection status for a branch in a repository.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository. This name is not case sensitive.
string
required
The name of the branch. This name IS case-sensitive (unlike owner and repo). Wildcard characters are not allowed. To use wildcard characters in branch names, consider using the GraphQL API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_COMMIT_STATUSESLists a page of statuses for a commit reference (SHA, branch, or tag) in reverse chronological order, for checking CI/CD results from various systems.

Input Parameters

string
required
The commit reference. Can be a commit SHA, branch name (heads/BRANCH_NAME), or tag name (tags/TAG_NAME).
integer
Page number of results to fetch. Default: 1
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
Number of results per page, maximum 100. Default: 30

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_COMMUNITY_PROFILE_METRICSRetrieves a repository’s community profile metrics, including health percentage and the presence of key community files (e.g., README, LICENSE).

Input Parameters

string
required
Name of the repository, without ‘.git’ extension. Not case-sensitive.
string
required
Username of the account owning the repository. Not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_CONTEXTUAL_INFORMATION_FOR_A_USERGets contextual hovercard information for a GitHub user; subject_type and subject_id can be jointly provided for more specific details.

Input Parameters

string
required
GitHub username for whom to retrieve hovercard data.
string
Entity ID for subject_type for more specific hovercard context; required if subject_type is also given.
string ("organization" | "repository" | "issue" | "pull_request")
Entity type for more specific hovercard context (e.g., ‘repository’); required if subject_id is also given.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_CUSTOM_DEPLOYMENT_PROTECTION_RULERetrieves 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.

Input Parameters

string
required
The name of the repository without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository (username or organization name). This name is not case sensitive.
string
required
The name of the environment. The name must be URL encoded if it contains special characters (e.g., any slashes / must be replaced with %2F).
integer
required
The unique identifier of the custom deployment protection rule. Get this ID from GITHUB_GET_ALL_DEPLOYMENT_PROTECTION_RULES_FOR_AN_ENVIRONMENT action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_DEFAULT_ATTRIBUTES_FOR_A_CODESPACEGet 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.

Input Parameters

string
Git reference (branch name, tag name, or commit SHA) for devcontainer configuration. If omitted, the repository’s default branch is used.
string
required
Name of the repository, without the .git extension (case-insensitive).
string
required
Username of the account owning the repository (case-insensitive).
string
Optional IP address to override default location auto-detection (e.g., for proxied requests). If unspecified, location is inferred from source IP.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_DEFAULT_WORKFLOW_PERMISSIONS_FOR_AN_ORGANIZATIONGets the default GITHUB_TOKEN workflow permissions and settings for a GitHub organization.

Input Parameters

string
required
The name of the organization. This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_DEFAULT_WORKFLOW_PERMISSIONS_FOR_A_REPOSITORYGets 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.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_DEPENDABOT_ALERTGet one Dependabot vulnerability alert for a repository.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The number that identifies the Dependabot alert.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_DEPENDENCY_DIFFGets 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.

Input Parameters

string
The optional full path, relative to the repository root, of a specific dependency manifest file (e.g., package-lock.json, pom.xml). If provided, the diff will be scoped to this file.
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
string
required
A string specifying the base and head Git revisions to compare, in the format BASE_REF...HEAD_REF. BASE_REF and HEAD_REF can be commit SHAs, branch names, or tags. For example, main...develop or v1.0.0...v1.1.0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_DEPLOY_KEYGets a specific deploy key, identified by its key_id, for the GitHub repository specified by owner and repo.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
integer
required
The unique numerical identifier of the deploy key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_DEPLOYMENTGets a specific deployment by ID from a repository, provided the repository and deployment ID exist.

Input Parameters

string
required
The name of the repository, without the ‘.git’ extension. This field is not case-sensitive.
string
required
The username of the account that owns the repository. This field is not case-sensitive.
integer
required
The unique numeric identifier of the deployment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_DEPLOYMENT_BRANCH_POLICYRetrieves a specific deployment branch policy for an environment in a repository, identified by its unique ID.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.
integer
required
The unique identifier of the branch policy.
string
required
The name of the environment. The name must be URL encoded; for example, replace any slashes in the name with %2F.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_DEPLOYMENT_STATUSRetrieves a specific deployment status by its ID for a given deployment within a GitHub repository.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The unique identifier of the deployment status.
integer
required
The unique identifier of the deployment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_DETAILS_ABOUT_A_CODESPACE_EXPORTRetrieves detailed information about a specific export of a codespace.

Input Parameters

string
required
The ID of the export operation. Currently, only ‘latest’ is supported, which refers to the most recent export for the specified codespace.
string
required
The unique name of the codespace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_DISCUSSIONFetches a specific discussion by its number from a team within an organization. This is a read-only action that retrieves discussion details including title, body, author information, comment count, and reactions. The authenticated user must be a member of the organization to access team discussions.

Input Parameters

string
required
The organization’s name (case-insensitive).
string
required
The team’s slug (URL-friendly name).
integer
required
The discussion’s unique number within the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_DISCUSSION_COMMENTFetches a specific comment from a team discussion within a specific organization.

Input Parameters

string
required
The name of the organization. This field is not case-sensitive.
string
required
The slug of the team name. This is the team name converted to lowercase, with spaces and special characters replaced by hyphens. For example, ‘Developer Tools Team’ becomes ‘developer-tools-team’.
integer
required
The unique number identifying the comment within the discussion.
integer
required
The unique number identifying the discussion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_EMOJISLists all emojis available for use on GitHub, including custom and Unicode emojis.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_ENTERPRISE_MEMBER_INVITATIONTool to look up a pending enterprise unaffiliated member invitation by invitee and enterprise. Use when you need to check the status of a specific invitation.

Input Parameters

string
required
The login (username) of the user invited to join the enterprise. This is the GitHub username of the invitee.
string
required
The slug of the enterprise the user was invited to join. Enterprise slugs are used to identify enterprises in GitHub URLs (e.g., ‘acme-corp’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_FEEDSFetches a list of available GitHub feed URLs for the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_GISTFetches a GitHub gist by ID, including its files and metadata. File contents or the file list may be truncated; use the raw file URL or clone the gist to retrieve complete content when needed.

Input Parameters

string
required
The unique hexadecimal string identifier of the gist, found in its URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_GIST_COMMENTRetrieves a specific GitHub Gist comment using the gist ID and comment ID, returning its text, author information, and timestamps.

Input Parameters

string
required
The unique alphanumeric identifier of the Gist (found in the Gist URL after gist.github.com/username/).
integer
required
The unique numeric identifier of the comment. Obtain this from listing gist comments or from the comment URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_GIST_REVISIONRetrieves a specific revision of a gist.

Input Parameters

string
required
The SHA (Secure Hash Algorithm) identifier of a specific gist revision. This is a 40-character hexadecimal string.
string
required
The unique identifier of the gist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_GITHUB_ACTIONS_CACHE_USAGE_FOR_AN_ORGANIZATIONRetrieves total GitHub Actions cache usage for an organization, including active cache count and size across its repositories. Usage data refreshes approximately every five minutes and may lag changes.

Input Parameters

string
required
Name of the organization (case-insensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_GITHUB_ACTIONS_CACHE_USAGE_FOR_A_REPOSITORYRetrieves the total count of active GitHub Actions caches and their combined size in bytes for a specified repository.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_GITHUB_ACTIONS_PERMISSIONS_FOR_AN_ORGANIZATIONGets the GitHub Actions permissions for a specified organization, detailing repository enablement and allowed actions policies.

Input Parameters

string
required
The name of the GitHub organization. This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_GITHUB_ACTIONS_PERMISSIONS_FOR_A_REPOSITORYGets the GitHub Actions permissions policy for a repository, including its enabled status and the scope of allowed actions.

Input Parameters

string
required
The name of the repository, without the .git extension. This is not case-sensitive.
string
required
The username of the account that owns the repository. This is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_GITHUB_BILLING_PREMIUM_REQUEST_USAGE_REPORT_USERTool to get billing premium request usage report for a GitHub user. Use when you need to retrieve usage data for premium features like Copilot or AI models.

Input Parameters

integer
If specified, only return results for a single day. The value of day is an integer between 1 and 31. If no year or month is specified, the default year and month are used.
integer
If specified, only return results for a single year. The value of year is an integer with four digits representing a year. For example, 2025. Default value is the current year.
string
The model name to query usage for. The name is not case sensitive.
integer
If specified, only return results for a single month. The value of month is an integer between 1 and 12. Default value is the current month. If no year is specified the default year is used.
string
The product name to query usage for. The name is not case sensitive.
string
required
The handle for the GitHub user account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_GITHUB_BILLING_USAGE_SUMMARY_FOR_USERTool to retrieve billing usage summary for a GitHub user account. Use when tracking usage costs, monitoring billing details, or generating usage reports for a specific user. Note: This endpoint only returns data for the past 24 months and is currently in public preview.

Input Parameters

integer
If specified, only return results for a single day. The value of day is an integer between 1 and 31. If no year or month is specified, the default year and month are used.
string
The SKU to query for usage.
integer
If specified, only return results for a single year. The value of year is an integer with four digits representing a year (e.g., 2025). Default value is the current year.
integer
If specified, only return results for a single month. The value of month is an integer between 1 and 12. Default value is the current month. If no year is specified the default year is used.
string
The product name to query usage for. The name is not case sensitive.
string
required
The handle for the GitHub user account.
string
The repository name to query for usage in the format owner/repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_GITHUB_META_INFORMATIONFetches GitHub’s publicly available metadata, useful for configuring network security policies or IP allow-listing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_GITHUB_PAGES_BUILDRetrieves detailed information about a specific GitHub Pages build for a repository, which must have GitHub Pages enabled.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
integer
required
The unique identifier of the GitHub Pages build to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_GITIGNORE_TEMPLATERetrieves a specific .gitignore template from GitHub by its name, which must be an existing template in GitHub’s collection.

Input Parameters

string
required
The name of the .gitignore template to retrieve (e.g., ‘Python’, ‘Node’). This is case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_GLOBAL_SECURITY_ADVISORYRetrieve a global GitHub security advisory by its GHSA identifier. Use this to get detailed information about vulnerabilities including severity, affected packages, CVSS scores, and references.

Input Parameters

string
required
The GHSA (GitHub Security Advisory) identifier of the advisory.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_GRAPHQL_NODEFetch a GitHub GraphQL node by its global ID. By default, only its ID is requested; supply a GraphQL fragment to retrieve additional fields.

Input Parameters

string
required
The global node ID of the object to fetch. This is the GraphQL global identifier (node_id) returned by GitHub’s API, not the numeric ID.
string
Optional GraphQL fragment to specify which fields to retrieve from the returned node. Use GraphQL inline fragment syntax (e.g., ’… on User { login name }’). If omitted, only the ‘id’ field will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_GRAPHQL_RATE_LIMITTool to retrieve the authenticated client’s GitHub GraphQL API rate limit information. Use when you need to check remaining quota, current usage, or reset time for GraphQL requests.

Input Parameters

boolean
If true, calculate the cost for the query without evaluating it. Use this to estimate query costs without consuming actual quota.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_INFORMATION_ABOUT_A_SARIF_UPLOADRetrieves 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.

Input Parameters

string
required
Name of the repository, without the .git extension (not case-sensitive).
string
required
Username of the account that owns the repository (not case-sensitive).
string
required
Unique identifier of the SARIF upload, returned when a SARIF file is successfully uploaded.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_INTERACTION_RESTRICTIONS_FOR_AN_ORGANIZATIONRetrieves interaction restrictions for an organization, showing which GitHub user types can interact with its public repositories and when restrictions expire; returns an empty response if no restrictions are set.

Input Parameters

string
required
The name of the organization. This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_INTERACTION_RESTRICTIONS_FOR_A_REPOSITORYRetrieves 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.

Input Parameters

string
required
The name of the repository, without the .git extension. This is case-insensitive.
string
required
The username of the account that owns the repository. This is case-insensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_INTERACTION_RESTRICTIONS_FOR_PUBLIC_REPOSRetrieves currently active interaction restrictions for the authenticated user’s public repositories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_ISSUE_COMMENTSRetrieves a page of comments for a specific GitHub issue. Comments can be filtered by update time and paginated to view discussion history.

Input Parameters

integer
Page number of the results to retrieve.
string
required
Name of the repository, without the .git extension (case-insensitive).
string
required
Username of the account owning the repository (case-insensitive).
string
Only show comments updated at or after this ISO 8601 timestamp (e.g., YYYY-MM-DDTHH:MM:SSZ).
integer
Number of comments to return per page (maximum 100).
integer
required
Number that identifies the issue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_LABELRetrieves a specific label by its name from a specified GitHub repository.

Input Parameters

string
required
The name of the label to retrieve. GitHub’s API treats label names as case-insensitive for this operation.
string
required
The name of the repository, without the .git extension. The name is not case-sensitive.
string
required
The account owner of the repository (e.g., a username or organization name). The name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_LARGE_FILESLists files larger than 100MB identified during a previous source import for the specified repository. NOTE: This endpoint has been deprecated by GitHub as of April 12, 2024, and is no longer available. The Source Imports REST API has been retired due to very low usage levels. Please use the GitHub Importer tool at https://github.com/new/import for repository imports.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_LATEST_PAGES_BUILDRetrieves 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.

Input Parameters

string
required
The name of the repository, without the ‘.git’ extension. This name is not case-sensitive.
string
required
The username of the account or the name of the organization that owns the repository. This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_LICENSECall this action to retrieve comprehensive details for a specific software license recognized by GitHub, using its unique license key.

Input Parameters

string
required
The unique identifier (key) of the license. This is typically the SPDX license identifier (e.g., ‘mit’, ‘apache-2.0’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_LICENSE_GRAPH_QLTool to look up an open source license by its SPDX ID using GitHub’s GraphQL API. Use when you need to fetch license details for compliance tracking or repository setup.

Input Parameters

string
required
The license’s downcased SPDX ID. Common keys include ‘mit’, ‘apache-2.0’, ‘gpl-3.0’, ‘bsd-3-clause’, ‘lgpl-3.0’, ‘mpl-2.0’, ‘agpl-3.0’, ‘unlicense’, ‘isc’, ‘bsd-2-clause’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_OCTOCATFetches an ASCII art representation of GitHub’s Octocat, suitable for text-based displays.

Input Parameters

string
Custom message for Octocat’s speech bubble. If omitted or empty, a random ‘Zen of GitHub’ message will be displayed instead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_OIDC_SUBJECT_CLAIM_TEMPLATERetrieves the OpenID Connect (OIDC) subject claim customization template for a repository’s GitHub Actions workflows. The validated response has no declared template fields.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_ORG_ALLOWED_ACTIONSGets the list of allowed actions and reusable workflows for an organization when the ‘allowed_actions’ policy is set to ‘selected’.

Input Parameters

string
required
The unique identifier or name of the organization. This field is not case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_ORGANIZATION_AUDIT_LOGTool to retrieve an organization’s audit log events for security and compliance investigations. Use when tracking organizational changes, security audits, or compliance monitoring. Requires organization owner permissions and read:audit_log scope.

Input Parameters

string
required
The organization name. The name is not case sensitive.
string
A cursor for pagination. Returns events after this cursor. Use the cursor from the response to fetch the next page.
string
The order of audit log events. Can be ‘asc’ (ascending, oldest first) or ‘desc’ (descending, newest first). Defaults to ‘desc’.
string
A cursor for pagination. Returns events before this cursor. Use the cursor from the response to fetch the previous page.
string
A search phrase to filter audit log events. For example, ‘action:org’ for organization-related events, or ‘actor:octocat’ for events by a specific user.
string
The event types to include. Can be ‘web’ (web interface events), ‘git’ (Git events), or ‘all’. Defaults to ‘web’.
integer
The number of results per page (max 100). Defaults to 30.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_ORGANIZATION_CUSTOM_PROPERTYRetrieves the definition (schema) of a specific, existing custom property for an organization.

Input Parameters

string
required
Organization’s login name (not case-sensitive).
string
required
Name of the custom property to retrieve (case-sensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_ORGANIZATION_MEMBERSHIP_FOR_USERReturn a named user’s membership state and role in a GitHub organization.

Input Parameters

string
required
The organization name. The name is not case sensitive.
string
required
The handle for the GitHub user account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_ORGANIZATION_PROJECT_ITEMTool to get an item from an organization-owned GitHub Projects V2 project. Use when you need to retrieve details about a specific project item including its content, fields, timestamps, and creator information.

Input Parameters

string
required
The organization name. The name is not case sensitive.
string
Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Format: fields[]=123&fields[]=456 or fields=123,456,789
integer
required
The unique identifier of the project item.
integer
required
The project’s number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_ORGANIZATION_PUBLIC_KEYRetrieves an organization’s public key, which must be used to encrypt secret values before they are configured for Codespaces.

Input Parameters

string
required
The name of the GitHub organization. This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_ORGANIZATION_PUBLIC_KEY_FOR_DEPENDABOTRetrieves the public key for an existing GitHub organization, required for encrypting Dependabot secrets. Requires admin:org scope.

Input Parameters

string
required
The name of the GitHub organization. Requires admin:org scope (must be an organization admin). This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_ORGANIZATION_TEAMSRetrieves a list of teams for a specified GitHub organization. Use this action when you need to list all teams, find team information, or explore team structure within an organization. Requires read:org scope and returns paginated results.

Input Parameters

string
required
The organization name. The name is not case sensitive.
integer
The page number of the results to fetch.
integer
The number of results per page (max 100).
string ("all" | "enterprise" | "organization")
Filter teams by type: ‘all’ for all teams, ‘enterprise’ for enterprise-level teams, or ‘organization’ for organization-level teams.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_ORG_DEV_ENVIRONMENT_SECRET_SAFELYRetrieves metadata for a specific secret available to an organization’s GitHub Codespaces without exposing its encrypted value.

Input Parameters

string
required
The organization name (login). The name is not case-sensitive.
string
required
The name of the development environment secret to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_ORG_OIDC_SUBJECT_CLAIM_TEMPLATERetrieves 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.

Input Parameters

string
required
The name of the GitHub organization (case-insensitive). This is the organization’s login/username, not a numeric ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_PAGES_DNS_HEALTH_CHECKRetrieves the DNS health check status (e.g., CNAME/A records, HTTPS) for a GitHub Pages site; the check may be pending (HTTP 202) on initial calls or after site changes.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case sensitive.
string
required
The username or organization name that owns the repository. This field is not case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_PAGES_SITERetrieves information for a GitHub Pages site, which must be enabled for the repository.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_PAGE_VIEWSRetrieves page view statistics for a repository over the last 14 days, including total views, unique visitors, and a daily or weekly breakdown.

Input Parameters

string ("day" | "week")
The time unit for which to aggregate page views.
string
required
The name of the repository, without the .git extension. This field is case-insensitive.
string
required
The username of the account that owns the repository. This field is case-insensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_PARENT_ISSUERetrieve the parent issue of a GitHub sub-issue.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The number that identifies the sub-issue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_PENDING_DEPLOYMENTS_FOR_A_WORKFLOW_RUNRetrieves pending deployment environments for a specific workflow run that are awaiting approval due to protection rules.

Input Parameters

string
required
Name of the repository, without the .git extension; not case-sensitive.
string
required
Account owner of the repository (user or organization); not case-sensitive.
integer
required
Unique numerical identifier of the workflow run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_PROJECT_PERMISSION_FOR_A_USERRetrieves permission information for a GitHub project (classic) collaborator. Returns the permission level and may include the collaborator’s GitHub user information.

Input Parameters

string
required
The GitHub username of the project owner or the user whose permission is being checked.
integer
required
The unique identifier (number) of the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_PUBLIC_KEY_FOR_SECRET_ENCRYPTIONRetrieves a repository’s public key for encrypting GitHub Codespaces secrets. For private repositories, classic OAuth or personal access tokens need the repo scope; fine-grained tokens need write permission for repository Codespaces secrets.

Input Parameters

string
required
Repository name, without the .git extension (not case-sensitive).
string
required
Username or organization name of the repository owner (not case-sensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_PUBLIC_KEY_FOR_THE_AUTHENTICATED_USERRetrieves the authenticated user’s public key for encrypting GitHub Codespaces secrets. The returned key must be used with libsodium sealed box encryption before creating or updating secrets via the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_PULL_REQUEST_REVIEW_PROTECTIONRetrieves the pull request review protection settings for a specific branch in a GitHub repository, if such protection is configured.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive. For example, in ‘octocat/Hello-World’, ‘Hello-World’ is the repository name.
string
required
The account owner of the repository. This name is not case-sensitive. For example, in ‘octocat/Hello-World’, ‘octocat’ is the owner.
string
required
The name of the branch. Wildcard characters are not allowed. To use wildcard characters in branch names, refer to the GitHub GraphQL API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_PULL_REQUESTSRetrieves a page of pull requests from a repository, optionally filtered by state, base branch, or head branch and sorted by the selected order. Returns pull request details including title, state, author, labels, timestamps, and branch information.

Input Parameters

string
Filter pulls by base branch name. Example: gh-pages.
string
Filter pulls by head user or head organization and branch name in the format of user:ref-name or organization:ref-name. For example: github:new-script-format or octocat:test-branch.
integer
The page number of the results to fetch.
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string ("created" | "updated" | "popularity" | "long-running")
What to sort results by. popularity will sort by the number of comments. long-running will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.
string
required
The account owner of the repository. The name is not case sensitive.
string ("open" | "closed" | "all")
Filter pull requests by state: open, closed, or all.
integer
The number of results per page (max 100).
string ("asc" | "desc")
Sort direction options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_RATE_LIMIT_STATUS_FOR_THE_AUTHENTICATED_USERRetrieves the authenticated user’s current GitHub API rate limit status, including usage and limits across different resource categories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_RAW_REPOSITORY_CONTENTFetches raw file content from a GitHub repository as a downloadable file, without parsing or validating its format. Ensure owner, repo, ref, and path are consistent when combining with other GitHub tools.

Input Parameters

string
The branch name, tag name, or commit SHA to fetch the file from. Defaults to the repository’s default branch (usually ‘main’ or ‘master’). Recommended to pass explicitly — omitting it fetches from the default branch, which may not match the ref used in other tool calls and can yield unexpected or missing content.
string
required
The file path within the repository, relative to the repository root. Use forward slashes for directory separators (e.g., ‘src/utils/helper.js’). Do not include leading slash. Do NOT pass a full GitHub URL - only the relative path within the repo. Must exactly match the file path as it exists in the repository — use GITHUB_GET_A_TREE to discover valid paths rather than guessing directory structure.
string
required
The repository name (not the full URL). This is the repository name shown in the repository URL (e.g., for github.com/torvalds/linux, the repo is ‘linux’). Do not include ‘.git’ suffix. Case-insensitive.
string
required
The GitHub username or organization name that owns the repository. This is the account name shown in the repository URL (e.g., for github.com/torvalds/linux, the owner is ‘torvalds’). Case-insensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_REPO_ALLOWED_ACTIONSGets the settings for allowed actions and reusable workflows in a repository. Requires the repository’s allowed_actions policy to be set to selected (returns 409 if set to all or local_only).

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_REPO_DEV_ENV_SECRETGets metadata (name, creation/update timestamps) for a specific, existing development environment secret (Codespaces secret) in a repository, without exposing its value.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is case-insensitive.
string
required
The username or organization name that owns the repository. This field is case-insensitive.
string
required
The name of the development environment secret to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_REPOS_ATTESTATIONSTool to retrieve attestations by subject digest from a GitHub repository. Use when you need to verify or check attestations for a specific artifact identified by its SHA256 digest.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see “Using pagination in the REST API”.
string
required
The account owner of the repository. The name is not case sensitive.
string
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see “Using pagination in the REST API”.
integer
The number of results per page (max 100). For more information, see “Using pagination in the REST API”.
string
Optional filter for fetching attestations with a given predicate type. This option accepts provenance, sbom, release, or freeform text for custom predicate types.
string
required
The parameter should be set to the attestation’s subject’s SHA256 digest, in the form sha256:HEX_DIGEST.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_REPOSITORY_CLONESRetrieves the total number of clones and a breakdown of clone activity (daily or weekly) for a specified repository over the preceding 14 days.

Input Parameters

string ("day" | "week")
Specifies the time frame for aggregating clone data: day for daily clone counts, or week for weekly clone counts (a week starts on Monday).
string
required
The name of the repository, without the ‘.git’ extension. This field is not case-sensitive.
string
required
The username of the account that owns the repository. This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_REPOSITORY_CONTENTRetrieves a file’s Base64-encoded content or lists a directory’s contents in a GitHub repository. Specify a branch, tag, or commit to read from, or use the repository’s default branch; an empty path lists the root directory.

Input Parameters

string
The name of the commit, branch, or tag to read from. Use this parameter to specify which branch (e.g., ‘feat/godlocal-dev’, ‘main’, ‘develop’), tag (e.g., ‘v1.2.0’), or commit SHA you want to access. If not provided, the repository’s default branch will be used. Note: Branch names should be passed here, NOT in the path parameter.
string
required
Required. Path to file or directory in the repository. Empty string (”) retrieves root directory contents. Leading slashes auto-stripped. CRITICAL: Do NOT pass branch names here (e.g., ‘feat/godlocal-dev’, ‘main’). Branch names belong in the ref parameter. Path should be file/directory path only (e.g., ‘src/main.js’, ‘README.md’), NOT prefixed with branch name (use ‘src/main.js’ not ‘main/src/main.js’). File paths must include extension (e.g., ‘README.md’, not ‘README’). For common files (README, LICENSE, CHANGELOG) without extensions, action auto-tries common extensions (.md, .txt, .rst). Paths are case-sensitive. On 404 errors, list parent directory to verify exact path/casing.
string
required
Required. The name of the repository, without the .git extension. This name is not case sensitive.
string
required
Required. The account owner of the repository. This name is not case sensitive. Can also accept full repository path in format ‘owner/repo’ - the repo part will be extracted automatically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_REPOSITORY_DISCUSSION_THREADReads one repository Discussion with cursor-paginated top-level comments and up to the requested first replies for each comment.

Input Parameters

string
required
The repository name.
string
required
The user or organization login that owns the repository.
integer
Maximum number of replies to return for each comment (1-100).
string
Cursor from comments.pageInfo.endCursor for the next comments page.
integer
Maximum number of discussion comments to return (1-100).
integer
required
The repository-local number of the Discussion thread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_REPOSITORY_GRAPH_QLTool to lookup a repository by owner and name using GitHub’s GraphQL API. Use when you need comprehensive repository information.

Input Parameters

string
required
The name of the repository.
string
required
The login field of a user or organization that owns the repository.
boolean
Follow repository renames. If true, the query will follow repository renames to find the current repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_REPOSITORY_OWNERTool to lookup a repository owner (User or Organization) by login using GitHub’s GraphQL API. Use when you need to determine whether a login is a user or organization and retrieve basic profile information.

Input Parameters

string
required
The username or organization name to lookup. This is case-sensitive and must match the exact GitHub login.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_REPOSITORY_PERMISSIONS_FOR_A_USERRetrieves a user’s repository permission and assigned role, including custom roles. The legacy permission level is admin, write, read, or none; maintain maps to write and triage to read.

Input Parameters

string
required
Name of the repository, without the .git extension (case-insensitive).
string
required
Account owner of the repository (case-insensitive).
string
required
GitHub user’s handle (case-insensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_REPOSITORY_PUBLIC_KEY_FOR_ENCRYPTIONGets a repository’s public key, used to encrypt secrets for Dependabot.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_REPOSITORY_SECRET_SECURELYRetrieves metadata for an existing Dependabot secret in a repository, without exposing its encrypted value.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
string
required
The name of the Dependabot secret to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_REPOSITORY_SECURITY_ADVISORYTool to retrieve a repository security advisory using its GHSA identifier. Use when you need detailed information about a specific security vulnerability.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
string
required
The GHSA (GitHub Security Advisory) identifier of the advisory.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_REPOSITORY_STAR_HISTORYGets one page of up to 30 privacy-safe weekly star-count records, newest first. Increase page to move backward in a repository’s history.

Input Parameters

integer
Page number of weekly star history records to return, from 1 to 100.
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
Number of weekly star history records to return per page, from 1 to 30.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_REPOSITORY_WEBHOOK_DELIVERYRetrieves a specific delivery for a repository webhook, identified by its hook_id and delivery_id.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The unique identifier of the webhook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery, or by listing repository webhooks.
integer
required
The unique identifier of a specific delivery for the webhook. This ID corresponds to a single delivery attempt. You can find this by listing webhook deliveries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_RULES_FOR_A_BRANCHRetrieves a page of active rules for a specific branch in a GitHub repository, excluding rules in ‘evaluate’ or ‘disabled’ status.

Input Parameters

integer
Page number of results to fetch.
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The GitHub account owner of the repository. This name is not case-sensitive.
string
required
The name of the branch. Wildcard characters are not supported for this parameter; to use wildcards, refer to the GitHub GraphQL API.
integer
Number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_SINGLE_ORG_SECRET_WITHOUT_DECRYPTIONGets a single organization Dependabot secret’s metadata (name, timestamps, visibility) without revealing its encrypted value. Requires admin:org scope.

Input Parameters

string
required
The name of the GitHub organization (case-insensitive).
string
required
The name of the Dependabot secret to retrieve (case-insensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_STATUS_CHECKS_PROTECTIONRetrieves the status check protection settings for a specific branch in a GitHub repository, if status check protection is enabled for it.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The account owner of the repository (e.g., a GitHub username or organization name). This field is not case-sensitive.
string
required
The name of the branch. Wildcard characters are not supported in branch names for this endpoint; for wildcard support, please refer to the GitHub GraphQL API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_TEAM_MEMBERSRetrieves one page of members for a specific team within an organization, including members of child teams, optionally filtered by role. Requires the authenticated user to have read access to the team.

Input Parameters

string
required
The organization name. This field is not case-sensitive.
integer
The page number of the results to fetch. Used for pagination.
string ("member" | "maintainer" | "all")
Filters members returned by their role in the team. Can be ‘member’ for regular team members, ‘maintainer’ for team maintainers, or ‘all’ to include both.
integer
The number of results per page. Maximum is 100.
string
required
The slug of the team name. This is the URL-friendly version of the team name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_TEAM_MEMBERSHIP_FOR_A_USERRetrieves a user’s role and membership status in a GitHub organization team. A successful lookup returns the role and state; is_member=False can also indicate access denial or a missing team or organization, not just non-membership.

Input Parameters

string
required
The name of the GitHub organization. This field is not case-sensitive.
string
required
The GitHub username of the user.
string
required
The URL-friendly version of the team name (slug).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_TEAMS_WITH_ACCESS_TO_THE_PROTECTED_BRANCHLists teams with explicit push access to a protected branch. A 404 response is returned as an empty teams list, which can also reflect a missing branch or absent branch protection.

Input Parameters

string
required
Repository name, without the .git extension; not case-sensitive.
string
required
Username of the repository owner; not case-sensitive.
string
required
Name of the branch; does not support wildcard characters (for wildcard support, use the GraphQL API).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_THE_AUTHENTICATED_USERGets the profile information for the currently authenticated GitHub user, including potentially private details based on user settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_THE_COMBINED_STATUS_FOR_A_SPECIFIC_REFERENCERetrieves the combined commit status and status entries for a specific reference (SHA, branch, or tag) in a GitHub repository.

Input Parameters

string
required
The specific commit reference to query. This can be a commit SHA, a branch name (e.g., heads/main), or a tag name (e.g., tags/v1.0.0). See “Git References” for more details.
integer
The page number for the results to retrieve. See “Using pagination in the REST API” for more information.
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
integer
The number of results to display per page, with a maximum of 100. Details on pagination can be found in “Using pagination in the REST API.”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_THE_HOURLY_COMMIT_COUNT_FOR_EACH_DAYRetrieves the ‘punch card’ data, showing hourly commit counts for each day of the week for an existing and accessible repository.

Input Parameters

string
required
The name of the repository, without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. This is typically the username or organization name. The name is not case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_THE_LAST_YEAR_OF_COMMIT_ACTIVITYFetches weekly commit totals and daily commit counts for the last 52 weeks for a specified GitHub repository.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_THE_LATEST_RELEASEFetches the latest official (non-prerelease, non-draft) release for a GitHub repository; requires at least one such published release.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The account owner of the repository (e.g., a GitHub username or organization name). This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_THE_LICENSE_FOR_A_REPOSITORYRetrieves the license file and its details for a repository, optionally from a specific Git reference (branch, tag, or commit SHA).

Input Parameters

string
The specific Git reference (branch name, tag name, or commit SHA) to retrieve the license from. For a branch, it can be formatted as refs/heads/<branch_name> or simply <branch_name>. To reference a pull request’s merge commit, use refs/pull/<pull_number>/merge. If omitted, the license from the repository’s default branch is used.
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The account owner of the repository (username or organization name). This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_THE_REVIEW_HISTORY_FOR_A_WORKFLOW_RUNRetrieves 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.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The username of the account or the name of the organization that owns the repository. This name is not case-sensitive.
integer
required
The unique identifier of the workflow run for which to retrieve the review history.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_THE_STATUS_OF_A_GITHUB_PAGES_DEPLOYMENTRetrieves the status of a specific GitHub Pages deployment for a repository, which must have GitHub Pages enabled.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The account owner of the repository (username or organization name). This field is not case-sensitive.
string
required
The unique identifier of the GitHub Pages deployment. This can be the numeric ID of the deployment or the commit SHA that triggered the deployment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_THE_WEEKLY_COMMIT_ACTIVITYFetches the weekly commit activity (additions and deletions per week) for a repository over the past year; best for repositories with under 10,000 commits.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository (e.g., a user or organization). This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_THE_WEEKLY_COMMIT_COUNTRetrieves the weekly commit count for a repository, detailing commits by the owner and all contributors over the last 52 weeks; GitHub may return a 202 status or an empty response if statistics are being computed.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_THE_ZEN_OF_GITHUBRetrieves 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_TOP_REFERRAL_PATHSFetches the top 10 most viewed content paths for a repository from the last 14 days.

Input Parameters

string
required
Repository name, without the .git extension (not case-sensitive).
string
required
Username of the account or organization owning the repository (not case-sensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_TOP_REFERRAL_SOURCESFetches the top 10 websites that referred traffic to a repository within the last 14 days.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is case-insensitive.
string
required
The username or organization name that owns the repository. This field is case-insensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_USER_BY_IDRetrieves a GitHub user’s profile information by their unique numeric account ID. Use when you know the user’s numeric ID rather than their username.

Input Parameters

integer
required
The unique numeric identifier of the GitHub user account to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_USER_PROJECT_ITEMTool to get an item from a user-owned project in GitHub Projects V2. Use when you need to retrieve details about a specific item (issue, pull request, or draft issue) in a user’s project board.

Input Parameters

string
Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789
integer
required
The unique identifier of the project item.
string
required
The handle for the GitHub user account.
integer
required
The project’s number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_USERS_ATTESTATIONSRetrieves attestations for a GitHub user and subject digest, with optional predicate filtering and pagination. A GitHub 404 is returned as an empty attestation list.

Input Parameters

string
A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
string
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
integer
The number of results per page (max 100). For more information, see ‘Using pagination in the REST API’.
string
required
The handle for the GitHub user account.
string
Optional filter for fetching attestations with a given predicate type. This option accepts ‘provenance’, ‘sbom’, ‘release’, or freeform text for custom predicate types.
string
required
Subject digest for the attestation. Must include the algorithm prefix (e.g., ‘sha256:’ or ‘sha512:’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_USERS_PROJECTS_V2Tool to list GitHub Projects v2 for a specified user. Use when you need to retrieve all projects owned by a user with pagination support.

Input Parameters

string
Limit results to projects of the specified type.
string
A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see ‘Using pagination in the REST API’.
string
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see ‘Using pagination in the REST API’.
integer
The number of results per page (max 100). For more information, see ‘Using pagination in the REST API’.
string
required
The handle for the GitHub user account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_USERS_WITH_ACCESS_TO_THE_PROTECTED_BRANCHLists users with explicit push access to a protected branch through its push restrictions. A 404 response is returned as an empty user list, including when the branch or repository is inaccessible or missing.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository (e.g., user or organization). This name is not case-sensitive.
string
required
The name of the protected branch. Wildcard characters are not supported. To use wildcard characters in branch names, refer to the GitHub GraphQL API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_VIEWER_GRAPHQLTool to retrieve the authenticated user’s profile information via GitHub GraphQL. Use when working with GraphQL queries or need viewer details in GraphQL format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_WORKFLOW_EXTERNAL_ACCESSGets the access level settings for a private repository, determining how workflows outside this repository can use its actions and reusable workflows.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_WORKFLOW_RUN_JOBRetrieves 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.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
integer
required
The unique numerical identifier of the job to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_WORKFLOW_RUN_USAGEGets the billable time, in milliseconds, for a specific workflow run, detailing time spent on various operating systems.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
Account owner of the repository (username or organization name); not case sensitive.
integer
required
Unique identifier of the workflow run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_GET_WORKFLOW_USAGEGets the billable time (in milliseconds, broken down by runner OS) for a specific workflow within a repository for the current billing cycle.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
string
required
The unique identifier (ID) of the workflow or the workflow’s file name (e.g., ‘main.yml’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_IS_REPOSITORY_STARRED_BY_THE_USERUse 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); the action fails (e.g., HTTP 404) if the repository is not starred or does not exist.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository (e.g., a user or organization). This name is not case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ACCEPTED_ASSIGNMENTS_FOR_AN_ASSIGNMENTLists accepted assignments (student repositories created after acceptance) for an existing GitHub Classroom assignment, identified by its unique assignment_id.

Input Parameters

integer
Page number of the results to retrieve.
integer
Number of results to return per page (maximum 100).
integer
required
The unique identifier of the classroom assignment for which to list accepted assignments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ACCESSIBLE_REPOSITORIESLists repositories that the authenticated user can access through a specific GitHub App installation. Returns repositories where the user has explicit :read, :write, or :admin permission through the installation. The response includes permission details for each repository. Prerequisites: - Requires a GitHub App user access token (not a standard OAuth token) - Use GITHUB_LIST_APP_INSTALLATIONS first to get valid installation IDs

Input Parameters

integer
Page number of the results to fetch, starting from 1.
integer
Number of repositories to return per page. Maximum is 100.
integer
required
The unique identifier of the GitHub App installation. Get this from GITHUB_LIST_APP_INSTALLATIONS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_APP_INSTALLATIONSLists a page of GitHub App installations accessible to the authenticated user, including installation details, permissions, and repository access. Supports page and page-size selection and returns the total count of accessible installations.

Input Parameters

integer
Page number of results to retrieve.
integer
Number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_APPS_WITH_ACCESS_TO_THE_PROTECTED_BRANCHLists GitHub Apps with push access to a repository’s protected branch. A 404 returns no app list and an explanatory message; it can indicate a missing branch or unavailable restrictions.

Input Parameters

string
required
The name of the repository, without the ‘.git’ extension. This field is not case-sensitive.
string
required
The username of the account that owns the repository. This field is not case-sensitive.
string
required
The name of the protected branch. This name cannot contain wildcard characters. To work with branch names containing wildcard characters, please use the GitHub GraphQL API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ARTIFACTS_FOR_A_REPOSITORYLists GitHub Actions workflow artifacts for a specified repository, which must exist.

Input Parameters

string
The name of an artifact. If specified, only artifacts with this exact name will be returned. If omitted or null, all artifacts in the repository are listed (subject to pagination).
integer
The page number of the results to fetch, starting from 1.
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The account owner of the repository (username or organization name). This field is not case-sensitive.
integer
The number of artifacts to return per page; maximum is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ASSIGNEESLists users who can be assigned to issues in a repository, typically those with push access.

Input Parameters

integer
Page number of results (1-indexed).
string
required
The name of the repository, without the .git extension. This is not case-sensitive.
string
required
The username of the account that owns the repository. This is not case-sensitive.
integer
Number of results per page. Max 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ASSIGNMENTS_FOR_A_CLASSROOMLists a page of assignments for an accessible GitHub Classroom, with page and page-size controls.

Input Parameters

integer
Specifies the page number of the results to retrieve. For more information, refer to GitHub’s documentation on Using pagination in the REST API.
integer
Specifies the number of results to return per page (maximum is 100). For more information, refer to GitHub’s documentation on Using pagination in the REST API.
integer
required
The unique identifier of the classroom for which assignments are to be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ATTESTATION_REPOSITORIESTool to list attestation repositories for an organization. Use when you need to discover which repositories in an organization have attestations. Attestations provide verifiable metadata about software artifacts.

Input Parameters

string
required
The organization name. The name is not case sensitive.
string
A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see ‘Using pagination in the REST API’.
string
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see ‘Using pagination in the REST API’.
integer
The number of results per page (max 100). For more information, see ‘Using pagination in the REST API’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_AUTHENTICATED_USER_SSH_KEYSList public Git SSH keys owned by the connected GitHub user.

Input Parameters

integer
The page number of the results to fetch.
integer
The number of SSH keys to return per page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_AVAILABLE_MACHINE_TYPES_FOR_A_REPOSITORYLists machine types available for GitHub Codespaces in a repository, optionally using a Git ref to check compatibility based on prebuild availability and devcontainer configurations.

Input Parameters

string
The Git reference (branch name, tag name, or commit SHA) to check for prebuild availability and devcontainer configuration restrictions. This ensures listed machine types are compatible with the specified repository version.
string
required
The name of the repository, without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. This is typically the username (for personal repositories) or the organization name (for organization-owned repositories). The name is not case sensitive.
string
The geographic location to check for available machine types. If not provided, the location may be inferred. Specifying a location can help find machines in a preferred region.
string
An IP address used for auto-detecting the location if location is not specified. This is particularly useful when requests are proxied, to ensure location-based machine availability is accurate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_BRANCHESLists a page of branches in a GitHub repository, optionally filtered by protection status. Returns branch names, commit information, and protection status.

Input Parameters

integer
The page number of the results to fetch. For more information, see ‘Using pagination in the REST API’.
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
The number of results per page (max 100). For more information, see ‘Using pagination in the REST API’.
boolean
Setting to true returns only branches protected by branch protections or rulesets. When set to false, only unprotected branches are returned. Omitting this parameter returns all branches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_BRANCHES_FOR_HEAD_COMMITLists branches in an accessible repository where the provided commit SHA is the head, useful for identifying development lines based on that commit.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository (e.g., a user or organization). This name is not case-sensitive.
string
required
The full SHA-1 hash of the commit. This action will find branches where this commit is the most recent one (the head).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CHECK_RUN_ANNOTATIONSLists annotations for a specific check run in a GitHub repository, detailing issues like errors or warnings on particular code lines.

Input Parameters

integer
The page number of the results to fetch. See “Using pagination in the REST API” for more details.
string
required
The name of the repository, without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. This is typically the username or organization name. The name is not case sensitive.
integer
The number of results per page (maximum 100). See “Using pagination in the REST API” for more details.
integer
required
The unique identifier of the check run for which annotations are to be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CHECK_RUNS_FOR_A_REFList GitHub check runs for a commit SHA, branch, or tag to assess CI status and conclusions. Results default to the latest runs; the filter can be set to include all runs.

Input Parameters

string
required
The git reference - can be a commit SHA, branch name, or tag name.
integer
Page number of results to fetch.
string
required
The name of the repository without .git extension. Case-insensitive.
string
required
The account owner of the repository (username or organization name). Case-insensitive.
integer
Filter by GitHub App identifier.
string
Filter by completion timestamp: ‘latest’ returns the most recent check runs, ‘all’ returns all check runs.
string
Filter by check run status: queued, in_progress, or completed.
integer
Number of results per page, maximum 100.
string
Filters results to check runs with the specified name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CHECK_RUNS_IN_A_CHECK_SUITELists check runs for a specific check suite in a GitHub repository, optionally filtering by check name or status. Results default to the latest runs; the filter can be set to include all runs.

Input Parameters

integer
Page number of results to fetch (starts at 1).
string
required
Repository name, without the .git extension (case-insensitive).
string
required
Username or organization name of the repository owner (case-insensitive).
string ("latest" | "all")
Filter by completed_at timestamp: ‘latest’ for most recent, ‘all’ for all check runs.
string ("queued" | "in_progress" | "completed")
Filter check runs by status; returns all statuses if omitted.
integer
Number of check runs per page (max 100).
string
Filter check runs by this name; returns all names if omitted.
integer
required
Numeric ID of the check suite.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CHECK_SUITES_FOR_A_GIT_REFERENCELists check suites for a Git reference (commit SHA, branch, or tag) in a repository, optionally filtering by GitHub App ID or check run name.

Input Parameters

string
required
Git reference (commit SHA, branch name like heads/BRANCH_NAME or BRANCH_NAME, or tag name like tags/TAG_NAME or TAG_NAME) to list check suites for.
integer
Page number of results to fetch (1-indexed).
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository (username or organization name). This name is not case-sensitive.
integer
Filters check suites by the id of the GitHub App that created them. If omitted, check suites from all apps are returned.
integer
Number of results per page (max 100).
string
Filters check suites by the name of a check run. Only check suites that contain at least one check run with this name will be returned. If omitted, check suites are not filtered by check run name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CHILD_TEAMSLists the immediate child teams of a parent team within an organization.

Input Parameters

string
required
The organization name (not case-sensitive).
integer
Page number of the results to retrieve.
integer
Number of results per page (maximum 100).
string
required
The slug (URL-friendly version) of the parent team’s name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CLASSROOMSLists GitHub Classrooms to which the authenticated user has administrative access.

Input Parameters

integer
Page number for the results.
integer
Number of results per page (maximum 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CODEOWNERS_ERRORSLists syntax errors in a repository’s CODEOWNERS file, which must be located at the root, .github/, or docs/ directory for the specified ref.

Input Parameters

string
Branch name, tag, or commit SHA for the CODEOWNERS file; defaults to the repository’s default branch if unspecified.
string
required
Name of the repository, without the .git extension (not case-sensitive).
string
required
Username of the account owning the repository (not case-sensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CODEQL_DATABASES_FOR_A_REPOSITORYLists all CodeQL databases for a repository where CodeQL analysis has been previously run and completed.

Input Parameters

string
required
Name of the repository, without the .git extension (not case-sensitive).
string
required
Username of the account owning the repository (not case-sensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CODE_SCANNING_ALERTS_FOR_AN_ORGANIZATIONLists code scanning alerts for a GitHub organization; use either tool name or tool GUID when filtering by tool. Some access or scanning errors return an empty alert list with a message.

Input Parameters

string
required
The GitHub organization name (case-insensitive).
integer
Page number for results. Used if before or after cursors are not provided.
string ("created" | "updated")
Sort field.
string
A pagination cursor to retrieve results appearing after this.
string ("open" | "closed" | "dismissed" | "fixed")
Filter alerts by state.
string
A pagination cursor to retrieve results appearing before this.
integer
Number of results per page (maximum 100).
string ("critical" | "high" | "medium" | "low" | "warning" | "note" | "error")
Filter alerts by severity.
string ("asc" | "desc")
Sort direction.
string
GUID of the code scanning tool. Some tools may not report a GUID. Cannot be used with tool_name.
string
Name of the code scanning tool (e.g., ‘CodeQL’). Cannot be used with tool_guid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CODE_SCANNING_ALERTS_FOR_A_REPOSITORYLists code scanning alerts for a repository, optionally filtering by tool, Git reference, state, or severity. Some scanning or authorization errors return an empty alert list with a message rather than an error.

Input Parameters

string
Git reference (branch, tag, or pull request merge reference, e.g., refs/pull/42/merge) for retrieving alerts; defaults to the repository’s default branch if unspecified.
integer
Page number for paginated results, starting at 1.
string
required
The name of the repository, without the .git extension; not case-sensitive.
string ("created" | "updated")
Sort property: created (alert creation time) or updated (last update time).
string
required
The account owner of the repository (username or organization name); not case-sensitive.
string ("open" | "closed" | "dismissed" | "fixed")
Filters alerts by state.
integer
Number of results per page (max 100).
string ("critical" | "high" | "medium" | "low" | "warning" | "note" | "error")
Filters alerts by severity.
string ("asc" | "desc")
Sort direction: asc (ascending) or desc (descending).
string
The GUID of a code scanning tool to filter alerts by; use either tool_guid or tool_name, not both. Some tools may not provide a GUID.
string
The name of a code scanning tool to filter alerts by; use either tool_name or tool_guid, not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CODE_SCANNING_ANALYSES_FOR_A_REPOSITORYLists code scanning analyses for a repository, optionally filtering by tool, Git reference, or SARIF ID. Some scanning and access errors return an empty list without an explanatory message.

Input Parameters

string
The Git reference for which to list analyses. This can be a branch name (e.g., ‘main’ or ‘refs/heads/main’) or a pull request merge reference (e.g., ‘refs/pull/123/merge’).
integer
Page number of the results to retrieve.
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string ("created")
Property by which to sort the results. Currently, only ‘created’ is a supported sort field.
string
required
The account owner of the repository. This name is not case-sensitive.
integer
Number of results to return per page (maximum 100).
string
Filter analyses to those associated with a specific SARIF upload ID.
string ("asc" | "desc")
Direction to sort results. ‘asc’ for ascending, ‘desc’ for descending.
string
The GUID of a code scanning tool used to filter analyses. Only results from this tool will be listed. Some tools may not provide a GUID. Mutually exclusive with tool_name.
string
The name of a code scanning tool used to filter analyses. Only results from this tool will be listed. Mutually exclusive with tool_guid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CODES_OF_CONDUCTRetrieves all available codes of conduct from GitHub, often used to select one for a repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CODES_OF_CONDUCT_GRAPHQLTool to fetch all available codes of conduct using GitHub’s GraphQL API. Use when you need to retrieve the complete list of codes of conduct that can be applied to repositories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CODESPACES_FOR_A_USER_IN_ORGANIZATIONLists a page of GitHub Codespaces for a specified member of an organization, with pagination controls.

Input Parameters

string
required
Name of the GitHub organization (case-insensitive).
integer
Page number of the results to retrieve (starts from 1).
integer
Number of codespaces to return per page (maximum 100).
string
required
GitHub username of the organization member.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CODESPACES_FOR_THE_AUTHENTICATED_USERLists GitHub Codespaces for the authenticated user, optionally filtering by repository ID and supporting pagination.

Input Parameters

integer
Page number for results (starts at 1). For pagination details, see: https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api.
integer
Number of codespaces per page (max 100). For pagination details, see: https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api.
integer
If provided, filters codespaces to this repository ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CODESPACES_FOR_THE_ORGANIZATIONLists active/pending GitHub Codespaces for an existing organization; admins list all, members list their own.

Input Parameters

string
required
Non-case-sensitive unique identifier of the GitHub organization.
integer
Page number of results. Details: ‘Using pagination in the REST API’.
integer
Number of results per page (max 100). Details: ‘Using pagination in the REST API’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_COMMENT_CHANGESTool to list issue and PR comment changes across an organization’s repositories efficiently. Use when monitoring comment activity without per-PR/per-issue polling. Filters organization events to return only comment-related events (IssueCommentEvent, PullRequestReviewCommentEvent, CommitCommentEvent). Note: Events are limited to the past 30 days and up to 300 events per timeline. Use ETag header for efficient polling to avoid rate limits.

Input Parameters

string
required
Organization name to list comment events for. Not case-sensitive.
integer
Page number of results to fetch.
integer
Number of events to return per page (maximum 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_COMMENTS_FOR_A_PULL_REQUEST_REVIEWLists a page of comments for a specific review on a GitHub pull request, with pagination support.

Input Parameters

integer
Page number of the results to fetch. See GitHub’s pagination guide.
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
integer
Number of comments to retrieve per page (max 100). See GitHub’s pagination guide.
integer
required
The unique identifier of the pull request review.
integer
required
The unique number that identifies the pull request within the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_COMMIT_COMMENTSRetrieves a page of comments for a specific commit in a GitHub repository, supporting pagination.

Input Parameters

integer
The page number of the results to retrieve. For more information, see “Using pagination in the REST API.”
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.
integer
The number of comments to return per page. Maximum value is 100. For more information, see “Using pagination in the REST API.”
string
required
The SHA hash of the commit for which comments are to be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_COMMIT_COMMENTS_FOR_A_REPOSITORYLists a page of commit comments for an accessible GitHub repository.

Input Parameters

integer
Page number of the results to fetch (starts at 1).
string
required
The name of the repository, without the .git extension (not case-sensitive).
string
required
The account owner of the repository (not case-sensitive).
integer
Number of results to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_COMMITSLists a page of commits for a GitHub repository, optionally filtered by SHA or branch, path, author, committer, or date range. The default page size is one commit.

Input Parameters

string
SHA hash or branch name to start listing commits from. If not provided, the GitHub API uses the repository’s default branch (usually main or master).
integer
Page number of the results to fetch when using pagination.
string
Only commits modifying this specific file path will be returned.
string
required
The name of the repository without the .git extension (repository name only, not the full ‘owner/repo’ path). Must contain only alphanumeric characters, hyphens (-), underscores (_), and periods (.). Wildcards like ’*’ are not supported.
string
required
The account owner of the repository (username or organization name only, not the full ‘owner/repo’ path). Must contain only alphanumeric characters and hyphens, cannot start/end with a hyphen, max 39 characters. Wildcards are not supported.
string
Only commits created on or after this timestamp will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
string
Only commits created before this timestamp will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
string
Filter commits by the commit author’s GitHub login or email address.
integer
Number of results to return per page (max 100).
string
Filter commits by the commit committer’s GitHub login or email address. The committer is the user who applied the patch and may differ from the original author.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_COMMITS_ON_A_PULL_REQUESTLists commits for a pull request; requires the repository and pull request to exist and be accessible, and supports pagination.

Input Parameters

integer
The page number of the results to fetch.
string
required
Repository name, without the .git extension. This name is not case-sensitive.
string
required
Account owner of the repository. This name is not case-sensitive.
integer
The number of results per page (maximum 100).
integer
required
The number that identifies the pull request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_COMMONLY_USED_LICENSESRetrieves a list of commonly used software licenses from GitHub, optionally filtering for ‘featured’ licenses whose specific selection criteria by GitHub may vary.

Input Parameters

integer
The page number for the set of results to retrieve (must be an integer starting from 1). Used for paginating through the list of licenses.
If true, filters for licenses that GitHub considers ‘featured’, such as popular or recommended licenses. If false or not provided, returns all commonly used licenses.
integer
The number of license results to return per page (must be an integer between 1 and 100, inclusive). Used for paginating through the list of licenses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CUSTOM_PROPERTIES_FOR_AN_ORGANIZATIONGets the schema definitions for an organization’s custom properties, rather than repository-specific values. On non-200 responses, it returns an empty property list alongside an error and status code.

Input Parameters

string
required
The unique identifier (login name) of the GitHub organization. This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CUSTOM_PROPERTY_VALUES_FOR_A_REPOSITORYGets all custom property values for a repository. Custom properties are defined at the organization level, so this endpoint works with organization-owned repositories. Returns an empty array if no custom properties are set.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The organization name that owns the repository. Custom properties are an organization-level feature, so this endpoint primarily works with organization-owned repositories. This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_CUSTOM_PROPERTY_VALUES_FOR_ORG_REPOSLists repositories in an organization with their custom property values. Requires ‘Custom properties’ organization permission (read).

Input Parameters

string
required
The organization name (login). Not case-sensitive. Example: ‘github’, ‘microsoft’.
integer
Page number of results to fetch (default 1).
integer
Number of results per page (max 100, default 30).
string
Optional query string to filter repositories. Uses GitHub’s search syntax with keywords and qualifiers like ‘is:public’, ‘topic:security’, ‘language:python’, ‘archived:false’. Leave empty to list all repositories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_DELIVERIES_FOR_AN_ORGANIZATION_WEBHOOKRetrieves a list of webhook deliveries for a specific webhook in an organization, allowing inspection of delivery history and details.

Input Parameters

string
required
Name of the organization (case-insensitive).
string
Pagination cursor specifying the starting delivery for the page.
integer
required
Unique identifier of the webhook.
integer
Number of results to return per page (max 100).
boolean
Filter for redeliveries: true for only redeliveries, false to exclude them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_DELIVERIES_FOR_A_REPOSITORY_WEBHOOKRetrieves delivery attempts for a specific repository webhook to inspect its history; ensure the webhook ID exists.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is case-insensitive.
string
required
The username or organization name that owns the repository. This field is case-insensitive.
string
Specifies the starting delivery for pagination. The Link header in the response provides cursors for the next and previous pages.
integer
required
The unique identifier of the webhook. This ID can be found in the X-GitHub-Hook-ID header of a webhook delivery.
integer
Maximum 100 results per page. For more details, refer to “Using pagination in the REST API”.
boolean
If set to true, the response will include the latest redelivery attempt for each delivery, rather than the original delivery.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_DEPLOY_KEYSLists deploy SSH keys for a specified repository; the repository must exist.

Input Parameters

integer
The page number of the results to fetch, starting from 1.
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.
integer
The number of deploy keys to return per page. Maximum value is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_DEPLOYMENT_BRANCH_POLICIESLists a page of deployment branch policies for a specified environment in a GitHub repository.

Input Parameters

integer
Page number of results (starts at 1).
string
required
Repository name, without the .git extension; not case sensitive.
string
required
Account owner of the repository; not case sensitive.
integer
Number of results per page (max 100).
string
required
Name of the environment; URL encode if it contains special characters (e.g., slashes to %2F).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_DEPLOYMENTSLists deployments for a specified repository; repository must exist.

Input Parameters

string
Filter by the ref name (branch, tag, or commit SHA).
string
Filter by the commit SHA recorded when the deployment was created.
integer
The page number of the results to retrieve. For more information, see “Using pagination in the REST API.”
string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
Filter by the task name specified for the deployment.
string
required
The account owner of the repository. This name is not case sensitive.
integer
The number of results to display per page (maximum 100). For more information, see “Using pagination in the REST API.”
string
Filter by the environment name to which deployed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_DEPLOYMENT_STATUSESLists a page of statuses for a given deployment in a repository.

Input Parameters

integer
Page number of the results to fetch.
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
Number of results per page (maximum 100).
integer
required
The unique identifier of the deployment for which statuses are being requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_DISCUSSION_COMMENTSLists a page of comments for a specific team discussion within an organization; team discussions are deprecated. A 404 response is returned as an empty list, so an empty result does not necessarily mean there are no comments.

Input Parameters

string
required
The organization name (case-insensitive).
integer
Page number of the results.
integer
Number of comments per page (max 100).
string ("asc" | "desc")
Sort direction for comments: ‘asc’ (oldest first) or ‘desc’ (newest first).
string
required
The team’s slug (URL-friendly identifier).
integer
required
The unique number identifying the team discussion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_DISCUSSIONSLists a page of discussions for a specific team within an organization, with sorting and pinned-status filtering; team discussions are deprecated. A 404 response is returned as an empty list, so an empty result does not necessarily mean there are no discussions.

Input Parameters

string
required
The organization’s name (case-insensitive).
integer
Page number for pagination. Defaults to 1.
string
Filter for pinned discussions. Use ‘true’ to show only pinned discussions. Omit to show all discussions.
integer
Number of results per page (max 100). Defaults to 30.
string ("asc" | "desc")
Sort direction for results: ‘asc’ (oldest first) or ‘desc’ (newest first). Defaults to ‘desc’.
string
required
The team’s slug (URL-friendly name).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_EMAIL_ADDRESSES_FOR_THE_AUTHENTICATED_USERLists a page of email addresses for the authenticated user, including their primary status, verification status, and visibility.

Input Parameters

integer
Page number of the results to retrieve.
integer
Number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ENVIRONMENT_CUSTOM_DEPLOYMENT_RULESLists a page of custom deployment protection rule integrations available for a GitHub repository environment. The caller must have repository admin or owner permissions; pagination supports up to 100 results per page.

Input Parameters

integer
Page number of the results to fetch, starting from 1.
string
required
Name of the repository, without the .git extension; not case-sensitive.
string
required
Account owner of the repository (user or organization); not case-sensitive.
integer
Number of results per page, with a maximum of 100.
string
required
Name of the environment, which must be URL-encoded (e.g., slashes / replaced with %2F).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ENVIRONMENTSRetrieves a page of deployment environments for a specified repository, which are used to configure protection rules and secrets for different software lifecycle stages.

Input Parameters

integer
The page number of the results to retrieve. Starts from 1.
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
integer
The number of results to return per page. Maximum value is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ENVIRONMENT_SECRETSLists the names and metadata (not values) of secrets for a specified, existing environment within an existing GitHub repository.

Input Parameters

integer
Page number for results (1-indexed).
string
required
Repository name, without the .git extension (case-insensitive).
string
required
The account owner’s username (case-insensitive).
integer
Number of secrets per page (maximum 100).
string
required
Name of the environment; URL-encode if it contains special characters (e.g., ’/’ becomes ‘%2F’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ENVIRONMENT_VARIABLESLists a page of plaintext GitHub Actions environment variables for a specified environment within a repository.

Input Parameters

integer
Page number of the results to fetch.
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository (e.g., a user or organization). This name is not case-sensitive.
integer
Number of results per page (maximum 30).
string
required
The name of the environment. The name must be URL-encoded. For example, any slashes / in the name must be replaced with %2F.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_EVENTS_FOR_THE_AUTHENTICATED_USERLists public events for the specified GitHub user, or private events if authenticated as that user, in reverse chronological order.

Input Parameters

integer
Page number of the results to fetch.
integer
Number of events to return per page (maximum 100).
string
required
The GitHub username for whom to list events. For example, ‘octocat’ or ‘torvalds’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_EVENTS_FOR_USERLists events performed by a GitHub user in reverse chronological order. If authenticated as the specified user, you will see private events; otherwise, only public events are returned. Use this action when you need to retrieve a user’s activity history, such as commits, pull requests, issues, and other GitHub actions.

Input Parameters

integer
Page number of the results to fetch. For more information, see “Using pagination in the REST API.”
integer
Number of events to return per page (maximum 100). For more information, see “Using pagination in the REST API.”
string
required
The GitHub username (handle) for the user whose events you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_EVENTS_RECEIVED_BY_THE_AUTHENTICATED_USERLists events a specific GitHub user received from followed users and watched repositories; returns private events if authenticated for username, otherwise public.

Input Parameters

integer
Indicates the page number of the results to fetch. For more information, see GitHub’s REST API pagination guide.
integer
Specifies the number of events to return per page (maximum 100). For more information, see GitHub’s REST API pagination guide.
string
required
The GitHub username for whom to fetch received events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_FOLLOWERS_OF_A_USERLists followers for a specified, existing GitHub user.

Input Parameters

integer
Page number for pagination of results (starts at 1).
integer
Number of results per page (maximum 100). Used for pagination.
string
required
The GitHub username (e.g., ‘octocat’, ‘torvalds’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_FOLLOWERS_OF_THE_AUTHENTICATED_USERLists users following the authenticated GitHub user, returning an empty list if the user has no followers.

Input Parameters

integer
Page number of the results to fetch.
integer
Number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_FOLLOWING_FOR_USERLists the people that a GitHub user follows. Use this action when you need to retrieve the list of users that a specific GitHub user is following. The response includes public profile information for each followed user with pagination support.

Input Parameters

integer
The page number of the results to fetch. For more information, see “Using pagination in the REST API”.
integer
The number of results per page (max 100). For more information, see “Using pagination in the REST API”.
string
required
The handle for the GitHub user account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_FORKSLists forks for a specified repository, which must exist, with options for sorting and pagination.

Input Parameters

integer
The page number of the results to retrieve, used for pagination. Defaults to 1.
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string ("newest" | "oldest" | "stargazers" | "watchers")
The sort order for the returned forks. stargazers sorts by the number of stars. Defaults to newest.
string
required
The username of the account that owns the repository. This field is not case-sensitive.
integer
The number of fork results to return per page. Maximum value is 100. Defaults to 30.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_GIST_COMMENTSLists comments for a specified GitHub Gist.

Input Parameters

integer
Page number of the results to fetch.
string
required
The unique identifier of the Gist for which comments are to be listed.
integer
Number of comments to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_GIST_COMMITSLists a page of commits for a specified gist, with pagination controls.

Input Parameters

integer
Page number of the results to fetch.
string
required
The unique identifier of the gist.
integer
Number of results per page (maximum 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_GIST_FORKSLists a page of forks for a given GitHub gist ID, with pagination controls.

Input Parameters

integer
The page number of the results to retrieve, starting from 1. For more information, see “Using pagination in the REST API.”
string
required
The unique identifier (ID) of the gist for which to list forks.
integer
The number of fork results to display per page. Maximum value is 100. For more information, see “Using pagination in the REST API.”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_GISTS_FOR_A_USERlists public gists for a specified GitHub user.

Input Parameters

integer
Indicates the page number of the results to retrieve.
string
Filters gists to those updated on or after this ISO 8601 timestamp (e.g., YYYY-MM-DDTHH:MM:SSZ).
integer
Specifies the number of gists to return per page. Maximum value is 100.
string
required
The GitHub username of the user whose gists are to be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_GISTS_FOR_THE_AUTHENTICATED_USERLists gists for the authenticated user, with optional filtering by update time and pagination.

Input Parameters

integer
Page number of results to retrieve.
string
Filters gists to include only those updated at or after this ISO 8601 timestamp (e.g., YYYY-MM-DDTHH:MM:SSZ).
integer
Number of gists to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_GITHUB_ACTIONS_CACHES_FOR_A_REPOSITORYLists GitHub Actions caches for a repository, with options to filter by Git reference or cache key, and to sort and paginate results.

Input Parameters

string
An explicit key or a prefix to filter caches that match the key or start with the prefix.
string
Full Git reference for filtering caches (e.g., refs/heads/<branch_name> or refs/pull/<pull_request_number>/merge).
integer
Page number of results to retrieve (starts from 1).
string
required
Name of the repository, without the .git extension (case-insensitive).
string ("created_at" | "last_accessed_at" | "size_in_bytes")
Property for sorting results: created_at (creation time), last_accessed_at (last access time), or size_in_bytes (cache size).
string
required
Username of the account owning the repository (case-insensitive).
integer
Number of cache entries per page (max 100).
string ("asc" | "desc")
Direction for sorting results: asc (ascending) or desc (descending).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_GITHUB_PAGES_BUILDSLists GitHub Pages builds for a repository; GitHub Pages must be enabled on the repository for builds to be listed.

Input Parameters

integer
The page number of the results to fetch. For more information, see “Using pagination in the REST API.”
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository (e.g., username or organization). This name is not case-sensitive.
integer
The number of results per page (max 100). For more information, see “Using pagination in the REST API.”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_GITIGNORE_TEMPLATESRetrieves all available .gitignore template names from GitHub (e.g., ‘Python’, ‘Node’, ‘Java’), used for generating .gitignore files.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_GLOBAL_SECURITY_ADVISORIESLists GitHub’s global security advisories, filterable by ID, type, ecosystem, severity, dates, and other attributes. The advisory type defaults to reviewed.

Input Parameters

array
Filter by a list of Common Weakness Enumeration (CWE) identifiers.
string ("updated" | "published" | "epss_percentage" | "epss_percentile")
Property to sort results by (updated, published, epss_percentage, epss_percentile).
string ("reviewed" | "malware" | "unreviewed")
Filter by advisory type (e.g., reviewed, malware). Defaults to ‘reviewed’; if this default is active and no other search parameters are used, malware advisories are also excluded.
string
Pagination cursor to retrieve results after this value.
string
Pagination cursor to retrieve results before this value.
string
Filter by Common Vulnerabilities and Exposures (CVE) identifier.
array
Filter by affected ‘package’ or ‘package@version’. Max 100 items. Example: affects=pkg1,pkg2@1.0.0.
string
Filter by GitHub Security Advisory (GHSA) identifier.
string
Filter by update date or date range. For syntax, see GitHub’s ‘understanding the search syntax’ documentation.
string
Filter by last modification (update or publication) date or date range. For syntax, see GitHub’s ‘understanding the search syntax’ documentation.
integer
Number of results per page (max 100).
string ("unknown" | "low" | "medium" | "high" | "critical")
Filter by advisory severity (e.g., high, critical).
string ("asc" | "desc")
Sort direction for results (asc, desc).
string ("rubygems" | "npm" | "pip" | "maven" | "nuget" | "composer" | "go" | "rust" | "erlang" | "actions" | "pub" | "other" | "swift")
Filter by package ecosystem (e.g., npm, pip).
string
Filter by publication date or date range. For syntax, see GitHub’s ‘understanding the search syntax’ documentation.
boolean
Filter for withdrawn advisories.
string
Filter by EPSS (Exploit Prediction Scoring System) percentage score. Use comparison operators (e.g., ‘>0.5’, ’<=0.1’).
string
Filter by EPSS (Exploit Prediction Scoring System) percentile score. Use comparison operators (e.g., ‘>0.9’, ’>=0.5’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_GPG_KEYS_FOR_A_USERTool to list GPG keys for a GitHub user. Use when you need to fetch the public GPG keys associated with a specific GitHub user account.

Input Parameters

integer
The page number of the results to fetch. For more information, see “Using pagination in the REST API”.
integer
The number of results per page (max 100). For more information, see “Using pagination in the REST API”.
string
required
The handle for the GitHub user account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_INSTALLATION_REQUESTS_FOR_THE_AUTHENTICATED_APPLists pending installation requests made by users or organizations for the authenticated GitHub App.

Input Parameters

integer
Page number of the results to retrieve.
integer
Number of results to return per page (maximum 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_INSTANCES_OF_A_CODE_SCANNING_ALERTLists a page of instances of a specific code scanning alert, optionally filtered by Git ref. Some access or repository-state errors are returned as an empty instance list with an explanatory message.

Input Parameters

string
The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.
integer
The page number of the results to fetch. For more information, see “Using pagination in the REST API.”
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
The number of results per page (max 100). For more information, see “Using pagination in the REST API.”
integer
required
The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ISSUE_COMMENTSLists comments for a specified issue in a GitHub repository.

Input Parameters

integer
Page number of the results to retrieve.
string
required
Name of the repository, without the .git extension (not case-sensitive).
string
required
Username of the account owning the repository (not case-sensitive).
string
Filters comments to include only those updated at or after this ISO 8601 timestamp (e.g., YYYY-MM-DDTHH:MM:SSZ).
integer
Number of comments to return per page (max 100).
integer
required
Number that identifies the issue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ISSUE_COMMENTS_FOR_A_REPOSITORYLists issue comments, including those on pull requests, for an accessible repository.

Input Parameters

integer
The page number of the results to fetch, used for pagination. Default is 1. For more information, see “Using pagination in the REST API.”
string
required
REQUIRED. The name of the repository, without the .git extension. This is a path parameter needed to construct the API URL. This field is not case-sensitive.
string ("created" | "updated")
Specifies the field by which to sort the issue comments. Valid values are created (for creation date, default) or updated (for last update date).
string
required
REQUIRED. The username of the account or the organization name that owns the repository. This is a path parameter needed to construct the API URL. This field is not case-sensitive.
string
Filters comments to include only those last updated at or after the specified time. This should be a timestamp in ISO 8601 format (e.g., YYYY-MM-DDTHH:MM:SSZ).
integer
The number of issue comments to retrieve per page. Default is 30, maximum is 100. For more information, see “Using pagination in the REST API.”
string ("asc" | "desc")
The direction for sorting results. Valid values are asc (ascending) or desc (descending). This parameter is effective only when sort is also specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ISSUE_DEPENDENCIES_BLOCKED_BYLists a page of issues that block a specified GitHub issue.

Input Parameters

integer
The page number of the results to fetch. For more information, see “Using pagination in the REST API.”
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
The number of results per page (max 100). For more information, see “Using pagination in the REST API.”
integer
required
The number that identifies the issue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ISSUE_DEPENDENCIES_BLOCKINGTool to list dependencies an issue is blocking. Use when you need to see which issues are blocked by a specific issue.

Input Parameters

integer
The page number of the results to fetch. For more information, see “Using pagination in the REST API.”
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
The number of results per page (max 100). For more information, see “Using pagination in the REST API.”
integer
required
The number that identifies the issue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ISSUE_EVENTSRetrieves a page of issue events for a specific issue within a GitHub repository.

Input Parameters

integer
The page number of the results to fetch. For more information, see “Using pagination in the REST API.”
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The username of the account that owns the repository. This name is not case-sensitive.
integer
The number of results to return per page. For more information, see “Using pagination in the REST API.”
integer
required
The unique number that identifies the issue within the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ISSUE_EVENTS_FOR_A_REPOSITORYLists a page of issue events, such as closed, reopened, and assigned events, for a specified repository.

Input Parameters

integer
Page number for pagination.
string
required
Repository name, without the .git extension; case-insensitive.
string
required
Account owner of the repository (username or organization name); case-insensitive. Must match an existing GitHub user or organization exactly.
integer
Number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ISSUES_ASSIGNED_TO_THE_AUTHENTICATED_USERLists GitHub issues for the authenticated user across visible repositories, with filtering by user relationship, state, labels, an ISO 8601 since timestamp (YYYY-MM-DDTHH:MM:SSZ), and sorting options; pull requests are typically included.

Input Parameters

integer
Page number for results.
string
Field to sort issues by.
string
Return issues updated at or after this ISO 8601 timestamp (YYYY-MM-DDTHH:MM:SSZ).
string
Filter issues by state (e.g., ‘open’, ‘closed’).
string
Specifies the relationship for filtering issues (e.g., ‘assigned’, ‘created’).
string
Comma-separated list of label names for filtering.
integer
Number of results per page (max 100).
string
Sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ISSUE_TYPESList all issue types configured for a GitHub organization. Requires read:org scope for OAuth tokens.

Input Parameters

string
required
The organization name (case-insensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_JOBS_FOR_A_WORKFLOW_RUNLists jobs for a specific workflow run in a GitHub repository.

Input Parameters

integer
The page number of the results to fetch. For more details, see “Using pagination in the REST API.”
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
string ("latest" | "all")
Filters jobs by their completed_at timestamp. latest returns jobs from the most recent execution attempt of the workflow run. all returns all jobs for a workflow run, including from previous execution attempts.
integer
required
The unique identifier of the workflow run for which jobs are to be listed.
integer
The number of results to return per page, with a maximum of 100. For more details, see “Using pagination in the REST API.”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_JOBS_FOR_A_WORKFLOW_RUN_ATTEMPTLists jobs, including details like ID, status, and steps, for a specific attempt of a GitHub Actions workflow run.

Input Parameters

integer
Page number of the results to fetch.
string
required
Name of the repository, without the .git extension (not case-sensitive).
string
required
Account owner of the repository (not case-sensitive).
integer
required
Unique identifier of the workflow run.
integer
Number of results per page (max 100).
integer
required
Attempt number of the workflow run, corresponding to a specific retry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_LABELS_FOR_AN_ISSUELists a page of labels for a specified issue in a GitHub repository, with pagination controls.

Input Parameters

integer
The page number of the results to fetch. Defaults to 1. For more information, see “Using pagination in the REST API.”
string
required
The name of the repository, without the .git extension. This is not case-sensitive.
string
required
The account owner of the repository (username or organization name). This is not case-sensitive.
integer
The number of results to return per page. Maximum value is 100. Defaults to 30. For more information, see “Using pagination in the REST API.”
integer
required
The unique number identifying the issue within the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_LABELS_FOR_A_REPOSITORYLists labels for a specified GitHub repository, with pagination.

Input Parameters

integer
Page number of the results to fetch (starts from 1).
string
required
Name of the repository, without the .git extension (case-insensitive).
string
required
Username of the account owning the repository (case-insensitive).
integer
Number of results to return per page (maximum 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_LABELS_FOR_A_SELF_HOSTED_RUNNER_FOR_A_REPOSITORYLists all labels assigned to a specific self-hosted runner registered with the given repository.

Input Parameters

string
required
The name of the repository, without the ‘.git’ extension. This field is not case-sensitive.
string
required
The username of the account that owns the repository. This field is not case-sensitive.
integer
required
The unique identifier (ID) of the self-hosted runner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_LABELS_FOR_ISSUES_IN_A_MILESTONELists a page of labels for issues within a specific milestone in a repository.

Input Parameters

integer
The page number of the results to retrieve. For more information, see “Using pagination in the REST API.”
string
required
The name of the repository, without the .git extension. This is case-insensitive.
string
required
The username of the account that owns the repository. This is case-insensitive.
integer
The number of results to return per page. The maximum value is 100. For more information, see “Using pagination in the REST API.”
integer
required
The unique number that identifies the milestone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_LABELS_FOR_SELF_HOSTED_RUNNER_ORGLists all labels assigned to a specific self-hosted runner within a GitHub organization, which are used to route workflows.

Input Parameters

string
required
The name of the GitHub organization. This name is not case-sensitive.
integer
required
The unique identifier (ID) of the self-hosted runner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_LICENSES_GRAPH_QLTool to fetch all known open source licenses using GitHub’s GraphQL API. Use when you need to retrieve the complete list of licenses that can be applied to repositories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_MACHINE_TYPES_FOR_A_CODESPACELists available machine types for a specific, accessible codespace, enabling it to be transitioned to a new hardware configuration.

Input Parameters

string
required
The unique name of the codespace for which to list available machine types. This is often a combination of a username, repository name, and a unique identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_MATCHING_REFERENCESLists a page of Git references, such as branches or tags, in a repository that start with the provided partial reference path.

Input Parameters

string
required
Partial Git reference path (e.g., ‘heads/main’, ‘tags/v1.0’) to match from the beginning of the reference name; do not include the refs/ prefix.
integer
Page number of the results to retrieve.
string
required
The name of the repository, without the .git extension. This is case-insensitive.
string
required
The username or organization name that owns the repository. This is case-insensitive.
integer
Number of results to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_MILESTONESLists milestones, which track progress for groups of issues and pull requests, for an existing repository, allowing filtering by state and sorting.

Input Parameters

integer
Page number for paginated results.
string
required
The name of the repository, without the ‘.git’ extension. This field is not case-sensitive.
string ("due_on" | "completeness")
Sort by due_on (due date) or completeness (percentage of issues completed).
string
required
The username of the account that owns the repository. This field is not case-sensitive.
string ("open" | "closed" | "all")
Filters milestones by their state.
integer
Number of results per page (max 100).
string ("asc" | "desc")
Sort direction: asc (ascending) or desc (descending).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_NOTIFICATIONSTool to list notification threads for the authenticated user with efficient polling support. Use when you need to fetch the user’s GitHub notification inbox with filters like unread/participating/since. Returns notification threads plus polling headers (Last-Modified, ETag, X-Poll-Interval) for efficient polling. IMPORTANT: This endpoint requires a Personal Access Token (classic) with ‘notifications’ or ‘repo’ scope. It does NOT work with GitHub App tokens or fine-grained personal access tokens. If the token type is incompatible, a clear error message will be returned.

Input Parameters

boolean
If true, show notifications marked as read. Default shows only unread notifications.
integer
Page number of results to fetch.
string
Only show notifications updated after the given ISO 8601 timestamp (YYYY-MM-DDTHH:MM:SSZ).
string
Only show notifications updated before the given ISO 8601 timestamp (YYYY-MM-DDTHH:MM:SSZ).
integer
Number of results per page (maximum 50).
boolean
If true, only shows notifications in which the user is directly participating or mentioned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_NOTIFICATIONS_FOR_THE_AUTHENTICATED_USERDEPRECATED: Use GITHUB_LIST_NOTIFICATIONS instead. Lists notifications for the authenticated user, sorted by most recent update, with filtering and pagination options.

Input Parameters

boolean
If true, shows all notifications including those marked as read.
integer
Page number of results to fetch.
string
Only show notifications updated after this ISO 8601 timestamp (e.g., YYYY-MM-DDTHH:MM:SSZ).
string
Only show notifications updated before this ISO 8601 timestamp (e.g., YYYY-MM-DDTHH:MM:SSZ).
integer
Number of results per page (max 50).
boolean
If true, shows only notifications in which the authenticated user is directly participating or has been mentioned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORGANIZATION_APP_INSTALLATIONSList GitHub App installations across a named organization.

Input Parameters

string
required
The organization name. The name is not case sensitive.
integer
Page number of the results to fetch.
integer
Number of installations to return per page, from 1 to 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORGANIZATION_CODESPACES_SECRETSLists all Codespaces secrets available for a specified organization, which must exist.

Input Parameters

string
required
The GitHub organization name (case-insensitive).
integer
Page number for pagination.
integer
Number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORGANIZATION_EVENTS_FOR_THE_AUTHENTICATED_USERLists public events for the authenticated user’s organization dashboard in a specified GitHub organization, such as pushes, pull requests, issues, and forks. The user must be an organization member to see events. Results are paginated; a 404 response is reported as an empty event list.

Input Parameters

string
required
Name of the GitHub organization (case-insensitive).
integer
The page number of results to retrieve. Page numbering starts at 1. Default is 1.
integer
Number of events to return per page. Must be between 1 and 100. Default is 30.
string
required
The GitHub username of the authenticated user. Must match the username of the account associated with the authentication token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORGANIZATION_MEMBERSList a page of members of a GitHub organization, optionally filtered by role or two-factor authentication status. Organization owners can filter by 2FA status to identify members who need to enable or upgrade their 2FA methods.

Input Parameters

string
required
The organization name. The name is not case sensitive.
integer
The page number of the results to fetch.
string ("all" | "admin" | "member")
Role filter for organization members.
string ("2fa_disabled" | "2fa_insecure" | "all")
Filter options for organization members.
integer
The number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORGANIZATION_MEMBERSHIPS_FOR_THE_AUTHENTICATED_UList organization memberships for authenticated user

Input Parameters

integer
The page number of the results to fetch.
string ("active" | "pending")
Membership state filter options.
integer
The number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORGANIZATION_PROJECTSLists projects (V2) for a specified GitHub organization, with optional search query and cursor-based pagination.

Input Parameters

string
Limit results to projects of the specified type or matching a search query.
string
required
The name of the GitHub organization (e.g., ‘octocat’, ‘microsoft’). This name is not case-sensitive.
string
A cursor for pagination. Returns results after this cursor.
string
A cursor for pagination. Returns results before this cursor.
integer
Number of projects to return per page (maximum 100). GitHub Projects V2 uses the GraphQL API and cursor-based pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORGANIZATION_REPOSITORIESRetrieves a list of repositories for a specified GitHub organization, allowing filtering by type and sorting.

Input Parameters

string
required
Name of the GitHub organization (not case-sensitive).
integer
Page number for pagination (starts from 1).
string ("created" | "updated" | "pushed" | "full_name")
Property to sort repositories by: created, updated, pushed, or full_name.
string ("all" | "public" | "private" | "forks" | "sources" | "member")
Specifies the type of repositories to return: all, public, private (requires permissions), forks, sources (not forks), or member (repositories with explicit user access).
integer
Number of results per page (maximum 100).
string ("asc" | "desc")
Sort order: asc (ascending) or desc (descending). Defaults to asc if sort is full_name, else desc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORGANIZATION_ROLES_FOR_AN_ORGANIZATIONLists all custom organization roles for an existing GitHub organization.

Input Parameters

string
required
The unique name of the GitHub organization. This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORGANIZATIONSLists GitHub organizations for the authenticated user, sorted by ID in ascending order.

Input Parameters

integer
An organization ID. If provided, only organizations with an ID greater than this will be returned, for pagination.
integer
Number of results to return per page, max 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORGANIZATION_SECRETSLists GitHub Actions secrets available for a specified organization.

Input Parameters

string
required
Name of the GitHub organization (case-insensitive).
integer
Page number for results.
integer
Number of secrets to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORGANIZATIONS_FOR_A_USERLists public organizations for a specified GitHub user; the username must be a valid GitHub handle.

Input Parameters

integer
Page number of the results to fetch.
integer
Number of results per page (maximum 100).
string
required
GitHub username (handle) of the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORGANIZATIONS_FOR_THE_AUTHENTICATED_USERLists organizations the authenticated GitHub user is a member of, returning details for each organization.

Input Parameters

integer
The page number of the results to retrieve, used for pagination. Default is 1.
integer
The number of organization results to return per page. Default is 30, maximum is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORGANIZATIONS_FOR_USERList a page of public organization memberships for a specified GitHub user, with pagination controls.

Input Parameters

integer
The page number of the results to fetch. For more information, see “Using pagination in the REST API”.
integer
The number of results per page (max 100). For more information, see “Using pagination in the REST API”.
string
required
The handle for the GitHub user account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORGANIZATION_VARIABLESLists a page of GitHub Actions variables for a specified organization.

Input Parameters

string
required
The organization name (not case-sensitive).
integer
Page number of results to fetch (starts at 1).
integer
Number of results per page (max 30).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORGANIZATION_WEBHOOKSLists a page of webhooks for a specified GitHub organization, with pagination controls.

Input Parameters

string
required
The GitHub organization name (not case-sensitive).
integer
Page number of results to fetch.
integer
Number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORG_FINE_GRAINED_PERMISSIONSLists all fine-grained permissions available in a GitHub organization for use in custom organization roles. These permissions define granular access controls that can be combined when creating custom roles. Note: This endpoint requires GitHub Enterprise Cloud with the custom organization roles feature enabled. The authenticated user must be an administrator or have the ‘read_organization_custom_org_role’ permission.

Input Parameters

string
required
The organization name (not case-sensitive). Note: This endpoint requires GitHub Enterprise Cloud with custom organization roles enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORG_ISSUES_FOR_THE_AUTHENTICATED_USERLists issues for the authenticated user within a specified GitHub organization, with options to filter by involvement type, state, labels, and to sort results.

Input Parameters

string
required
The name of the GitHub organization. This name is not case-sensitive.
integer
Page number of the results to retrieve.
string ("created" | "updated" | "comments")
Field to sort results by.
string
Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
string ("open" | "closed" | "all")
Filters issues by their state.
string ("assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all")
Filter indicating the type of issues to return based on user involvement (e.g., assigned, created, mentioned, subscribed, or all/repos for all accessible issues).
string
A comma-separated list of label names to filter issues by. For example: bug,ui,@high. Issues returned must match all specified labels.
integer
Number of issues to return per page (maximum 100).
string ("asc" | "desc")
Direction for sorting results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORG_PACKAGE_VERSIONSLists a page of versions for a specified package owned by a GitHub organization, filtered by active or deleted state. Defaults to active versions.

Input Parameters

string
required
Name of the GitHub organization owning the package (case-insensitive).
integer
Page number for results (starts at 1).
string ("active" | "deleted")
Filters package versions by state.
integer
Results per page (max 100).
string
required
Unique package name within its ecosystem.
string ("npm" | "maven" | "rubygems" | "docker" | "nuget" | "container")
required
Package’s ecosystem. Important notes: GitHub Gradle packages use maven; images in ghcr.io use container; docker type can find images from docker.pkg.github.com, including those migrated to ghcr.io.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORG_PROJECT_VIEW_ITEMSLists a page of items in a specific view of a GitHub organization’s Projects V2 project, with their content, metadata, and field values. Returns pagination cursors when available.

Input Parameters

string
required
The organization name. The name is not case sensitive.
string
A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see ‘Using pagination in the REST API’.
string
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see ‘Using pagination in the REST API’.
string
Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: ‘fields[]=123&fields[]=456&fields[]=789’ or ‘fields=123,456,789’
integer
The number of results per page (max 100). For more information, see ‘Using pagination in the REST API’.
integer
required
The number that identifies the project view.
integer
required
The project’s number (unique identifier within the organization).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORG_REPOS_WITH_GITHUB_ACTIONS_ENABLEDLists the selected repositories that are enabled for GitHub Actions in an organization. This endpoint only returns results when the organization’s ‘enabled_repositories’ permission policy is configured to ‘selected’. Requires admin:org scope and organization admin permissions.

Input Parameters

string
required
The organization name. The name is not case sensitive.
integer
The page number of the results to fetch.
integer
The number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORG_RESOURCE_ACCESS_TOKENSLists approved fine-grained personal access tokens with access to a GitHub organization’s resources, with optional filters; requires a GitHub App with read access to the organization’s personal access tokens. Non-list API responses are returned as an empty token list.

Input Parameters

string
required
Name of the GitHub organization (not case-sensitive).
integer
Page number of results to fetch (starts from 1).
string ("created_at")
Property to sort results by. Currently only ‘created_at’ is supported.
array
Filter by a list of owner usernames (max 10 items).
integer
Number of results per page (max 100).
array
Filter by a list of token IDs (max 50 items). Use this to look up specific tokens.
string ("asc" | "desc")
Sort direction: ‘asc’ for ascending or ‘desc’ for descending (default).
string
Filter by permission string in format ‘scope:level’ where scope is the permission area (e.g., ‘issues’, ‘actions’, ‘contents’) and level is ‘read’ or ‘write’. Common examples: ‘issues:read’, ‘issues:write’, ‘actions:read’, ‘actions:write’, ‘contents:read’, ‘contents:write’, ‘metadata:read’, ‘pull_requests:write’.
string
Filter by repository name.
string
Filter for tokens last used after this ISO 8601 timestamp (YYYY-MM-DDTHH:MM:SSZ).
string
Filter for tokens last used before this ISO 8601 timestamp (YYYY-MM-DDTHH:MM:SSZ).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORG_RESOURCES_WITH_PERSONAL_TOKENSLists requests from organization members to access organization resources with fine-grained personal access tokens (pending, approved, or denied). Note: This endpoint requires GitHub App authentication with ‘organization_personal_access_token_requests:read’ permissions; it cannot be used with personal access tokens.

Input Parameters

string
required
The GitHub organization name (case-insensitive).
integer
Page number for results (1-based).
string ("created_at")
Sorts results by ‘created_at’ (currently the only supported property).
array
Filter by a list of token owner GitHub usernames.
integer
Number of results per page (max 100).
array
Filter by a list of token IDs (max 50 items). Use this to look up specific token requests.
string ("asc" | "desc")
Sort direction: ‘asc’ for ascending or ‘desc’ for descending.
string
Filters requests by the specific permission granted to the token.
string
Filter by repository name for tokens that access this repository.
string
Filters for tokens last used after this ISO 8601 timestamp.
string
Filters for tokens last used before this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_ORG_SECRETS_WITHOUT_VALUESLists a page of Dependabot secret metadata for a specified organization, including names and creation and update timestamps, without secret values.

Input Parameters

string
required
The unique identifier of the GitHub organization. This name is not case-sensitive.
integer
The page number of the results to fetch. Starts from 1. For more information, see “Using pagination in the REST API.”
integer
The number of results to return per page. The maximum value is 100. For more information, see “Using pagination in the REST API.”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_OUTSIDE_COLLABORATORS_FOR_AN_ORGANIZATIONLists outside collaborators for a GitHub organization, with options to filter (e.g., by 2FA status) and paginate results.

Input Parameters

string
required
The GitHub organization name (not case-sensitive).
integer
Page number for pagination.
string ("2fa_disabled" | "2fa_insecure" | "all")
Filter for the list: ‘all’ for every collaborator, ‘2fa_disabled’ for those without two-factor authentication, ‘2fa_insecure’ for those with insecure 2FA.
integer
Number of results per page (maximum 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_OWNED_PACKAGE_VERSIONSLists a page of versions for an existing package owned by the authenticated user, identified by its type and name. Results can be filtered by active or deleted state.

Input Parameters

integer
Page number of the results to fetch, starting from 1.
string ("active" | "deleted")
Filters package versions by state.
integer
Number of results per page (maximum 100).
string
required
Unique name of the package.
string ("npm" | "maven" | "rubygems" | "docker" | "nuget" | "container")
required
Packages in GitHub’s Gradle registry have the type maven. Docker images pushed to GitHub’s Container registry (ghcr.io) have the type container. Use docker to find images from GitHub’s Docker registry (docker.pkg.github.com), even if migrated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PACKAGES_FOR_AN_ORGANIZATIONLists GitHub Packages for an organization, noting specific interpretations for package_type and visibility parameters.

Input Parameters

string
required
Name of the GitHub organization (case-insensitive).
integer
Page number for paginated results.
integer
Number of results per page (maximum 100).
string ("public" | "private" | "internal")
Filter packages by visibility. ‘internal’ is for registries with granular permissions; otherwise, it’s treated as ‘private’.
string ("npm" | "maven" | "rubygems" | "docker" | "nuget" | "container")
required
Package type to filter by. Note: Gradle packages use ‘maven’; ghcr.io Docker images use ‘container’; ‘docker’ type finds images from docker.pkg.github.com.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PACKAGES_FOR_A_USERLists packages for a specified GitHub user, filterable by package type and visibility.

Input Parameters

integer
Page number of the results to retrieve.
integer
Number of results to return per page (maximum 100).
string
required
The GitHub username of the account whose packages are to be listed.
string ("public" | "private" | "internal")
Filters packages by visibility. The internal visibility is supported only for GitHub Packages registries allowing granular permissions; for others, internal is synonymous with private.
string ("npm" | "maven" | "rubygems" | "docker" | "nuget" | "container")
required
Filters by package type. Note: GitHub’s Gradle packages are type maven. Images in ghcr.io (Container registry) are container. Use docker for images from docker.pkg.github.com, including those migrated to the Container registry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PACKAGES_FOR_THE_AUTHENTICATED_USERLists packages of a specific type and visibility within the authenticated user’s namespace on GitHub.

Input Parameters

integer
Page number of the results to fetch.
integer
Number of results to return per page, maximum 100.
string ("public" | "private" | "internal")
Filters packages by visibility. ‘internal’ is specific to GitHub Packages registries with granular permissions; for others, it’s treated as ‘private’.
string ("npm" | "maven" | "rubygems" | "docker" | "nuget" | "container")
required
The type of package to list. For GitHub’s Gradle registry, use ‘maven’; for Docker images from GitHub’s Container registry (ghcr.io), use ‘container’. ‘docker’ finds images from the original Docker registry (docker.pkg.github.com), even if migrated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PACKAGE_VERSIONS_FOR_A_PACKAGE_OWNED_BY_A_USERLists a page of versions of a public package owned by a specified GitHub user, identified by package type, package name, and username.

Input Parameters

integer
Page number of the results to retrieve.
integer
Number of results to return per page (max 100).
string
required
The GitHub username of the account that owns the package (e.g., ‘octocat’).
string
required
The name of the package as it is registered in GitHub Packages.
string
required
Type of the package. Valid values: npm, maven, rubygems, docker, nuget, container. Note: GitHub Gradle registry packages use ‘maven’. GitHub Container registry (ghcr.io) images use ‘container’. The ‘docker’ type can find images from the older GitHub Docker registry (docker.pkg.github.com), even if migrated to the Container registry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PENDING_TEAM_INVITATIONSLists a page of pending membership invitations for a specified team within an organization, including invitee, role, and inviter details; total_count is the number returned on that page. The authenticated user must be an organization member with read:org scope.

Input Parameters

string
required
The organization name (case-insensitive). The authenticated user must be an organization member with read:org scope.
integer
Page number of results to fetch (1-indexed). Default is 1.
integer
Number of results per page (max 100). Default is 30.
string
required
The slug (URL-friendly identifier) of the team name. Typically lowercase and hyphenated (e.g., ‘my-team’ for ‘My Team’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PROJECT_CARDSLists project cards in a GitHub Projects (classic) column, with archive filtering and pagination. The classic Projects REST API was sunset on April 1, 2025; the tool returns an empty card list for HTTP 404 or 410, which can also mask an unavailable or missing column.

Input Parameters

integer
Page number of results to retrieve (1-indexed). Default is 1.
integer
Number of project cards to return per page (1-100). Default is 30.
integer
required
The unique identifier of the project column for which to list cards. This ID can be obtained from the ‘list_project_columns’ action or from the column’s API URL (e.g., /projects/columns/12345).
string ("all" | "archived" | "not_archived")
Filters the project cards based on their archived state. Options: “all” returns all cards, “archived” returns only archived cards, and “not_archived” returns only unarchived/active cards.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PROJECT_COLLABORATORSLists collaborators for a GitHub Project (classic) by project ID. IMPORTANT: This action uses the Projects (classic) REST API which was sunset on April 1, 2025 for GitHub.com. The API may still be available on GitHub Enterprise Server versions before 3.17. For GitHub.com users: GitHub Projects (classic) has been replaced by the new Projects experience. The new Projects does not have a REST API for listing collaborators - use the GitHub web interface to manage project collaborators instead. You must be an organization owner or a project admin to list collaborators.

Input Parameters

integer
Page number for paginated results. Starts at 1.
integer
Number of collaborators to return per page. Maximum is 100.
integer
required
The unique numeric identifier of the Project (classic). This is a database ID, not the project number shown in URLs.
string ("outside" | "direct" | "all")
Filter collaborators by affiliation type: ‘outside’ returns only outside collaborators (users who are not organization members), ‘direct’ returns only collaborators with explicit project permissions, ‘all’ returns all collaborators including organization members with default permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PROJECT_COLUMNSLists a page of columns in a GitHub Projects (classic) project, such as its stages of work. A missing or unavailable project can produce an empty list. DEPRECATED: The Projects (classic) REST API has been sunset; use the newer GitHub Projects instead. Projects (classic) was removed from GitHub Enterprise Server 3.17.

Input Parameters

integer
The page number of the results to fetch. Starts from 1. For more information on pagination, see GitHub’s REST API documentation: https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api.
integer
The number of results to return per page. The maximum value is 100. For more information on pagination, see GitHub’s REST API documentation: https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api.
integer
required
The unique identifier of the project for which columns are to be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PROJECT_FIELDS_FOR_USERTool to list all fields in a GitHub Projects V2 project for a specific user. Use when you need to see available fields in a project.

Input Parameters

string
A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see ‘Using pagination in the REST API’.
string
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see ‘Using pagination in the REST API’.
integer
The number of results per page (max 100). For more information, see ‘Using pagination in the REST API’.
string
required
The handle for the GitHub user account.
integer
required
The project’s number (visible in the project URL).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PROJECT_ITEMS_FOR_USERLists a page of items, including issues, pull requests and draft issues, in a user-owned GitHub project. Supports cursor pagination and filtering.

Input Parameters

string
Search query to filter items. See GitHub’s filtering projects documentation for syntax.
string
A cursor for pagination. If specified, the query only searches for results after this cursor.
string
A cursor for pagination. If specified, the query only searches for results before this cursor.
string
Limit results to specific fields by their IDs. Format: ‘fields[]=123&fields[]=456’ or ‘fields=123,456,789’. If not specified, the title field will be returned.
integer
The number of results per page (max 100). Defaults to 30.
string
required
The handle for the GitHub user account.
integer
required
The project’s number (displayed in the project URL).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PROJECT_VIEW_ITEMS_FOR_USERTool to list items for a user’s GitHub Projects (v2) view. Use when you need to retrieve items from a specific view of a user’s project. Supports pagination and field filtering.

Input Parameters

string
A cursor for pagination. If specified, the query only searches for results after this cursor.
string
A cursor for pagination. If specified, the query only searches for results before this cursor.
string
Limit results to specific fields by their IDs. If not specified, the title field will be returned. Example: ‘123,456,789’
integer
The number of results per page (max 100).
string
required
The GitHub username that owns the project.
integer
required
The number that identifies the project view.
integer
required
The project’s number (unique identifier within the user’s projects).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PUBLIC_EMAILS_FOR_AUTH_USERLists the public email addresses for the authenticated user.

Input Parameters

integer
Page number of the results to fetch.
integer
Number of results to return per page. Maximum value is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PUBLIC_EVENTSLists public GitHub events, which may be delayed by up to 5 minutes, with support for pagination.

Input Parameters

integer
Specifies the page number of the results to retrieve. Starts from 1. For more information, see “Using pagination in the REST API.”
integer
Specifies the number of events to return per page. Maximum value is 100. For more information, see “Using pagination in the REST API.”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PUBLIC_EVENTS_FOR_A_NETWORK_OF_REPOSITORIESRetrieves public events (up to 90 days old, newest first) for a GitHub repository network, including the repository and its forks.

Input Parameters

integer
Specifies the page number for the results to be fetched. For further details, consult “Using pagination in the REST API.”
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.
integer
Sets the number of results to return per page, with a maximum of 100. For further details, consult “Using pagination in the REST API.”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PUBLIC_EVENTS_FOR_A_USERRetrieves a list of public events for a specified GitHub user, in reverse chronological order.

Input Parameters

integer
Page number for paginated results.
integer
Number of events to return per page (max 100).
string
required
The GitHub username (e.g., ‘octocat’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PUBLIC_EVENTS_RECEIVED_BY_A_USERLists public events for a specified GitHub user (e.g., activities in repositories they watch or are involved in); the target user’s profile must be public, and if blocked by the authenticated user, a 404 error is returned.

Input Parameters

integer
The page number for the set of results to be fetched. For more information, see “Using pagination in the REST API.”
integer
The number of public events to retrieve per page. The maximum value is 100. For more information, see “Using pagination in the REST API.”
string
required
The GitHub username for the user whose received public events are to be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PUBLIC_GISTSLists public gists from GitHub, optionally filtering by a ‘since’ timestamp and supporting pagination; results are generally newest first.

Input Parameters

integer
Page number of the results to fetch for pagination.
string
Filters results to gists last updated at or after this ISO 8601 timestamp (e.g., YYYY-MM-DDTHH:MM:SSZ).
integer
Number of gists to return per page (maximum 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PUBLIC_KEYS_FOR_A_USERLists the verified public SSH keys for a specified GitHub user.

Input Parameters

integer
The page number of the results to fetch. For more information, see “Using pagination in the REST API.”
integer
The number of results to return per page (maximum 100). For more information, see “Using pagination in the REST API.”
string
required
The GitHub username (handle) of the user whose public SSH keys are to be listed. For example, ‘octocat’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PUBLIC_ORGANIZATION_EVENTSLists public events for a specified GitHub organization, which must exist. This action retrieves the events that are publicly accessible for the organization specified. It returns a paginated list of events with details about each event.

Input Parameters

string
required
The GitHub organization name (case-insensitive).
integer
Page number of results to retrieve (starts from 1).
integer
Number of results per page (maximum 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PUBLIC_ORGANIZATION_MEMBERSLists users who have publicly declared their membership in a specified, existing GitHub organization.

Input Parameters

string
required
The name of the GitHub organization. This field is not case-sensitive.
integer
Page number of the results to retrieve.
integer
Number of results to return per page (maximum 100). Defaults to 30.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PUBLIC_REPOSITORIESLists all public repositories on GitHub; use the since parameter with a repository ID from a previous result for pagination.

Input Parameters

integer
A repository ID. Returns only repositories with an ID greater than this value, for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PULL_REQUESTSLists pull requests for a GitHub repository. REQUIRES ‘owner’ AND ‘repo’ parameters - both are MANDATORY and must be provided in every call. Does NOT support filtering by assignee or date range - use GITHUB_FIND_PULL_REQUESTS instead for searching PRs by assignee, author, or across multiple repositories.

Input Parameters

string
Filter by base branch name.
string
Filter by head user/org and branch name, e.g., user:ref-name.
integer
Page number for results.
string
required
[REQUIRED - MUST BE PROVIDED] The name of the repository (without the .git extension). This parameter is mandatory and cannot be omitted. Example: ‘Spoon-Knife’ or ‘vscode’. To search PRs across multiple repos, use GITHUB_FIND_PULL_REQUESTS instead.
string
Sorts results. Valid values: ‘created’, ‘updated’, ‘popularity’, ‘long-running’. ‘popularity’ is by comment count; ‘long-running’ by age and recent activity.
string
required
[REQUIRED - MUST BE PROVIDED] The GitHub username or organization name that owns the repository. This parameter is mandatory and cannot be omitted. Example: ‘octocat’ or ‘microsoft’. To search PRs across all repos without specifying owner, use GITHUB_FIND_PULL_REQUESTS instead.
string
Filter by pull request state. Valid values: ‘open’, ‘closed’, ‘all’.
integer
Number of results per page (maximum 100).
string
Sort direction. Valid values: ‘asc’, ‘desc’. Defaults to ‘desc’ if sort is ‘created’ or unspecified, else ‘asc’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PULL_REQUESTS_ASSOCIATED_WITH_A_COMMITLists pull requests for a commit; returns merged PRs that introduced the commit if on the default branch, or open PRs including the commit if on other branches.

Input Parameters

integer
Page number of results to retrieve.
string
required
Repository name, without the .git extension (case-insensitive).
string
required
Account owner of the repository (GitHub username or organization name, case-insensitive).
integer
Number of results per page (max 100).
string
required
SHA of the commit to list associated pull requests for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_PULL_REQUESTS_FILESLists a page of files changed in a specified GitHub pull request, including additions, modifications, and removals.

Input Parameters

integer
Page number of the results to retrieve for pagination.
string
required
The name of the repository, without the .git extension. This field is not case sensitive.
string
required
The account owner of the repository (e.g., a GitHub username or organization name). This field is not case sensitive.
integer
Number of file results to return per page (max 100).
integer
required
The numeric identifier of the pull request whose files are to be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REACTIONS_FOR_A_COMMIT_COMMENTLists reactions for a specific commit comment; this is a read-only operation.

Input Parameters

integer
Page number for the results (1-indexed).
string
required
Repository name, excluding the ‘.git’ extension (case-insensitive).
string
required
Owner of the repository (username or organization, case-insensitive).
string ("+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes")
Filter by reaction type. If unspecified, all reaction types for the comment are returned.
integer
Number of results per page (maximum 100).
integer
required
Identifier of the commit comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REACTIONS_FOR_AN_ISSUELists reactions for a specific, existing issue within an accessible GitHub repository, optionally filtering by content type.

Input Parameters

integer
The page number of the results to fetch for pagination.
string
required
The name of the repository, without the .git extension. This is not case-sensitive.
string
required
The username of the account that owns the repository. This is not case-sensitive.
string ("+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes")
Filters reactions by a specific type. If omitted, all reactions to the issue are listed.
integer
The number of results to return per page, up to a maximum of 100.
integer
required
The unique number identifying the issue within the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REACTIONS_FOR_AN_ISSUE_COMMENTLists reactions for a specific issue comment in a GitHub repository, optionally filtering by content type.

Input Parameters

integer
Page number of results to fetch.
string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository (e.g., a user or organization). This name is not case sensitive.
string ("+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes")
Filters reactions by their content type (e.g., ‘+1’, ‘laugh’). Omit to list all types of reactions.
integer
Number of results to return per page (max 100).
integer
required
The unique identifier of the issue comment for which to list reactions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REACTIONS_FOR_A_PULL_REQUEST_REVIEW_COMMENTLists reactions for a pull request review comment in a repository, optionally filtering by reaction type.

Input Parameters

integer
Page number of the results to fetch.
string
required
Name of the repository, without the .git extension (not case sensitive).
string
required
Account owner of the repository (not case sensitive).
string ("+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes")
Filters reactions by a specific type; if omitted, all reactions are listed.
integer
Number of results per page (max 100).
integer
required
Unique identifier of the pull request review comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REACTIONS_FOR_A_RELEASELists a page of reactions for a GitHub release, optionally filtered by reaction type.

Input Parameters

integer
Page number of the results to fetch. Starts from 1.
string
required
The name of the repository, without the .git extension (not case-sensitive).
string
required
The GitHub account owner of the repository (not case-sensitive).
string ("+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes")
Supported reaction types for releases (note: -1 and confused are NOT supported for releases).
integer
Number of results per page. Range: 1-100, default: 30.
integer
required
The unique identifier of the release. Obtain this from the List Releases API or from the release URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REACTIONS_FOR_A_TEAM_DISCUSSIONLists a page of reactions for an existing team discussion within an organization, optionally filtered by reaction type. OAuth app tokens and personal access tokens (classic) need the read:discussion scope.

Input Parameters

string
required
The organization name. Account name of the organization (case-insensitive).
integer
The page number of results to fetch. Default: 1.
string ("+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes")
Valid reaction content types for GitHub team discussions.
integer
The number of results per page (max 100). Default: 30.
string
required
The team’s slug (URL-friendly identifier). This is the lowercase, hyphenated version of the team name.
integer
required
The unique number that identifies the team discussion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REACTIONS_FOR_A_TEAM_DISCUSSION_COMMENTLists reactions for a specific comment in a team discussion within an organization, optionally filtering by content type.

Input Parameters

string
required
The organization’s name (case-insensitive).
integer
Page number of the results to retrieve.
string ("+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes")
Filters reactions by a specific content type.
integer
Number of results per page (max 100).
string
required
URL-friendly slug of the team name.
integer
required
Unique identifier for the comment within the discussion.
integer
required
Unique identifier for the team discussion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_RELEASE_ASSETSLists assets (e.g., compiled binaries, source code archives) for a specific GitHub release, identified by release_id which must be valid for an existing release in the repository.

Input Parameters

integer
Page number of the results to fetch (starts from 1). For pagination details, see “Using pagination in the REST API.”
string
required
Name of the repository, excluding the .git extension (case-insensitive).
string
required
Username or organization name of the repository owner (case-insensitive).
integer
Number of results per page (max 100). For pagination details, see “Using pagination in the REST API.”
integer
required
Unique numerical identifier for the release. Obtainable by listing a repository’s releases.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_RELEASESRetrieves a page of releases for a specified repository, including published releases and available draft and prerelease versions.

Input Parameters

integer
The page number of the results to fetch. For more information, see “Using pagination in the REST API.”
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.
integer
The number of results to return per page. The maximum value is 100. For more information, see “Using pagination in the REST API.”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPO_ACCESS_BY_TOKENLists repositories in an organization that a fine-grained personal access token has requested access to. Only GitHub Apps can use this endpoint. Requires ‘Personal access token requests’ organization permissions (read).

Input Parameters

string
required
The organization name. The name is not case sensitive.
integer
The page number of the results to fetch.
integer
The number of results per page (max 100).
integer
required
Unique identifier of the request for access via fine-grained personal access token. Obtain this from the ‘List PAT grant requests’ endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPO_CODESPACESLists Codespaces the authenticated user can access within a specified, existing repository.

Input Parameters

integer
Page number of the results to retrieve.
string
required
Name of the repository, without the .git extension (case-insensitive).
string
required
Username or organization name of the account that owns the repository (case-insensitive).
integer
Number of results to return per page. Maximum: 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPO_DEV_CONTAINER_CONFIGS_FOR_USERLists the devcontainer.json configurations available in a specified repository for use with GitHub Codespaces.

Input Parameters

integer
Page number of the dev container configuration results to fetch.
string
required
The name of the repository, without the .git extension (not case-sensitive).
string
required
The username or organization name that owns the repository (not case-sensitive).
integer
Number of dev container configuration results to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPO_INVITATIONS_FOR_AUTH_USERLists a page of pending repository invitations for the authenticated user.

Input Parameters

integer
Page number of the results to retrieve.
integer
Number of results to return per page. Maximum allowed value is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPO_NOTIFICATIONS_FOR_AUTH_USERRetrieves notifications for the authenticated user from a specified repository, to which the user must have access.

Input Parameters

boolean
If true, shows notifications marked as read; otherwise, only unread notifications are returned.
integer
The page number of the results to retrieve.
string
required
The name of the repository, without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
string
Only includes notifications last updated on or after this ISO 8601 UTC timestamp (e.g., YYYY-MM-DDTHH:MM:SSZ).
string
Only includes notifications last updated before this ISO 8601 UTC timestamp (e.g., YYYY-MM-DDTHH:MM:SSZ).
integer
The number of notifications to return per page. Maximum value is 100.
boolean
If true, shows only notifications in which the authenticated user is directly participating or was mentioned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPO_SECRETS_WITHOUT_VALUESLists a page of Codespaces secrets for a specified repository, without their encrypted values. Returns secret metadata and the total count.

Input Parameters

integer
Page number of the results to retrieve. Used for pagination.
string
required
The name of the repository, without the .git extension. This is not case-sensitive.
string
required
The username of the account that owns the repository. This is not case-sensitive.
integer
Number of secrets to return per page. Maximum value is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORIESLists repositories accessible to the authenticated user based on visibility, affiliation, and type filters. Returns repositories owned by the user, those they collaborate on, or those accessible through organization membership. Use this action when you need to retrieve a comprehensive list of repositories the authenticated user can access, with options to filter by visibility (public/private), affiliation (owner/collaborator/organization), or type. Supports pagination for large result sets.

Input Parameters

integer
Page number of results to fetch.
string ("created" | "updated" | "pushed" | "full_name")
The property to sort the results by.
string ("all" | "owner" | "public" | "private" | "member")
Limit results to repositories of the specified type. Note: Using ‘type’ with ‘visibility’ or ‘affiliation’ will cause a 422 error. Use either ‘type’ OR ‘visibility’/‘affiliation’, not both.
string
Only show repositories updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
string
Only show repositories updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
integer
Number of results per page (maximum 100).
string ("asc" | "desc")
The order to sort by. Default: asc when using full_name, otherwise desc.
string ("all" | "public" | "private")
Limit results to repositories with the specified visibility (all, public, or private).
string
Comma-separated list of values defining which repositories to include: ‘owner’ (repositories owned by the authenticated user), ‘collaborator’ (repositories where the user is a collaborator), ‘organization_member’ (repositories accessible through organization membership). When not specified, defaults to ‘owner,collaborator,organization_member’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORIES_ACCESSIBLE_TO_THE_APP_INSTALLATIONLists repositories a GitHub App installation can access. IMPORTANT: This endpoint requires a GitHub App installation access token (ghs_* prefix) for authentication. OAuth/user access tokens (gho_*) or personal access tokens are not supported and will result in a 403 Forbidden error. Returns ‘total_count’ and ‘repositories’ array with pagination support.

Input Parameters

integer
Page number of the results to fetch.
integer
Number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORIES_FOR_A_USERLists public repositories for a specified GitHub user, who must have an existing account.

Input Parameters

integer
Page number for results (starts from 1). See GitHub REST API pagination docs for more info.
string ("created" | "updated" | "pushed" | "full_name")
Sort criterion: created (default), updated, pushed, or full_name (repository name). When not specified, GitHub API defaults to created.
string ("all" | "owner" | "member" | "public")
Filter for repository type: all (owned or member), owner (directly owned), member (user is a public member), or public (public repositories only). When omitted, API returns all public repositories.
integer
Number of results per page (max 100). See GitHub REST API pagination docs for more info.
string
required
GitHub username, e.g., ‘octocat’.
string ("asc" | "desc")
Sort direction: asc (ascending) or desc (descending). When not specified, defaults to asc for full_name sort, and desc for all other sort options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORIES_FOR_THE_AUTHENTICATED_USERLists repositories for the authenticated user; using ‘type’ with ‘visibility’ or ‘affiliation’ API parameters (not in this model) can cause a 422 error.

Input Parameters

integer
Page number of results to fetch.
string ("created" | "updated" | "pushed" | "full_name")
The repository property by which to sort the results.
string ("all" | "owner" | "public" | "private" | "member")
Filters the results to repositories of the specified type.
string
Filters for repositories updated at or after this specified time. Provide as an ISO 8601 formatted timestamp.
string
Filters for repositories updated before this specified time. Provide as an ISO 8601 formatted timestamp.
integer
The number of results to return per page (maximum 100).
string ("asc" | "desc")
The direction of the sort. Defaults to asc when sort is ‘full_name’, and desc otherwise.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORIES_STARRED_BY_A_USERLists repositories a valid and existing GitHub user has starred.

Input Parameters

integer
Page number of the results to retrieve (starts from 1). For more information, see “Using pagination in the REST API.”
string ("created" | "updated")
The criteria for sorting the starred repositories. created sorts by the date the repository was starred. updated sorts by the date the repository was last pushed to.
integer
The number of results to display per page (max 100). For more information, see “Using pagination in the REST API.”
string
required
The GitHub username of the user whose starred repositories are to be listed.
string ("asc" | "desc")
The direction for sorting the results. Can be asc for ascending or desc for descending.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORIES_STARRED_BY_THE_AUTHENTICATED_USERLists repositories starred by the authenticated user, with sorting and pagination options.

Input Parameters

integer
Page number of results (starts from 1).
string ("created" | "updated")
Sorts starred repositories by ‘created’ (date starred) or ‘updated’ (date last pushed).
integer
Number of results per page (max 100). Defaults to 30.
string ("asc" | "desc")
Sort direction: ‘asc’ (ascending) or ‘desc’ (descending).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORIES_WATCHED_BY_A_USERLists repositories a given GitHub user is watching; the username must be a valid and existing GitHub user handle.

Input Parameters

integer
Page number of results (starts from 1).
integer
Number of results per page (max 100).
string
required
The GitHub username (case-sensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORIES_WATCHED_BY_THE_AUTHENTICATED_USERLists repositories the authenticated user is watching (subscribed to for notifications). This action retrieves a list of repositories that the authenticated user is currently watching. It allows the user to manage their watched repositories effectively.

Input Parameters

integer
Page number of the results to retrieve.
integer
Number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORIES_WITH_GITHUB_ACTIONS_CACHE_USAGERetrieves a paginated list of GitHub Actions cache usage statistics for repositories within an existing GitHub organization.

Input Parameters

string
required
The name of the GitHub organization for which to retrieve repository cache usage. This name is not case-sensitive.
integer
The page number for the set of results to fetch.
integer
The number of repository cache usage results to return per page (maximum is 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_ACTIVITIESLists activities for a GitHub repository, ensuring the repository exists and is accessible.

Input Parameters

string
The Git reference for which to list activities (e.g., a branch name like main or a full ref like refs/heads/main). If unspecified, activities from all branches are listed.
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
The GitHub username of the person who performed the activity. Filters activities to only those performed by this user.
string
A pagination cursor. Returns activity items that occurred after this cursor. This cursor is typically obtained from the Link header in a previous API response. For more details, see GitHub’s REST API documentation on “Using pagination in the REST API” and “Using Link headers”.
string
required
The account owner of the repository (e.g., a GitHub username or organization name). This name is not case-sensitive.
string
A pagination cursor. Returns activity items that occurred before this cursor. This cursor is typically obtained from the Link header in a previous API response. For more details, see GitHub’s REST API documentation on “Using pagination in the REST API” and “Using Link headers”.
integer
The number of activity results to return per page. Defaults to 30, maximum is 100. For more information, see the GitHub REST API guide on “Using pagination in the REST API”.
string ("asc" | "desc")
The direction to sort the activity results. Use ‘asc’ for ascending (oldest first) or ‘desc’ for descending (newest first).
string ("day" | "week" | "month" | "quarter" | "year")
Filters activities based on a predefined time period. For example, ‘day’ retrieves activities from the last 24 hours, and ‘week’ from the last 7 days (168 hours).
string ("push" | "force_push" | "branch_creation" | "branch_deletion" | "pr_merge" | "merge_queue_merge")
Filters activities by a specific type, such as ‘push’ or ‘pr_merge’. If unspecified, all relevant activity types are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_COLLABORATORSLists collaborators for a specified repository, provided it exists and is accessible to the authenticated user.

Input Parameters

integer
The page number of the results to retrieve.
string
required
The name of the repository, without the .git extension. This value is not case sensitive.
string
required
The username of the account that owns the repository. This value is not case sensitive.
integer
The number of results to return per page. Maximum value is 100.
string ("pull" | "triage" | "push" | "maintain" | "admin")
Filter collaborators by their repository permission level. If not specified, all collaborators are returned regardless of permission.
string ("outside" | "direct" | "all")
Filter collaborators by affiliation: ‘outside’ (collaborators of an organization-owned repository not part of the org), ‘direct’ (collaborators with direct permissions to an organization-owned repository), or ‘all’ (all collaborators visible to the authenticated user).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_CONTRIBUTORSLists contributors to a specified repository, sorted by number of contributions in descending order; the repository must exist and be accessible.

Input Parameters

string
Set to ‘1’ or ‘true’ to include anonymous contributors. If omitted, anonymous contributors are not included.
integer
Page number of results to retrieve (1-based indexing).
string
required
Name of the repository (without .git extension). Not case-sensitive.
string
required
Username of the account owning the repository. Not case-sensitive.
integer
Number of contributor results per page. Maximum value is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_DEPENDABOT_ALERTSList Dependabot vulnerability alerts for a repository with filters and cursor pagination.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string ("created" | "updated" | "epss_percentage")
Property used to sort alerts.
string
Cursor from a GitHub Link header for the next page.
string
required
The account owner of the repository. The name is not case sensitive.
string
Comma-separated dependency scopes. Allowed values are development and runtime.
string
Comma-separated alert states. Allowed values are auto_dismissed, dismissed, fixed, and open.
string
Cursor from a GitHub Link header for the previous page.
string
Comma-separated package names to include.
string
Comma-separated manifest paths to include.
integer
Number of alerts to return per page, from 1 to 100.
string
Comma-separated severities. Allowed values are low, medium, high, and critical.
string ("asc" | "desc")
Direction used to sort alerts.
string
Comma-separated package ecosystems to include.
string
Comma-separated dependency relationships. Allowed values are unknown, direct, transitive, and inconclusive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_EVENTSLists chronological events (e.g., code pushes, issue activities, PR actions, forks) for a specified, existing GitHub repository.

Input Parameters

integer
Page number for paginating results.
string
required
Repository name, without the .git extension (not case-sensitive).
string
required
Owner’s username or organization name (not case-sensitive).
integer
Number of events to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_INVITATIONSLists a page of pending collaboration invitations for a specified GitHub repository.

Input Parameters

integer
Page number of the results to retrieve.
string
required
The name of the repository, without the ‘.git’ extension. This field is not case-sensitive.
string
required
The username of the account that owns the repository. This field is not case-sensitive.
integer
Number of results to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_ISSUESLists issues (including pull requests) from a GitHub repository. Requires BOTH ‘owner’ AND ‘repo’ parameters (e.g., owner=‘octocat’, repo=‘Hello-World’ for github.com/octocat/Hello-World).

Input Parameters

integer
Page number for the set of results. Refer to GitHub’s REST API documentation for pagination details.
string
required
REQUIRED. The name of the repository (without .git extension). For ‘octocat/Hello-World’, repo is ‘Hello-World’. Not case-sensitive. Must be provided together with ‘owner’.
string ("created" | "updated" | "comments")
The field to sort the results by.
string
Filter issues by type name. Use ’*’ for issues with any type, ‘none’ for issues without a type, or specify a type name.
string
required
REQUIRED. The GitHub account owner (user or organization) of the repository. For ‘octocat/Hello-World’, owner is ‘octocat’. Not case-sensitive. Must be provided together with ‘repo’.
string
Filters issues to include only those updated at or after the specified time. This should be a timestamp in ISO 8601 format (e.g., YYYY-MM-DDTHH:MM:SSZ).
string ("open" | "closed" | "all")
Filters issues based on their state.
string
A comma-separated list of label names to filter issues by. Example: ‘bug,ui,@high’.
string
Filter issues by the username of the user who created the issue.
string
Filter issues by assignee’s username. Use ‘none’ for issues with no assignee, or ’*’ for issues assigned to any user.
integer
Number of results per page (max 100). Default is 30, which matches GitHub’s API default. Refer to GitHub’s REST API documentation for pagination details.
string ("asc" | "desc")
The direction of the sort.
string
Filter issues by a user mentioned in the issue’s description or comments. Provide the username.
string
Filter issues by milestone. Provide the milestone number as a string, ’*’ for issues with any milestone, or ‘none’ for issues without a milestone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_LANGUAGESLists the programming languages used in a GitHub repository, returning a byte count for each language.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository (username or organization name). This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_ORGANIZATION_SECRETSLists names of organization-level secrets shared with the specified repository; actual secret values are not returned and visibility depends on token access.

Input Parameters

integer
Page number for paginated results.
string
required
Name of the repository, without the .git extension (case-insensitive).
string
required
The username or organization name that owns the repository (case-insensitive).
integer
Number of secrets per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_ORGANIZATION_VARIABLESLists organization-level variables that are shared with a specific repository. The repository must belong to an organization (not a personal account).

Input Parameters

integer
Page number of results. For pagination details, see GitHub REST API docs.
string
required
Name of the repository, without the .git extension (case-insensitive).
string
required
The organization name that owns the repository (case-insensitive). This endpoint only works for organization repositories, not personal account repositories.
integer
Number of results per page (max 30). For pagination details, see GitHub REST API docs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_PROJECTSLists a page of a repository’s Projects (classic), filtered by open, closed, or all states. An empty result with a message can also indicate that the repository was not found or classic projects are not enabled. DEPRECATED: The classic Projects REST API has been sunset; use GitHub Projects V2 instead.

Input Parameters

integer
Page number of the results to retrieve.
string
required
Name of the repository, without the .git extension (case-insensitive).
string
required
Username of the account owning the repository (case-insensitive).
string ("open" | "closed" | "all")
Filters projects by their state.
integer
Number of projects to return per page (maximum 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_RULESETSRetrieves a page of rulesets for a GitHub repository, including parent rulesets by default. Rulesets define conditions and actions for repository interactions such as branch protection.

Input Parameters

integer
Page number for pagination.
string
required
Name of the repository, without .git extension (case-insensitive).
string
required
Username or organization name of the repository owner (case-insensitive).
integer
Number of rulesets per page (max 100).
boolean
If True, also fetches rulesets from parent levels (e.g., organization) applicable to this repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_RULE_SUITESLists rule suite evaluations for a repository, allowing filtering by ref (non-wildcard), time period, actor, and result.

Input Parameters

string
The ref (e.g., branch or tag name) to filter by; cannot contain wildcard characters. If provided, only evaluations for this ref are returned.
integer
Page number of results to retrieve.
string
required
The name of the repository, without the ‘.git’ extension. This field is not case-sensitive.
string
required
The username of the account or the organization name that owns the repository. This field is not case-sensitive.
integer
Number of results per page (max 100).
string
GitHub username of the actor to filter by. If specified, only evaluations triggered by this user are returned.
string ("hour" | "day" | "week" | "month")
Time period to filter rule suites: ‘hour’ (last hour), ‘day’ (last 24 hours), ‘week’ (last 7 days), or ‘month’ (last 30 days).
string ("pass" | "fail" | "bypass" | "all")
Filter rule suites by evaluation outcome (e.g., ‘pass’, ‘fail’, ‘bypass’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_SECRETSLists a page of metadata for GitHub Actions secrets in a repository, including names and timestamps but not secret values.

Input Parameters

integer
Page number of the results to fetch.
string
required
The name of the repository, without the .git extension. The name is not case-sensitive.
string
required
The GitHub account owner of the repository. This is typically a username or organization name. The name is not case-sensitive.
integer
Number of secrets per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_SECRETS_WITHOUT_DECRYPTINGLists a page of metadata for Dependabot secrets in a repository, including names and creation and update dates; secret values are not included.

Input Parameters

integer
Page number of the results to retrieve (starts from 1).
string
required
The name of the repository, without the .git extension. This field is not case sensitive.
string
required
The account owner of the repository (e.g., a GitHub username or organization name). This field is not case sensitive.
integer
Number of secrets to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_SECURITY_ADVISORIESLists repository security advisories, optionally filtered by state and sorted or paginated.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string ("created" | "updated" | "published")
The property to sort the results by.
string
A cursor for pagination. If specified, the query only searches for results after this cursor.
string
required
The account owner of the repository. The name is not case sensitive.
string ("triage" | "draft" | "published" | "closed")
Filter by state of the repository advisories. Only advisories of this state will be returned.
string
A cursor for pagination. If specified, the query only searches for results before this cursor.
integer
The number of advisories to return per page.
string ("asc" | "desc")
The direction to sort the results by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_TAGSLists tags for a specified GitHub repository.

Input Parameters

integer
The page number of the results to retrieve for pagination.
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
integer
The number of tag results to return per page; maximum 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_TEAMSLists a page of teams with explicit permission to access the specified repository; the repository must exist.

Input Parameters

integer
Page number of the results to retrieve.
string
required
The name of the repository, without the .git extension. This value is not case-sensitive.
string
required
The username of the account that owns the repository. This value is not case-sensitive.
integer
The number of team results to return per page (maximum 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_TOPICSRetrieves all topics for a specified, existing, and accessible repository.

Input Parameters

integer
Page number of the results to fetch.
string
required
Name of the repository, without the .git extension (case-insensitive).
string
required
Account owner of the repository (case-insensitive).
integer
Number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_VARIABLESLists plain text key-value variables for GitHub Actions workflows within a specific, accessible repository.

Input Parameters

integer
Page number of the results to fetch.
string
required
The name of the repository, without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. This can be a username or an organization name. The name is not case sensitive.
integer
Number of repository variables to return per page (maximum 30).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_WEBHOOKSRetrieves a list of webhooks for a repository, which must exist and be accessible.

Input Parameters

integer
Page number of the results to retrieve.
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository (e.g., a GitHub username or organization name). This name is not case-sensitive.
integer
Number of webhook results per page. Maximum is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REPOSITORY_WORKFLOWSLists a page of GitHub Actions workflows for a specified repository, which must exist and be accessible. The response includes the total workflow count.

Input Parameters

integer
The page number of the results to fetch.
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
integer
The number of workflow results to return per page. Maximum value is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REQUESTED_REVIEWERS_FOR_A_PULL_REQUESTGets all users and teams requested to review a specific pull request in a repository.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The number that identifies the pull request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REVIEW_COMMENTS_IN_A_REPOSITORYLists a page of pull request review comments across a specified repository, with sorting and pagination options.

Input Parameters

integer
Page number for the results to retrieve.
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string ("created" | "updated" | "created_at")
Sort field for review comments: created (creation time), updated (last update time), or created_at (creation timestamp). Defaults to API’s standard sort order (typically by ID, ascending) if unspecified.
string
required
The username of the account that owns the repository. This name is not case-sensitive.
string
Filters for comments updated at or after this ISO 8601 timestamp (e.g., YYYY-MM-DDTHH:MM:SSZ).
integer
Number of review comments per page (max 100).
string ("asc" | "desc")
Sort direction (asc or desc). Effective only if sort is specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REVIEW_COMMENTS_ON_A_PULL_REQUESTLists a page of review comments on a specific pull request within a GitHub repository, with sorting and pagination options.

Input Parameters

integer
Page number of results to retrieve.
string
required
Name of the repository, without the .git extension. Not case sensitive.
string ("created" | "updated")
Sort review comments by created or updated.
string
required
Username of the account owning the repository. Not case sensitive.
string
Only include comments updated at or after this ISO 8601 timestamp (YYYY-MM-DDTHH:MM:SSZ).
integer
Number of comments per page (max 100).
string ("asc" | "desc")
Sort direction (asc or desc); ignored if sort is not provided.
integer
required
Unique number identifying the pull request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_REVIEWS_FOR_A_PULL_REQUESTLists submitted reviews chronologically for a specific pull request within a GitHub repository.

Input Parameters

integer
The page number for the set of results to retrieve.
string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository (e.g., a GitHub username or organization name). This name is not case sensitive.
integer
The number of review results to display per page. Maximum 100.
integer
required
The unique number identifying the pull request within the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_RUNNER_APPLICATIONS_FOR_AN_ORGANIZATIONLists downloadable GitHub Actions runner application binaries for setting up self-hosted runners in a GitHub organization. Returns download URLs and checksums for various OS/architecture combinations (linux/win/osx on x64/arm/arm64). Requires admin:org scope or fine-grained ‘Self-hosted runners’ read permission.

Input Parameters

string
required
The name of the GitHub organization. This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_RUNNER_APPLICATIONS_FOR_A_REPOSITORYLists available self-hosted runner application binaries for a specific repository, including their OS, architecture, and download URL.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username of the account or the name of the organization that owns the repository. This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_SECRET_SCANNING_ALERTS_FOR_A_REPOSITORYList secret scanning alerts for a GitHub repository using first-party detections. Use this to retrieve detected secrets with filtering by state, type, resolution, and validity. Supports optional hiding of secret literals for security.

Input Parameters

integer
Page number of results to fetch.
string
required
The name of the repository without .git extension. The name is not case sensitive.
string ("created" | "updated")
Sort alerts by ‘created’ or ‘updated’ timestamp.
string
Cursor for pagination to fetch results after this cursor.
string
required
The account owner of the repository. The name is not case sensitive.
string ("open" | "resolved")
Filter alerts by state: ‘open’ for unresolved alerts or ‘resolved’ for resolved alerts.
string
Cursor for pagination to fetch results before this cursor.
string
Filter by assignee. Use ’*’ for any assigned alerts, ‘none’ for unassigned alerts, or a specific GitHub username.
integer
Number of results per page, maximum 100.
string ("active" | "inactive" | "unknown")
Filter by token validity status: ‘active’ (token still valid), ‘inactive’ (token revoked/expired), or ‘unknown’ (validity cannot be determined).
string ("asc" | "desc")
Sort direction: ‘asc’ for ascending or ‘desc’ for descending.
string
Comma-separated list of resolutions to filter by. Valid values: ‘false_positive’, ‘wont_fix’, ‘revoked’, ‘pattern_edited’, ‘pattern_deleted’, ‘used_in_tests’.
boolean
Hide the literal secret value from API response for security. When true, the ‘secret’ field will be omitted from results.
string
Comma-separated list of secret types to filter by (e.g., ‘github_personal_access_token,aws_access_key_id’).
boolean
Filter by multi-repo tag presence. True returns only alerts found in multiple repositories.
boolean
Filter by publicly-leaked status. True returns only alerts for secrets that were found publicly exposed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_SECRETS_FOR_THE_AUTHENTICATED_USERLists all Codespaces secrets accessible to the authenticated user for use within GitHub Codespaces.

Input Parameters

integer
The page number of the results to retrieve (starts from 1).
integer
The number of secrets to return per page (up to 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_SECURITY_ADVISORIES_GRAPHQLTool to list GitHub Security Advisories using the GraphQL API. Use when you need to query security vulnerabilities and malware advisories from the GitHub Advisory Database with advanced filtering and pagination options.

Input Parameters

integer
Returns the last n elements from the list. Cannot be used with ‘first’.
string
Returns the elements in the list that come after the specified cursor. Used for pagination.
integer
Returns the first n elements from the list. Cannot be used with ‘last’.
string
Returns the elements in the list that come before the specified cursor. Used for pagination.
object
Ordering options for security advisory connections.
object
Filter for security advisory identifiers.
string
Filter advisories to those updated since a time in the past. ISO 8601 datetime string.
number
The EPSS (Exploit Prediction Scoring System) percentage to filter advisories by. Range: 0.0 to 1.0.
number
The EPSS percentile to filter advisories by. Range: 0.0 to 1.0.
string
Filter advisories to those published since a time in the past. ISO 8601 datetime string.
array
List of classifications to filter advisories by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_SECURITY_VULNERABILITIESQuery software vulnerabilities documented by GitHub Security Advisories using GraphQL. Use this to find security issues in packages across ecosystems like npm, pip, maven, etc.

Input Parameters

integer
Returns the last n elements from the list. Maximum value is 100.
string
Returns the elements in the list that come after the specified cursor. Use the endCursor from pageInfo in the previous response.
integer
Returns the first n elements from the list. Maximum value is 100.
string
Returns the elements in the list that come before the specified cursor. Use the startCursor from pageInfo in the previous response.
string
A package name to filter vulnerabilities by (e.g., ‘lodash’, ‘django’).
string ("COMPOSER" | "GO" | "MAVEN" | "NPM" | "NUGET" | "PIP" | "RUBYGEMS" | "RUST")
The possible ecosystems of a security advisory.
array
A list of severities to filter vulnerabilities by. Can include multiple values.
string ("UPDATED_AT")
Properties by which security vulnerability connections can be ordered.
array
A list of advisory classifications to filter vulnerabilities by.
string ("ASC" | "DESC")
Possible directions in which to order a list of items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_SELECTED_REPOSITORIES_FOR_AN_ORGANIZATION_SECRETLists a page of repositories selected to access a Codespaces organization secret whose visibility is set to ‘selected’. Requires admin:org scope and admin access to the organization.

Input Parameters

string
required
The organization name. The name is not case sensitive.
integer
Page number of the results to fetch (starts at 1).
integer
Number of results per page (max 100).
string
required
The name of the Codespaces secret. The secret must have its visibility set to ‘selected’ to return results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_SELECTED_REPOSITORIES_FOR_A_USER_SECRETLists repositories that have access to the specified user Codespaces secret. This endpoint retrieves all repositories that the authenticated user has granted access to for a specific user-level Codespaces secret. The secret must already exist for this endpoint to work. Use ‘list_secrets_for_the_authenticated_user’ to discover available secrets first. Note: The authenticated user must have Codespaces access enabled. OAuth tokens and personal access tokens require the ‘codespace’ or ‘codespace:secrets’ scope.

Input Parameters

integer
Page number of the results to retrieve.
integer
Number of results to return per page (max 100).
string
required
The name of the user Codespaces secret. Secret names are case-sensitive and must be alphanumeric with underscores (e.g., ‘MY_API_TOKEN’, ‘DATABASE_URL’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_SELECTED_REPOSITORIES_FOR_SECRET_ACCESSLists repositories within a specified organization that have been granted access to a particular Dependabot secret. Note: This endpoint only returns results when the secret’s visibility is set to ‘selected’. Secrets with visibility ‘all’ or ‘private’ do not have specific repository selections. Requires ‘admin:org’ scope and the user must have admin access to the organization.

Input Parameters

string
required
The name of the GitHub organization. This field is not case-sensitive.
integer
The page number of the results to retrieve, starting at 1.
integer
The number of results to return per page, with a maximum of 100.
string
required
The name of the Dependabot secret (with visibility set to ‘selected’) for which to list repository access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_SELECTED_REPOS_ORG_VARIABLELists repositories in an organization that can access a specific organization variable; supports pagination and returns an empty list if no repositories have been granted access. Note: This endpoint only works for variables with visibility set to ‘selected’ - attempting to use it on variables with ‘all’ or ‘private’ visibility will result in a 409 Conflict error.

Input Parameters

string
required
The organization’s name (case-insensitive).
string
required
The name of the variable.
integer
Page number for pagination.
integer
Number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_SELF_HOSTED_RUNNERS_FOR_AN_ORGANIZATIONLists self-hosted runners for a GitHub organization, optionally filtering by name and paginating results, providing details for each runner such as OS, status, and labels.

Input Parameters

string
required
The GitHub organization name (case-insensitive).
string
Name to filter the list of self-hosted runners.
integer
Page number for results retrieval (starts at 1).
integer
Number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_SELF_HOSTED_RUNNERS_FOR_A_REPOSITORYLists self-hosted runners configured for a repository, with optional runner-name filtering and pagination.

Input Parameters

string
The name of a specific self-hosted runner to filter by. If not provided, all runners for the repository are listed.
integer
The page number of the results to fetch, starting from 1. For more information, see “Using pagination in the REST API.”
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
The number of results per page (maximum 100). For more information, see “Using pagination in the REST API.”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_SOCIAL_ACCOUNTS_FOR_A_USERLists social media accounts publicly linked to an existing GitHub user’s profile.

Input Parameters

integer
The page number of the results to fetch when paginating. For more information, see “Using pagination in the REST API.”
integer
The number of social account results to return per page. Maximum is 100. For more information, see “Using pagination in the REST API.”
string
required
The handle (username) of the GitHub user (e.g., ‘octocat’) for whom to list social media accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_SOCIAL_ACCOUNTS_FOR_THE_AUTHENTICATED_USERLists a page of social media accounts linked to the authenticated user’s GitHub profile, including links to platforms such as Twitter and LinkedIn.

Input Parameters

integer
Page number of the results to retrieve.
integer
Number of social accounts to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_SPONSORABLESTool to list users and organizations who can be sponsored via GitHub Sponsors. Use when you need to discover sponsorable entities with optional filtering by dependency ecosystem.

Input Parameters

integer
Returns the last n elements from the list. Use for backward pagination.
string
Returns elements following the specified cursor. Use for forward pagination with first parameter.
integer
Returns the first n elements from the list. Use for forward pagination.
string
Returns elements preceding the specified cursor. Use for backward pagination with last parameter.
string ("ACTIONS" | "COMPOSER" | "GO" | "MAVEN" | "NPM" | "NUGET" | "PIP" | "PUB" | "RUBYGEMS" | "RUST" | "SWIFT")
Ecosystem of a dependency graph package.
string ("LOGIN")
Field to order sponsorables by.
boolean
If true, restricts results to sponsorables owning the authenticated viewer’s dependencies. Requires authentication.
string ("ASC" | "DESC")
Direction for ordering results.
string
Organization username to check dependencies against. Used with only_dependencies to filter sponsorables owning this organization’s dependencies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_SSH_SIGNING_KEYS_FOR_A_USERLists the public SSH signing keys for a specified GitHub user.

Input Parameters

integer
The page number of the results to fetch. For more information, see “Using pagination in the REST API.”
integer
The number of results per page (max 100). For more information, see “Using pagination in the REST API.”
string
required
The handle for the GitHub user account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_STARGAZERSLists users who have starred the specified GitHub repository, which must exist.

Input Parameters

integer
Page number of the results to fetch.
string
required
Name of the repository, without the .git extension; case-insensitive.
string
required
Username of the account owner (user or organization) of the repository; case-insensitive.
integer
Number of results to display per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_STARRED_GISTSLists gists starred by the authenticated GitHub user. Optionally filter to gists updated after a specified time and select a page of results, with up to 100 results per page.

Input Parameters

integer
Page number of the results to fetch.
string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) to filter gists updated after this time.
integer
Number of results per page (maximum 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_STARRED_REPOSITORIES_FOR_USERLists a page of public repositories starred by a specified GitHub user, sorted by when they were starred or last updated. Supports pagination and sort direction.

Input Parameters

integer
The page number of the results to fetch.
string ("created" | "updated")
The property to sort the results by. ‘created’ means when the repository was starred. ‘updated’ means when the repository was last pushed to.
integer
The number of results per page (max 100).
string
required
The handle for the GitHub user account.
string ("asc" | "desc")
The direction to sort the results by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_STATUS_CHECK_CONTEXTSFetches required status check contexts for a branch. Returns an empty list for 404 responses other than an explicit branch-not-found message, so an empty result does not necessarily establish that checks are absent.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.
string
required
The exact name of the branch (case-sensitive). Wildcard characters (e.g., *) are not permitted. For operations involving branches with wildcard patterns, the GitHub GraphQL API should be utilized.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_SUB_ISSUESTool to list sub-issues for a specific GitHub issue. Use when you need to retrieve all sub-issues associated with a parent issue, supporting pagination for large hierarchies.

Input Parameters

integer
The page number of the results to fetch. For more information, see “Using pagination in the REST API.”
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
The number of results per page (max 100). For more information, see “Using pagination in the REST API.”
integer
required
The number that identifies the issue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_SUBSCRIPTIONS_FOR_THE_AUTHENTICATED_USERTool to list GitHub Marketplace subscriptions for the authenticated user. Use when you need to retrieve active marketplace app subscriptions including billing details, plan information, and trial status. Returns subscription information with account, plan, billing cycle, and pricing details.

Input Parameters

integer
The page number of the results to fetch. For more information, see “Using pagination in the REST API”.
integer
The number of results per page (max 100). For more information, see “Using pagination in the REST API”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_SUBSCRIPTIONS_FOR_THE_AUTHENTICATED_USER_STUBBEDLists the authenticated user’s stubbed (test/example data, not live) GitHub Marketplace subscriptions, useful for development or testing.

Input Parameters

integer
Page number of results to fetch (starts from 1).
integer
Number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_TAG_PROTECTION_STATES_FOR_A_REPOSITORYLists a repository’s legacy tag protection rules, including the patterns used to identify protected tags. DEPRECATED: GitHub sunset the tag protection API on GitHub.com and says it returns null data; use GITHUB_GET_ALL_REPOSITORY_RULESETS to view tag protection through repository rulesets instead.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository. This name is not case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_TEAM_MEMBERSLists members of a specific team within an organization, including members of child teams.

Input Parameters

string
required
Organization name (case-insensitive).
integer
Page number for results.
string ("member" | "maintainer" | "all")
Filters members by their role in the team.
integer
Number of results per page (maximum 100).
string
required
Team slug (URL-friendly name).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_TEAM_PROJECTSLists GitHub projects accessible to a specific team within an organization.

Input Parameters

string
required
Name of the GitHub organization (case-insensitive). E.g., ‘MyOrg’ for github.com/MyOrg.
integer
Page number for pagination.
integer
Number of project results per page (max 100).
string
required
The team’s URL-friendly slug (e.g., ‘web-developers’ for ‘Web Developers’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_TEAM_REPOSITORIESLists repositories accessible to a specific team within a GitHub organization. Returns a list of repositories that the specified team has access to, including the team’s permission level (admin, maintain, push, triage, pull) for each repository. Requires read:org scope and membership in the organization to access team data.

Input Parameters

string
required
The name of the GitHub organization (case-insensitive). Example: ‘octo-org’.
integer
Page number of results to fetch. Default: 1.
integer
Number of results per page (1-100). Default: 30.
string
required
The URL-friendly slug of the team name (lowercase with dashes). Example: ‘justice-league’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_TEAMSLists teams for a specified GitHub organization.

Input Parameters

string
required
The name of the GitHub organization. This field is not case-sensitive.
integer
The page number of the results to fetch when paginating through the list of teams.
integer
The number of team results to return per page. Maximum value is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_TEAMS_FOR_THE_AUTHENTICATED_USERLists all teams across all organizations to which the authenticated user belongs, supporting pagination.

Input Parameters

integer
Page number of the results to retrieve.
integer
Number of team results to return per page (max 100). For more information, refer to GitHub’s documentation on API pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_TEAMS_THAT_ARE_ASSIGNED_TO_AN_ORGANIZATION_ROLELists a page of teams assigned to a specific role in a GitHub organization, helping administrators audit role assignments. Requires organization administrator privileges; page size can be set from 1 to 100.

Input Parameters

string
required
Name of the GitHub organization (case-insensitive). You must be an administrator of this organization.
integer
Page number of results to fetch (starts at 1).
integer
required
Unique numerical identifier of the organization role. Use ‘Get all organization roles’ to find valid role IDs.
integer
Number of results per page (1-100). Default is 30.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_THE_PEOPLE_A_USER_FOLLOWSLists GitHub users that a valid GitHub username is following, supporting pagination.

Input Parameters

integer
Page number for the results to retrieve (starts from 1).
integer
Number of results to return per page (maximum 100).
string
required
GitHub username (case-sensitive) of the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_THE_PEOPLE_THE_AUTHENTICATED_USER_FOLLOWSLists people the authenticated user follows.

Input Parameters

integer
Page number for paginated results.
integer
Number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_TIMELINE_EVENTS_FOR_AN_ISSUELists chronological events (e.g., comments, commits, label changes) for a specific issue in a GitHub repository.

Input Parameters

integer
Page number for results.
string
required
Name of the repository, without the .git extension (not case-sensitive).
string
required
Account owner of the repository (not case-sensitive).
integer
Number of events per page (max 100).
integer
required
Number identifying the issue within the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_TOKEN_ACCESS_REPOSITORIESLists a page of repositories in an organization accessible to a specified fine-grained personal access token, for auditing its repository access. The caller must be an organization owner or have the Personal access tokens organization permission; the endpoint is for GitHub Apps.

Input Parameters

string
required
The organization name (case-insensitive). You must be an organization owner or have the ‘Personal access tokens’ organization permission to use this endpoint.
integer
Page number of the results to fetch. Default: 1.
integer
required
The unique numeric identifier of the fine-grained personal access token. You can obtain this ID from the ‘list_org_resource_access_tokens’ action.
integer
Number of results per page (max 100). Default: 30.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_USER_PROJECTSLists Projects V2 for a specified GitHub user using GraphQL, with page-based pagination and optional state filtering. State filtering is applied after fetching the page, so a page may contain fewer matching projects than requested.

Input Parameters

integer
Page number for pagination.
string ("open" | "closed" | "all")
Filter projects by state.
integer
Number of results per page (max 100).
string
required
GitHub username (handle).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_USERSLists a page of GitHub users, including individuals and organizations, in chronological order of sign-up. Supports pagination by starting user ID and results per page.

Input Parameters

integer
A user ID. If provided, only users with an ID greater than this ID will be returned. This parameter facilitates pagination. If omitted, the list starts from the first user.
integer
Specifies the number of user results to return per page. The maximum allowed value is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_USERS_BLOCKED_BY_AN_ORGANIZATIONLists users blocked by a specified GitHub organization.

Input Parameters

string
required
The organization name. This name is not case sensitive.
integer
Specifies the page number of the results to fetch. Default is 1. For more information, see “Using pagination in the REST API.”
integer
Specifies the number of results to return per page, with a maximum of 100. Default is 30. For more information, see “Using pagination in the REST API.”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_USERS_BLOCKED_BY_THE_AUTHENTICATED_USERLists users blocked by the authenticated user, returning an empty list if no users are blocked.

Input Parameters

integer
The page number of the results to retrieve.
integer
The number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_USERS_THAT_ARE_ASSIGNED_TO_AN_ORGANIZATION_ROLELists users assigned to a specific role within a GitHub organization.

Input Parameters

string
required
The name of the GitHub organization. This is not case-sensitive.
integer
Page number of results (1-indexed).
integer
required
The unique identifier for the organization role. Use the ‘Get all organization roles’ action first to retrieve valid role IDs.
integer
Number of results per page (maximum 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_WATCHERSRetrieves a list of users watching a specific repository; the repository must be accessible to the authenticated user.

Input Parameters

integer
Page number of the results to retrieve.
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username of the account that owns the repository. This field is not case-sensitive.
integer
Number of results to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_WORKFLOW_RUN_ARTIFACTSLists artifacts (e.g., build outputs, test results) for a specific workflow run in a GitHub repository.

Input Parameters

string
If specified, filters artifacts by this exact name.
integer
Page number of results to fetch.
string
required
Repository name, without the .git extension (not case sensitive).
string
required
Account owner of the repository (not case sensitive).
integer
required
Unique identifier of the workflow run.
integer
Number of results per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_WORKFLOW_RUNS_FOR_A_REPOSITORYLists workflow runs for a repository, allowing filtering by actor, branch, event, status, creation date, check suite ID, or head SHA; the repository must exist and be accessible.

Input Parameters

integer
Page number of the results to fetch.
string
required
The name of the repository, without the .git extension (not case-sensitive).
string
Filter by the actor’s login (e.g., the user who triggered the push).
string
Filter by the event that triggered the workflow (e.g., push, pull_request).
string
required
The account owner of the repository (not case-sensitive).
string
Filter by branch name (e.g., main or the branch that triggered the push).
string ("completed" | "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "in_progress" | "queued" | "requested" | "waiting" | "pending")
Filter by status or conclusion (e.g., success, in_progress). Note: Only GitHub Actions can set waiting, pending, or requested.
string
Filter by creation date or date-time range (ISO8601 format: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ). Supports operators like >, <, >=, <=, and .. for ranges.
string
Filter to include only runs associated with the specified head_sha (commit SHA at the head of the branch).
integer
Number of results per page (maximum 100).
integer
Filter by a specific check_suite_id.
boolean
Set to true to exclude workflow runs triggered by pull request events. Omit or leave as null to include all runs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LIST_WORKFLOW_RUNS_FOR_A_WORKFLOWLists runs for a specified, existing workflow (identified by ID or filename like main.yml) in a GitHub repository, with filtering options.

Input Parameters

integer
Page number of the results to retrieve.
string
required
Repository name, without the .git extension (case-insensitive).
string
Filter by the GitHub username of the actor who initiated the run.
string
Filter by the event that triggered the run (e.g., push, pull_request). For more event types, see GitHub’s documentation on “Events that trigger workflows”.
string
required
Account owner of the repository (case-insensitive).
string
Filter by branch name, typically for push events.
string ("completed" | "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "in_progress" | "queued" | "requested" | "waiting" | "pending")
Filter by status or conclusion (e.g., success, in_progress). Note: waiting, pending, or requested statuses are set exclusively by GitHub Actions.
string
Filter by creation date/time range. For syntax, refer to GitHub’s “Understanding the search syntax” guide for dates.
string
Filter by the head commit’s SHA.
integer
Number of results per page (max 100).
string
required
The ID of the workflow (integer) or the workflow file name (string, e.g., main.yml or ci.yaml).
integer
Filter by check_suite_id (identifier for a collection of check runs).
boolean
If true, exclude workflow runs triggered by pull requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LOCK_AN_ISSUELocks an existing GitHub issue’s conversation, preventing further comments; an optional reason can be specified.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The username of the account that owns the repository. This name is not case-sensitive.
string ("off-topic" | "too heated" | "resolved" | "spam")
Optional reason for locking the conversation. Valid values: ‘off-topic’, ‘too heated’, ‘resolved’, ‘spam’. If omitted, no reason is displayed.
integer
required
The number that uniquely identifies the issue to be locked within the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LOOKUP_ENTERPRISE_ADMINISTRATOR_INVITATIONLook up a pending enterprise administrator invitation by invitee login, enterprise slug, and role. An empty result can indicate either no invitation was returned or a GraphQL resolution or not-found error.

Input Parameters

string ("OWNER" | "BILLING_MANAGER" | "UNAFFILIATED")
required
The role for the enterprise administrator invitation. Must be one of: OWNER, BILLING_MANAGER, or UNAFFILIATED.
string
required
The login (username) of the user invited to join the enterprise as an administrator.
string
required
The slug of the enterprise the user was invited to join. This is the URL-friendly identifier for the enterprise.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LOOKUP_GITHUB_RESOURCELook up a GitHub resource by URL and return its GraphQL type and URL.

Input Parameters

string
required
The GitHub URL of the resource to lookup. Can be a repository, issue, pull request, or other GitHub resource URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LOOKUP_NODES_BY_IDSLook up multiple GitHub nodes by their global node IDs in a single GraphQL query, returning each node’s ID and type.

Input Parameters

array
required
A list of GitHub global node IDs to lookup. Each ID must be a valid base64-encoded global node ID (e.g., ‘MDQ6VXNlcjU4MzIzMQ==’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LOOKUP_ORGANIZATION_GRAPH_QLTool to lookup a GitHub organization by login using GraphQL. Use when you need organization information via GraphQL API.

Input Parameters

string
required
The organization’s login username to look up. Case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_LOOKUP_TOPIC_BY_NAMETool to look up a GitHub topic by name using GraphQL. Use when you need to find information about a specific GitHub topic including its popularity (stargazer count) and related topics.

Input Parameters

string
required
The topic’s name to look up (e.g., ‘python’, ‘javascript’, ‘machine-learning’).
The number of related topics to fetch (between 1 and 10). Only used if include_related_topics is true.
Whether to include related topics in the response. If true, up to 3 related topics will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_MANAGE_ACCESS_CONTROL_FOR_ORGANIZATION_CODESPACESSets the Codespaces access control policy for a GitHub organization, determining which members can use them. This endpoint requires admin permissions on the organization. The API returns HTTP 204 No Content on success.

Input Parameters

string
required
The name of the GitHub organization (case-insensitive). The authenticated user must have admin permissions on this organization.
string ("disabled" | "selected_members" | "all_members" | "all_members_and_outside_collaborators")
required
Defines which users can access Codespaces within the organization. disabled: Codespaces are disabled for all users in the organization. selected_members: Only users specified in selected_usernames can access Codespaces. all_members: All members of the organization can access Codespaces. all_members_and_outside_collaborators: All members and outside collaborators can access Codespaces.
array
A list of GitHub usernames who should have access to Codespaces. Required when visibility is set to selected_members. Providing a list here will replace any existing list of selected usernames. The specified users must be members or outside collaborators of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_MANAGE_CUSTOM_PROPERTIES_FOR_ORG_REPOSCreates or updates values for an organization’s predefined custom properties across multiple repositories (up to 30).

Input Parameters

string
required
The organization’s name (case-insensitive).
string
required
JSON string containing an array of custom properties to set. Each must have property_name (predefined for the organization) and value. Example: ’[{“property_name”: “project-status”, “value”: “active”}]’
array
required
Repository names (max 30) to apply the custom property values to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_MANAGE_ISSUE_BLOCKING_DEPENDENCYAdd or remove an issue that blocks another issue in the same repository.

Input Parameters

string
required
Repository name.
string
required
Repository owner.
string ("add" | "remove")
required
Whether to add or remove the blocked-by relationship.
integer
required
Number of the issue being blocked.
integer
required
Global database ID of the blocking issue, not its repository issue number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_MANAGE_SECRETS_IN_SELECTED_REPOSITORIESLists a page of repositories explicitly selected to access a GitHub Actions organization secret. The secret’s visibility must be set to ‘selected’; organization admin access and appropriate authorization are required.

Input Parameters

string
required
The name of the GitHub organization. This name is not case-sensitive.
integer
Page number of the results to fetch. Default is 1. See ‘Using pagination in the REST API’ for more details.
integer
Number of results to return per page (maximum 100). Default is 30. See ‘Using pagination in the REST API’ for more details.
string
required
The name of the organization secret for which to list accessible repositories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_MAP_A_COMMIT_AUTHORUpdates Git author information (name and/or email) for an author_id obtained during a repository import, to correctly attribute commits. NOTE: This endpoint has been deprecated by GitHub as of April 12, 2024, and is no longer available. The Source Imports REST API has been retired due to very low usage levels. Please use the GitHub Importer tool at https://github.com/new/import for repository imports.

Input Parameters

string
New Git author name for the author_id. At least one of email or name must be provided.
string
required
Name of the repository, without the .git extension (not case-sensitive).
string
New Git author email for the author_id. At least one of email or name must be provided.
string
required
Username of the account owning the repository (not case-sensitive).
integer
required
Numeric ID of the author to map, identified during a repository import; this ID is specific to the import process.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_MARK_A_THREAD_AS_DONEMarks the GitHub notification thread (identified by thread_id) as done or read for the authenticated user, effectively archiving it.

Input Parameters

integer
required
ID of the notification thread to mark as done. Typically obtained from the id field in notification list operations (e.g., GET /notifications).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_MARK_A_THREAD_AS_READMarks an existing GitHub notification thread, identified by its thread_id, as read.

Input Parameters

integer
required
The unique identifier of the notification thread. This ID is obtained from a notification’s id field, for example, via the ‘List notifications for the authenticated user’ endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_MARK_NOTIFICATIONS_AS_READMarks notifications as read or unread, optionally for those updated at or before a last_read_at timestamp.

Input Parameters

boolean
Indicates whether to mark targeted notifications as read (true) or unread (false). Defaults to true (mark as read) if not provided.
string
If provided, only notifications updated at or before this timestamp are affected. If omitted, all current notifications are targeted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_MARK_PULL_REQUEST_READY_FOR_REVIEWMarks a draft pull request as ready for review using GitHub GraphQL API, transitioning it from draft to reviewable state. Use this action when a draft pull request has reached a stage where it is ready for team review and can potentially be merged. This action cannot be used on pull requests that are already marked as ready for review.

Input Parameters

string
required
The global Node ID of the pull request to mark as ready for review (e.g., ‘PR_kwDOABCDEFGHIJK’). This is the GraphQL ID, not the numeric pull request number. You can obtain this ID from the ‘node_id’ field when listing or getting pull requests.
string
A unique identifier for the client performing the mutation. Used to ensure idempotency of mutations and track the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_MARK_REPOSITORY_NOTIFICATIONS_AS_READMarks notifications in a repository as read; if ‘last_read_at’ is specified, notifications updated after this timestamp are not marked as read.

Input Parameters

string
required
Name of the repository, without the .git extension (case-insensitive).
string
required
Username of the account owning the repository (case-insensitive).
string
Timestamp (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ). If provided, notifications updated after this time will NOT be marked as read. If omitted, all notifications in the repository are marked as read. Defaults to the current time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_MERGE_A_BRANCHMerges a head branch or commit SHA into a base branch in a repository; fails if there are merge conflicts requiring manual resolution.

Input Parameters

string
required
The name of the branch to merge the head branch into.
string
required
Source branch name or full commit SHA to merge into the base branch.
string
required
Repository name, without the .git extension. Not case-sensitive.
string
required
Username or organization name of the repository owner. Not case-sensitive.
string
Commit message for the merge. If omitted, GitHub uses a default message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_MERGE_A_PULL_REQUESTMerges an open and mergeable pull request in a repository. A 405 error can occur for multiple reasons: (1) The PR is still in draft mode - convert it to ready-for-review first using GITHUB_UPDATE_A_PULL_REQUEST. (2) Branch protection rules are not satisfied - check for required approving reviews, status checks, or other repository rules that must be met before merging. (3) The base branch has been modified since the PR was last synced - update the PR branch first using GITHUB_UPDATE_A_PULL_REQUEST_BRANCH.

Input Parameters

string
SHA of the pull request’s head commit. Must match for merge to succeed, ensuring PR hasn’t changed since review.
string
required
Repository name, without the .git extension. Not case-sensitive.
string
required
Repository owner’s username. Not case-sensitive.
integer
required
The unique number identifying the pull request. The PR must be mergeable: not a draft, and all branch protection rules (required reviews, status checks, etc.) must be satisfied.
string
Title for the merge commit message.
string ("merge" | "squash" | "rebase")
Merge strategy: ‘merge’, ‘squash’, or ‘rebase’. Defaults to repository’s setting if unspecified.
string
Additional details for the merge commit message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_MOVE_A_PROJECT_CARDMoves a project card to a specified position within a column (GitHub Classic Projects). DEPRECATION NOTICE: GitHub Projects (classic) and its REST API were sunset on April 1, 2025. This action will return 404 for most requests on GitHub.com. It may still work on GitHub Enterprise Server instances where classic projects remain enabled. For new projects, use GitHub Projects V2 which uses the GraphQL API instead. See: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ On success, the API returns HTTP 201 with an empty body, indicating the card was moved.

Input Parameters

integer
required
The unique identifier of the project card to be moved. Obtain this ID from the list_project_cards or get_a_project_card actions.
string
required
The target position of the card within the column. Must be one of: ‘top’ (place card at top of column), ‘bottom’ (place card at bottom of column), or ‘after:<card_id>’ (place card immediately after the specified card). When using ‘after:<card_id>’, the referenced card must exist in the target column.
integer
The unique identifier of the column to move the card to. If omitted, the card stays in its current column but moves to the specified position.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_MOVE_A_PROJECT_COLUMNMoves a column within a GitHub Classic Project to the first or last position, or after a specified column. DEPRECATED: The Classic Projects REST API has been sunset and this action no longer works on GitHub.com. Use GitHub Projects V2 with the GraphQL API for new projects.

Input Parameters

string
required
The new position for the column within the project. Valid values are: ‘first’ (move to the beginning), ‘last’ (move to the end), or ‘after:<column_id>’ (place after the specified column, e.g., ‘after:67890’).
integer
required
The unique identifier of the project column to be moved. Must be a valid column ID from a GitHub project (classic).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_PING_AN_ORGANIZATION_WEBHOOKSends a ping event to a specified existing organization webhook to test its configuration. A successful request queues the event; it does not confirm delivery.

Input Parameters

string
required
The name of the organization. This field is not case-sensitive.
integer
required
The unique identifier of the webhook. This ID can be found in the X-GitHub-Hook-ID header of a webhook delivery.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_PING_A_REPOSITORY_WEBHOOKPings an existing webhook on a repository to test its configuration and reachability by GitHub.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_PRIVATELY_REPORT_A_SECURITY_VULNERABILITYPrivately reports a security vulnerability to a repository’s maintainers. IMPORTANT: You cannot report vulnerabilities to repositories you own - this API is for third-party security researchers to report to other repositories. The target repository must have private vulnerability reporting enabled. Specify EITHER severity OR cvss_vector_string, but not both.

Input Parameters

string
required
The name of the repository without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.
array
A list of Common Weakness Enumeration (CWE) identifiers relevant to the vulnerability.
string
required
A short, descriptive summary of the security vulnerability.
string ("critical" | "high" | "medium" | "low")
The advisory’s severity level. Mutually exclusive with cvss_vector_string.
string
required
A detailed explanation of the security vulnerability, its impact, and potential mitigations.
string
JSON string representing a list of vulnerability objects detailing the affected packages or products. Each object should specify the package’s ecosystem and name, the vulnerable version range, and optionally, patched versions and vulnerable functions.
string
The CVSS vector string for advisory severity. Mutually exclusive with severity.
boolean
Whether to create a temporary private fork to collaborate on a fix for the reported vulnerability.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_PUBLISH_SPONSORS_TIER_GRAPH_QLTool to publish a draft GitHub Sponsors tier using GraphQL. Use when you need to make a draft sponsors tier visible to potential sponsors. The tier must already exist in draft status.

Input Parameters

string
required
The global Relay ID of the draft sponsors tier to publish. Must be a tier that is currently in draft status.
string
A unique identifier for the client performing the mutation. Used to track requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REDELIVER_A_DELIVERY_FOR_AN_ORGANIZATION_WEBHOOKRedelivers a specific webhook delivery for a webhook within an organization, to resend an event that previously failed or was not processed.

Input Parameters

string
required
The name of the organization. This name is not case-sensitive.
integer
required
The unique identifier of the webhook. This ID can be found in the X-GitHub-Hook-ID header of a webhook delivery or by listing webhooks for an organization.
integer
required
The unique identifier of the specific webhook delivery to be redelivered. This ID is typically obtained from the X-GitHub-Delivery header of the original delivery attempt or by listing deliveries for a webhook.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REDELIVER_A_DELIVERY_FOR_A_REPOSITORY_WEBHOOKRedelivers a specific, previously made webhook delivery (delivery_id) for a repository’s webhook (hook_id).

Input Parameters

string
required
The repository name, without the .git extension (not case-sensitive).
string
required
The account username that owns the repository (not case-sensitive).
integer
required
Unique identifier of the webhook (e.g., from X-GitHub-Hook-ID header or by listing repository webhooks).
integer
required
Unique identifier of a specific past delivery for the webhook (obtainable by listing deliveries for that webhook).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_A_CUSTOM_PROPERTY_FOR_AN_ORGANIZATIONDeletes a custom property, specified by custom_property_name, from an existing organization (org) for which the property is currently defined, preventing its future assignment to repositories.

Input Parameters

string
required
The name of the organization. This name is not case sensitive.
string
required
The name of the custom property to remove. This name is case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_A_LABEL_FROM_AN_ISSUERemoves a label currently applied to a specific issue in a repository.

Input Parameters

string
required
The name of the label to remove from the issue. Emoji reactions will not be removed and names with spaces or special characters must be URL-encoded.
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The number that identifies the issue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_ALL_LABELS_FROM_AN_ISSUERemoves all labels from a specified issue in a GitHub repository; this operation is idempotent.

Input Parameters

string
required
The name of the repository, without the ‘.git’ extension. This field is not case-sensitive.
string
required
The username of the account that owns the repository. This field is not case-sensitive.
integer
required
The unique number that identifies the issue from which all labels will be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_ALL_ORGANIZATION_ROLES_FOR_A_TEAMRevokes all organization roles for a team in an organization; this is destructive and succeeds even if the team initially has no roles.

Input Parameters

string
required
The name of the organization. This field is not case-sensitive.
string
required
The slug of the team name. Team slugs are typically all lowercase and replace spaces with hyphens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_ALL_ORGANIZATION_ROLES_FOR_A_USERRevokes all assigned organization-level roles from a specified user (who must be a member of the organization) within a GitHub organization, without removing the user from the organization or affecting repository-specific roles.

Input Parameters

string
required
The organization name. This name is not case sensitive.
string
required
The handle for the GitHub user account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_AN_ORGANIZATION_MEMBERRemoves a member from a GitHub organization. This action permanently removes a user’s membership from the specified organization, revoking their access to all organization resources, repositories, and teams. Requirements: - The authenticated user must be an organization owner - The target user must currently be a member of the organization Note: This action cannot be used to remove the last owner of an organization.

Input Parameters

string
required
The organization name (case-insensitive). Must be an organization where the authenticated user has owner permissions.
string
required
The GitHub username of the member to remove. The user must currently be a member of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_AN_ORGANIZATION_ROLE_FROM_A_TEAMRevokes an organization role that a team currently possesses within an organization.

Input Parameters

string
required
The name of the organization. This value is not case sensitive.
integer
required
The unique identifier of the organization role to be removed from the team.
string
required
The slug (short name) of the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_AN_ORGANIZATION_ROLE_FROM_A_USERRemoves a custom organization role from a user within a GitHub organization, provided the organization exists, the user is a member, and the role_id corresponds to a valid custom role in that organization.

Input Parameters

string
required
The GitHub organization’s name (not case-sensitive).
integer
required
Unique ID of the organization role to be removed. Use the ‘Get all organization roles’ action to retrieve valid role IDs.
string
required
GitHub username of the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_APP_ACCESS_RESTRICTIONSRemoves all GitHub App access restrictions from a protected branch without altering user or team restrictions. A 404 is returned as an empty app list with an explanatory message rather than an exception.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username of the account that owns the repository. This field is not case-sensitive.
string
required
The name of the branch from which all app access restrictions will be removed. Wildcard characters are not supported; for branches with wildcards, please use the GraphQL API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_A_PROJECT_FROM_A_TEAMRemoves a classic project from a team within an organization.

Input Parameters

string
required
The organization name. The name is not case sensitive.
string
required
The slug of the team name (URL-friendly version, e.g., ‘justice-league’).
integer
required
The unique identifier of the project to be removed from the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_A_REPOSITORY_COLLABORATORRemoves a collaborator from a specified GitHub repository, provided the repository exists and the user is an existing collaborator.

Input Parameters

string
required
The name of the repository, without the .git extension (not case-sensitive).
string
required
The account owner of the repository (not case-sensitive).
string
required
The GitHub username of the collaborator to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_A_REPOSITORY_FROM_AN_APP_INSTALLATIONRemoves a repository from a GitHub App installation for the authenticated user, given a valid installation_id and the repository_id of a repository currently linked to that installation; this operation is idempotent.

Input Parameters

integer
required
The unique identifier of the repository to be removed from the installation.
integer
required
The unique identifier of the GitHub App installation from which to remove the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_A_REPOSITORY_FROM_A_TEAMDisassociates a repository from a team; team members may lose access permissions, but the repository and team are not deleted.

Input Parameters

string
required
The name of the organization where the team and repository exist. This field is case-insensitive.
string
required
The name of the repository, without the ‘.git’ extension. This field is case-insensitive.
string
required
The username of the account that owns the repository. This field is case-insensitive.
string
required
The URL-friendly identifier (slug) for the team. Team slugs are typically all lowercase with hyphens instead of spaces (e.g., ‘justice-league’ for ‘Justice League’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_A_SELECTED_REPOSITORY_FROM_A_USER_SECRETRemoves a selected repository’s access to a user’s Codespaces secret; the secret must exist and the repository must have previously been granted access.

Input Parameters

string
required
Name of the user’s Codespaces secret from which repository access will be revoked.
integer
required
The unique integer identifier of the repository that will lose access to the specified Codespaces secret.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_ASSIGNEES_FROM_AN_ISSUERemoves specified assignees from a GitHub issue; requires push access, and invalid removal attempts are silently ignored.

Input Parameters

string
required
The name of the repository, excluding the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository (username or organization name). This name is not case-sensitive.
array
Usernames to unassign from the issue. Note: Requires push access to the repository; attempts to remove users without permission or those not currently assigned are silently ignored.
integer
required
The unique number that identifies the issue within the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_CUSTOM_LABEL_FROM_REPO_RUNNERRemoves a custom label from a repository’s self-hosted runner; this operation is idempotent.

Input Parameters

string
required
Name of the custom label to remove from the self-hosted runner. Note: only custom labels can be removed; read-only system labels (like ‘self-hosted’, ‘linux’, ‘x64’) cannot be removed.
string
required
Repository name, without the .git extension (case-insensitive).
string
required
Account owner of the repository (case-insensitive).
integer
required
Unique identifier of the self-hosted runner. Get this from listing runners for the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_CUSTOM_LABEL_FROM_SELF_HOSTED_RUNNERRemoves a currently assigned custom label (name) from a self-hosted runner (runner_id) in an organization (org). This action allows the organization to manage the labels associated with their runners effectively.

Input Parameters

string
required
The name of the organization. This name is not case-sensitive.
string
required
The name of the custom label to remove from the self-hosted runner.
integer
required
Unique identifier of the self-hosted runner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_CUSTOM_LABELS_FROM_SELF_HOSTED_REPO_RUNNERRemoves all custom labels from a self-hosted runner registered at the repository level, leaving only its default labels and any labels inherited from its runner group or organization.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.
integer
required
Unique identifier (ID) of the self-hosted runner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_INTERACTION_RESTRICTIONS_FOR_AN_ORGANIZATIONRemoves all interaction restrictions from public repositories in the specified GitHub organization, allowing all users to resume interactions.

Input Parameters

string
required
The name of the GitHub organization. This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_INTERACTION_RESTRICTIONS_FOR_A_REPOSITORYRemoves all interaction restrictions for a repository, enabling all users to comment, open issues, and create pull requests by lifting any existing temporary interaction limits.

Input Parameters

string
required
Repository name, without the .git extension; case-insensitive.
string
required
Username or organization name of the repository owner; case-insensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_ORG_DEV_ENV_SECRET_BY_NAMEDeletes a named GitHub Codespaces secret from an organization. A not-found response is treated as success, so success does not necessarily confirm that a secret was deleted.

Input Parameters

string
required
Name of the GitHub organization (case-insensitive).
string
required
Name of the Codespaces secret to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_ORG_SECRET_BY_NAMEPermanently removes a specific Dependabot secret, by its secret_name, from the GitHub org, making it unavailable to Dependabot for that organization.

Input Parameters

string
required
GitHub organization name (case-insensitive).
string
required
Dependabot secret name to remove from the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_OUTSIDE_COLLABORATOR_FROM_AN_ORGANIZATIONRemoves a user, who must be an outside collaborator, from the specified GitHub organization, revoking their access to all its repositories.

Input Parameters

string
required
The name of the GitHub organization. This name is not case-sensitive.
string
required
The GitHub username of the outside collaborator to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_PUBLIC_ORG_MEMBERSHIPRemoves the authenticated user’s public organization membership, making it private. The user remains a member of the organization but their membership is no longer publicly visible. This operation is idempotent - calling it when the membership is already private will succeed.

Input Parameters

string
required
Name of the GitHub organization (case-insensitive). The authenticated user must be a member of this organization.
string
required
GitHub username of the authenticated user. Must match the currently authenticated user - you can only modify your own public membership status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_PUBLIC_REPO_INTERACTION_RESTRICTIONSRemoves all interaction restrictions (limitations on comments, issues, or pull requests) from all public repositories owned by the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_REPO_FROM_ORG_DEV_ENV_SECRETRemoves a repository’s access to an organization-level Codespaces secret, if it was previously granted.

Input Parameters

string
required
The GitHub organization name (not case-sensitive).
string
required
The Codespaces secret name.
integer
required
The unique identifier of the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_REPO_FROM_ORG_SECRET_WITH_SELECTED_VISIBILITYRevokes a specific repository’s access to an organization-level Dependabot secret, applicable only when the secret has ‘selected’ visibility and the specified repository currently has access.

Input Parameters

string
required
Name of the organization (not case-sensitive).
string
required
Name of the Dependabot secret.
integer
required
Unique numeric ID of the repository (not the repository name).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_REQUESTED_REVIEWERS_FROM_A_PULL_REQUESTRemoves currently assigned user logins and/or team slugs from a GitHub pull request’s list of requested reviewers.

Input Parameters

string
required
Repository name, without the .git extension (not case-sensitive).
string
required
Username of the repository owner (not case-sensitive).
array
required
GitHub user logins for removal. At least one of reviewers or team_reviewers must be specified.
integer
required
Number of the pull request.
array
GitHub team slugs (URL-friendly names) for removal. At least one of reviewers or team_reviewers must be specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_REVIEW_REQUESTRemoves requested reviewers from a pull request. Use this action when you need to cancel a review request that was previously sent to users or teams. Only users with push access to the repository can remove review requests.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
array
required
An array of user logins that will be removed from the review request.
integer
required
The number that identifies the pull request.
array
An array of team slugs that will be removed from the review request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_SELECTED_REPO_FROM_ORG_SECRETRemoves a specific repository’s access to an organization-level secret; the repository must have been previously granted access to this secret.

Input Parameters

string
required
Organization name (case-insensitive).
string
required
Name of the organization secret.
integer
required
Repository ID to remove from the secret’s access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_SELECTED_REPO_FROM_ORG_VARIABLERemoves a repository’s access to an organization variable that has ‘selected’ visibility. This endpoint removes a specific repository from an organization variable’s access list. The variable must have its visibility set to ‘selected’ for this operation to work. Returns a 409 Conflict error if the variable visibility is not ‘selected’.

Input Parameters

string
required
The organization’s name (case-insensitive).
string
required
Name of the organization variable.
integer
required
Unique identifier of the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_STATUS_CHECK_CONTEXTSRemoves specified status check contexts from a protected branch’s required status checks. This action removes the specified status check contexts from the existing list of required status checks for a protected branch. The branch must already have branch protection enabled with status checks configured. Note: The ‘contexts’ parameter is deprecated by GitHub in favor of ‘checks’ array. For new implementations, consider using update_status_check_protection with the ‘checks’ parameter instead.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository. This name is not case sensitive.
string
required
The name of the branch. Wildcard characters are not allowed. To use wildcard characters in branch names, refer to the GraphQL API documentation.
array
required
The status check contexts to remove from the protected branch. These are the names of CI/CD jobs or other checks that should no longer be required before merging. Can be provided as a single string or a list of strings. Examples: ‘ci/test’, ‘linter’, ‘continuous-integration/travis-ci’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_STATUS_CHECK_PROTECTIONRemoves status check protection from a branch, disabling required status checks for merging pull requests; will only have an effect if status check protection is currently configured on the branch.

Input Parameters

string
required
Name of the repository, without the .git extension; not case-sensitive.
string
required
Account owner (username or organization) of the repository; not case-sensitive.
string
required
Name of the branch; wildcard characters are not allowed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_TEAM_ACCESS_RESTRICTIONSRemoves specified teams from push access to a protected branch. This action removes teams from the list of teams with push access to a protected branch. Removing a team will also remove push access for any child teams. Prerequisites: - The repository must be owned by an organization (not a personal account) - The branch must have protection rules enabled - The branch protection must have restrictions configured - The teams must currently have push access to the branch

Input Parameters

string
required
The name of the repository, without the .git extension. This value is not case-sensitive.
string
required
The organization name that owns the repository. Team access restrictions only work for organization-owned repositories, not personal repositories. This value is not case-sensitive.
array
required
The list of team slugs to remove from push access to the protected branch. A team slug is the URL-friendly version of the team name (lowercase, hyphens instead of spaces). Removing a team will also remove push access for any child teams. This removes teams from the existing list (does not replace the entire list).
string
required
The name of the protected branch to remove team restrictions from. The branch must already have branch protection enabled with restrictions configured. Wildcard characters are not supported. For wildcard branch protection, use the GitHub GraphQL API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_TEAM_MEMBERSHIPTool to remove team membership for a user in an organization. Use when you need to revoke a user’s membership from a specific team. This action is irreversible — the user must be explicitly re-added if you want to restore their team membership. Note that if team synchronization is set up, this operation may fail with a 403 Forbidden error.

Input Parameters

string
required
The organization name. The name is not case sensitive.
string
required
The handle for the GitHub user account.
string
required
The slug of the team name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_TEAM_MEMBERSHIP_FOR_A_USERRemoves a user from a specific team within an organization. This action requires admin:org scope permissions. It will fail if: - Team synchronization with an Identity Provider (IdP) is enabled (403 Forbidden) - The organization, team, or user membership doesn’t exist (404 Not Found) - You don’t have sufficient permissions to manage team memberships (403 Forbidden) Note: If the removed user was the last member and the team is not nested, the team may be deleted automatically.

Input Parameters

string
required
The name of the GitHub organization that owns the team. Not case-sensitive.
string
required
The GitHub username of the user to remove from the team. Must be an exact match of the user’s login handle.
string
required
The URL-friendly identifier (slug) of the team. This is the hyphenated, lowercase version of the team name as it appears in the team’s URL (e.g., ‘justice-league’ for a team named ‘Justice League’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_USER_ACCESS_RESTRICTIONSRemoves specified users from the list of people allowed to push to a protected branch. Important notes: - This action only works on organization-owned repositories (not personal repos) - The branch must have protection rules with push restrictions enabled - Users being removed must currently have push access to the branch - The combined total of users, apps, and teams is limited to 100 items

Input Parameters

string
required
The name of the repository, without the .git extension. Not case-sensitive.
string
required
The account owner of the repository. Must be an organization name (user access restrictions only work on organization repositories). Not case-sensitive.
array
required
The list of user logins to remove from push access to the protected branch. These users will no longer be able to push directly to this branch. The combined total of users, apps, and teams with restrictions is limited to 100 items.
string
required
The name of the branch from which to remove user access restrictions. Wildcard characters (e.g., ’*’) are not allowed. Use the GitHub GraphQL API for wildcard branch patterns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_USER_AS_A_COLLABORATORRemoves a user as a collaborator from an organization project (classic); a success result can also indicate that the user was already absent. The Projects (classic) REST API is sunset on GitHub.com and may still work on GitHub Enterprise Server versions before 3.17.

Input Parameters

string
required
The GitHub username of the user to remove as a collaborator from the organization project (classic).
integer
required
The unique database identifier of the organization project (classic). This is a numeric ID returned when listing or creating classic projects, not the project number visible in URLs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REMOVE_USERS_CODESPACES_ACCESS_ORGRemoves selected users from GitHub Codespaces billing access for an existing organization.

Input Parameters

string
required
The name of the GitHub organization. This field is not case-sensitive.
array
required
A list of GitHub usernames, typically organization members. After removal, the organization will no longer be billed for Codespaces created by these users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_RENAME_A_BRANCHRenames an existing branch in a GitHub repository; the new name must be unique and adhere to GitHub’s naming conventions, and the current branch name cannot contain wildcard characters.

Input Parameters

string
required
The name of the repository, without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
string
required
The current name of the branch. Wildcard characters (e.g., *) are not allowed.
string
required
The new name for the branch. Must be unique and adhere to GitHub’s branch naming conventions (e.g., no spaces, ’..’, or leading/trailing slashes).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_RENDER_A_MARKDOWN_DOCUMENTRenders Markdown to HTML; for ‘gfm’ mode, provide ‘context’ (owner/repo) to correctly link issues, pull requests, and user mentions.

Input Parameters

string ("markdown" | "gfm")
Rendering mode: ‘markdown’ for standard Markdown or ‘gfm’ for GitHub Flavored Markdown.
string
required
The Markdown string to convert to HTML.
string
The repository context (e.g., ‘owner/repo’) used when mode is ‘gfm’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_RENDER_MARKDOWN_RAWTool to render raw Markdown text to HTML using GitHub’s markdown API. Use when you need to convert plain Markdown content to HTML without GitHub-specific features like issue references or @mentions.

Input Parameters

string
required
The raw Markdown text to render as HTML. This can include any valid Markdown syntax like headers, lists, links, bold/italic text, code blocks, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REOPEN_ISSUEReopens a closed GitHub issue by changing its state to ‘open’ with state_reason ‘reopened’. Use this action when you need to reopen a previously closed issue that requires further attention or work. Only users with push access to the repository can reopen issues.

Input Parameters

string
required
The name of the repository without the .git extension (case-insensitive).
string
required
The account owner of the repository (case-insensitive).
integer
required
The number that identifies the issue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REOPEN_PULL_REQUESTReopens a previously closed pull request by setting its state to ‘open’. This restores the pull request to an active state where it can be reviewed, commented on, and merged. Use this action when you need to reactivate a closed pull request that was closed prematurely or needs to be reconsidered for merging.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The number that identifies the pull request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REPLACE_ALL_REPOSITORY_TOPICSReplaces all topics of a repository.

Input Parameters

string
required
The name of the repository, without the .git extension. This is case-insensitive.
array
required
A list of topic names to replace the current set of topics for the repository. Provide one or more topics to set them. To remove all topics, pass an empty list ([]). Note: Topic names cannot contain uppercase letters and are limited to 25 characters.
string
required
The username of the account that owns the repository. This is case-insensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REPLACE_ORG_SECRET_VISIBILITY_TO_SELECTEDReplaces the list of repositories that can access a Dependabot organization secret when the secret’s visibility is already set to ‘selected’.

Input Parameters

string
required
The name of the organization. This parameter is not case-sensitive.
string
required
Name of the Dependabot secret (alphanumeric characters and underscores only, no spaces allowed).
array
required
Array of repository IDs that can access this organization Dependabot secret. This list completely replaces any current repository associations. For incremental changes (add/remove individual repos), use dedicated add/remove repository secret actions instead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REPLACE_REPO_ACCESS_ON_ORG_DEV_ENV_SECRET_SETReplaces the list of repositories that can access an organization-level Codespaces secret. This operation completely replaces the existing list of repositories with the provided list. The secret must already have its visibility set to ‘selected’ for this operation to succeed. Use this when you want to set an exact list of repositories that should have access. Prerequisites: - The organization must exist and you must have admin:org scope - The Codespaces secret must already exist in the organization - The secret’s visibility must be set to ‘selected’ (not ‘all’ or ‘private’) Returns HTTP 204 No Content on success, 404 if secret/org not found, 409 if visibility is not ‘selected’.

Input Parameters

string
required
The GitHub organization name (case-insensitive).
string
required
Name of the development environment secret for which repository access is being configured.
array
required
Array of repository IDs that can access the organization Codespaces secret. This completely replaces any existing list of repositories. Note: The secret’s visibility must already be set to ‘selected’ (not ‘all’ or ‘private’) for this operation to succeed; otherwise, a 409 Conflict error is returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REQUEST_A_GITHUB_PAGES_BUILDManually triggers a GitHub Pages build for a repository if GitHub Pages is enabled, useful for deployments not automatically built or for retrying failed builds.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REQUEST_REVIEWERSRequests reviewers for a specific pull request identified by owner, repository, and pull request number. Use this action when you need to add individual users or teams as reviewers to an existing pull request. At least one of reviewers (individual users) or team_reviewers (teams) must be provided.

Input Parameters

string
required
Name of the repository, without the .git extension. Not case sensitive.
string
required
Account owner of the repository (username or organization name). Not case sensitive.
array
GitHub user login strings (usernames) to request reviews from. At least one of reviewers or team_reviewers must be provided.
integer
required
Number identifying the pull request.
array
GitHub team slug strings (e.g., ‘justice-league’) to request reviews from. Slugs are typically lowercase and use hyphens for spaces. At least one of reviewers or team_reviewers must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REQUEST_REVIEWERS_FOR_A_PULL_REQUESTAdds reviewers to a specific pull request identified by owner, repo, and pull_number. This is NOT a search action - it operates on an already-known PR number. Requires owner, repo, pull_number, and at least one of reviewers or team_reviewers.

Input Parameters

string
required
Name of the repository, without the .git extension; not case sensitive.
string
required
Account owner of the repository (username or organization name); not case sensitive.
array
GitHub user login strings (usernames) to request reviews from. At least one of reviewers or team_reviewers must be provided.
integer
required
Number identifying the pull request.
array
GitHub team slug strings (e.g., ‘justice-league’) to request reviews from. Slugs are typically lowercase and use hyphens for spaces. At least one of reviewers or team_reviewers must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REREQUEST_A_CHECK_RUNTriggers a re-run of a specific check run in a GitHub repository, resetting its status to ‘queued’, clearing its conclusion, and triggering the check_run webhook with rerequested action. IMPORTANT: This endpoint requires GitHub App authentication with ‘checks:write’ permission. The check run can ONLY be re-requested by the same GitHub App that originally created it. OAuth tokens and personal access tokens (PAT) cannot use this endpoint.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is case-insensitive.
string
required
The account owner of the repository (username or organization name). This field is case-insensitive.
integer
required
The unique numerical identifier of the check run to be re-requested. Must be a check run created by the same GitHub App making the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REREQUEST_A_CHECK_SUITETriggers a new run of an existing check suite within a repository, resetting its status to ‘queued’, clearing its conclusion, and triggering the check_suite webhook with rerequested action. IMPORTANT: This endpoint requires GitHub App authentication with ‘checks:write’ permission. OAuth tokens and classic personal access tokens (PAT) cannot use this endpoint. Only GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens with checks:write permission are supported.

Input Parameters

string
required
The name of the repository without the .git extension. This field is case-insensitive.
string
required
The account owner of the repository (username or organization name). This field is case-insensitive.
integer
required
The unique numerical identifier of the check suite to be re-requested. You can obtain this from the list_check_suites_for_a_git_reference endpoint or from a workflow run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_RE_RUN_A_JOB_FROM_A_WORKFLOW_RUNRe-runs a specific job and any dependent jobs from a GitHub Actions workflow run in the specified repository, optionally enabling debug logging.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository (e.g., a GitHub username or organization name). This name is not case sensitive.
integer
required
The unique numerical identifier of the job to be re-run. This ID can be obtained by listing jobs for a workflow run.
boolean
If true, enables additional debug logging for the re-run of the job. Defaults to false if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_RE_RUN_A_WORKFLOWRe-runs a specific GitHub Actions workflow run identified by its owner, repository, and run ID, optionally enabling debug logging.

Input Parameters

string
required
Name of the repository (without the .git extension) where the workflow run exists (not case-sensitive).
string
required
Account owner of the repository where the workflow run exists (not case-sensitive).
integer
required
Unique ID of the workflow run to re-execute.
boolean
Set to true to enable diagnostic logging for the re-run, helpful for troubleshooting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_RE_RUN_FAILED_JOBS_FROM_A_WORKFLOW_RUNRe-runs all failed jobs and their dependent jobs from a specified workflow run if the run contains previously failed jobs.

Input Parameters

string
required
The name of the repository, without the .git extension; not case-sensitive.
string
required
The account owner of the repository (username or organization name); not case-sensitive.
integer
required
The unique identifier of the workflow run.
boolean
Set to true to enable extensive debug logging for the re-run, providing additional logs to aid in diagnosing issues.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_RESET_A_TOKENInvalidates the provided OAuth access_token and generates a new one for the GitHub OAuth App identified by client_id. Used for token rotation when a token may be compromised or for regular security maintenance. Note: This endpoint requires the OAuth App owner’s credentials (client_id/client_secret for Basic Auth).

Input Parameters

string
required
The client ID of the GitHub OAuth App.
string
required
The existing OAuth access token that needs to be reset. This token will be invalidated and replaced by a new one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_RESTORE_A_PACKAGE_FOR_AN_ORGANIZATIONRestores a package in an organization, provided it was deleted within the last 30 days.

Input Parameters

string
required
Name of the GitHub organization that owns the package (case-insensitive).
string
Optional token for restoring private packages or specific versions requiring special permissions.
string
required
Unique name of the package to be restored.
string ("npm" | "maven" | "rubygems" | "docker" | "nuget" | "container")
required
Type of the package. Gradle packages use maven. Docker images in ghcr.io use container; docker finds images from docker.pkg.github.com, even if migrated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_RESTORE_A_PACKAGE_FOR_A_USERRestores a user-owned package previously deleted from GitHub Packages, if restorable under GitHub’s data retention policy (typically within 30 days of deletion).

Input Parameters

string
Optional package version token. Only required when restoring packages with versions that have more than 50,000 downloads.
string
required
The GitHub username of the account that owns the deleted package.
string
required
The unique name of the deleted package to restore.
string
required
The type of GitHub package registry. Supported values: npm, maven, rubygems, docker, nuget, container. Use maven for Gradle packages. docker can be used for images migrated from docker.pkg.github.com to the Container registry (ghcr.io), while container is for images originally pushed to ghcr.io.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_RESTORE_A_PACKAGE_FOR_THE_AUTHENTICATED_USERRestores a package deleted by the authenticated user within the last 30 days, if its namespace and version are still available.

Input Parameters

string
Optional token to identify a specific package version to restore, useful if multiple versions were deleted. If omitted, the most recently deleted version is typically restored.
string
required
The unique name of the package to be restored within its namespace and type.
string
required
The type of the package to be restored, specifying its ecosystem. For example, npm for Node.js packages, maven for Java packages. Special cases: packages in GitHub’s Gradle registry use the type maven. Docker images pushed to GitHub’s Container registry (ghcr.io) use the type container. The docker type can be used to find images originally pushed to GitHub’s Docker registry (docker.pkg.github.com), even if they have been migrated to the Container registry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_RESTORE_A_PACKAGE_VERSION_FOR_THE_AUTHENTICATED_USERRestores a package version that was deleted by the authenticated user within the last 30 days.

Input Parameters

string
required
Name of the package.
string ("npm" | "maven" | "rubygems" | "docker" | "nuget" | "container")
required
Specifies the package type. Use maven for GitHub’s Gradle registry. Use container for images in GitHub’s Container registry (ghcr.io). docker can be used for images previously in GitHub’s Docker registry (docker.pkg.github.com), even if migrated.
integer
required
Unique ID of the package version to restore.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_RESTORE_PACKAGE_VERSION_FOR_AN_ORGANIZATIONRestores a package version for an organization, provided it was deleted within the last 30 days.

Input Parameters

string
required
Organization name (case-insensitive).
string
required
Unique name of the package.
string ("npm" | "maven" | "rubygems" | "docker" | "nuget" | "container")
required
The type of package. Supported types include “npm”, “maven”, “rubygems”, “docker”, “nuget”, and “container”. Packages in GitHub’s Gradle registry use the maven type. Docker images in GitHub’s Container registry (ghcr.io) use the container type. The docker type can be used for images previously in GitHub’s Docker registry (docker.pkg.github.com), even if migrated to the Container registry.
integer
required
Unique identifier of the package version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_RESTORE_PACKAGE_VERSION_FOR_A_USERRestores a specific, user-owned package version if it was deleted within the last 30 days and its original namespace and version name are still available.

Input Parameters

string
required
The GitHub username of the package owner.
string
required
The name of the package.
string
required
Specifies the package type. Packages in GitHub’s Gradle registry have the type maven. Docker images pushed to GitHub’s Container registry (ghcr.io) have the type container. Use docker for images from GitHub’s Docker registry (docker.pkg.github.com), even if migrated to the Container registry.
integer
required
The unique numeric identifier of the package version to be restored. Obtain this by first listing package versions using ‘list_package_versions_for_a_package_owned_by_a_user’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_RETIRE_SPONSORS_TIERTool to retire a published payment tier from your GitHub Sponsors profile using GraphQL. Use when you need to prevent a tier from being used for new sponsorships. Existing sponsors at this tier remain unaffected.

Input Parameters

string
required
The global node ID of the sponsors tier to retire (e.g., ‘ST_kwDOCNqc1s4ACOVb’). Once retired, this tier cannot be used to start new sponsorships, but existing sponsors at this tier are unaffected.
string
A unique identifier for the client performing the mutation. Used to ensure idempotency of mutations and track request origin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REVIEW_ACCESS_WITH_PERSONAL_TOKENApproves or denies a pending fine-grained personal access token request for organization resources; must be performed by a GitHub App.

Input Parameters

string
required
The name of the GitHub organization. This field is not case-sensitive.
string ("approve" | "deny")
required
The action to take on the personal access token request. Must be ‘approve’ to approve the request or ‘deny’ to deny it.
string
An optional comment explaining the reason for approving or denying the request. Maximum length is 1024 characters.
integer
required
The unique identifier of the pending fine-grained personal access token request that needs to be reviewed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REVIEW_DEPLOYMENT_PROTECTION_RULESApproves or rejects pending custom deployment protection rules for a workflow run. This endpoint allows GitHub Apps to review their own pending custom deployment protection rules for a specific workflow run. The review can either approve (allowing the deployment to proceed) or reject (blocking the deployment). Important notes: - GitHub Apps can only review their own custom deployment protection rules - This endpoint requires GitHub App installation access tokens with Deployments permission (write) - Custom deployment protection rules are available in public repos for all plans; for private/internal repos, GitHub Enterprise is required - Returns 204 No Content on success

Input Parameters

string
required
Repository name, without .git extension (case-insensitive).
string
required
Repository owner’s username or organization name (case-insensitive).
string ("approved" | "rejected")
required
The review decision: ‘approved’ to allow the deployment or ‘rejected’ to block it.
integer
required
Unique identifier of the workflow run.
string
Optional comment to include with the review decision.
string
required
The name of the deployment environment to review (e.g., ‘production’, ‘staging’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REVIEW_PENDING_DEPLOYMENTS_FOR_A_WORKFLOW_RUNApproves or rejects pending deployments for a specific workflow run that are in a ‘waiting’ state within specified, configured environments.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
string ("approved" | "rejected")
required
State to apply to the pending deployments.
integer
required
The unique identifier of the workflow run.
string
required
Comment to include with the review decision.
array
required
Environments targeted by the review; they must be configured for the repository and be part of the pending deployments for this run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REVIEW_RESOURCE_REQUESTS_WITH_FINE_GRAINED_TOKENSSubmits a bulk approval or denial of fine-grained personal access token requests for a GitHub organization. The returned success message indicates acceptance for processing, not confirmation that every request has been processed.

Input Parameters

string
required
The organization name where the token requests are pending. Case-insensitive.
string ("approve" | "deny")
required
The action to perform on the specified token requests. Use ‘approve’ to grant access or ‘deny’ to reject the requests.
string
Optional reason for the decision. Maximum 1024 characters. This reason is stored and may be visible to the requester.
array
required
List of unique identifiers for the fine-grained personal access token requests to review. Must contain between 1 and 100 request IDs. Get these IDs from the ‘List requests to access organization resources’ endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_REVOKE_AN_INSTALLATION_ACCESS_TOKENRevokes the GitHub App’s current installation access token, immediately invalidating it for API authentication. IMPORTANT: This endpoint requires a GitHub App installation access token (ghs_* prefix) for authentication. OAuth tokens (gho_*) or personal access tokens are not supported and will result in a 403 Forbidden error. After successful revocation, the token becomes permanently invalid and cannot be used for any subsequent API calls. To continue API operations, a new installation access token must be generated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_RUN_GRAPH_QL_QUERYTool to run an arbitrary GitHub GraphQL v4 query or mutation. Use when fetching multiple datasets in one batch. Cost-based rate limit: ~5,000 points/hour; keep field selections narrow, avoid deep nesting, and include rateLimit in responses to monitor quota. Responses are nested under data.data (e.g., data.data.repository.vulnerabilityAlerts); always inspect the errors array even on HTTP 200, as partial failures embed there. Paginate by looping on pageInfo.hasNextPage and advancing with pageInfo.endCursor. Search results cap at ~1,000 items per query; split by label, date range, or repository for full coverage. Use ProjectV2 nodes, not Classic Projects (deprecated). Parallel mutations (e.g., addProjectV2ItemById) can trigger transient conflicts; use sequential execution.

Input Parameters

string
required
GraphQL query or mutation string. Must comply with GitHub’s GraphQL v4 schema.
object
JSON object mapping variable names to values for use in the query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_RUN_GRAPH_QL_RELAY_QUERYRuns a supplied GitHub GraphQL query or mutation, including queries that access root fields through the relay context. The response may include GraphQL errors alongside data.

Input Parameters

string
required
GraphQL query string to execute within the relay context. Must comply with GitHub’s GraphQL v4 schema. The relay field re-exposes the root Query object, allowing you to nest any valid root query fields.
object
JSON object mapping variable names to values for use in the query. Optional - omit if the query has no variables.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SEARCH_CODESearches code file contents and paths on the default branch of GitHub repositories using a query string; searches only files under 384KB, returns max 1000 results by best match, and is optimized for precision.

Input Parameters

string
required
Code search query, including keywords and qualifiers (e.g., language:python, user:octocat, repo:owner/repo). For full syntax and qualifiers, see GitHub docs: Constructing a search query and code search qualifiers.
integer
Page number for results. For pagination details, see GitHub docs: Using pagination in the REST API.
string ("indexed" | "updated")
DEPRECATED. Valid: ‘indexed’ (sorts by last indexed time) or ‘updated’ (sorts by last updated time). If unspecified, results sorted by best match. Docs: ranking search results.
string ("desc" | "asc")
DEPRECATED. Order (‘asc’ or ‘desc’) for results; effective only if sort is specified. Docs: ranking search results.
integer
Results per page (max 100). For pagination details, see GitHub docs: Using pagination in the REST API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SEARCH_CODE_ALL_PAGESSearches GitHub code across multiple pages, optionally capped by a result limit; results may be partial, including because of GitHub’s approximately 1,000-result cap and default-branch indexing. Queries combining parentheses with AND, OR, or NOT are rejected by the tool.

Input Parameters

string
required
The search query string for code search. IMPORTANT: While GitHub’s documentation mentions boolean operators (AND, OR, NOT) support, the REST API still uses older syntax that frequently rejects queries with operators or parentheses (ERROR_TYPE_QUERY_PARSING_FATAL). For reliable searches, avoid boolean operators and parentheses. Supports qualifiers: language:, repo:, path:, extension:, user:, org:, in:file. Multiple terms use implicit AND: hello world finds both. Quote exact phrases: "exact phrase". For complex boolean logic, use multiple separate API calls or the GitHub web interface.
integer
Page number to start retrieval (min 1).
string
Sort field: only ‘indexed’ is valid (sort by last indexed time).
integer
Optional cap on total number of items to retrieve across pages (min 1).
string ("desc" | "asc")
Sort order for results: ‘asc’ or ‘desc’. Only effective when sort is provided.
string
Custom Accept header for media type (e.g., application/vnd.github.text-match+json to include text match metadata).
integer
Number of results per page (min 1, max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SEARCH_COMMITSFinds commits on GitHub using a query string (q) supporting keywords and qualifiers, with options for sorting and pagination.

Input Parameters

string
required
Search query with at least one text keyword plus optional qualifiers. GitHub requires actual search text (commit message keywords) - qualifiers alone are not allowed. Common qualifiers: ‘repo:owner/name’, ‘author:username’, ‘committer:username’, ‘author-date:YYYY-MM-DD’ or ‘author-date:>YYYY-MM-DD..YYYY-MM-DD’, ‘committer-date:YYYY-MM-DD’, ‘merge:true/false’, ‘hash:HASH’, ‘parent:HASH’, ‘tree:HASH’. IMPORTANT: The ‘hash:’ qualifier requires a full 40-character hexadecimal commit hash (e.g., ‘hash:e5bd3914e2e596debea16f433f57875b5b90bcd6’). Do NOT use branch names, tag names, or short refs with ‘hash:’ - use ‘repo:owner/name’ with other filters to search commits on a specific branch.
integer
Page number of results to retrieve.
string ("author-date" | "committer-date")
Sorts results by ‘author-date’ or ‘committer-date’. Use separately with the ‘order’ parameter (e.g., sort=‘committer-date’ with order=‘desc’). Do not combine them into a single value. If unspecified, GitHub defaults to ‘best match’ ranking.
string ("desc" | "asc")
Sort order: ‘desc’ (newest first) or ‘asc’ (oldest first). Use with the ‘sort’ parameter to control direction (e.g., sort=‘committer-date’ with order=‘desc’).
integer
Number of results per page (maximum 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SEARCH_COMMITS_BY_AUTHORSearches commits across GitHub repositories using keywords and qualifiers such as author, committer email, organization, or date range. Results can be sorted by author or committer date and returned in pages of up to 100 commits.

Input Parameters

string
required
GitHub search query for commits. IMPORTANT: Must include search text (keywords) in addition to qualifiers. Qualifier-only queries are not allowed by the GitHub API. Supports qualifiers like author:, committer-email:, org:, repo:, author-date:, committer-date:, merge:, hash:, parent:, tree:, is:public/private. Examples: ‘fix author:octocat’, ‘bug repo:owner/repo’, ‘update author:octocat author-date:>=2025-01-01’. If only qualifiers are provided, a wildcard search term will be automatically added.
integer
Page number of results to fetch.
string ("author-date" | "committer-date")
Sort options for commit search.
string ("asc" | "desc")
Order options for search results.
integer
Number of results per page (maximum 100).
string
Message about any automatic modifications made to the input

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SEARCH_GITHUB_GRAPHQLTool to perform GitHub GraphQL searches across issues, pull requests, repositories, users, and discussions. Returns up to 1,000 results with cursor-based pagination. Use when you need structured search results with specific fields.

Input Parameters

string ("ISSUE" | "REPOSITORY" | "USER" | "DISCUSSION")
required
The type of resource to search. Determines the structure of returned results.
string
Cursor string obtained from pageInfo.endCursor in a previous response. Returns results after this cursor for pagination.
integer
Number of results to return (1-100). Returns the first N elements from the result set. Use with ‘after’ parameter for pagination.
string
required
The search query string using GitHub search syntax. Supports qualifiers like ‘repo:’, ‘org:’, ‘user:’, ‘is:open’, ‘is:closed’, ‘label:’, etc. For issues/PRs, use ‘is:issue’ or ‘is:pr’. For repositories, search by name, description, or topics. Maximum 1,000 results can be retrieved across all pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SEARCH_ISSUESSearches GitHub issues and pull requests using keywords and qualifiers, with sorting and pagination. Results are limited to accessible repositories and may be incomplete or subject to GitHub search limits.

Input Parameters

string
required
Search query string for issues and pull requests. Supports qualifiers: repo:owner/repo, user:username, org:orgname, author:username, assignee:username, mentions:username, commenter:username, involves:username, label:labelname, milestone:title, state:open&#124;closed, type:pr&#124;issue, is:pr&#124;issue&#124;open&#124;closed&#124;merged&#124;unmerged&#124;locked&#124;unlocked&#124;draft, in:title&#124;body&#124;comments, created:YYYY-MM-DD, updated:YYYY-MM-DD, closed:YYYY-MM-DD, merged:YYYY-MM-DD, no:label&#124;milestone&#124;assignee, language:language, comments:n, reactions:n, interactions:n, project:number, archived:true&#124;false, reviewed-by:username. Use comparison operators (>, <, >=, <=, ..) with numeric/date qualifiers. Multiple terms use implicit AND; quote exact phrases. Example: ‘repo:owner/repo is:issue state:open label:bug’
integer
Page number to retrieve (min 1).
string ("comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated")
Sort options for issue search results.
string ("asc" | "desc")
Order options for search results.
integer
Number of results per page (min 1, max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SEARCH_ISSUES_AND_PULL_REQUESTSSearches GitHub for issues and pull requests using keywords and qualifiers, with sorting and pagination. Standalone issue or pull request type filters must be combined with another term; @me is resolved by GitHub.

Input Parameters

string
required
Search query using GitHub’s search syntax. Supports keywords, qualifiers (repo:, org:, user:, state:, label:, author:, assignee:, mentions:, etc.), and type filters (is:issue, is:pr). IMPORTANT: Type filters (is:issue, is:pr) cannot be used alone - they must be combined with at least one keyword or other qualifier. All other qualifiers work independently (e.g., ‘state:open’, ‘label:bug’, ‘assignee:octocat’). The @me shorthand (e.g., assignee:@me, mentions:@me, author:@me) can be used to reference the authenticated user. Logical operators (AND, OR, NOT) can be used to combine terms (maximum 5 operators total).
integer
Page number for results.
string ("comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated")
Field for sorting results. GitHub defaults to ‘best match’ if unspecified.
string ("desc" | "asc")
Order for sorted results (ascending/descending). Effective only if sort is also provided.
integer
Number of results per page.
string ("minimal" | "full")
Level of detail in the response. ‘minimal’ (default) returns an optimized response for AI agents. ‘full’ returns the complete GitHub API response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SEARCH_LABELSSearches for labels within a GitHub repository by keywords in their names or descriptions.

Input Parameters

string
required
The search keywords or query to find labels. This endpoint does not accept qualifiers in the query. For more details on query construction, refer to GitHub’s documentation on Constructing a search query.
integer
The page number of the results to retrieve, starting from 1. For more information, see “Using pagination in the REST API.”
string ("created" | "updated")
Specifies the field to sort the search results by. Valid options are ‘created’ or ‘updated’. If not provided, results are sorted by best match according to GitHub’s default ranking: best match.
string ("desc" | "asc")
Determines the sorting order of results, either ‘asc’ (ascending) or ‘desc’ (descending). This parameter is only effective when sort is also specified. Defaults to ‘desc’.
integer
The number of search results to return per page. The maximum value is 100. For more information, see “Using pagination in the REST API.”
integer
required
The unique identifier of the repository where labels will be searched.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SEARCH_REPOSITORIESSearches GitHub repositories using a flexible query (keywords, qualifiers) with sorting, ordering, and pagination. IMPORTANT: The ‘q’ parameter (search query) is REQUIRED and must always be provided.

Input Parameters

string
required
REQUIRED non-empty search query. Max 5 AND/OR/NOT operators. Qualifiers: language:LANG, stars:N, stars:>N, forks:N, size:N (KB), topic:TOPIC, license:LICENSE, created:DATE, pushed:DATE, is:public&#124;private, archived:true&#124;false, in:name&#124;description&#124;readme, user:USERNAME, org:ORGNAME. Must use real GitHub usernames/orgs (e.g., user:octocat), not placeholders. Queries with logical operators must include at least one plain keyword; topic:solana OR topic:ethereum fails, use solana OR ethereum stars:>100 instead.
integer
The page number for pagination of search results. Defaults to 1. Used in conjunction with per_page to fetch subsequent sets of results. See GitHub API documentation for more on pagination.
string ("stars" | "forks" | "help-wanted-issues" | "updated" | "created")
Specifies the field to sort the search results by. Options include stars, forks, help-wanted-issues, updated (recency of update), or created (creation date). If not provided, results are sorted by GitHub’s default ‘best match’ ranking.
string ("desc" | "asc")
Determines the order of search results: desc for descending or asc for ascending. This parameter is only effective when sort is also specified. Defaults to desc.
integer
The number of repository results to return per page. The maximum value is 100. Defaults to 30. See GitHub API documentation for more on pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SEARCH_TOPICSFinds topics on GitHub using keywords and qualifiers with GitHub’s search syntax, supporting pagination.

Input Parameters

string
required
Search query string. Supports keywords, qualifiers, and GitHub’s search syntax; see Constructing a search query.
integer
Page number of the results to retrieve for pagination.
integer
Number of topic results per page (maximum 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SEARCH_USERSSearches for users on GitHub by criteria like username, email, location, followers, or repository associations, using a flexible query string q.

Input Parameters

string
required
Search query string supporting keywords and qualifiers for user attributes (e.g., username, location, followers). See examples for syntax.
integer
Page number for results (1-indexed).
string ("followers" | "repositories" | "joined")
Field to sort results by. If not specified, GitHub’s ‘best match’ algorithm is used.
string ("desc" | "asc")
Sort order for results when sort is specified; ignored otherwise.
integer
Number of search results per page. Maximum 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_ADMIN_BRANCH_PROTECTIONEnables administrator enforcement on a branch, making existing protection rules also apply to administrators; branch protection rules must already be configured.

Input Parameters

string
required
Repository name, without the .git extension. Not case sensitive.
string
required
Account owner of the repository (user or organization name). Not case sensitive.
string
required
Branch name. Wildcards not permitted (use GitHub GraphQL API for wildcard patterns).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_APP_ACCESS_RESTRICTIONSReplaces the list of GitHub Apps permitted to push to a protected branch; the branch must have push restrictions configured, and apps must be installed with contents write permission on an eligible organization repository. A 404 returns an empty app list with an explanatory message.

Input Parameters

array
required
The list of GitHub App slugs to grant push access. This replaces the entire list of apps with push access. Apps must be installed on the repository and have ‘contents’ write permission. The app slug is the URL-friendly name of the GitHub App (e.g., ‘github-actions’, ‘dependabot’).
string
required
The name of the repository without the .git extension. Not case-sensitive.
string
required
The organization or username that owns the repository. Push restrictions are only available for organization-owned repositories.
string
required
The name of the protected branch. Wildcards are not permitted. The branch must already have protection rules enabled with push restrictions configured.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_A_REPOSITORY_SUBSCRIPTIONSets the authenticated user’s notification subscription for a repository.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case-sensitive.
string
required
The account owner of the repository. The name is not case-sensitive.
boolean
Determines if all notifications should be blocked from this repository. If true, this repository will be ignored, and the subscribed parameter will be disregarded (effectively setting subscribed to false).
boolean
Determines if notifications should be received from this repository. Set to true to watch the repository, false to unwatch. This parameter is overridden if ignored is set to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_A_THREAD_SUBSCRIPTIONSets whether a GitHub notification thread is ignored (muted) or unignored (unmuted), for a thread_id that must identify an existing notification thread.

Input Parameters

boolean
Whether to ignore (mute) the thread. True blocks notifications; False allows them if otherwise subscribed.
integer
required
Unique identifier of the notification thread (e.g., from GET /notifications).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_DEFAULT_WORKFLOW_PERMISSIONS_FOR_AN_ORGANIZATIONUpdates an organization’s default GITHUB_TOKEN permissions for workflows and whether GitHub Actions can approve pull requests; note that allowing Actions to approve pull requests (can_approve_pull_request_reviews: true) is a security risk.

Input Parameters

string
required
The name of the GitHub organization. This name is not case-sensitive.
string ("read" | "write")
Specifies the default permissions for the GITHUB_TOKEN in GitHub Actions workflows.
boolean
Whether GitHub Actions can approve pull requests; enabling this (true) can be a security risk. If omitted, the current setting is preserved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_DEFAULT_WORKFLOW_PERMISSIONS_FOR_A_REPOSITORYSets the default permissions for the GITHUB_TOKEN within a repository and configures whether GitHub Actions can approve pull requests.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository. This name is not case sensitive.
string ("read" | "write")
The default permissions granted to the GITHUB_TOKEN when running workflows in the repository. ‘read’ allows read-only access, while ‘write’ allows write access.
boolean
Specifies whether GitHub Actions workflows, using the GITHUB_TOKEN, can approve pull requests. Enabling this can pose a security risk by allowing automated processes to approve code changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_EMAIL_VISIBILITYSets the visibility (‘public’ or ‘private’) of the authenticated user’s primary email address on GitHub, if one is configured.

Input Parameters

string ("public" | "private")
required
Desired visibility for the authenticated user’s primary email. Use ‘public’ to make the email visible on the user’s profile, or ‘private’ to hide it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_GITHUB_ACTIONS_PERMISSIONS_FOR_AN_ORGANIZATIONSets the GitHub Actions permissions policy for an organization, specifying which repositories can run Actions and which actions/workflows are allowed; if ‘selected’ is chosen for either, manage the specific lists via other endpoints.

Input Parameters

string
required
The organization name (not case-sensitive).
string ("all" | "local_only" | "selected")
Policy for which actions and reusable workflows are allowed. If ‘selected’, manage the list of specific actions/workflows via other GitHub API endpoints. Required when enabled_repositories is set to ‘all’ or ‘selected’.
string ("all" | "none" | "selected")
required
Policy for which repositories can run GitHub Actions. If ‘selected’, manage the list of specific repositories via other GitHub API endpoints.
boolean
Whether actions and reusable workflows must be pinned to full-length commit SHAs. This enforces an additional security requirement for GitHub Actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_GITHUB_ACTIONS_PERMISSIONS_FOR_A_REPOSITORYSets GitHub Actions permissions for a repository, enabling/disabling Actions and defining the policy for allowed actions and reusable workflows.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
boolean
required
Specifies whether GitHub Actions is enabled for the repository. Set to True to enable, False to disable.
string ("all" | "local_only" | "selected")
Permissions policy: all (all actions/workflows allowed), local_only (only from this repository), or selected (configured in settings). Optional; inherits from organization/enterprise or GitHub defaults if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_INTERACTION_RESTRICTIONS_FOR_AN_ORGANIZATIONLimits interactions (comments, new issues, PRs) in an organization’s public repositories by user type and duration, typically to mitigate high traffic or unwanted activity.

Input Parameters

string
required
Name of the organization (case-insensitive).
string ("existing_users" | "contributors_only" | "collaborators_only")
required
Type of GitHub user to be restricted from commenting, opening issues, or creating pull requests in the organization’s public repositories.
string ("one_day" | "three_days" | "one_week" | "one_month" | "six_months")
Duration of the restriction; if omitted, the API defaults to one_day. A new limit overwrites any existing one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_INTERACTION_RESTRICTIONS_FOR_A_REPOSITORYTemporarily limits which GitHub users (e.g., existing_users, contributors_only) can interact (comment, open issues, create pull requests) in a repository for a specified duration.

Input Parameters

string
required
The name of the repository (without .git extension, case-insensitive).
string ("existing_users" | "contributors_only" | "collaborators_only")
required
Specifies which group of GitHub users (e.g., existing_users, contributors_only) can interact with the repository.
string
required
The account owner of the repository (username or organization name, case-insensitive).
string ("one_day" | "three_days" | "one_week" | "one_month" | "six_months")
Duration for the interaction restriction (e.g., one_day, six_months); API defaults to ‘one_day’ if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_INTERACTION_RESTRICTIONS_FOR_YOUR_PUBLIC_REPOSSets or updates temporary interaction restrictions for all public repositories owned by the authenticated user, overriding any repository-specific limits.

Input Parameters

string ("existing_users" | "contributors_only" | "collaborators_only")
required
Specifies the type of GitHub user that can comment, open issues, or create pull requests in your public repositories while the interaction limit is in effect.
string ("one_day" | "three_days" | "one_week" | "one_month" | "six_months")
Specifies the duration of the interaction restriction; API defaults to one_day if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_LABELS_FOR_AN_ISSUEReplaces all existing labels on a GitHub issue with a new set of labels.

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
array
required
A list of label names to apply to the issue. This replaces all existing labels on the issue. Providing an empty list will remove all labels from the issue.
integer
required
The number that identifies the issue within the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_OIDC_SUBJECT_CLAIM_TEMPLATESets the OpenID Connect (OIDC) subject claim template for a GitHub repository, allowing use of the default template or a custom one defined by include_claim_keys if use_default is false.

Input Parameters

string
required
Repository name, without the .git extension (case-insensitive).
string
required
Owner of the repository (username or organization name, case-insensitive).
boolean
required
If true, applies the default GitHub-provided OIDC subject claim template (ignoring include_claim_keys); if false, a custom template defined by include_claim_keys is used.
array
Array of unique OIDC claim strings (alphanumeric and underscores) for the token. Used only if use_default is false. Consult GitHub’s OIDC documentation for supported claim keys.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_ORG_ALLOWED_ACTIONSSets the GitHub Actions permissions for an existing organization, specifying allowed GitHub-owned actions, verified creator actions, and action/workflow patterns from public repositories.

Input Parameters

string
required
The name of the organization. This name is not case-sensitive.
array
String-matching patterns for allowed actions/workflows from public repositories (e.g., monalisa/octocat@*, monalisa/*); supports wildcards, tags, SHAs.
boolean
Whether actions from GitHub Marketplace verified creators are allowed.
boolean
Whether GitHub-owned actions (e.g., from the actions organization) are allowed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_ORG_RUNNER_LABELSSets the custom labels for a self-hosted runner in an organization; this operation does not affect default system-assigned labels (e.g., ‘self-hosted’, ‘linux’, ‘x64’).

Input Parameters

string
required
The name of the organization. This name is not case-sensitive.
array
required
A list of custom label names to set for the runner. This replaces all existing custom labels. Provide an empty list to remove all custom labels from the runner.
integer
required
Unique identifier of the self-hosted runner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_REPO_ALLOWED_ACTIONSSets allowed GitHub Actions and reusable workflows for a repository, managing permissions for GitHub-owned, verified creator, or specific pattern-matched actions/workflows (note: patterns_allowed applies only to public repositories).

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case-sensitive.
string
required
The account owner of the repository. The name is not case-sensitive.
array
String-matching patterns (wildcards, tags, SHAs allowed) for specific actions/workflows; Note: Only applies to public repositories.
boolean
Determines if actions from GitHub Marketplace verified creators are allowed.
boolean
Determines if GitHub-owned actions (e.g., from the actions organization) are allowed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_REPO_RUNNER_LABELSReplaces all custom labels for a specific self-hosted runner in a repository; an empty list for labels removes all existing custom labels.

Input Parameters

string
required
Name of the repository, without the .git extension (not case-sensitive).
string
required
Account owner of the repository (not case-sensitive).
array
required
Custom labels to set for the runner; an empty list removes all custom labels and replaces existing ones.
integer
required
Unique identifier of the self-hosted runner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_SELECTED_REPOS_FOR_ORG_VARIABLEReplaces the list of repositories that can access an organization-level variable; the variable’s visibility must be ‘selected’.

Input Parameters

string
required
The slug or name of the GitHub organization. This value is not case-sensitive.
string
required
The name of the organization variable for which to set repository access.
array
required
A list of unique integer identifiers for the repositories that can access the organization variable. This list will replace any current selection of repositories. An empty list will remove access for all repositories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_SELECTED_REPOSITORIES_FOR_AN_ORGANIZATION_SECRETReplaces the list of repositories that can access an organization secret; only effective if the secret’s visibility is ‘selected’. Prerequisites: - The organization secret must already exist - The secret’s visibility must be set to ‘selected’ (not ‘all’ or ‘private’) - Requires admin:org scope or actions secrets fine-grained permission This action completely replaces the repository access list. To add or remove individual repositories without affecting others, use the dedicated add/remove repository actions instead.

Input Parameters

string
required
The name of the GitHub organization. This name is not case-sensitive.
string
required
The name of the organization secret whose repository access list is being updated.
array
required
An array of unique integer IDs for repositories that will be granted access to the organization secret. This completely replaces the existing list. Use dedicated actions to add or remove individual repositories without replacing the entire list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_SELECTED_REPOSITORIES_FOR_A_USER_SECRETDefines the list of repositories permitted to access a specific Codespaces secret for the authenticated user.

Input Parameters

string
required
The name of the Codespaces secret for which to set repository access. This secret must already exist for the authenticated user.
array
required
A list of repository IDs to which the secret will be granted access. This list completely replaces any existing set of repositories for the secret. Each repository ID must correspond to a repository accessible by the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_STATUS_CHECK_CONTEXTSReplaces required status check contexts for a protected branch, requiring admin permissions; an empty contexts array removes all checks.

Input Parameters

string
required
The name of the repository, without the .git extension; not case sensitive.
string
required
The account owner (username or organization) of the repository; not case sensitive.
string
required
The name of the branch for which to set status check contexts; cannot contain wildcard characters.
array
required
Names of the status checks to require; an empty array removes all required status checks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_TEAM_ACCESS_RESTRICTIONSReplaces the list of teams with push access to a protected branch. This action sets (replaces) the teams that have push access to a protected branch. Unlike ‘Add team access restrictions’ (POST), this action replaces the entire list rather than adding to it. Use an empty list to remove all team restrictions. Prerequisites: - The repository must be owned by an organization (not a personal account) - The branch must have protection rules enabled - The branch protection must have restrictions configured - The teams must exist in the organization and have repository access

Input Parameters

string
required
The name of the repository, without the .git extension. This value is not case-sensitive.
string
required
The organization name that owns the repository. Team access restrictions only work for organization-owned repositories, not personal repositories. This value is not case-sensitive.
array
required
The list of team slugs to grant push access to the protected branch. A team slug is the URL-friendly version of the team name (lowercase, hyphens instead of spaces). The teams must already have access to the repository. This REPLACES the entire existing list of teams with push access (use empty list to remove all teams).
string
required
The name of the protected branch to set team restrictions on. The branch must already have branch protection enabled with restrictions configured. Wildcard characters are not supported. For wildcard branch protection, use the GitHub GraphQL API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_USER_ACCESS_RESTRICTIONSReplaces the list of users with push access to a protected branch in an organization repository. Important notes: - This action only works on organization-owned repositories (not personal repos) - The branch must already have protection rules with restrictions enabled - This REPLACES (not adds to) the existing list of users with push access - Users must have write access to the repository to be added - The combined total of users, apps, and teams is limited to 100 items - To add users without replacing, use the ‘add_user_access_restrictions’ action instead

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository (must be an organization for user restrictions). This name is not case-sensitive.
array
required
The list of user logins (usernames) to grant push access to the protected branch. This REPLACES the existing list of users. Users must have write access to the repository. Pass an empty list [] to remove all user restrictions. The combined total of users, apps, and teams is limited to 100 items.
string
required
The name of the branch. Cannot contain wildcard characters. To use wildcards in branch names, use the GitHub GraphQL API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_USER_INTERACTION_LIMIT_GRAPH_QLSet interaction limits on a specified user’s public repositories using GraphQL, temporarily restricting who can comment, open issues, or create pull requests.

Input Parameters

string ("EXISTING_USERS" | "CONTRIBUTORS_ONLY" | "COLLABORATORS_ONLY")
required
The level of interaction to limit. EXISTING_USERS limits to users with accounts older than 24 hours, CONTRIBUTORS_ONLY limits to prior contributors, COLLABORATORS_ONLY limits to collaborators only.
string ("ONE_DAY" | "THREE_DAYS" | "ONE_WEEK" | "ONE_MONTH" | "SIX_MONTHS")
When the interaction limit expires.
string
required
The global ID of the user to set interaction limits for. This is required and must be a valid GitHub user node ID.
string
A unique identifier for the client performing the mutation. Used to track requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SET_WORKFLOW_EXTERNAL_ACCESSSets the access level for workflows outside a repository to use actions and reusable workflows within that repository.

Input Parameters

string
required
Repository name, without .git extension. Not case-sensitive.
string
required
Owner’s username or organization name. Not case-sensitive.
string ("none" | "user" | "organization")
required
Specifies the level of access workflows outside this repository have to its actions and reusable workflows. - none: Actions and reusable workflows are accessible only from workflows within this repository. - user: Actions and reusable workflows can be shared with other private repositories owned by the same user. - organization: Actions and reusable workflows can be shared with other repositories within the same organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_STAR_A_GISTStars a GitHub gist identified by gist_id; this action is idempotent and returns a 204 No Content status upon success, even if the gist is already starred.

Input Parameters

string
required
The unique identifier of the gist. This ID is the string of characters found at the end of a gist’s URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_STAR_A_REPOSITORY_FOR_THE_AUTHENTICATED_USERStars a specified repository (identified by owner and repo name) for the authenticated user; this action is idempotent and succeeds even if the repository is already starred. Requires explicit repository identification via owner and repo parameters.

Input Parameters

string
required
Required. The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
Required. The username of the account that owns the repository. This field is not case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_START_A_CODESPACE_FOR_THE_AUTHENTICATED_USERInitiates the startup process for an existing GitHub Codespace (identified by codespace_name) if it’s in a startable state like ‘Available’ or ‘Stopped’.

Input Parameters

string
required
The unique name of the codespace to be started. This is the identifier for the codespace, often system-generated or user-defined.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_STOP_A_CODESPACE_FOR_AN_ORGANIZATION_USERStops a running codespace for an organization member. This action allows organization administrators to stop a codespace that belongs to a member of their organization. The codespace must be in a running state (e.g., ‘Available’) to be stopped. Required permissions: - OAuth/PAT: admin:org scope - Fine-grained tokens: ‘Organization codespaces’ (write) or ‘Codespaces lifecycle admin’ (write) Common HTTP responses: - 200: Codespace successfully stopped, returns codespace object - 304: Not modified (codespace already stopped) - 401: Authentication required - 403: Insufficient permissions (need admin:org) - 404: Organization, user, or codespace not found

Input Parameters

string
required
The organization name (login). Case-insensitive. The authenticated user must have admin:org permissions for this organization.
string
required
The GitHub username (login) of the organization member whose codespace will be stopped.
string
required
The unique name of the codespace to stop. This is typically a hyphenated string like ‘username-repo-name-randomchars’. You can obtain this from the ‘List codespaces for a user in organization’ action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_STOP_A_CODESPACE_FOR_THE_AUTHENTICATED_USERStops a running or available Codespace for the authenticated user, pausing its execution and billing.

Input Parameters

string
required
The unique name of the Codespace to be stopped. This name is assigned by GitHub when the Codespace is created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SUBMIT_A_REVIEW_FOR_A_PULL_REQUESTFinalizes a pending pull request review (identified by review_id) with a required event (APPROVE, REQUEST_CHANGES, COMMENT) and an optional body.

Input Parameters

string
The main textual content of the review. Highly recommended for COMMENT events to provide context; can also supplement APPROVE or REQUEST_CHANGES actions.
string
required
The name of the repository, without the .git extension. Case-insensitive.
string ("APPROVE" | "REQUEST_CHANGES" | "COMMENT")
required
The review action: APPROVE, REQUEST_CHANGES, or COMMENT. An invalid/omitted event will result in an HTTP 422 error and set the review state to PENDING, requiring a subsequent valid submission.
string
required
The username of the account that owns the repository. Case-insensitive.
integer
required
Identifier of the pending review to be submitted. Typically obtained when a review is first created or initiated.
integer
required
The number that uniquely identifies the pull request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_SYNC_FORK_BRANCH_WITH_UPSTREAMSynchronizes a branch in a forked GitHub repository with its upstream counterpart, assuming the repository is a fork, the branch exists, an upstream is configured, and the merge is conflict-free.

Input Parameters

string
required
The name of the forked repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name of the account that owns the forked repository. This field is not case-sensitive.
string
required
The name of the branch in the forked repository that should be updated to match the corresponding branch in the upstream repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_TEST_REPOSITORY_WEBHOOKTriggers a simulated push event to test a repository’s push webhook; a test event is only delivered if the webhook is subscribed to ‘push’ events, otherwise, it returns 204 No Content without sending a POST.

Input Parameters

string
required
Name of the repository, without the .git extension (not case-sensitive).
string
required
Account owner of the repository (not case-sensitive).
integer
required
Unique identifier of the hook, found in the X-GitHub-Hook-ID header of a webhook delivery or by listing repository webhooks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_TRANSFER_A_REPOSITORYInitiates a repository transfer to a new owner (who must accept the request); if the new owner is an organization, it must be configured to allow transfers.

Input Parameters

string
required
Name of the repository to transfer, without .git (case-insensitive).
string
required
Current owner’s username or organization name (case-insensitive).
string
Optional new name for the repository post-transfer; retains current name if unspecified.
array
List of team IDs to add the repository to if new_owner is an organization; teams must belong to the new_owner.
string
required
Target username or organization name for the repository transfer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UNBLOCK_A_USERUnblocks a GitHub user, provided they are currently blocked by the authenticated user.

Input Parameters

string
required
The GitHub username (handle) of the user to unblock.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UNBLOCK_USER_FROM_ORGANIZATIONUnblocks a user from a specified organization. A 404 response is returned as an unsuccessful result indicating that the user was not blocked or the organization or user was not found.

Input Parameters

string
required
The name of the organization. This is case-insensitive.
string
required
The GitHub username of the user to unblock.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UNFOLLOW_A_USERUnfollows an existing GitHub user; this action is idempotent, succeeding even if the authenticated user is not currently following them.

Input Parameters

string
required
The GitHub username (handle) of the user whom the authenticated user wishes to unfollow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UNFOLLOW_ORGANIZATIONTool to unfollow a GitHub organization using GraphQL. Use when you need to stop following a specific organization on GitHub.

Input Parameters

string
required
The Node ID of the organization to unfollow (e.g., ‘MDEyOk9yZ2FuaXphdGlvbjk5MTk=’). This is the global GraphQL node ID, not the organization name or numeric ID.
string
A unique identifier for the client performing the mutation. This value will be returned in the response and can be used for request tracking or idempotency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UNFOLLOW_USERTool to unfollow a GitHub user using GraphQL. Use when you need to stop following a specific user on GitHub.

Input Parameters

string
required
The Node ID of the user to unfollow (e.g., ‘MDQ6VXNlcjE=’). This is the global GraphQL node ID, not the username or numeric user ID.
string
A unique identifier for the client performing the mutation. This value will be returned in the response and can be used for request tracking or idempotency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UNLOCK_AN_ISSUEUnlocks a currently locked GitHub issue in the specified repository, allowing new comments and interactions.

Input Parameters

string
required
The name of the repository, without the .git extension. This value is not case-sensitive.
string
required
The username (account) or organization name that owns the repository. This value is not case-sensitive.
integer
required
The number that uniquely identifies the issue within the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UNLOCK_ORGANIZATION_REPOSITORYUnlocks a repository that was locked for migration within a GitHub organization. This action is part of the organization migrations workflow. When you start a migration with lock_repositories=true, the source repositories are locked to prevent changes during export. After the migration is complete and applied to the target instance, use this action to unlock the repositories so they can be accessed or deleted. Requirements: - You must be an organization owner to unlock repositories - The repository must be currently locked as part of the specified migration - This endpoint does not work with GitHub App tokens or fine-grained personal access tokens Typical workflow: 1. Start an organization migration with POST /orgs/{org}/migrations 2. Wait for the migration to complete (state: “exported”) 3. Apply the migration to your target instance 4. Unlock each migrated repository using this action 5. Delete the source repositories if no longer needed

Input Parameters

string
required
The name of the GitHub organization that owns the migration. This name is not case-sensitive.
string
required
The name of the repository to unlock. Must be one of the repositories included in the specified migration.
integer
required
The unique numeric identifier of the organization migration. You can find this by listing organization migrations using GET /orgs/{org}/migrations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UNLOCK_USER_REPOSITORYUnlocks a repository (repo_name) that was locked as part of a user migration (migration_id), making it usable or deletable; this action requires the repository to be currently locked.

Input Parameters

string
required
The name of the repository to unlock.
integer
required
The unique identifier of the user migration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UNSTAR_A_GISTRemoves a star from the specified gist; the action is idempotent and will not error if the gist was not previously starred by the user.

Input Parameters

string
required
The unique identifier (ID) of the gist to be unstarred. This ID can be retrieved from API endpoints that list gists or from the gist’s URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UNSTAR_REPOSITORYRemoves the authenticated user’s star from a specified repository, which must already be starred by the user.

Input Parameters

string
required
Repository name, without the .git extension (case-insensitive).
string
required
Username of the repository owner (case-insensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_CHECK_RUNUpdates an existing check run for a specific commit in a repository, allowing modifications to its status, conclusion, output, and other details. NOTE: This endpoint requires GitHub App authentication with ‘checks:write’ permission - OAuth tokens and personal access tokens cannot update check runs.

Input Parameters

string
Name of the check (e.g., “code-coverage”).
string
required
Repository name without the .git extension (not case sensitive).
string
required
Account owner of the repository (not case sensitive).
string ("queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending")
Current status of the check run. Only GitHub Actions can set waiting, pending, or requested.
string
JSON string representing user-triggerable actions (max 3), each with label, identifier, and description.
string ("action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out")
Final conclusion of the check. Required if completed_at is provided or status is completed. Providing conclusion sets status to completed. Users cannot set stale.
string
Timestamp of when the check run started (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ).
string
URL of the integrator’s site with full check details.
string
Reference for the run on the integrator’s system.
integer
required
The unique identifier of the check run.
string
Timestamp of when the check run completed (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ).
string
Text for the output, can contain Markdown.
string
Title for the check run output. Displayed prominently in the GitHub checks UI.
string
JSON string representing images for the output, displayed in the GitHub PR UI.
string
Summary of the output, can contain Markdown. Required if the output object is provided.
string
JSON string representing line-specific analysis information, visible in PRs. Max 50 per request (appended to existing). GitHub Actions: 10 warnings/10 errors per step.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_CODE_SCANNING_ALERTUpdates a specific code scanning alert in a GitHub repository, primarily to change its state (e.g., ‘open’ or ‘dismissed’).

Input Parameters

string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
string ("open" | "dismissed")
required
The new state for the code scanning alert. Must be either ‘open’ or ‘dismissed’. If ‘dismissed’, dismissed_reason is mandatory.
integer
required
The number that identifies an alert. Found in the alert’s URL or the number field of the GET alerts API response.
string ("false positive" | "won't fix" | "used in tests")
The reason for dismissing or closing the alert. Required if state is ‘dismissed’.
string
An optional comment to provide further context when dismissing an alert. Maximum 280 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_COMMIT_COMMENTChanges the body of an existing commit comment.

Input Parameters

string
required
The new content of the comment.
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
integer
required
The unique identifier of the comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_CUSTOM_ORGANIZATION_ROLEUpdates an existing custom role in an organization by modifying its name, description, or permissions; at least one of these fields must be provided.

Input Parameters

string
required
The organization name (not case-sensitive).
string
New name for the custom role. Unchanged if omitted.
integer
required
Unique identifier of the custom organization role.
string
The system role from which this role inherits permissions. One of: ‘none’, ‘read’, ‘triage’, ‘write’, ‘maintain’, or ‘admin’. Unchanged if omitted.
string
New short description for the role. Unchanged if omitted.
array
New list of GitHub organization permissions for the role, replacing existing ones. An empty list removes all permissions. Unchanged if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_DEPLOYMENT_BRANCH_POLICYUpdates the name pattern of an existing deployment branch policy for a specific environment in a repository.

Input Parameters

string
required
The new name pattern that branches must match to deploy to this environment. Wildcard characters (*) can be used but will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*. For more information about pattern matching syntax, refer to the Ruby File.fnmatch documentation (https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.
integer
required
The unique identifier of the deployment branch policy to be updated.
string
required
The name of the deployment environment. This name must be URL-encoded if it contains special characters such as slashes (e.g., replace / with %2F).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_DISCUSSIONUpdates the title and/or body of a specific team discussion within an organization.

Input Parameters

string
required
The organization name (not case-sensitive).
string
The new body text for the discussion post. Supports markdown formatting. Only provide this if you want to change the body content.
string
The new title for the discussion post. Only provide this if you want to change the title.
string
required
The slug of the team name.
integer
required
The unique number that identifies the discussion within the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_DISCUSSION_COMMENTUpdates the body of a comment in a team’s discussion within an organization.

Input Parameters

string
required
The name of the organization. This is not case sensitive.
string
required
The new body text for the discussion comment. Supports GitHub Flavored Markdown.
string
required
The slug of the team name. This is the team name converted to lowercase with spaces replaced by hyphens (e.g., ‘justice-league’).
integer
required
The unique number identifying the comment within the discussion.
integer
required
The unique number identifying the discussion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_GISTUpdates a gist’s description, and/or its files (including content, filename changes, or deletion).

Input Parameters

string
Specifies changes to gist files as a JSON string. Keys are current filenames (e.g., hello.py). For each file: update content, assign a new filename to rename (or both). To delete a file, set its value to null or an object without content or filename. Files not mentioned are preserved.
string
required
The unique identifier of the gist to be updated.
string
A new description for the gist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_GIST_COMMENTUpdates an existing comment on a specified gist.

Input Parameters

string
required
The new text content for the comment. Supports Markdown formatting.
string
required
The unique identifier of the gist. This is typically a 32-character hexadecimal string found in the gist URL.
integer
required
The unique numeric identifier of the comment to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_LABELUpdates an existing label’s name, color, or description within a specified repository.

Input Parameters

string
required
Current name of the label to be updated; value is not case-sensitive.
string
required
Name of the repository, without the .git extension; value is not case-sensitive.
string
Hexadecimal color code for the label, without the leading ’#’ (e.g., ‘f29513’).
string
required
Account owner of the repository; value is not case-sensitive.
string
New name for the label (not case-sensitive). Emoji can be added using native characters or colon-style markup (e.g., ‘:strawberry:’). Refer to GitHub’s emoji cheat sheet for a full list of codes.
string
Short description for the label (max 100 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_MILESTONEUpdates a repository milestone identified by owner, repository, and milestone number. It can modify the title, state, description, or due date; if state is omitted, it is sent as open.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username of the account that owns the repository. This field is not case-sensitive.
string ("open" | "closed")
The new state of the milestone. If not provided, the state will remain unchanged. Defaults to ‘open’.
string
The new title for the milestone. If not provided, the title will remain unchanged.
string
The milestone due date in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. If not provided, the due date will remain unchanged. To remove the due date, pass an empty string or null.
string
A new description for the milestone. If not provided, the description will remain unchanged.
integer
required
The unique number that identifies the milestone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_AN_ENVIRONMENT_VARIABLEUpdates an existing environment variable’s name and/or value in a specific GitHub repository environment; requires providing either a new name or a new value.

Input Parameters

string
required
Current name of the environment variable to update.
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository. The name is not case sensitive.
string
New value for the environment variable; if omitted, the value is not changed.
string
New name for the environment variable. If provided, the variable will be renamed to this value. If omitted, the name remains unchanged.
string
required
The name of the environment. The name must be URL encoded (e.g., replace slashes / with %2F).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_AN_ISSUEUpdates an existing GitHub issue’s title, body, state, milestone, labels, or assignees. Empty lists can clear labels or assignees; null values are omitted from the update.

Input Parameters

string
New issue body; send null to clear, omit to leave unchanged.
string
required
Repository name, without the .git extension (case-insensitive).
string
required
Owner of the repository (case-insensitive).
string ("open" | "closed")
New issue state; omit to leave unchanged.
string
New issue title; send null to clear, omit to leave unchanged.
array
Replaces all existing labels. Send [] to remove all; omit to leave unchanged. Requires push access for changes.
string
DEPRECATED: Username to assign; use assignees. Send null to unassign, omit to leave unchanged.
array
Replaces all existing assignees. Send [] to remove all; omit to leave unchanged. Requires push access for changes.
string
Milestone ID (as string) or title. Send null to clear; omit to leave unchanged. Numeric ID recommended.
integer
required
Unique number identifying the issue.
string ("completed" | "not_planned" | "reopened")
Reason for state change, considered only if state also changes. Valid reasons depend on the new state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_AN_ISSUE_COMMENTUpdates an existing comment on an issue or pull request within a specified repository. You can only update comments that the authenticated user has permission to edit. The comment_id can be obtained from the list_issue_comments or get_an_issue_comment actions.

Input Parameters

string
required
New content for the issue comment (GitHub Flavored Markdown supported).
string
required
Name of the repository, without the .git extension (not case-sensitive).
string
required
Username of the account owning the repository (not case-sensitive).
integer
required
Unique ID of the issue comment to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_AN_ORGANIZATIONUpdates an organization’s settings; changing security-related fields requires admin, owner, or security manager permissions. Omitted repository-permission, repository-creation, Pages, private-forking, and web-commit signoff settings are sent with the tool’s defaults and may change existing settings.

Input Parameters

string
required
The organization’s unique, case-insensitive identifier.
string
URL of the organization’s blog.
string
Display name.
string
Publicly visible email address.
string
Company name.
string
Geographical location.
string
Short description.
string
Billing email address (not publicly visible).
string
Twitter username.
boolean
Whether repository-level projects can be used within the organization.
boolean
Whether members can create GitHub Pages sites. Does not affect existing sites.
boolean
Whether organization-level projects can be used.
boolean
Whether web interface commits require sign-off.
string ("read" | "write" | "admin" | "none")
Default permission for members on organization repositories.
boolean
Whether members can create public GitHub Pages sites. Does not affect existing sites.
boolean
Whether non-admin members can create repositories. Overridden by members_allowed_repository_creation_type.
boolean
Whether members can create private GitHub Pages sites. Does not affect existing sites.
boolean
Whether members can fork private repositories of the organization.
boolean
Whether members can create public repositories.
boolean
Whether members can create private repositories.
string ("all" | "private" | "none")
Types of repositories non-admin members can create. private option only on GitHub Enterprise Cloud. Deprecated; overrides members_can_create_repositories.
boolean
Whether members can create internal repositories. Only for organizations in an enterprise account.
URL displayed if secret_scanning_push_protection_custom_link_enabled is true and a push is blocked.
boolean
Automatically enable secret scanning for new repositories.
boolean
Automatically enable dependency graph for new repositories.
boolean
Automatically enable GitHub Advanced Security for new repositories.
boolean
Automatically enable Dependabot alerts for new repositories.
Show custom link to contributors blocked by secret scanning push protection.
boolean
Automatically enable Dependabot security updates for new repositories.
boolean
Automatically enable secret scanning push protection for new repositories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_AN_ORGANIZATION_VARIABLEUpdates an existing GitHub Actions organization variable’s name, value, or visibility (all, private, selected), requiring selected_repository_ids with valid repository IDs if visibility is selected.

Input Parameters

string
required
The organization name. The name is not case sensitive.
string
required
The current name of the organization variable to be updated. This name is case-sensitive.
string
Optional: The new value for the organization variable. If provided, the variable’s value will be updated. If omitted or null, the current value is preserved.
string
Optional: The new name for the organization variable. If provided, the variable will be renamed. If omitted or null, the current name is preserved.
string ("all" | "private" | "selected")
Optional: Specifies the new visibility of the organization variable. Determines which repositories can access this variable: ‘all’ (all repositories), ‘private’ (only private repositories), or ‘selected’ (specific repositories). When set to ‘selected’, you must also provide selected_repository_ids. If omitted or null, visibility remains unchanged.
array
Optional: A list of repository IDs (integers) that can access this organization variable. Required when visibility is set to ‘selected’. Ignored for other visibility values. If omitted when visibility=‘selected’, the API may reject the request or use existing repository access list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_AN_ORGANIZATION_WEBHOOKUpdates an existing organization’s webhook configuration, subscribed events, active status, or name. If active status is omitted, the request enables the webhook.

Input Parameters

string
required
The name of the organization. This value is not case-sensitive.
string
Must be passed as ‘web’ for organization webhooks. This is a fixed value required by the GitHub API.
boolean
Set to true to send notifications, or false to disable them.
array
List of events that trigger this webhook. GitHub REPLACES the full event list when this is sent — omit (leave unset) to preserve the existing event subscription. Use ['*'] to subscribe to all events. See GitHub docs for available event types.
integer
required
The unique identifier of the webhook. This ID can be found in the X-GitHub-Hook-ID header of a webhook delivery.
string
Target URL for webhook payloads. Required if updating other config properties (e.g., content_type, secret), as GitHub mandates url when config is modified.
string
Secret key for HMAC digest to ensure payload integrity. Refer to GitHub documentation on delivery headers for details.
string
Media type for serializing payloads (json or form). The API defaults to form if this field is not provided.
string
Controls SSL certificate verification for payload delivery. Set to ‘1’ to skip verification (insecure), or ‘0’ to enforce (API default). Use with caution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_PROJECTUpdates an existing GitHub project (V2) attributes like title, description, visibility, and state. Note: This action uses GitHub’s Projects V2 GraphQL API. The legacy Projects (classic) REST API was sunset on April 1, 2025. The project is identified by its number (visible in the project URL) and owner (either a username or organization name). If no owner is specified, the authenticated user is assumed. At least one field to update must be provided.

Input Parameters

string
The organization that owns the project. If provided, this takes precedence over username.
string
The new title for the project. If not provided, the title will not be changed.
boolean
Sets whether the project is closed. True closes the project, False reopens it. If not provided, the state will not be changed.
boolean
Sets the visibility of the project. True makes it public (visible to everyone), False makes it private. If not provided, the visibility will not be changed.
string
The project’s README content (supports Markdown formatting). If not provided, the README will not be changed.
string
The GitHub username who owns the project. If not provided, defaults to the authenticated user.
integer
required
The project’s sequential number (e.g., 1, 2, 3). This is displayed in the project URL as https://github.com/users/&#123;username&#125;/projects/&#123;project_number&#125;.
string
A short description for the project (displayed in project cards and listings). If not provided, the description will not be changed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_PULL_REQUESTUpdates an existing pull request, allowing changes to attributes like title, body, state, base branch, and maintainer modification settings.

Input Parameters

string
The name of the branch to which you want your changes pulled. This must be an existing branch in the current repository. Cannot update the base branch to point to another repository. If None, the base branch remains unchanged.
string
The new contents of the pull request. To remove the body, pass an empty string. If None, the body remains unchanged.
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.
string ("open" | "closed")
The new state of the pull request. Can be ‘open’ or ‘closed’. If None, the state remains unchanged.
string
The new title for the pull request. If None, the title remains unchanged.
integer
required
The unique number that identifies the pull request within the repository.
boolean
Indicates whether maintainers can modify the pull request. If None, this setting remains unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_PULL_REQUEST_BRANCHRequests an asynchronous update of an open pull request’s head branch by merging its base branch, if mergeable and repository merging is enabled. The result may instead report merge conflicts, an already up-to-date branch, or an expected head SHA mismatch.

Input Parameters

string
required
Repository name, without the .git extension (not case-sensitive).
string
required
Account owner of the repository (not case-sensitive).
integer
required
Unique number identifying the pull request.
string
SHA of the expected head commit of the pull request’s branch. If this SHA does not match the actual head SHA, the request fails (422 error), ensuring the branch was not updated unexpectedly. If omitted, the API uses the current head SHA of the branch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_REFERENCEUpdates an existing Git reference (e.g., a branch or tag) to point to a specific commit SHA. By default, only allows fast-forward updates (where the new commit is a descendant of the current one). Set force=true to allow non-fast-forward updates that rewrite history. IMPORTANT: The reference must already exist - use ‘Create a reference’ action to create new refs.

Input Parameters

string
required
The name of the Git reference to update WITHOUT the ‘refs/’ prefix. For branches: use ‘heads/<branch-name>’ (e.g., ‘heads/main’, ‘heads/feature-branch’). For tags: use ‘tags/<tag-name>’ (e.g., ‘tags/v1.0.0’). Note: Branch references require ‘heads/’ (plural), not ‘head/’ (singular). Bare branch names will be automatically prefixed with ‘heads/’. The reference must already exist - this endpoint only updates existing refs.
string
required
The SHA1 commit hash to point this reference to. Must be exactly 40 hexadecimal characters (0-9, a-f) representing a valid commit that exists in the repository.
string
required
Repository name, excluding .git extension (case-insensitive).
boolean
Controls whether to allow non-fast-forward updates. When false (default), the new commit must be a direct descendant of the current commit (fast-forward only) - this prevents accidental history rewriting. When true, allows moving the reference to any commit, even if it means rewriting history or moving backward. Set to true only when you need to force-push changes, reset a branch, or intentionally rewrite commit history.
string
required
Account owner of the repository (case-insensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_RELEASEUpdates an existing release in a GitHub repository, allowing modification of its attributes; if linking a discussion, the discussion_category_name must refer to an existing category in the repository.

Input Parameters

string
Text describing the contents of the release. Supports GitHub Flavored Markdown.
string
The title of the release.
string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
boolean
Set to true to mark the release as a draft, or false to publish it. Default: false.
string
required
The account owner of the repository. This name is not case-sensitive.
string
The name of the tag. This can be an existing tag or a new tag name.
boolean
Set to true to identify the release as a pre-release, or false for a full release. Default: false.
integer
required
The unique identifier of the release to be updated.
string ("true" | "false" | "legacy")
Specifies whether this release should be set as the latest release for the repository. Accepts ‘true’, ‘false’, or ‘legacy’. Drafts and pre-releases cannot be set as latest. Defaults to true for newly published releases. legacy specifies that the latest release should be determined based on the release creation date and higher semantic version.
string
Specifies the commitish value (e.g., branch name or commit SHA) that determines where the Git tag is created from. Can be any branch or commit SHA. This parameter is unused if the Git tag specified by tag_name already exists. Defaults to the repository’s default branch if omitted.
string
If specified, a discussion of this category is created and linked to the release. The category must already exist in the repository. This parameter is ignored if a discussion is already linked to the release. For more information, see “Managing categories for discussions in your repository.”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_RELEASE_ASSETUpdates the name, label, or state of a release asset in a GitHub repository, requiring at least one of these properties to be provided for modification.

Input Parameters

string
The new file name for the asset. This updates the display name of the asset.
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
An alternate short description for the asset. This is used in place of the filename if provided, offering a more descriptive label.
string
required
The account owner of the repository. The name is not case sensitive.
string
The new state of the release asset. While the GitHub API documentation primarily shows ‘state’ in responses (e.g., ‘uploaded’), this field allows attempting to update it. The effect and accepted values might be specific.
integer
required
The unique identifier of the release asset to be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_REPOSITORYUpdates settings for an existing GitHub repository, such as name, description, visibility, merge strategies, and security configurations.

Input Parameters

string
New name for the repository (not case-sensitive).
string
required
ACTUAL name of an existing repository, without the .git extension (not case-sensitive). MUST be a real repository that exists and is accessible - placeholder values like ‘your-repo-name’ will cause 404 errors.
string
required
ACTUAL GitHub username or organization name that owns the repository (not case-sensitive). MUST be a real, existing account - placeholder values like ‘your-username’ will cause 404 errors.
boolean
Whether the repository is private. IMPORTANT: Public forks cannot be made private - this is a GitHub platform restriction. Changing visibility may also be restricted by organization policies.
boolean
Archives the repository (making it read-only) or unarchives it.
boolean
Enables the GitHub Wiki.
string
URL of the project’s homepage.
boolean
Enables GitHub Issues for this repository.
string ("public" | "private" | "internal")
Repository visibility. IMPORTANT: Public forks cannot be made private - this is a GitHub platform restriction.
string
Brief summary of the repository.
boolean
Designates this repository as a template repository.
boolean
Enables GitHub Projects. Note: Organization settings might override this and cause an error if projects are disabled organization-wide.
boolean
Allows private forks of this repository. IMPORTANT: This setting can ONLY be changed for organization-owned repositories. Attempting to set this for user-owned repositories will result in a 422 error. Omit this field if you don’t want to change the forking setting.
string
Name of the default branch.
boolean
Enables auto-merge for pull requests.
boolean
Allows merging pull requests via merge commits.
boolean
Allows rebase-merging pull requests.
boolean
Allows squash-merging pull requests.
string ("PR_TITLE" | "MERGE_MESSAGE")
Default title for merge commits: ‘PR_TITLE’ or ‘MERGE_MESSAGE’. CONSTRAINT: If set to ‘PR_TITLE’, merge_commit_message must be ‘PR_BODY’ or ‘BLANK’. If set to ‘MERGE_MESSAGE’, merge_commit_message must be blank/unset.
boolean
Allows updating a pull request’s head branch from the base branch if not strictly required for merging.
string ("PR_BODY" | "PR_TITLE" | "BLANK")
Default message for merge commits: ‘PR_BODY’, ‘PR_TITLE’, or ‘BLANK’. CONSTRAINT: If merge_commit_title is ‘PR_TITLE’, this must be ‘PR_BODY’ or ‘BLANK’. Cannot be set when merge_commit_title is ‘MERGE_MESSAGE’.
boolean
Automatically deletes head branches after merging pull requests.
string ("PR_TITLE" | "COMMIT_OR_PR_TITLE")
Default title for squash merge commits: ‘PR_TITLE’ or ‘COMMIT_OR_PR_TITLE’.
string ("PR_BODY" | "COMMIT_MESSAGES" | "BLANK")
Default message for squash merge commits: ‘PR_BODY’, ‘COMMIT_MESSAGES’, or ‘BLANK’.
boolean
Requires contributors to sign off on web-based commits.
boolean
DEPRECATED: Use squash_merge_commit_title. If true, squash merge commits use PR title; otherwise, commit message.
string
Manages secret scanning. Set to ‘enabled’ or ‘disabled’.
string
Manages GitHub Advanced Security. Set to ‘enabled’ or ‘disabled’.
string
Manages secret scanning push protection. Set to ‘enabled’ or ‘disabled’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_REPOSITORY_INVITATIONUpdates an active repository invitation to modify the invited user’s permissions; the specified repository and invitation must exist.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository (e.g., a username or organization name). This name is not case sensitive.
string ("read" | "write" | "maintain" | "triage" | "admin")
The new permissions to grant the invited user on the repository.
integer
required
The unique identifier of the repository invitation to be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_REPOSITORY_RULESETUpdates an existing repository ruleset, identified by ruleset_id for a given repository, allowing partial updates to its configuration such as name, target, enforcement, bypass actors, conditions, and rules.

Input Parameters

string
The new name for the ruleset.
string
required
The name of the repository without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository. This name is not case sensitive.
string
String representing rules to enforce. Each rule has a type and optional parameters (e.g., [{'type': 'creation'}, {'type': 'pull_request', 'parameters': {'required_approving_review_count': 2}}]). Accepts both JSON format with double quotes or Python list syntax with single quotes. Refer to GitHub API documentation for available rule types and their parameters.
string ("branch" | "tag")
The target of the ruleset (e.g., branch or tag).
integer
required
The unique identifier of the existing ruleset to be updated.
string ("disabled" | "active" | "evaluate")
Specifies the enforcement level: disabled (ruleset is ignored), active (ruleset is enforced), or evaluate (allows testing rules before enforcement - GitHub Enterprise only).
string
String representing actors that can bypass ruleset. Each actor specifies actor_id, actor_type (RepositoryRole, Team, Integration, OrganizationAdmin), and bypass_mode (always, pull_request). Accepts both JSON format with double quotes or Python list syntax with single quotes. Example: [{'actor_id': 1, 'actor_type': 'RepositoryRole', 'bypass_mode': 'always'}].
array
Ref names or patterns (fnmatch-style globs) to exclude. The ruleset will not apply if any of these patterns match.
array
Ref names or patterns (fnmatch-style globs) to include for the ruleset to apply. ~DEFAULT_BRANCH targets the default branch; ~ALL targets all branches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_REPOSITORY_VARIABLEUpdates the name and/or value of an existing GitHub Actions variable in a repository.

Input Parameters

string
required
The current name of the Actions variable to update (path parameter). Variable names are case-insensitive and can only contain alphanumeric characters or underscores.
string
required
The name of the repository, without the .git extension; case-insensitive.
string
required
The account owner of the repository (e.g., GitHub username or organization name); case-insensitive.
string
The new value for the Actions variable. If omitted, the current value is retained. Must be a non-empty string if provided. You must provide either new_name or value (or both).
string
Optional new name for the variable. If provided, renames the variable. Can only contain alphanumeric characters or underscores; cannot start with GITHUB_ prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_REPOSITORY_WEBHOOKUpdates the URL, content type, secret, SSL verification, events, or active status of an existing repository webhook. The active status defaults to true when omitted.

Input Parameters

string
required
Repository name, without the .git extension (not case-sensitive).
string
required
Username or organization name of the repository owner (not case-sensitive).
boolean
Set true if active and sending notifications, false otherwise.
array
List of events to trigger the webhook. GitHub REPLACES the full event list when this is sent — omit (leave unset) to preserve the existing subscription. Use add_events/remove_events for incremental changes. See GitHub webhook event payloads docs for available event types.
integer
required
Unique identifier of the webhook (found in X-GitHub-Hook-ID header of a delivery).
array
Events to add to current subscriptions.
string
New URL for webhook payload delivery.
array
Events to remove from current subscriptions.
string
Optional secret for HMAC digest of delivery signature headers (see GitHub docs).
string
Media type for serializing payloads (‘json’ or ‘form’).
string
Set to ‘1’ to disable SSL verification (insecure), ‘0’ to enable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_A_TEAMUpdates a team’s settings (e.g., name, description, privacy, parent team) within a GitHub organization, identified by its slug and organization name.

Input Parameters

string
required
The organization’s name (case-insensitive). This is a required path parameter.
string
New display name for the team.
string ("secret" | "closed" | "public")
The desired privacy level for the team. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. - For a non-nested team: - secret: Visible only to organization owners and members of this team. - closed: Visible to all members of this organization. - public: Visible to all members of this organization (equivalent to closed). - For a parent or child team: - closed: Visible to all members of this organization. - public: Visible to all members of this organization (equivalent to closed).
string
required
The team’s unique slug identifier (typically URL-friendly version of team name). This is a required path parameter.
string ("pull" | "push" | "admin")
Deprecated. Default permission (pull, push, or admin) for new repositories added to this team. This may be removed in future versions.
string
New team description; an empty string clears the existing description.
integer
The unique identifier (ID) of an existing team to set as this team’s parent. This establishes a nested team structure. To remove an existing parent team relationship and make this a top-level team, explicitly pass null for this field (e.g., by setting this parameter to Python None). If this parameter is not provided in the request, the current parent team, if any, remains unchanged.
string ("notifications_enabled" | "notifications_disabled")
The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. - notifications_enabled: Team members receive notifications when the team is @mentioned. - notifications_disabled: No one receives notifications for team @mentions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_BRANCH_PROTECTIONUpdates branch protection settings for a specific existing repository branch; wildcard branch names are not supported. Unspecified status checks, admin enforcement, pull request reviews, and push restrictions are sent as null and may be disabled; unspecified user, team, or app lists within supplied push restrictions are sent empty.

Input Parameters

string
required
The name of the repository, without the .git extension (not case-sensitive).
string
required
The account owner of the repository (not case-sensitive).
string
required
Name of the branch to protect; wildcard characters are not allowed (use GraphQL API for wildcard support).
boolean
If True, sets the branch to read-only, preventing pushes.
boolean
Enforces configured restrictions for repository administrators. Set to True to enforce for admins, or None/null to disable.
boolean
Allows deletion of the protected branch.
boolean
If True, push restrictions also apply to creating matching new branches, unless pusher has explicit push access.
boolean
Permits force pushes to the protected branch. Set to True to allow, None/null to block.
boolean
Allows users to pull upstream changes into their fork when the branch is locked.
array
App slugs with push access. Cannot be used with restrictions_users or restrictions_teams. Empty list removes all.
array
Team slugs with push access. Cannot be used with restrictions_apps or restrictions_users. Empty list removes all.
array
User logins with push access. Cannot be used with restrictions_apps or restrictions_teams. Empty list removes all.
boolean
Enforces linear commit history by preventing merge commits. Repository must allow squash or rebase merging.
array
List of status checks required to merge. Each check object needs a context string and optionally an app_id integer. Mutually exclusive with contexts - use one or the other, not both.
boolean
Require branches to be up to date with the base branch before merging; if True, merges are blocked if the head branch is behind the base branch.
boolean
Requires all conversations on code to be resolved before merging a pull request.
array
Deprecated: List of status check contexts required to merge. If set by a GitHub App, future checks must come from that app. Use checks for finer control. Mutually exclusive with checks - use one or the other, not both.
boolean
If True, new commits dismiss previous review approvals on a pull request branch.
integer
Number of approving reviews (0-6) required to merge a pull request; 0 disables.
array
App slugs allowed to bypass pull request requirements. Empty list removes all.
array
Team slugs allowed to bypass pull request requirements. Empty list removes all.
array
User logins allowed to bypass pull request requirements. Empty list removes all.
array
App slugs allowed to dismiss pull request reviews. Empty list removes all.
array
Team slugs allowed to dismiss pull request reviews. Empty list removes all.
array
User logins allowed to dismiss pull request reviews. Empty list removes all.
boolean
If True, pull requests affecting files with code owners must be reviewed by them.
boolean
If True, the most recent push must be approved by someone other than the pusher.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_CODE_SCANNING_DEFAULT_SETUPUpdates the default setup configuration for code scanning in a repository; GitHub Advanced Security must be enabled for the repository.

Input Parameters

string
required
Repository name (case-insensitive, without .git extension).
string
required
Account owner of the repository (case-insensitive).
string ("configured" | "not-configured")
Specifies whether to enable (‘configured’) or disable (‘not-configured’) code scanning default setup.
array
CodeQL languages for analysis; if omitted, all supported repository languages are analyzed.
string ("default" | "extended")
CodeQL query suite to be used (‘default’ for curated, ‘extended’ for comprehensive queries).
string ("standard" | "labeled" | "not_set")
Type of runner to use for code scanning. ‘standard’ uses GitHub-hosted runners, ‘labeled’ uses self-hosted runners with a specific label, ‘not_set’ resets to default.
string
Label of the self-hosted runner to use when runner_type is ‘labeled’. Ignored when runner_type is ‘standard’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_CODESPACEUpdates an existing GitHub Codespace’s machine type, display name, or recent folders for the authenticated user; machine type changes take effect on the next start.

Input Parameters

string
Target machine type for the codespace; must be valid and available for the user or organization.
string
New display name for the codespace.
string
required
The unique name of the codespace to be updated (e.g., ‘octocat-codespace-githu-org-name-abcdef12’).
array
Up to three recently opened folder paths (e.g., ‘/workspaces/project/src’) to suggest which folder to load upon opening.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_GIT_LFS_PREFERENCESets the Git Large File Storage (LFS) preference for a repository during a source import. NOTE: This endpoint has been deprecated by GitHub as of April 12, 2024, and is no longer available. The Source Imports REST API has been retired due to very low usage levels. Please use the GitHub Importer tool at https://github.com/new/import for repository imports.

Input Parameters

string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
string ("opt_in" | "opt_out")
required
Specifies whether to store large files using Git LFS during the import. opt_in enables Git LFS, storing large files. opt_out disables Git LFS, removing large files during the import.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_ISSUE_TYPEUpdate an existing issue type for a GitHub organization. Requires the authenticated user to be an organization administrator. OAuth tokens need admin:org scope.

Input Parameters

string
required
The organization name (case-insensitive).
string
required
The name of the issue type.
string ("gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple")
The color of the issue type.
boolean
required
Whether the issue type is enabled at the organization level.
string
A short description of the issue type.
integer
required
The unique identifier of the issue type to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_ORGANIZATION_WEBHOOK_CONFIGURATIONUpdates the configuration (URL, content type, secret, SSL verification) for an existing webhook within a specified organization.

Input Parameters

string
required
The organization name (not case-sensitive).
string
The URL to which the webhook payloads will be delivered.
string
Optional secret for HMAC hex digest in delivery signature headers.
integer
required
Unique identifier of the webhook (from X-GitHub-Hook-ID header of a delivery).
string
Media type for serializing payloads (json or form). Defaults to form.
string
Set to 1 to disable SSL certificate verification for the webhook URL, or 0 to enable. Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_PROJECT_CARDUpdates an existing project card’s note and/or archived status (GitHub Classic Projects). DEPRECATION NOTICE: GitHub Projects (classic) and its REST API were sunset on April 1, 2025. This action will return 404 for most requests on GitHub.com. However, it may still work on GitHub Enterprise Server instances where classic projects are enabled. For new projects, use GitHub Projects V2 which uses the GraphQL API instead. See: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/

Input Parameters

string
New note content (supports GitHub Flavored Markdown). Use empty string or null to clear the note. If omitted, the note remains unchanged.
integer
required
The unique identifier of the project card to be updated. This ID must correspond to an existing classic project card.
boolean
Archive status: true to archive the card, false to unarchive it. If omitted, the archived status remains unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_PROJECT_COLUMNUpdates the name of an existing column, identified by column_id, in a GitHub project (classic). DEPRECATION NOTICE: GitHub Classic Projects (V1) and its REST API were sunset on April 1, 2025. This action will return a 404 error on GitHub.com. For new projects, use GitHub Projects V2 which uses the GraphQL API instead. See: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/

Input Parameters

string
required
The new name for the project column.
integer
required
The unique identifier of the project column to be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_PULL_REQUEST_REVIEWUpdates the body text of an existing pull request review.

Input Parameters

string
required
The new body text for the pull request review. This will replace the existing review body.
string
required
The name of the repository, without the .git extension. This is case-insensitive.
string
required
The username of the account that owns the repository. This is case-insensitive.
integer
required
The unique identifier of the pull request review to be updated.
integer
required
The number that uniquely identifies the pull request within the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_PULL_REQUEST_REVIEW_COMMENTUpdates the body of an existing review comment on a pull request.

Input Parameters

string
required
The new text of the pull request review comment. Must be a non-empty string.
string
required
The name of the repository, without the .git extension. This field is not case-sensitive.
string
required
The username or organization name that owns the repository. This field is not case-sensitive.
integer
required
The unique identifier of the pull request review comment to be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_PULL_REQUEST_REVIEW_PROTECTIONUpdates pull request review protection settings for a branch, including required approvals, review dismissal, and bypass allowances. The last-push approval setting defaults to false and is sent even when omitted; branch protection features must be available for the repository.

Input Parameters

string
required
Repository name, without the .git extension (case-insensitive).
string
required
Account owner of the repository (case-insensitive).
string
required
Branch name for protection rules (no wildcards; use GraphQL API for wildcards).
boolean
If true, new commits dismiss previous approving reviews; false keeps approvals valid.
boolean
If true, pull requests affecting files with code owners require their review. See about code owners.
boolean
If true, the most recent push requires approval by someone other than the pusher (GitHub Enterprise feature).
array
App slugs permitted to dismiss pull request reviews. Empty list removes restrictions.
array
Team slugs permitted to dismiss pull request reviews. Empty list removes restrictions.
array
User logins permitted to dismiss pull request reviews. Empty list removes restrictions.
integer
Number of approving reviews (1-6) required for merging; 0 to disable.
array
App slugs allowed to bypass pull request requirements. Empty list removes allowances.
array
Team slugs allowed to bypass pull request requirements. Empty list removes allowances.
array
User logins allowed to bypass pull request requirements. Empty list removes allowances.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_REPOSITORY_PREFERENCES_FOR_CHECK_SUITESUpdates repository preferences for automatic Check Suite creation on code pushes, allowing configuration for specific GitHub Apps that must be installed on the repository with checks:write permission.

Input Parameters

string
required
The name of the repository, without the .git extension. The name is not case sensitive.
string
required
The account owner of the repository (e.g., username or organization). The name is not case sensitive.
string
A list of preference objects as a JSON string for configuring automatic CheckSuite creation for specific GitHub Apps. Each object in the list must contain an app_id (integer: the ID of the GitHub App) and a setting (boolean: true to enable automatic triggers for that app on code push, false to disable). Example: ’[{“app_id”: 12345, “setting”: true}]‘

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_REPOSITORY_WEBHOOK_CONFIGURATIONUpdates the configuration (e.g., payload URL, content type, secret, SSL verification) for an existing webhook in a specified repository.

Input Parameters

string
The URL to which webhook payloads will be delivered.
string
required
The name of the repository, without the .git extension (not case-sensitive).
string
required
The account owner of the repository (not case-sensitive).
string
Optional secret for generating an HMAC hex digest of the payload, included in the X-Hub-Signature-256 header to verify authenticity.
integer
required
Unique identifier of the webhook, typically found in the X-GitHub-Hook-ID header of a webhook delivery.
string
Media type for payload serialization (e.g., json, form). GitHub defaults to form if this field is not provided.
string
Specifies SSL certificate verification: ‘0’ for enabled (default behavior if omitted), ‘1’ for disabled (not recommended).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_RESOURCE_ACCESS_WITH_TOKENSRevokes organization access for the personal access tokens identified by pat_ids; this action must be performed by a GitHub App, and pat_ids must be valid and associated with the organization. AUTHENTICATION REQUIREMENT: This endpoint requires GitHub App authentication with ‘Personal access tokens’ organization permissions (write). Standard personal access tokens CANNOT use this endpoint. The GitHub App must also have access to the organization.

Input Parameters

string
required
Organization name (case-insensitive).
string ("revoke")
required
Operation to perform on the fine-grained personal access tokens, resulting in removal of their access.
array
required
Fine-grained personal access token IDs for which access will be revoked.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_STATUS_CHECK_PROTECTIONUpdates required status checks for a branch, optionally requiring it to be up-to-date before merging.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case-sensitive.
string
required
The account owner of the repository. This name is not case-sensitive.
string
required
The name of the branch (required, cannot be null or empty). Wildcard characters are not allowed. To use wildcard characters in branch names, please use the GraphQL API.
array
A list of status checks to require in order to merge into this branch. Each check object should have a context (string) and an optional app_id (integer). Example: [{"context": "continuous-integration/jenkins", "app_id": 12345}]
boolean
Specifies whether to require branches to be up to date before merging.
array
Deprecated: A list of status checks to require in order to merge into this branch. If any of these checks were recently set by a particular GitHub App, they will be required to come from that app in the future for the branch to merge. For more fine-grained control, use checks instead of contexts. Can be provided as a single string or a list of strings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_SUBSCRIPTIONTool to update notification subscription state for issues, pull requests, or discussions. Use when you need to subscribe, unsubscribe, or ignore notifications for a specific GitHub item.

Input Parameters

string ("SUBSCRIBED" | "UNSUBSCRIBED" | "IGNORED")
required
The new subscription state. SUBSCRIBED: receive notifications for all activity. UNSUBSCRIBED: stop receiving notifications. IGNORED: never receive notifications even when mentioned.
string
required
The Node ID of the subscribable object (issue, pull request, discussion, etc.) to modify. This is a global GraphQL ID, not a repository-local number.
string
A unique identifier for the client performing the mutation. Used for tracking and deduplication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_THE_AUTHENTICATED_USERUpdates the authenticated user’s GitHub profile; a new public email must be verified, and existing private emails remain private even if specified.

Input Parameters

string
The new short biography for the user. Provide null to clear the existing bio.
string
The new URL for the user’s blog. Provide null to clear the existing blog URL. For example, ‘https://github.blog’.
string
The new full name for the user. For example, ‘Mona Lisa Octocat’.
string
The user’s new publicly visible email address. This email must be verified on the user’s GitHub account. If the provided email is not verified or not set to public, the update for this field might be ignored.
string
The new company affiliation for the user. Provide null to clear the existing company. For example, ‘GitHub’.
boolean
Indicates whether the user is available for hire. Set to true if available, or false if not.
string
The new geographical location of the user. Provide null to clear the existing location. For example, ‘San Francisco’.
string
The user’s new Twitter username (without the leading ’@’). Provide null to clear the existing Twitter username. For example, ‘github’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_TOKEN_ORG_ACCESSRevokes a fine-grained personal access token’s access to a specified GitHub organization. This operation requires a GitHub App with the organization’s ‘Personal access tokens’ write permission; personal access tokens cannot call it. List the organization’s resource access tokens to find the token ID.

Input Parameters

string
required
The organization name (case-insensitive). The authenticated GitHub App must have ‘Personal access tokens’ organization permissions (write) for this organization.
string ("revoke")
The action to perform. Currently only ‘revoke’ is supported, which removes the token’s access to the organization.
integer
required
The unique numeric identifier of the fine-grained personal access token to revoke. Obtain this from the GITHUB_LIST_ORG_RESOURCE_ACCESS_TOKENS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_USER_LISTTool to update an existing GitHub user list. Use when you need to modify the name, description, or privacy settings of a user list.

Input Parameters

string
The new name for the user list. Only provide if you want to change the name.
string
required
The unique ID of the user list to update. This is the GraphQL node ID (e.g., ‘UL_kwDOCNqc1s4AbuJ8’).
boolean
Whether the list should be private. Set to true to make private, false to make public. Only provide if you want to change visibility.
string
The new description for the user list. Only provide if you want to change the description.
string
A unique identifier for the client performing the mutation. Used for idempotency and tracking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_USER_LISTS_FOR_ITEMTool to update which of the viewer’s lists an item belongs to on GitHub. Use when you need to add an item (repository, issue, pull request, etc.) to specific user lists or move it between lists.

Input Parameters

string
required
The global node ID of the item to add to the lists (e.g., ‘R_kgDOKl1DMA’ for a repository). This is the GraphQL global identifier returned by GitHub’s API.
array
required
The list of user list IDs that this item should belong to. The item will be added to these lists and removed from any other lists it previously belonged to.
string
A unique identifier for the client performing the mutation. This can be used to track the request.
array
Optional list of suggested list IDs to create and add this item to. These lists will be created if they don’t exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_USER_PROJECT_ITEMTool to update a field value for an item in a user’s GitHub ProjectV2. Use when you need to modify a field value of an existing project item.

Input Parameters

object
required
The value to set. Use {‘text’: ‘value’} for text fields, {‘number’: 123} for number fields, {‘singleSelectOptionId’: ‘option_id’} for single select, {‘date’: ‘2024-01-01’} for date fields, {‘iterationId’: ‘iteration_id’} for iteration fields.
string
required
The global node ID of the project item to update (e.g., ‘PVTI_lAHOCNqc1s4BN3oqzgldG_w’).
string
required
The global node ID of the field to update (e.g., ‘PVTSSF_lAHOCNqc1s4BN3oqzg8vTnA’).
string
required
The global node ID of the Project (e.g., ‘PVT_kwHOCNqc1s4BN3oq’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPDATE_USER_STATUSTool to update your status on GitHub. Use when you need to set or clear your GitHub profile status with an emoji, message, and availability indicator.

Input Parameters

string
The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., :rocket:, :smiley:. If omitted, any existing emoji will be cleared.
string
A short description of your current status. Maximum 80 characters. If omitted, any existing message will be cleared.
string
If set, the user status will not be shown after this date. Must be a valid ISO 8601 datetime string (e.g., 2024-12-31T23:59:59Z). If omitted, the status will persist indefinitely.
string
The global node ID of the organization whose members will be allowed to see the status. If omitted, the status will be publicly visible to everyone. Use this to limit status visibility to organization members only.
string
A unique identifier for the client performing the mutation. This value will be returned in the response and can be used for request tracking or idempotency.
boolean
Whether this status should indicate you are not fully available on GitHub (e.g., you are away or busy). When true, shows a busy indicator. Defaults to false if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPLOAD_RELEASE_ASSETTool to upload a binary asset to an existing GitHub release. Use when you need to attach files like installers or backups to a release programmatically.

Input Parameters

string
required
Repository name without the .git extension; not case sensitive.
object
required
Binary file to upload as the release asset.
string
Short description for the asset; displayed instead of filename.
string
required
Account owner of the repository; not case sensitive.
integer
required
Unique identifier of the release. The release must have a valid upload URL (i.e., not already finalized without one). Asset size must not exceed 2 GB.
string
required
Media type of the asset, for example ‘application/zip’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPLOAD_SARIF_ANALYSISUploads a gzipped and Base64 encoded SARIF file to a GitHub repository for a specific commit and reference; use checkout_uri if SARIF paths are absolute.

Input Parameters

string
required
The full Git reference for the analysis, formatted as refs/heads/<branch name>, refs/tags/<tag>, refs/pull/<number>/merge, or refs/pull/<number>/head.
string
required
The name of the repository, without the .git extension. This is case-insensitive.
string
required
The account owner of the repository. This is case-insensitive.
string
required
A Base64 encoded string of a gzipped SARIF file. For more information, see ‘SARIF support for code scanning’.
boolean
Specifies whether the uploaded SARIF file should be validated against the code scanning specifications. This is useful for integrators to ensure their SARIF files are correctly processed and rendered by GitHub.
string
Name of the tool that generated the analysis. GitHub defaults this to “API” if omitted. A tool GUID in the SARIF can be used for filtering alerts.
string
required
The SHA of the commit to which the analysis you are uploading relates. Must be a 40-character Git SHA.
string
The timestamp indicating when the analysis run began, in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
string
The base URI of the checkout directory as it appears in the SARIF file. This property is used to convert absolute file paths to relative paths, enabling alerts to be correctly mapped to their location in the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_UPSERT_REPO_CUSTOM_PROPERTY_VALUESCreates or updates up to 30 custom property values for a repository; custom properties must be predefined at the organization or repository level, and setting a property’s value to null removes it.

Input Parameters

string
required
The name of the repository, without the .git extension. This name is not case sensitive.
string
required
The account owner of the repository. This name is not case sensitive.
string
required
A list of custom property objects as a JSON string to create or update for the repository. Each object in the list must contain property_name (string identifying the custom property) and value (the value for the property, which can be a string, number, or a single-select option, matching the property’s defined type). Example: ’[{“property_name”: “environment”, “value”: “production”}]‘

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_VALIDATE_CREDENTIALChecks GitHub credentials using the authenticated-user endpoint and returns a validity flag and username when available. A 403 also returns valid=false and may indicate rate limiting or insufficient permissions rather than invalid credentials.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_VERIFY_DEV_CONTAINER_PERMISSIONS_ACCEPTEDVerifies if the authenticated user has accepted permissions for a specific devcontainer configuration in a repository, typically to ensure awareness before a codespace is created or used.

Input Parameters

string
required
Git reference (branch, tag, or commit SHA) for the devcontainer configuration.
string
required
Repository name, without .git extension (case-insensitive).
string
required
Username of the repository owner (case-insensitive).
string
required
Path to the devcontainer.json file in the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GITHUB_WHO_AM_IReturn the identity (login, name) of the connected GitHub account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: GITHUB_ARTIFACT_CREATED_TRIGGERType: pollTriggers when a new workflow artifact is created in a GitHub repository.Monitors for newly created GitHub Actions workflow artifacts. Optionally filters by artifact name to restrict monitoring to specific artifacts.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
Optional artifact name filter. When set, only artifacts whose name exactly matches this value will be reported. Leave blank to monitor all artifacts in the repository.
string
required
GitHub username or organisation that owns the repository (e.g. ‘octocat’ or ‘microsoft’).
string
required
Repository name without the .git extension (e.g. ‘Hello-World’ or ‘my-project’).

Payload

string
required
URL to download the artifact as a zip archive.
integer
required
Unique numeric identifier of the newly created artifact.
string
required
ISO 8601 timestamp of when the artifact was created.
string
SHA-256 digest of the artifact (only present for artifacts uploaded with upload-artifact v4 or later).
string
Type of event that occurred.
boolean
required
Whether the artifact has expired and is no longer available.
string
required
ISO 8601 timestamp of when the artifact will expire.
string
required
Name of the artifact.
string
required
GraphQL node ID of the artifact.
string
required
Owner of the repository.
string
required
Repository name.
integer
required
Size of the artifact in bytes.
string
required
ISO 8601 timestamp of when the artifact was last updated.
string
required
API URL for the artifact.
object
Metadata about the workflow run that produced the artifact.
Slug: GITHUB_BRANCH_CHANGED_TRIGGERType: pollTriggers when a GitHub branch changes.Monitors a specific branch for:
  • New commits pushed (head commit SHA changes)
  • Protection status toggled (branch becomes protected or unprotected)
  • Protection settings changed, including: required status checks and their enforcement level, admin enforcement, required pull request reviews (dismiss stale reviews, code owner reviews, approving review count, last push approval), required linear history, force push allowance, deletion allowance, conversation resolution, branch locking, and fork syncing.

Configuration

string
required
The exact name of the branch to monitor (e.g. ‘main’ or ‘develop’). The name is case-sensitive and must match exactly what is shown in the repository.
number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
GitHub username or organisation that owns the repository (e.g. ‘octocat’ or ‘microsoft’).
string
required
Repository name without the .git extension (e.g. ‘Hello-World’ or ‘my-service’).

Payload

string
required
Name of the monitored branch.
array
required
Names of the top-level fields that changed.
object
required
Snapshot of the branch’s tracked fields after the change.
string
Type of event that occurred.
string
required
The current head commit SHA of the branch.
string
required
Owner of the repository.
object
required
Snapshot of the branch’s tracked fields before the change.
boolean
required
Whether the branch is currently protected.
string
required
Repository name.
Slug: GITHUB_BRANCH_CREATED_TRIGGERType: pollTriggers when a new branch is created in a GitHub repository.Detects newly created branches. Deleted branches do not fire events.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
The account owner of the repository (GitHub username or organization name). Must contain only alphanumeric characters and hyphens, max 39 characters.
string
required
The name of the repository without the .git extension. Must contain only alphanumeric characters, hyphens, underscores, and periods.

Payload

string
required
SHA of the HEAD commit on the new branch.
string
required
GitHub REST API URL for the HEAD commit on the new branch.
string
required
The name of the newly created branch.
boolean
required
Whether the branch has branch-protection rules enabled.
string
required
Name of the repository the branch belongs to.
string
required
GitHub username or organization that owns the repository.
Slug: GITHUB_CHECK_RUN_STATUS_CHANGED_TRIGGERType: pollTriggers when a specific GitHub check run changes its status or conclusion.Monitors a single check run for changes to: status (queued, in_progress, completed, etc.), conclusion (success, failure, neutral, cancelled, skipped, timed_out, action_required), started_at, and completed_at.

Configuration

integer
required
The unique numeric identifier of the check run to monitor. You can obtain it from the check runs list API or from the CI/checks page in the GitHub UI.
number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
The account owner of the repository (username or organization name). Case-insensitive. Must contain only alphanumeric characters and hyphens.
string
required
The name of the repository without the .git extension. Case-insensitive.

Payload

object
GitHub App that created the check run.
array
List of field names that changed since the last poll.
integer
The ID of the check suite this check run belongs to.
string
ISO 8601 timestamp when the check run completed.
string
The conclusion of a completed check run: success, failure, neutral, cancelled, skipped, timed_out, or action_required.
string
URL providing detailed information about the check run.
string
The external identifier for the check run set by the integrator.
string
required
The SHA of the commit this check run targets.
string
The GitHub URL to view this check run.
integer
required
The unique numeric ID of the check run.
string
required
The name of the check run.
string
The GraphQL node ID of the check run.
object
Output details for a GitHub check run.
object
Previous string-serialized values of the changed fields.
string
required
The name of the repository the check run belongs to.
string
required
The owner of the repository the check run belongs to.
string
ISO 8601 timestamp when the check run started.
string
The current status of the check run: queued, in_progress, completed, waiting, requested, or pending.
string
required
The REST API URL for this check run.
Slug: GITHUB_CHECK_SUITE_STATUS_CHANGED_TRIGGERType: pollTriggers when a GitHub check suite changes its status or conclusion for a given ref.Monitors all check suites associated with a git reference (branch, tag, or commit SHA) for changes to status (queued, in_progress, completed, etc.) and conclusion (success, failure, neutral, cancelled, skipped, timed_out, action_required, startup_failure, stale). Optionally filters by GitHub App ID.

Configuration

integer
Optional: Filters check suites by GitHub App ID. Only monitor check suites created by this specific app. If omitted, all check suites for the ref are monitored.
number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
The account owner of the repository (username or organization name). Case-insensitive. Must contain only alphanumeric characters and hyphens.
string
required
The git reference (branch name, tag name, or commit SHA) to monitor check suites for. For example, ‘main’, ‘v1.0.0’, or a full commit SHA.
string
required
The name of the repository without the .git extension. Case-insensitive.

Payload

object
GitHub App associated with a check suite.
array
List of field names that changed since the last poll.
string
The API URL to retrieve the check runs in this suite.
string
The overall conclusion of the completed check suite: success, failure, neutral, cancelled, skipped, timed_out, action_required, startup_failure, or stale. Null if not yet completed.
string
ISO 8601 timestamp when this check suite was created.
string
The branch name the check suite belongs to.
string
required
The SHA of the head commit being checked.
integer
required
The unique numeric ID of the check suite.
integer
The number of check runs in this check suite.
string
The GraphQL node ID of the check suite.
object
Previous string-serialized values of the changed fields.
string
required
The git reference (branch/tag/SHA) that was monitored.
string
required
The name of the repository this check suite belongs to.
string
required
The owner of the repository this check suite belongs to.
string
The current phase of the check suite lifecycle: queued, in_progress, completed, waiting, requested, or pending.
string
ISO 8601 timestamp when this check suite was last updated.
string
The REST API URL for this check suite.
Slug: GITHUB_CODE_SCANNING_ALERT_CREATED_TRIGGERType: pollTriggers when a new code scanning alert is created in a repository.Fires an event for each newly created code scanning alert detected in the configured repository. Alerts can be filtered by Git reference, scanning tool, state, and severity. The payload includes the alert number, rule details, tool information, state, severity, and the location of the most recent instance.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
The account owner of the repository (GitHub username or organization name). The name is not case sensitive.
string
Optional Git reference to filter alerts by. For a branch use ‘refs/heads/<branch name>’ or just the branch name. For a pull request use ‘refs/pull/<number>/merge’. Leave empty to get alerts across all refs (default branch).
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
Optional filter by alert severity. Possible values: ‘critical’, ‘high’, ‘medium’, ‘low’, ‘warning’, ‘note’, ‘error’. Leave empty to include alerts of all severities.
string
Optional filter by alert state. Possible values: ‘open’, ‘closed’, ‘dismissed’, ‘fixed’. Leave empty to include alerts in all states.
string
Optional name of a code scanning tool to filter alerts by (e.g. ‘CodeQL’, ‘Semgrep’). Leave empty to include alerts from all tools.

Payload

integer
required
The unique sequential number identifying the alert within the repository.
string
The REST API URL of the alert resource.
string
ISO 8601 timestamp when the alert was created.
string
ISO 8601 timestamp when the alert was dismissed. Null if not dismissed.
string
Reason for dismissal: ‘false positive’, “won’t fix”, or ‘used in tests’.
string
ISO 8601 timestamp when the alert was fixed. Null if not fixed.
string
The GitHub web URL of the alert.
string
REST API URL to retrieve all instances of this alert.
string
Commit SHA where the most recent instance was detected.
string
Description of the vulnerability from the most recent instance.
string
File path of the most recent instance location.
string
The Git ref where the most recent instance was detected.
integer
Start line of the most recent instance location.
string
State of the most recent instance: ‘open’, ‘dismissed’, or ‘fixed’.
string
required
The name of the repository.
string
required
The GitHub username or organization that owns the repository.
object
The rule that triggered the code scanning alert.
string
Current state of the alert: ‘open’, ‘closed’, ‘dismissed’, or ‘fixed’.
object
The code scanning tool that generated the alert.
string
ISO 8601 timestamp when the alert was last updated.
Slug: GITHUB_COLLABORATOR_ADDED_TRIGGERType: pollTriggers when a new collaborator is added to a GitHub repository.Monitors the full list of collaborators on a repository and fires an event for each newly added collaborator. The payload includes the collaborator’s GitHub username, account ID, profile URL, avatar URL, permission flags (pull, triage, push, maintain, admin), and assigned role name.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
The account owner of the repository (username or organization name). Must contain only alphanumeric characters and hyphens, max 39 characters.
string
required
The name of the repository without the .git extension. Must contain only alphanumeric characters, hyphens, underscores, and periods.

Payload

string
required
URL of the collaborator’s avatar image.
string
required
GitHub profile URL of the collaborator.
integer
required
The unique numeric ID of the collaborator’s GitHub account.
string
required
The GitHub username of the new collaborator.
string
required
GraphQL global node identifier for the collaborator.
object
required
Permission flags granted to the collaborator on this repository.
string
required
The name of the repository.
string
required
The owner of the repository.
string
required
The role name assigned to the collaborator (e.g., ‘admin’, ‘maintain’, ‘write’, ‘triage’, ‘read’).
boolean
required
Whether the collaborator is a GitHub site administrator.
string
required
The type of GitHub account (e.g., ‘User’, ‘Organization’).
string
required
REST API URL for the collaborator’s user resource.
Slug: GITHUB_COMMIT_EVENTType: webhookTriggered when a new commit is pushed to a repository.

Configuration

string
required
Owner of the repository
string
required
Repository name

Payload

string
required
The GitHub username of the commit author
string
required
The SHA of the commit
string
required
The commit message
string
required
The timestamp of the commit
string
required
The GitHub URL of the commit
Slug: GITHUB_DEPLOYMENT_CREATED_TRIGGERType: pollTriggers when a new deployment is created in a GitHub repository.Fires an event for each newly created deployment detected in the configured repository. Deployments can optionally be filtered by target environment. The payload includes the deployment ID, commit SHA, ref, task, environment, creator details, and timestamps.

Configuration

string
Optional filter: only fire for deployments targeting this environment (e.g. ‘production’, ‘staging’, ‘Preview’). Leave empty to receive events for all environments.
number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
GitHub username or organisation that owns the repository (e.g. ‘octocat’ or ‘microsoft’).
string
required
Repository name without the .git extension (e.g. ‘Hello-World’ or ‘vscode’).

Payload

string
required
ISO 8601 timestamp when the deployment was created.
integer
required
Numeric ID of the creator.
string
required
GitHub login of the user or bot that created the deployment.
string
required
Account type of the creator (e.g. ‘User’, ‘Bot’).
integer
required
Unique numeric identifier for the deployment.
string
A short description of the deployment.
string
required
The name of the environment the deployment targets (e.g. ‘production’).
string
Type of event that occurred.
string
required
Global Node ID for the deployment.
string
required
The original environment of the deployment before any overrides.
string
required
Owner of the repository.
boolean
required
Whether this deployment targets the production environment.
string
required
The short ref name or full SHA of the deployment’s target.
string
required
Repository name.
string
required
API URL for the repository the deployment belongs to.
string
required
The SHA of the commit that was deployed.
string
required
API URL to list deployment statuses.
string
required
The name of the task that was used for the deployment (e.g. ‘deploy’).
boolean
required
Whether this is a transient environment (destroyed on inactivity).
string
required
ISO 8601 timestamp when the deployment was last updated.
string
required
API URL for this deployment resource.
Slug: GITHUB_DEPLOYMENT_STATE_CHANGED_TRIGGERType: pollTriggers when a specific GitHub deployment’s fields change.Monitors the following aspects of a single deployment:
  • environment — the target environment name
  • original_environment — the original environment name before normalization
  • description — the human-readable deployment description
  • task — the deployment task name
  • sha — the commit SHA being deployed
  • ref — the branch, tag, or SHA reference being deployed
  • updated_at — the last-updated timestamp
  • transient_environment — whether the environment is temporary
  • production_environment — whether this is a production deployment
When any of these fields change, an event is emitted containing the full current deployment details and a list of which fields changed.

Configuration

integer
required
The unique numeric identifier of the deployment to monitor. Obtain this from the deployments listing endpoint GET /repos/{owner}/{repo}/deployments or from your CI/CD output.
number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
GitHub username or organisation that owns the repository (e.g. ‘octocat’ or ‘my-company’).
string
required
Repository name without the .git extension (e.g. ‘Hello-World’ or ‘my-project’).

Payload

array
required
List of field names that changed since the previous poll. Possible values: ‘environment’, ‘original_environment’, ‘description’, ‘task’, ‘sha’, ‘ref’, ‘updated_at’, ‘transient_environment’, ‘production_environment’. Use this to route your automation — for example, alert only when ‘environment’ changes to detect environment promotions.
string
ISO 8601 timestamp when the deployment was created.
object
Minimal details about the user or bot that created the deployment.
object
The canonicalised snapshot from the current poll.
integer
required
Numeric ID of the deployment that changed.
string
Optional human-readable description of the deployment.
string
Target environment name (e.g. ‘production’, ‘staging’).
string
Event type identifier.
string
GraphQL node ID of the deployment.
string
Original environment name before any normalization.
string
required
Owner of the repository.
object
The canonicalised snapshot from the previous poll.
boolean
Whether this is a production environment deployment.
string
The ref (branch, tag, or SHA) that was deployed.
string
required
Repository name.
string
API URL for the repository.
string
Commit SHA that was deployed.
string
API URL for the deployment’s status history.
string
Deployment task name (e.g. ‘deploy’).
boolean
Whether the environment is temporary (e.g. for PR previews).
string
ISO 8601 timestamp when the deployment was last updated.
string
API URL of the deployment resource.
Slug: GITHUB_DEPLOYMENT_STATUS_CREATEDType: pollTriggers when a new deployment status is created for a specific deployment.Fires an event for each newly created deployment status on the monitored deployment. Deployment statuses represent state transitions such as pending, in_progress, success, failure, error, inactive, and queued. The payload includes the status state, creator, environment, description, timestamps, and relevant URLs.

Configuration

integer
required
The unique numeric ID of the deployment to monitor for new statuses.
number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
The account owner (user or organization) of the repository.
string
required
The name of the repository (without .git extension).

Payload

string
required
ISO 8601 timestamp when the deployment status was created.
object
required
The user or bot who created this deployment status.
integer
required
The ID of the deployment this status belongs to.
string
required
API URL for the associated deployment.
string
A short description of the status (max 140 characters).
string
The environment this deployment status targets.
string
The URL for accessing the deployment environment.
string
Event type identifier for this trigger.
integer
required
Unique numeric ID of the deployment status.
string
The URL to view the full output from the deployment.
string
required
GraphQL node identifier for the deployment status.
string
required
The name of the repository.
string
required
The owner of the repository.
string
required
API URL for the repository this deployment status belongs to.
string
required
The state of the deployment status. One of: error, failure, inactive, pending, success, queued, in_progress.
string
The target URL associated with this status, typically pointing to the deployment output or logs.
string
required
ISO 8601 timestamp when the deployment status was last updated.
string
required
API URL for this deployment status resource.
Slug: GITHUB_FOLLOWER_EVENTType: pollTriggers when new followers are detected on your GitHub account.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.

Payload

string
required
Username of the github follower
Slug: GITHUB_GIT_REFERENCE_CREATED_TRIGGERType: pollTriggers when a new Git reference (branch or tag) matching a specified prefix is created in a repository.Fires an event for each newly created branch or tag whose name matches the configured prefix. Use ref_prefix to control what is monitored:
  • heads/ to watch all branches
  • heads/feature/ to watch only feature branches
  • tags/ to watch all tags
  • tags/v to watch tags starting with ‘v’
The payload includes the full reference name, node ID, the SHA and type of the Git object the reference points to, and the reference API URL.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
GitHub username or organisation that owns the repository (e.g. ‘octocat’ or ‘microsoft’).
string
required
Partial Git reference path prefix to match, without the ‘refs/’ prefix. Use ‘heads/’ to match branches (e.g. ‘heads/feature/’) or ‘tags/’ to match tags (e.g. ‘tags/v’). Only references whose full name starts with ‘refs/{ref_prefix}’ will be monitored.
string
required
Repository name without the .git extension (e.g. ‘Hello-World’ or ‘my-project’).

Payload

string
Type of event that occurred.
string
required
The global node ID for the reference.
string
required
The SHA-1 hash of the Git object this reference points to.
string
required
The type of Git object (typically ‘commit’).
string
required
The API URL for the referenced Git object.
string
required
Owner of the repository.
string
required
The full Git reference name (e.g. ‘refs/heads/feature-a’ or ‘refs/tags/v1.0’).
string
required
The API URL for accessing this reference.
string
required
Repository name.
Slug: GITHUB_ISSUE_ADDED_EVENTType: webhookTriggered when a new issue is added to the repository.

Configuration

string
required
Owner of the repository
string
required
Repository name

Payload

string
required
The action that was performed on the issue
string
required
The timestamp when the issue was created
string
required
The GitHub username of the user who created the issue
string
A detailed description of the issue
integer
required
The unique ID assigned to the issue
integer
required
The unique number assigned to the issue
string
required
The title of the issue
string
required
The GitHub URL of the issue
Slug: GITHUB_ISSUE_ASSIGNED_TO_ME_TRIGGERType: pollTriggers when a new issue is assigned to the authenticated user.Fires an event for each GitHub issue that is newly assigned to the authenticated user. Pull requests are automatically excluded — only true issues are emitted. Issues can optionally be filtered by labels and state. The payload includes the issue number, title, body, state, labels, assignees, creator, repository details, and timestamps.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
A comma-separated list of label names to filter issues by. Only issues with ALL the specified labels will trigger events. Leave empty to receive all newly assigned issues regardless of labels.
string
Filter issues by state. Use ‘open’ to only receive open issues, ‘closed’ for closed issues, or ‘all’ for both.

Payload

array
GitHub users assigned to this issue.
string
The body text / description of the issue.
string
ISO 8601 timestamp when the issue was closed, if applicable.
integer
required
Number of comments on the issue.
string
required
ISO 8601 timestamp when the issue was created.
string
required
The GitHub URL to view this issue.
integer
required
The unique numeric ID of the issue.
array
Labels attached to the issue.
integer
required
The issue number within the repository.
object
Minimal repository information attached to an issue.
string
required
The state of the issue: ‘open’ or ‘closed’.
string
required
The title of the issue.
string
required
ISO 8601 timestamp when the issue was last updated.
string
required
The REST API URL for this issue.
object
required
The user who created the issue.
Slug: GITHUB_ISSUE_COMMENT_CHANGED_TRIGGERType: pollTriggers when a specific GitHub issue comment changes.Monitors the following fields for changes:
  • body — the text content of the comment (detects edits)
  • updated_at — the last-updated timestamp
  • reactions_* — all individual reaction counts (thumbs up/down, laugh, confused, heart, hooray, eyes, rocket) and the total count
When a change is detected, the payload includes the full current comment data plus a changed_fields list indicating exactly which fields were modified.

Configuration

integer
required
The unique numeric identifier of the issue comment to monitor. You can obtain this from the comment’s URL or via the GitHub API.
number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
GitHub username or organisation that owns the repository (e.g. ‘octocat’ or ‘microsoft’).
string
required
Repository name without the .git extension (e.g. ‘Hello-World’ or ‘vscode’).

Payload

string
required
How the author is associated with the repository. Possible values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER.
string
required
Current body (text) of the issue comment.
array
required
List of canonicalised field names that changed since the previous poll. Possible values: ‘body’, ‘updated_at’, ‘reactions_total_count’, ‘reactions_plus_one’, ‘reactions_minus_one’, ‘reactions_laugh’, ‘reactions_confused’, ‘reactions_heart’, ‘reactions_hooray’, ‘reactions_eyes’, ‘reactions_rocket’.
integer
required
Unique numeric ID of the issue comment.
string
required
ISO 8601 timestamp when the comment was created.
object
The canonicalised snapshot from the current poll.
string
Event type identifier.
string
required
Web URL to view the comment on GitHub.
string
required
GitHub API URL for the parent issue.
string
required
GraphQL node identifier of the comment.
string
required
Owner of the repository.
object
The canonicalised snapshot from the previous poll.
object
Reaction counts for the issue comment.
string
required
Repository name.
string
required
ISO 8601 timestamp when the comment was last updated.
string
required
GitHub API URL for the issue comment.
object
Condensed representation of the comment author.
Slug: GITHUB_ISSUE_COMMENT_CREATED_TRIGGERType: pollTriggers when a new comment is added to a specific GitHub issue.Only genuinely new comments are emitted; edits to existing comments do not produce duplicate events. The payload includes the comment ID, text body, author details, timestamps, and direct links to the comment on GitHub.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
integer
required
The number that identifies the issue to monitor for new comments (e.g. 42). You can find it in the issue URL (github.com/owner/repo/issues/42).
string
required
GitHub username or organisation that owns the repository (e.g. ‘octocat’ or ‘microsoft’).
string
required
Repository name without the .git extension (e.g. ‘Hello-World’ or ‘vscode’).

Payload

string
required
The comment author’s relationship to the repository. Possible values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER.
string
required
The text content of the comment.
integer
required
Unique identifier of the issue comment.
string
required
ISO 8601 timestamp when the comment was created.
string
required
Web URL to view the comment on GitHub.
integer
required
The issue number this comment belongs to.
string
required
GitHub API URL for the parent issue.
string
required
GraphQL node ID of the comment.
string
required
Owner of the repository.
string
required
Repository name.
string
required
ISO 8601 timestamp when the comment was last updated.
string
required
GitHub API URL for the comment.
object
GitHub user information associated with a comment.
Slug: GITHUB_ISSUE_CREATED_TRIGGERType: pollTriggers when a new issue is created in a GitHub repository.Pull requests are automatically excluded — only true issues produce events. Results can be filtered by labels, assignee, creator, and mentioned user.The payload includes the issue number, title, body, state, labels, assignees, comment count, creator details, timestamps, and direct links to the issue on GitHub.

Configuration

string
Filter issues assigned to a specific GitHub username. Use ‘none’ for unassigned issues, ’*’ for any assigned issue. Leave empty to receive issues regardless of assignee.
string
Filter issues created by a specific GitHub username. Leave empty to receive issues from any creator.
number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
A comma-separated list of label names to filter issues by. Only issues with ALL the specified labels will trigger events. Leave empty to receive all new issues regardless of labels.
string
Filter issues where the given GitHub username is mentioned. Leave empty to receive all new issues.
string
required
The account owner of the repository (username or organization name). Must contain only alphanumeric characters and hyphens, max 39 characters.
string
required
The name of the repository without the .git extension. Must contain only alphanumeric characters, hyphens, underscores, and periods.
string
Issue state to monitor: ‘open’, ‘closed’, or ‘all’. Defaults to ‘open’.

Payload

array
GitHub users assigned to this issue.
string
The body text / description of the issue.
string
ISO 8601 timestamp when the issue was closed, if applicable.
integer
required
Number of comments on the issue.
string
required
ISO 8601 timestamp when the issue was created.
string
required
The GitHub URL to view this issue.
integer
required
The unique numeric ID of the issue.
boolean
True if this item is actually a pull request. GitHub’s issues API also returns pull requests; this flag distinguishes them.
array
Labels attached to the issue.
integer
required
The issue number within the repository.
string
required
The name of the repository the issue belongs to.
string
required
The owner of the repository the issue belongs to.
string
required
The state of the issue: ‘open’ or ‘closed’.
string
required
The title of the issue.
string
required
ISO 8601 timestamp when the issue was last updated.
string
required
The REST API URL for this issue.
object
required
The user who created the issue.
Slug: GITHUB_ISSUE_EVENT_OCCURRED_TRIGGERType: pollTriggers when a new issue event occurs in a GitHub repository.Covers all issue timeline events such as issues being closed, reopened, assigned, unassigned, labeled, unlabeled, milestoned, demilestoned, renamed, locked, or unlocked. Events can optionally be filtered by type.The payload includes the event type, timestamp, the actor who triggered the event, the affected issue details, and any associated commit references.

Configuration

string
Comma-separated list of event types to filter (e.g., ‘closed,labeled,assigned’). Leave empty to receive all issue events. Common values: closed, reopened, assigned, unassigned, labeled, unlabeled, milestoned, demilestoned, renamed, locked, unlocked.
number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
The account owner of the repository (username or organization name). Must contain only alphanumeric characters and hyphens, max 39 characters.
string
required
The name of the repository without the .git extension. Must contain only alphanumeric characters, hyphens, underscores, and periods.

Payload

object
Minimal GitHub user information for the event actor.
string
SHA of the commit that referenced this issue, if applicable.
string
API URL for the associated commit, if applicable.
string
required
ISO 8601 timestamp when the event was created.
string
required
The type of event (e.g., closed, reopened, assigned, unassigned, labeled, unlabeled, milestoned, demilestoned, renamed, locked, unlocked).
integer
required
The unique numeric ID of the issue event.
object
Minimal issue information embedded in the event.
string
required
GraphQL global node identifier of the event.
string
required
The name of the repository the event belongs to.
string
required
The owner of the repository the event belongs to.
string
required
The REST API URL for this event.
Slug: GITHUB_ISSUE_LABEL_CHANGED_TRIGGERType: pollTriggers when the labels on a specific GitHub issue change.Fires whenever a label is added to, removed from, or has its metadata (color, description) modified on the monitored issue. The payload includes:
  • current_labels — the full set of labels currently on the issue
  • added_labels — labels that were newly added
  • removed_label_names — names of labels that were removed
  • changed_label_names — labels whose metadata changed without being added or removed

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
integer
required
The unique number of the GitHub issue to monitor for label changes. You can find this number in the issue’s URL: https://github.com/&#123;owner&#125;/&#123;repo&#125;/issues/&#123;issue_number&#125;
string
required
The account owner of the repository (username or organization name). This is not case-sensitive. For example: ‘octocat’ or ‘my-organization’.
string
required
The name of the repository without the .git extension. This is not case-sensitive.

Payload

array
Labels that were added to the issue since the previous poll.
array
Names of labels whose metadata (color, description) changed since the previous poll without being added/removed.
array
The full current set of labels on the issue after the change.
string
Event type identifier.
integer
required
The number of the issue whose labels changed.
string
required
The account owner of the repository (username or org).
array
Names of labels that were removed from the issue since the previous poll.
string
required
The repository name.
Slug: GITHUB_ISSUE_STATE_CHANGED_TRIGGERType: pollTriggers when a specific GitHub issue changes any of its tracked properties.Monitored properties: state (open/closed), state_reason, title, body, assignees, labels, milestone, lock status, active_lock_reason, comment count, and closed_at timestamp.When a change is detected, the payload includes the full current issue details, the list of changed field names, and their previous values.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
integer
required
The identifying number of the issue to monitor. This is the number shown next to the issue title (e.g., #42) or visible in the issue URL.
string
required
The account owner of the repository (username or organization name). Must contain only alphanumeric characters and hyphens, max 39 characters.
string
required
The name of the repository without the .git extension. Must contain only alphanumeric characters, hyphens, underscores, and periods.

Payload

string
The reason the issue is locked, if locked.
array
GitHub users currently assigned to this issue.
string
The current body text / description of the issue.
array
List of field names that changed since the last poll.
string
ISO 8601 timestamp when the issue was closed, if applicable.
integer
required
Number of comments on the issue.
string
required
ISO 8601 timestamp when the issue was created.
string
required
The GitHub URL to view this issue.
integer
required
The unique numeric ID of the issue.
array
Labels currently attached to the issue.
boolean
required
Whether the issue is locked.
integer
required
The issue number within the repository.
object
Previous string-serialized values of the changed fields.
string
required
The name of the repository the issue belongs to.
string
required
The owner of the repository the issue belongs to.
string
required
The current state of the issue: ‘open’ or ‘closed’.
string
The reason for the current state. Possible values: completed, reopened, not_planned, duplicate, or null.
string
required
The current title of the issue.
string
required
ISO 8601 timestamp when the issue was last updated.
string
required
The REST API URL for this issue.
object
required
The user who created the issue.
Slug: GITHUB_ISSUE_UPDATED_TRIGGERType: pollTriggers when an existing issue is updated in a GitHub repository.Monitors issues for any changes such as title edits, body edits, label changes, assignee changes, state transitions (opening, closing, reopening), milestone updates, and comment additions. Only pre-existing issues that receive updates are emitted; newly created issues are excluded. Pull requests are also excluded — only true issues fire events.

Configuration

string
Filter issues assigned to a specific GitHub username. Use ‘none’ for unassigned issues, ’*’ for any assigned issue. Leave empty to receive issues regardless of assignee.
number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
A comma-separated list of label names to filter issues by. Only issues with ALL the specified labels will trigger events. Leave empty to receive events for all issues regardless of labels.
string
required
The account owner of the repository (username or organization name). Must contain only alphanumeric characters and hyphens, max 39 characters.
string
required
The name of the repository without the .git extension. Must contain only alphanumeric characters, hyphens, underscores, and periods.
string
Filter by issue state. Use ‘open’ for open issues only, ‘closed’ for closed issues, or ‘all’ for both. Defaults to ‘all’ so updates to any issue (e.g., closing an issue) are captured.

Payload

array
GitHub users assigned to this issue.
string
The body text / description of the issue.
string
ISO 8601 timestamp when the issue was closed, if applicable.
integer
required
Number of comments on the issue.
string
required
ISO 8601 timestamp when the issue was created.
string
required
The GitHub URL to view this issue.
integer
required
The unique numeric ID of the issue.
array
Labels attached to the issue.
integer
required
The issue number within the repository.
string
required
The name of the repository the issue belongs to.
string
required
The owner of the repository the issue belongs to.
string
required
The state of the issue: ‘open’ or ‘closed’.
string
Reason for the current state (completed, not_planned, reopened, or null).
string
required
The title of the issue.
string
required
ISO 8601 timestamp when the issue was last updated.
string
required
The REST API URL for this issue.
object
required
The user who created the issue.
Slug: GITHUB_LABEL_ADDED_EVENTType: webhookTriggered when a new label is added to a pull request.

Configuration

string
required
Owner of the repository
string
required
Repository name

Payload

string
required
The action that was performed on the label
string
required
The name of the label that was added
string
required
The timestamp when the label was added
string
required
The GitHub username of the user who added the label
integer
required
The unique number assigned to the pull request
string
required
The title of the pull request
string
required
The GitHub URL of the pull request
Slug: GITHUB_NEW_STARGAZER_ADDED_TRIGGERType: pollTriggers when a new user stars a GitHub repository.Emits an event for each new stargazer detected on the monitored repository.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
GitHub username or organisation that owns the repository (e.g. ‘octocat’ or ‘microsoft’).
string
required
Repository name without the .git extension (e.g. ‘Hello-World’ or ‘vscode’).

Payload

string
required
GitHub API URL for the stargazer’s user resource.
string
required
URL to the stargazer’s avatar image.
string
Type of event that occurred.
string
required
GitHub profile URL of the stargazer.
string
required
GitHub username of the user who starred the repository.
string
required
Owner of the repository.
string
required
Repository name.
boolean
required
Whether the stargazer is a GitHub site administrator.
integer
required
Unique numeric identifier for the user who starred the repository.
string
required
Type of the GitHub account (e.g. ‘User’ or ‘Organization’).
Slug: GITHUB_PR_REVIEW_COMMENT_CREATED_TRIGGERType: pollTriggers when a new inline review comment is added to a specific GitHub pull request.Monitors all review comments across all reviews on the specified pull request and emits an event for each newly created comment. Edits to existing comments do not fire new events.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
GitHub username or organisation that owns the repository (e.g. ‘octocat’ or ‘microsoft’).
integer
required
The number that identifies the pull request to monitor (e.g. 42). You can find it in the PR URL (github.com/owner/repo/pull/42).
string
required
Repository name without the .git extension (e.g. ‘Hello-World’ or ‘vscode’).

Payload

string
required
The comment author’s relationship to the repository. Possible values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER.
string
required
The text content of the review comment.
integer
required
Unique identifier of the review comment.
string
required
The SHA of the commit to which the comment applies.
string
required
ISO 8601 timestamp when the comment was created.
string
required
The diff hunk of the file that the comment refers to.
string
required
Web URL to view the comment on GitHub.
integer
The comment ID this comment replies to, if any.
integer
The line of the blob to which the comment applies. The last line of the range for a multi-line comment.
string
required
GraphQL node ID of the comment.
string
required
The SHA of the original commit to which the comment applies.
integer
The original line index in the diff.
integer
The original first line of the range for a multi-line comment.
string
required
Owner of the repository.
string
required
The relative path of the file to which the comment applies.
integer
required
The pull request number this comment belongs to.
integer
The ID of the pull request review the comment belongs to, if any.
string
required
GitHub API URL for the parent pull request.
string
required
Repository name.
string
The side of the diff to which the comment applies (LEFT or RIGHT).
integer
The first line of the range for a multi-line comment.
string
The side of the diff where the multi-line comment range starts (LEFT or RIGHT).
string
The level at which the comment is targeted: ‘line’ or ‘file’.
string
required
ISO 8601 timestamp when the comment was last updated.
string
required
GitHub API URL for the review comment.
object
GitHub user information associated with a pull request review comment.
Slug: GITHUB_PULL_REQUEST_COMMIT_ADDED_TRIGGERType: pollTriggers when a new commit is pushed to a specific pull request.Monitors all commits on the specified pull request and emits an event for each newly added commit. This covers force-pushes and additional commits pushed to the PR’s head branch.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
The account owner of the repository (username or organization name). Case-insensitive.
integer
required
The number of the pull request to monitor for new commits.
string
required
The name of the repository without the .git extension. Case-insensitive.

Payload

object
Minimal GitHub user info (author or committer).
string
API URL for comments on this commit.
object
Detailed metadata embedded in the commit object.
object
Minimal GitHub user info (author or committer).
string
GitHub URL to view the commit.
string
The GraphQL node ID of the commit.
array
Parent commits of this commit.
integer
required
The pull request number this commit belongs to.
string
required
The name of the repository (from config).
string
required
The owner of the repository (from config).
string
required
The commit SHA.
string
API URL for this commit.
Slug: GITHUB_PULL_REQUEST_CREATEDType: pollTriggers when a new pull request is created in GitHub, matching the optional configured filters.Emits an event for each newly created pull request. Supports filtering by repository, owner/organisation, author, assignee, label, state, base branch, head branch, and draft status.

Configuration

string
Only emit events for pull requests assigned to this GitHub username. Use ‘@me’ to match the authenticated user.
string
Only emit events for pull requests created by this GitHub username. Must be a valid GitHub login (alphanumeric + hyphens only, max 39 chars).
string
Only emit events for pull requests targeting this base branch (e.g., ‘main’ or ‘develop’).
string
Only emit events for pull requests whose source branch matches this name (e.g., ‘feature/login’).
number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
boolean
Filter by draft status. Set to True to receive events only for draft PRs, False for non-draft PRs, or leave blank to receive both.
string
Only emit events for pull requests that carry this label name (e.g., ‘bug’, ‘enhancement’).
string
Restrict the search to all repositories belonging to a GitHub user or organisation (e.g., ‘facebook’ or ‘microsoft’). Ignored when ‘repo’ is also provided.
string
Restrict the search to a specific repository. Must be in ‘owner/repo’ format (e.g., ‘facebook/react’). Leave blank to search across all repositories accessible to the account.
string
Pull request state to monitor: ‘open’, ‘closed’, or ‘all’. Defaults to ‘open’.

Payload

string
GitHub profile URL of the pull request author.
string
GitHub username of the pull request author.
string
Body/description of the pull request in markdown format.
string
ISO 8601 timestamp when the pull request was closed, null if open.
integer
Number of comments on the pull request.
string
required
ISO 8601 timestamp when the pull request was created.
boolean
required
Whether the pull request is marked as a draft.
string
Event type identifier for this trigger.
string
required
GitHub web interface URL to view the pull request.
array
Names of the labels attached to this pull request.
string
ISO 8601 timestamp when the pull request was merged, null if not merged.
string
GraphQL node identifier for the pull request.
integer
required
Pull request number within the repository.
string
required
Unique numeric identifier of the pull request (as string).
string
GitHub API URL for the repository the pull request belongs to.
string
required
State of the pull request: ‘open’ or ‘closed’.
string
required
Title of the pull request.
string
required
ISO 8601 timestamp when the pull request was last updated.
Slug: GITHUB_PULL_REQUEST_EVENTType: webhookTriggered when a pull request is opened, closed, or synchronized.

Configuration

string
required
Owner of the repository
string
required
Repository name

Payload

string
required
The action that was performed on the pull request
string
required
The timestamp when the pull request was created
string
required
The GitHub username of the user who created the pull request
string
A detailed description of the pull request
integer
required
The unique number assigned to the pull request
string
required
The title of the pull request
string
required
The GitHub URL of the pull request
Slug: GITHUB_PULL_REQUEST_REVIEWERS_CHANGED_TRIGGERType: pollTriggers when the list of requested reviewers (users or teams) for a pull request changes — for example when a reviewer is added, removed, or re-requested.The payload includes the full current reviewer list (users and teams with details), which reviewers were added, which were removed, and the previous reviewer list for reference.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
GitHub username or organisation that owns the repository (e.g. ‘octocat’ or ‘microsoft’).
integer
required
The numeric identifier of the pull request to monitor (e.g. 42). You can find this in the pull request URL.
string
required
Repository name without the .git extension (e.g. ‘Hello-World’ or ‘my-project’).

Payload

array
required
Sorted list of team slugs currently requested to review.
array
Full details of teams currently requested to review.
array
required
Sorted list of GitHub user logins currently requested to review.
array
Full details of users currently requested to review.
string
Event type identifier.
string
required
Owner of the repository.
array
Sorted list of team slugs from the previous poll.
array
Sorted list of user logins from the previous poll.
integer
required
The numeric identifier of the pull request.
string
required
Repository name.
array
Team slugs that were newly added as requested reviewers.
array
Team slugs that were removed from requested reviewers.
array
User logins that were newly added as requested reviewers.
array
User logins that were removed from requested reviewers.
Slug: GITHUB_PULL_REQUEST_REVIEW_SUBMITTED_TRIGGERType: pollTriggers when a new review is submitted for a GitHub pull request.Emits an event for each newly submitted review on the monitored pull request, covering all review types: APPROVED, CHANGES_REQUESTED, COMMENTED, and DISMISSED.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
GitHub username or organisation that owns the repository (e.g. ‘octocat’ or ‘microsoft’).
integer
required
The number of the pull request to monitor for new reviews.
string
required
Repository name without the .git extension (e.g. ‘Hello-World’ or ‘vscode’).

Payload

string
required
How the reviewer is associated with the repository (e.g. COLLABORATOR, CONTRIBUTOR, MEMBER, NONE, OWNER).
string
required
The body text of the review.
string
required
The commit SHA that was reviewed.
string
Type of event that occurred.
string
required
Web URL for the review.
string
required
GraphQL node identifier of the review.
string
required
Owner of the repository.
integer
required
The number of the pull request being reviewed.
string
required
API URL for the associated pull request.
string
required
Repository name.
integer
required
Unique numeric identifier of the review.
object
Minimal representation of the reviewer user.
string
required
State of the review. Possible values: APPROVED, CHANGES_REQUESTED, COMMENTED, DISMISSED, PENDING.
string
ISO 8601 timestamp of when the review was submitted.
Slug: GITHUB_PULL_REQUEST_STATE_CHANGED_TRIGGERType: pollTriggers when a specific GitHub pull request changes any of these tracked properties: state (open/closed), title, body, draft status, lock status, merge status, assignees, labels, requested reviewers, or milestone.The payload includes the full current PR details, the list of changed field names, and their previous values.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
The account owner of the repository (username or organization name). Must contain only alphanumeric characters and hyphens, max 39 characters.
integer
required
The identifying number of the pull request to monitor. This is the number shown next to the PR title (e.g., #42) or visible in the pull request URL.
string
required
The name of the repository without the .git extension. Must contain only alphanumeric characters, hyphens, underscores, and periods.

Payload

string
The reason the pull request is locked, if locked.
array
GitHub users currently assigned to this pull request.
string
The current body / description of the pull request.
array
List of field names that changed since the last poll.
string
ISO 8601 timestamp when the pull request was closed, if applicable.
string
required
ISO 8601 timestamp when the pull request was created.
boolean
required
Whether the pull request is a draft.
string
required
The GitHub URL to view this pull request.
integer
required
The unique numeric ID of the pull request.
array
Labels currently attached to the pull request.
boolean
required
Whether the pull request is locked.
string
SHA of the merge commit, if merged.
boolean
required
Whether the pull request has been merged.
string
ISO 8601 timestamp when the pull request was merged, if applicable.
object
Minimal GitHub user information attached to a pull request.
string
The milestone title associated with the pull request, if any.
integer
required
The PR number within the repository.
object
Previous string-serialized values of the changed fields.
string
required
The name of the repository the pull request belongs to.
string
required
The owner of the repository the pull request belongs to.
array
GitHub users whose review is currently requested.
string
required
The current state of the pull request: ‘open’ or ‘closed’.
string
required
The current title of the pull request.
string
required
ISO 8601 timestamp when the pull request was last updated.
string
required
The REST API URL for this pull request.
object
required
The user who created the pull request.
Slug: GITHUB_PULL_REQUEST_UPDATEDType: pollTriggers when an existing pull request is updated in a GitHub repository.Updates include title edits, description changes, label changes, assignee changes, reviewer requests, draft status changes, base branch changes, being closed, merged, or reopened. Only pre-existing PRs that receive an update will fire the trigger; newly created PRs are excluded.Supports optional filters: state, base branch, head branch, author, label, and draft status.

Configuration

string
Only emit events for pull requests authored by this GitHub username. Leave blank to watch PRs from any author.
string
Only emit events for pull requests targeting this base branch (the branch being merged into). Leave blank to watch all base branches.
boolean
Filter by draft status. Set to True to only watch draft PRs, False for non-draft PRs, or leave blank (None) to watch both.
string
Only emit events for pull requests coming from this head branch (the branch being merged). Supports the ‘user:branch’ format to filter across forks. Leave blank to watch all head branches.
number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
Only emit events for pull requests carrying this exact label name. Leave blank to watch PRs regardless of labels.
string
required
The account owner of the repository (GitHub username or organization name). Do not include the repository name here.
string
required
The name of the repository to watch for updated pull requests. Do not include the owner prefix.
string
Filter pull requests by state. Use ‘open’ for open PRs only, ‘closed’ for closed (merged or unmerged) PRs, or ‘all’ to catch updates to PRs in any state (e.g., a PR being merged or closed). Defaults to ‘all’.

Payload

array
List of GitHub users currently assigned to the pull request.
string
Author’s relationship to the repository: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, or OWNER.
object
Branch information (head or base) for a pull request.
string
The description / body of the pull request in markdown format.
string
ISO 8601 timestamp when the pull request was closed, null if still open.
string
required
ISO 8601 timestamp when the pull request was created.
boolean
required
Whether the pull request is marked as a draft.
string
Event type identifier for this trigger.
object
Branch information (head or base) for a pull request.
string
required
GitHub web interface URL to view the pull request.
integer
required
The unique numeric ID of the pull request across all of GitHub.
array
Labels attached to the pull request.
boolean
required
Whether the pull request conversation is locked.
string
SHA of the merge commit. Present before merging as a test-merge SHA; set to the actual merge commit SHA after merge.
string
ISO 8601 timestamp when the pull request was merged, null if not merged.
integer
required
The pull request number within the repository.
string
required
The name of the repository.
string
required
The owner (user or organization) of the repository.
array
List of users requested to review the pull request.
string
required
Current state of the pull request: ‘open’ or ‘closed’.
string
required
The title of the pull request.
string
required
ISO 8601 timestamp when the pull request was last updated.
string
required
GitHub REST API URL for this pull request.
object
GitHub user information attached to a pull request.
Slug: GITHUB_README_CHANGED_TRIGGERType: pollTriggers when the README file in a specific repository directory changes.Monitors the README in a configurable directory and branch/tag/commit. The payload includes the current README metadata (filename, path, SHA, size, URLs), the previous and current git blob SHAs, and a list of which tracked fields changed.

Configuration

string
The directory path within the repository whose README to monitor. Use ’.’ or leave blank to monitor the root README. For a subdirectory, provide the relative path (e.g. ‘docs’ or ‘src/api’).
number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
GitHub username or organisation that owns the repository (e.g. ‘octocat’ or ‘microsoft’).
string
Optional Git ref (branch, tag, or commit SHA) to read the README from. Leave blank to use the repository’s default branch.
string
required
Repository name without the .git extension (e.g. ‘Hello-World’ or ‘my-project’).

Payload

array
List of tracked field names that changed since the previous poll. Possible values: ‘sha’, ‘size’, ‘name’, ‘path’.
string
The git blob SHA observed in the current poll (after the change).
object
The canonicalised snapshot from the current poll.
string
required
Directory path that was monitored.
string
URL to download the raw README content.
string
Encoding used for the README content (typically ‘base64’).
string
Event type identifier.
string
GitHub API URL to the underlying git blob.
string
URL to view the README on GitHub.
string
Filename of the README (e.g. ‘README.md’).
string
required
Owner of the repository.
string
Full path of the README within the repository.
string
The git blob SHA observed in the previous poll (before the change).
object
The canonicalised snapshot from the previous poll.
string
required
Repository name.
string
Current git blob SHA of the README content.
integer
Current size of the README file in bytes.
string
GitHub API URL for the README resource.
Slug: GITHUB_RELEASE_ASSET_ADDED_TRIGGERType: pollTriggers when a new asset is added to a specific GitHub release.Monitors a single release (identified by release ID) for newly uploaded assets such as binaries, archives, or checksum files. One event is emitted per new asset, containing full asset metadata.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
The GitHub username or organization name that owns the repository (e.g. ‘octocat’ or ‘my-organization’).
integer
required
The unique numeric identifier of the release to monitor for new assets. You can obtain this by listing releases for the repository.
string
required
The name of the repository that contains the release to monitor (without the .git extension, e.g. ‘Hello-World’).

Payload

integer
required
Unique numeric identifier of the newly added release asset.
string
required
Direct download URL for the asset accessible in a browser.
string
required
MIME type of the asset (e.g. ‘application/zip’, ‘text/plain’).
string
required
ISO 8601 timestamp of when the asset was created.
string
SHA256 hash of the asset file for integrity verification.
integer
Number of times the asset has been downloaded.
string
Event type identifier for this trigger.
string
An optional label providing additional context for the asset.
string
required
The file name of the asset.
string
required
GraphQL node identifier for the release asset.
string
required
The GitHub username or organization that owns the repository.
integer
required
The numeric ID of the release this asset belongs to.
string
required
The name of the repository containing this release.
integer
required
Size of the asset file in bytes.
string
required
State of the release asset (e.g. ‘uploaded’ or ‘open’).
string
required
ISO 8601 timestamp of when the asset was last updated.
integer
Numeric GitHub user ID of the uploader.
string
GitHub login (username) of the user who uploaded the asset.
string
required
GitHub REST API URL for this release asset.
Slug: GITHUB_RELEASE_STATE_CHANGED_TRIGGERType: pollTriggers when a specific GitHub release (identified by tag name) changes.Monitors the release title, body/notes, draft flag, prerelease flag, published timestamp, target branch/commit, and the set of attached assets. The payload includes the full current release details, a list of which fields changed, and the previous values for comparison.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
GitHub username or organisation that owns the repository (e.g. ‘octocat’ or ‘microsoft’).
string
required
Repository name without the .git extension (e.g. ‘Hello-World’ or ‘my-project’).
string
required
The exact Git tag name of the release to monitor (e.g. ‘v1.0.0’). This identifies the specific release by its tag.

Payload

array
Current list of release assets.
string
Current release body/notes in markdown format.
array
required
List of field names that changed since the previous poll. Possible values: ‘name’, ‘body’, ‘draft’, ‘prerelease’, ‘published_at’, ‘target_commitish’, ‘asset_ids’.
object
The canonicalised snapshot from the current poll.
boolean
required
Whether the release is currently a draft.
string
Event type identifier.
string
Web URL to view the release on GitHub.
string
Current release name/title.
string
required
Owner of the repository.
boolean
required
Whether the release is currently marked as a prerelease.
object
The canonicalised snapshot from the previous poll.
string
ISO 8601 timestamp when the release was published (null for drafts).
integer
Numeric ID of the release that changed.
string
required
Repository name.
string
required
Git tag name for the release.
string
required
The branch or commit SHA the release tag points to.
Slug: GITHUB_REPOSITORY_CONTENT_CHANGED_TRIGGERType: pollTriggers when the content of a file or directory in a GitHub repository changes.Monitors a specified path within a repository on a given branch or tag. For a single file, fires content_changed when the file is modified. For a directory, fires content_changed, content_added, or content_removed for modified, new, or deleted entries respectively.content.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
GitHub username or organisation that owns the repository (e.g. ‘octocat’ or ‘microsoft’).
string
Path to the file or directory to monitor within the repository. Use an empty string (default) to monitor the root directory. For a specific file use its full path (e.g. ‘README.md’, ‘src/main.py’). For a directory use its path (e.g. ‘src’, ‘docs/api’).
string
The git reference (branch name, tag name, or commit SHA) to monitor. If omitted the repository’s default branch is used.
string
required
Repository name without the .git extension (e.g. ‘Hello-World’ or ‘my-project’).

Payload

string
required
Type of change: ‘content_changed’, ‘content_added’, or ‘content_removed’.
object
required
Metadata snapshot of the content item that changed, was added, or was removed.
string
required
The file or directory path being monitored.
string
required
Owner of the repository.
string
SHA of the item before the change. Non-empty only for ‘content_changed’ events.
string
The git reference (branch/tag/SHA) that was monitored. Empty string means the repository’s default branch was used.
string
required
Repository name.
Slug: GITHUB_REPOSITORY_NOTIFICATION_RECEIVED_TRIGGERType: pollTriggers when a new or newly updated notification thread appears for a specific GitHub repository.Monitors notifications for issues, pull requests, commits, releases, check suites, security alerts, and other repository activity. Supports filtering by read/unread status and by direct participation.Requires a Personal Access Token (classic) with the notifications

Configuration

boolean
If true, also return notifications that have already been marked as read. Default (false) shows only unread notifications.
number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
The account owner of the repository (username or organization). Not case sensitive.
boolean
If true, only return notifications where the authenticated user is directly participating or mentioned.
string
required
The name of the repository (without the .git extension). Not case sensitive.

Payload

string
required
Notification thread ID.
string
ISO 8601 timestamp of when the thread was last read, or null.
string
required
Reason the authenticated user received the notification (e.g., subscribed, mentioned, author, assign, review_requested, comment, ci_activity, security_alert, state_change, team_mention).
object
required
Repository the notification belongs to.
object
required
Subject of the notification thread.
string
required
API URL for managing the thread subscription.
boolean
required
Whether the notification thread is unread.
string
required
ISO 8601 timestamp of when the notification thread was last updated.
string
required
API URL for this notification thread.
Slug: GITHUB_REPOSITORY_TAG_CREATED_TRIGGERType: pollTriggers when a new tag is created in a GitHub repository.Monitors the repository’s tags and fires an event for each newly created tag. The payload includes the tag name, the commit SHA and URL it points to, and archive download URLs.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
GitHub username or organisation that owns the repository (e.g. ‘octocat’ or ‘microsoft’).
string
required
Repository name without the .git extension (e.g. ‘Hello-World’ or ‘my-project’).

Payload

string
required
The SHA of the commit the tag points to.
string
required
The API URL of the commit the tag points to.
string
Type of event that occurred.
string
required
The GraphQL node ID of the tag reference.
string
required
Owner of the repository.
string
required
Repository name.
string
required
The name of the newly created tag.
string
required
URL to download a tarball archive of the repository at this tag.
string
required
URL to download a zipball archive of the repository at this tag.
Slug: GITHUB_SECRET_SCANNING_ALERT_DETECTED_TRIGGERType: pollTriggers when a new secret scanning alert is detected in a GitHub repository.Monitors open secret scanning alerts and fires an event for each newly detected alert. Supports filtering by secret type (e.g., personal access tokens, AWS keys) and by token validity status (active, inactive, unknown).The payload includes the alert number, secret type, validity status, resolution state, timestamps, URLs, and flags for push protection bypass, public exposure, and multi-repo detection.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
The account owner of the repository. The name is not case sensitive.
string
required
The name of the repository without the .git extension. The name is not case sensitive.
string
Comma-separated list of secret types to filter by (e.g., ‘github_personal_access_token,aws_access_key_id’). Leave empty to monitor all secret types.
string ("active" | "inactive" | "unknown")
Filter by token validity status: ‘active’ (token still valid), ‘inactive’ (token revoked/expired), or ‘unknown’. Leave empty to monitor all validity states.

Payload

string
The ISO 8601 timestamp when the alert was created.
string
The GitHub web URL for the alert.
string
The REST API URL for the locations where the secret was detected.
boolean
Whether the secret was found in multiple repositories.
integer
The security alert number identifier.
boolean
Whether the secret was found publicly exposed.
boolean
Whether push protection was bypassed for this secret.
string
The ISO 8601 timestamp when push protection was bypassed.
string
The resolution when the alert is resolved: ‘false_positive’, ‘wont_fix’, ‘revoked’, ‘pattern_edited’, ‘pattern_deleted’, or ‘used_in_tests’.
string
The ISO 8601 timestamp when the alert was resolved, if applicable.
string
The type of secret that was detected (e.g., ‘github_personal_access_token’, ‘aws_access_key_id’).
string
The human-readable display name of the secret type.
string
The state of the alert: ‘open’ or ‘resolved’.
string
The ISO 8601 timestamp when the alert was last updated.
string
The REST API URL for the alert.
string
The validity status of the detected token: ‘active’, ‘inactive’, or ‘unknown’.
Slug: GITHUB_STAR_ADDED_EVENTType: webhookTriggered when a new star is added to the repository.

Configuration

string
required
Owner of the repository
string
required
Repository name

Payload

string
required
The action that was performed on the star
integer
required
The unique ID assigned to the repository
string
required
The name of the repository
string
required
The GitHub URL of the repository
string
required
The timestamp when the star was added
string
required
The GitHub username of the user who added the star
Slug: GITHUB_WORKFLOW_ADDED_TRIGGERType: pollTriggers when a new GitHub Actions workflow is added to a repository.Monitors a repository’s GitHub Actions workflows and fires an event for each newly added workflow. The payload includes the workflow’s name, file path, state, creation and update timestamps, and URLs for the API, web interface, and status badge.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
The GitHub username or organization name that owns the repository (e.g. ‘octocat’ or ‘my-organization’).
string
required
The name of the repository to monitor for new workflows (without the .git extension, e.g. ‘Hello-World’).

Payload

string
required
URL for the workflow status badge image.
string
required
ISO 8601 timestamp of when the workflow was created.
string
ISO 8601 timestamp of when the workflow was deleted, or null if not deleted.
string
Type of event that occurred.
string
required
GitHub web interface URL where the workflow can be viewed.
string
required
The name of the workflow as defined in the workflow file.
string
required
GraphQL node identifier for the workflow.
string
required
The GitHub username or organization that owns the repository.
string
required
The path to the workflow file within the repository (e.g. ‘.github/workflows/ci.yaml’).
string
required
The name of the repository the workflow was added to.
string
required
Current state of the workflow. Possible values: active, deleted, disabled_fork, disabled_inactivity, disabled_manually.
string
required
ISO 8601 timestamp of when the workflow was last updated.
string
required
API endpoint URL for accessing this specific workflow.
integer
required
Unique numeric identifier of the newly added workflow.
Slug: GITHUB_WORKFLOW_JOB_ADDED_TRIGGERType: pollTriggers when a new job appears in a specific GitHub Actions workflow run.This is useful for detecting matrix-expanded jobs that are added after the initial workflow run creation, or any other scenario where jobs are dynamically added to an existing run.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
GitHub username or organisation that owns the repository (e.g. ‘octocat’ or ‘microsoft’). Not case-sensitive.
string
required
Repository name without the .git extension (e.g. ‘Hello-World’ or ‘my-project’). Not case-sensitive.
integer
required
The unique identifier of the workflow run to monitor. You can find this in the URL of the workflow run page on GitHub (e.g. https://github.com/owner/repo/actions/runs/123456789).

Payload

string
required
The API URL of the check run associated with this job.
string
ISO 8601 timestamp of when the job completed.
string
The outcome of the job after completion (e.g. success, failure). Null if the job has not concluded.
string
required
ISO 8601 timestamp of when the job was created.
string
Type of event that occurred.
string
The branch name associated with this job.
string
required
The SHA of the commit being built in this job.
string
The GitHub URL to view the job in the browser.
integer
required
The unique identifier of the job.
string
required
The display name of the job.
string
required
The API URL to retrieve details about this job.
array
Runner labels used to identify the type of runner for this job.
string
required
The GraphQL node identifier for this job.
string
required
Owner of the repository.
string
required
Repository name.
integer
The attempt number of the associated workflow run, starting at 1.
integer
required
The workflow run ID this job belongs to.
string
required
The API URL of the workflow run.
integer
The identifier of the runner group executing this job.
string
The name of the runner group executing this job.
integer
The identifier of the runner executing this job.
string
The name of the runner executing this job.
string
required
ISO 8601 timestamp of when the job started.
string
required
The current lifecycle phase of the job (e.g. queued, in_progress, completed).
array
The individual steps that make up this job.
string
The name of the workflow this job is part of.
Slug: GITHUB_WORKFLOW_JOB_STATE_CHANGEDType: pollTriggers when the status, conclusion, timestamps, runner assignment, or step details of a specific GitHub Actions workflow job change between polls.The payload includes the full current job state, a list of which fields changed, and the previous status/conclusion values for easy comparison.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
integer
required
The unique numerical identifier of the GitHub Actions workflow job to monitor. You can find the job ID from the GitHub Actions UI URL or via the List Jobs for a Workflow Run API.
string
required
The account owner of the repository (GitHub username or organization name). Do not include the repository name here.
string
required
The name of the repository that contains the workflow job to watch. Do not include the owner prefix.

Payload

array
List of field names that changed compared to the previous snapshot. Empty on the very first event (initial state capture is skipped).
string
required
GitHub REST API URL for the check run.
string
ISO 8601 timestamp when the job finished. Null if still running.
string
Outcome of the job after completion: success, failure, neutral, cancelled, skipped, timed_out, or action_required. Null while running.
string
required
ISO 8601 timestamp when the job was created.
string
Event type identifier for this trigger.
string
Branch the job ran on.
string
required
SHA of the commit being run.
string
required
GitHub web UI URL to view this job.
integer
required
Unique numeric identifier of the workflow job.
array
Runner labels from the runs-on attribute.
string
required
Name of the job.
string
required
Owner of the repository.
string
Previous job conclusion before this change.
string
Previous job status before this change.
string
required
Repository name.
integer
Attempt number of the parent workflow run.
integer
required
ID of the parent workflow run.
integer
ID of the runner group. Null while queued.
string
Name of the runner group. Null while queued.
integer
ID of the runner executing the job. Null while queued.
string
Name of the runner executing the job. Null while queued.
string
required
ISO 8601 timestamp when the job started.
string
required
Current status of the job: queued, in_progress, or completed.
array
Current step details for the job.
string
required
GitHub REST API URL for this job.
string
Name of the workflow.
Slug: GITHUB_WORKFLOW_RUN_ARTIFACT_ADDEDType: pollTriggers when a new artifact is uploaded to a specific GitHub Actions workflow run.Monitors a single workflow run for newly added artifacts such as build outputs, test results, or coverage reports. Each new artifact detected fires a separate event.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
Account owner of the repository (GitHub username or organization name).
string
required
Repository name without the .git extension.
integer
required
Unique identifier of the workflow run to monitor for new artifacts.

Payload

string
required
Direct URL to download the artifact archive as a ZIP file.
string
Timestamp when the artifact was created.
string
SHA256 digest of the artifact (available for upload-artifact v4+).
boolean
required
Whether or not the artifact has expired.
string
Timestamp when the artifact will expire.
integer
required
Unique identifier for the artifact.
string
required
The name of the artifact.
string
required
GraphQL node identifier for the artifact.
integer
required
The size in bytes of the artifact.
string
Timestamp when the artifact was last updated.
string
required
API URL for accessing the artifact.
object
Metadata about the workflow run that created the artifact.
Slug: GITHUB_WORKFLOW_RUN_CREATEDType: pollTriggers when a new workflow run is created in a GitHub repository.Monitors the repository for any new workflow runs and fires an event for each one. Optional filters allow narrowing to a specific branch, actor, or event type.

Configuration

string
Filter workflow runs triggered by a specific GitHub user login. Leave blank to monitor runs triggered by any user.
string
Filter workflow runs to a specific branch name. Leave blank to monitor runs on all branches.
string
Filter workflow runs triggered by a specific event type (e.g. ‘push’, ‘pull_request’, ‘schedule’). Leave blank to monitor runs triggered by any event.
number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
The account owner of the repository (GitHub username or organization name). Do not include the repository name here.
string
required
The name of the repository to watch for new workflow runs. Do not include the owner prefix.

Payload

object
GitHub user who triggered the workflow run.
string
Conclusion of the workflow run (null if not completed).
string
required
ISO 8601 timestamp when the workflow run was created.
string
Event-specific title associated with the run or the value of run-name if set in the workflow file.
string
Name of the event that triggered the workflow run.
string
Event type identifier for this trigger.
string
Name of the branch that triggered the workflow run.
string
SHA of the commit that triggered the workflow run.
string
GitHub web UI URL to view the workflow run.
string
API URL to retrieve jobs for this workflow run.
string
API URL to download logs for this workflow run.
string
Name of the workflow run.
string
required
GraphQL node ID for the workflow run.
string
required
Owner of the repository.
string
Path to the workflow file in the repository.
string
required
Repository name.
integer
Attempt number of this run (increments with re-runs).
integer
required
Unique numeric identifier of the workflow run.
integer
required
Sequential run number for this workflow.
string
ISO 8601 timestamp when the workflow run actually started execution.
string
Current status of the workflow run.
string
ISO 8601 timestamp when the workflow run was last updated.
string
GitHub REST API URL for this workflow run.
integer
ID of the workflow definition.
Slug: GITHUB_WORKFLOW_RUN_STATE_CHANGED_TRIGGERType: pollTriggers when a GitHub Actions workflow run’s status or conclusion changes.Monitors a single workflow run and fires an event whenever it transitions between states (e.g., queued to in_progress, or in_progress to completed) or when its conclusion is set (e.g., success, failure, cancelled).

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
GitHub username or organisation that owns the repository (e.g. ‘octocat’ or ‘microsoft’).
string
required
Repository name without the .git extension (e.g. ‘Hello-World’ or ‘my-project’).
integer
required
The unique numeric identifier of the workflow run to monitor. You can find this in the URL of a workflow run on GitHub: https://github.com/&#123;owner&#125;/&#123;repo&#125;/actions/runs/&#123;run_id&#125;

Payload

array
List of state field names that changed since the previous poll. Possible values: ‘status’, ‘conclusion’.
string
Current conclusion of the workflow run. One of: success, failure, neutral, cancelled, skipped, timed_out, action_required, or null if not yet completed.
string
Timestamp when the workflow run was created (ISO 8601).
object
The canonicalised state snapshot from the current poll.
string
Display title of the workflow run.
string
The event that triggered the workflow run.
string
Event type identifier.
string
Name of the branch the workflow ran on.
string
SHA of the head commit that triggered the workflow run.
string
URL to view the workflow run on GitHub.
string
Name of the workflow.
string
required
Owner of the repository.
string
The conclusion observed in the previous poll (before the change).
object
The canonicalised state snapshot from the previous poll.
string
The status observed in the previous poll (before the change).
string
required
Repository name.
integer
Attempt number of the run (1 for first attempt).
integer
required
Unique identifier of the workflow run.
integer
Auto-incrementing run number for the workflow.
string
Timestamp when the workflow run started (ISO 8601).
string
Current status of the workflow run. One of: queued, in_progress, completed, waiting, requested, pending.
string
Timestamp when the workflow run was last updated (ISO 8601).