Github

Learn how to use Github with Composio

Overview

Enum

GITHUB

Description

GitHub API Tool

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to public_repo,user

Actions

Accepts a pending repository invitation that has been issued to the authenticated user.

Action Parameters

invitation_id
integerRequired

Action Response

data
object
error
successful
boolean
Deprecated: lists repositories starred by the authenticated user, including star creation timestamps; use 'list repositories starred by the authenticated user' instead.

Action Parameters

direction
stringDefaults to desc
page
integerDefaults to 1
per_page
integerDefaults to 1
sort
stringDefaults to created

Action Response

data
object
error
successful
boolean
Deprecated: lists users who have starred a repository; use `list stargazers` instead.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: stars a repository for the authenticated user; use `star a repository for the authenticated user` instead.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Replaces github app access restrictions for an existing protected branch; requires a json array of app slugs in the request body, where apps must be installed and have 'contents' write permissions.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Adds or removes assignees for a github issue; changes are silently ignored if the authenticated user lacks push access to the repository.

Action Parameters

assignees
array
issue_number
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Adds 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.

Action Parameters

owner
stringRequired
permission
stringDefaults to push
repo
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Adds 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.

Action Parameters

installation_id
integerRequired
repository_id
integerRequired

Action Response

data
object
error
successful
boolean
Designates an existing and eligible team as a security manager for an organization, allowing its members to manage security alerts, code security configurations, and dependency reviews for the organization's repositories.

Action Parameters

org
stringRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Grants a specified repository access to an authenticated user's existing codespaces secret, enabling codespaces created for that repository to use the secret.

Action Parameters

repository_id
integerRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Adds 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.

Action Parameters

emails
arrayRequired

Action Response

data
object
error
successful
boolean
Adds labels (provided in the request body) to a repository issue; labels that do not already exist are created.

Action Parameters

issue_number
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Adds new custom labels to an existing self-hosted runner for an organization; existing labels are not removed, and duplicates are not added.

Action Parameters

labels
arrayRequired
org
stringRequired
runner_id
integerRequired

Action Response

data
object
error
successful
boolean
Adds 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.

Action Parameters

org
stringRequired
role
stringDefaults to member
team_slug
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Idempotently adds a user to a github team or updates their role using a legacy endpoint; `team id` and `username` must already exist.

Action Parameters

role
stringDefaults to member
team_id
integerRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Grants or updates a team's permissions ('read', 'write', or 'admin') for a specific project, which must exist within the specified organization and be linked to it.

Action Parameters

org
stringRequired
permission
string
project_id
integerRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Sets or modifies a team's permissions for a specific project using a deprecated legacy github api endpoint; ensure the team can access the project's organization, and note that requests with an empty body (e.g., when relying on the default permission) might need a `content-length: 0` header.

Action Parameters

permission
string
project_id
integerRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Sets or updates a team's permission level for a repository within an organization; the team must be a member of the organization.

Action Parameters

org
stringRequired
owner
stringRequired
permission
stringDefaults to push
repo
stringRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Adds or updates a team's repository permissions using the deprecated github legacy teams api; use with caution as this endpoint is deprecated.

Action Parameters

owner
stringRequired
permission
string
repo
stringRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Adds a specified github user as a collaborator to an existing organization project with a given permission level.

Action Parameters

permission
stringDefaults to write
project_id
integerRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Adds a repository to an existing organization-level github actions secret that is configured for 'selected' repository access.

Action Parameters

org
stringRequired
repository_id
integerRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Grants an existing repository access to an existing organization-level dependabot secret; the repository must belong to the organization, and the call succeeds without change if access already exists.

Action Parameters

org
stringRequired
repository_id
integerRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Adds and appends custom labels to a self-hosted repository runner, which must be registered and active.

Action Parameters

labels
arrayRequired
owner
stringRequired
repo
stringRequired
runner_id
integerRequired

Action Response

data
object
error
successful
boolean
Adds a repository to an organization secret's access list when the secret's visibility is 'selected'; this operation is idempotent.

Action Parameters

org
stringRequired
repository_id
integerRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Grants a repository access to an organization-level github actions variable, if that variable's visibility is set to 'selected repositories'.

Action Parameters

name
stringRequired
org
stringRequired
repository_id
integerRequired

Action Response

data
object
error
successful
boolean
Adds one or more social media links (which must be valid, full urls for platforms supported by github) to the authenticated user's public github profile.

Action Parameters

account_urls
arrayRequired

Action Response

data
object
error
successful
boolean
Adds status check contexts (provided in the request body, e.g., `{"contexts": ["new-context"]}`) to a protected branch, requiring these contexts to have been previously reported.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Adds specified teams to an organization's active github copilot subscription; teams must exist within the organization.

Action Parameters

org
stringRequired
selected_teams
arrayRequired

Action Response

data
object
error
successful
boolean
Overwrites the list of teams (and their child teams) granted push access to a protected branch; the list of team slugs must be provided in the http post request body.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Invites or adds a user to a specific team using a deprecated github api endpoint; prefer 'add or update team membership for a user' instead.

Action Parameters

team_id
integerRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Sets or replaces the list of organization members granted codespaces access billed to the organization; ensure the organization's billing settings allow access for selected members.

Action Parameters

org
stringRequired
selected_usernames
arrayRequired

Action Response

data
object
error
successful
boolean
Adds specified organization members to an active github copilot subscription, which must have available seats.

Action Parameters

org
stringRequired
selected_usernames
arrayRequired

Action Response

data
object
error
successful
boolean
Sets/replaces list of users allowed to push to a protected branch; usernames (e.g., `["user1"]`) must be a json array in request body (not schema parameters), an empty array `[]` removes all restrictions.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Approves a workflow run from a forked repository's pull request; call this when such a run requires manual approval due to workflow configuration.

Action Parameters

owner
stringRequired
repo
stringRequired
run_id
integerRequired

Action Response

data
object
error
successful
boolean
Assigns an existing organization-level role (identified by `role id`) to a team (identified by `team slug`) within a github organization (`org`), provided the organization, team, and role already exist.

Action Parameters

org
stringRequired
role_id
integerRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Assigns a specific organization role to a user who is a member or an outside collaborator in a github organization, using a valid role id.

Action Parameters

org
stringRequired
role_id
integerRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists docker packages for the authenticated user that encountered conflicts during the docker migration process.

Action Parameters

Action Response

data
object
error
successful
boolean
Blocks an existing individual github user (not an organization or your own account), preventing them from interacting with your account and repositories.

Action Parameters

username
stringRequired

Action Response

data
object
error
successful
boolean
Blocks an existing github user from an existing organization, preventing their contributions, collaboration, and forking of the organization's repositories.

Action Parameters

org
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Cancels an ongoing repository import if one is actively in progress for the specified repository; note that this github feature is deprecated and may no longer function.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Cancels an existing, pending invitation to join a specified organization using the invitation's unique id.

Action Parameters

invitation_id
integerRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Cancels an existing, ongoing or queued github pages deployment for a repository using its `pages deployment id`.

Action Parameters

owner
stringRequired
pages_deployment_id
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Cancels a workflow run in a github repository if it is in a cancellable state (e.g., 'in progress' or 'queued').

Action Parameters

owner
stringRequired
repo
stringRequired
run_id
integerRequired

Action Response

data
object
error
successful
boolean
Checks if automated security fixes are enabled for a repository; returns 204 (empty response) if enabled, 404 if not or repo not found.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Checks if a github app or oauth access token is valid for the specified client id and retrieves its details, typically to verify its active status and grants.

Action Parameters

access_token
stringRequired
client_id
stringRequired

Action Response

data
object
error
successful
boolean
Checks if a gist, identified by `gist id`, is starred by the authenticated user, returning an empty response (204) if starred, or a 404 error if not starred or not found.

Action Parameters

gist_id
stringRequired

Action Response

data
object
error
successful
boolean
Verifies 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.

Action Parameters

assignee
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Checks if a specified github user can be assigned to a given issue within a repository.

Action Parameters

assignee
stringRequired
issue_number
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Checks if a github user `username` follows `target user`; returns a 204 http status if true, 404 if not or if users are invalid.

Action Parameters

target_user
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Checks if a user is a collaborator on a specified github repository, returning a 204 status if they are, or a 404 status if they are not or if the repository/user does not exist.

Action Parameters

owner
stringRequired
repo
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Checks if a github user is blocked by an organization; a successful response (204 no content) indicates the user is blocked, while a 404 not found error indicates the user is not blocked.

Action Parameters

org
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Checks if a specified github pull request has been merged, indicated by a 204 http status (merged) or 404 (not merged/found).

Action Parameters

owner
stringRequired
pull_number
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Use to determine if the authenticated user has starred a specific github repository, which is confirmed by an http 204 status (resulting in an empty dictionary in the response data); the action fails (e.g., http 404) if the repository is not starred or does not exist.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Checks if an existing github user is a member (public or private) of an existing github organization.

Action Parameters

org
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Checks if the authenticated github user follows a target github user; an http 204 status indicates the user is followed, while an http 404 status indicates the user is not followed or the target user does not exist.

Action Parameters

username
stringRequired

Action Response

data
object
error
successful
boolean
Checks if private vulnerability reporting is enabled for the specified repository.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Checks if a user is a public member of a github organization; returns an empty response (http 204) if the user is a public member, or an error (e.g., http 404) if the user is not a public member or if the organization/user doesn't exist.

Action Parameters

org
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Checks if a team has 'read', 'write', or 'admin' permissions for an organization's specific classic project, returning the project's details if access is confirmed.

Action Parameters

org
stringRequired
project_id
integerRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Checks a team's permissions (e.g., read, write, admin) for a specific project, given the team and project ids, using a legacy github teams api; returns project details with permissions or a 404 error if the project is not found or not managed by the team.

Action Parameters

project_id
integerRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Checks a team's permissions for a specific repository within an organization, including permissions inherited from parent teams.

Action Parameters

org
stringRequired
owner
stringRequired
repo
stringRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Verifies a team's access to a repository using a deprecated github legacy endpoint, returning repository details with permissions upon success or a 204/404 status otherwise.

Action Parameters

owner
stringRequired
repo
stringRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Checks if the specified github user is blocked by the authenticated user; a 204 no content response indicates the user is blocked, while a 404 not found indicates they are not.

Action Parameters

username
stringRequired

Action Response

data
object
error
successful
boolean
Checks if vulnerability alerts are enabled for a repository; a 204 no content response indicates enabled, while 404 not found suggests they are disabled or the repository is not found.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes github actions caches from a repository matching a specific `key` and an optional git `ref`, used to manage storage or clear outdated/corrupted caches; the action succeeds even if no matching caches are found to delete.

Action Parameters

key
stringRequired
owner
stringRequired
ref
string
repo
stringRequired

Action Response

data
object
error
successful
boolean
Removes all custom labels from a self-hosted runner for an organization; default labels (e.g., 'self-hosted', 'linux', 'x64') will remain.

Action Parameters

org
stringRequired
runner_id
integerRequired

Action Response

data
object
error
successful
boolean
Compares two commit points (commits, branches, tags, or shas) within a repository or across forks, using `base...head` or `owner:ref...owner:ref` format for the `basehead` parameter.

Action Parameters

basehead
stringRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Generates a jit configuration for a github organization's new self-hosted runner to run a single job then unregister; the runner group id must exist.

Action Parameters

labels
arrayRequired
name
stringRequired
org
stringRequired
runner_group_id
integerRequired
work_folder
stringDefaults to _work

Action Response

data
object
error
successful
boolean
Sets or updates the oidc subject claim customization template for an existing github organization by specifying which claims (e.g., 'repo', 'actor') form the oidc token's subject (`sub`).

Action Parameters

include_claim_keys
arrayRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Converts an existing organization member, who is not an owner, to an outside collaborator, restricting their access to explicitly granted repositories.

Action Parameters

async
boolean
org
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Creates an encrypted environment variable for a pre-existing environment within a github repository; will fail if the variable name already exists.

Action Parameters

environment_name
stringRequired
name
stringRequired
owner
stringRequired
repo
stringRequired
value
stringRequired

Action Response

data
object
error
successful
boolean
Creates 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.

Action Parameters

assignee
string
assignees
array
body
string
labels
array
milestone
string
owner
stringRequired
repo
stringRequired
title
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new comment on an existing github issue or pull request within the specified repository.

Action Parameters

body
stringRequired
issue_number
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Use this action to invite a user to a github organization by their github user id or email, specifying their role and optionally adding them to teams; the 'reinstate' role is for former organization members.

Action Parameters

email
string
invitee_id
integer
org
stringRequired
role
stringDefaults to direct_member
team_ids
array

Action Response

data
object
error
successful
boolean
Creates a new classic project board within a specified github organization.

Action Parameters

body
string
name
stringRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new repository within a specified github organization, with options for detailed configuration including visibility, features, merge strategies, initial commit, and templates.

Action Parameters

allow_auto_merge
boolean
allow_merge_commit
booleanDefaults to True
allow_rebase_merge
booleanDefaults to True
allow_squash_merge
booleanDefaults to True
auto_init
boolean
custom_properties
object
delete_branch_on_merge
boolean
description
string
gitignore_template
string
has_downloads
booleanDefaults to True
has_issues
booleanDefaults to True
has_projects
booleanDefaults to True
has_wiki
booleanDefaults to True
homepage
string
is_template
boolean
license_template
string
merge_commit_message
string
merge_commit_title
string
name
stringRequired
org
stringRequired
private
boolean
squash_merge_commit_message
string
squash_merge_commit_title
string
team_id
integer
use_squash_pr_title_as_default
boolean
visibility
string

Action Response

data
object
error
successful
boolean
Creates a repository ruleset to define and enforce policies (e.g., branch protections, commit formats) for repositories within an existing github organization.

Action Parameters

bypass_actors
array
enforcement
stringRequired
name
stringRequired
org
stringRequired
rules
array
target
string

Action Response

data
object
error
successful
boolean
Creates a new, uniquely named github actions variable for an organization, with configurable repository access visibility (all, private, or selected).

Action Parameters

name
stringRequired
org
stringRequired
selected_repository_ids
array
value
stringRequired
visibility
stringRequired

Action Response

data
object
error
successful
boolean
Creates a webhook for a github organization to deliver event notifications to a configured url.

Action Parameters

active
booleanDefaults to True
config__content__type
string
config__insecure__ssl
string
config__password
string
config__secret
string
config__url
string
config__username
string
events
arrayDefaults to ['push']
name
stringRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Creates a git blob in a repository, requiring content and encoding ('utf-8' or 'base64').

Action Parameters

content
stringRequired
encoding
stringDefaults to utf-8
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new check run for a specific commit in a repository, used by external services to report status, detailed feedback, annotations, and images directly within the github ui.

Action Parameters

actions
array
completed_at
string
conclusion
string
details_url
string
external_id
string
head_sha
stringRequired
name
stringRequired
output__annotations
array
output__images
array
output__summary
string
output__text
string
output__title
string
owner
stringRequired
repo
stringRequired
started_at
string
status
stringDefaults to queued

Action Response

data
object
error
successful
boolean
Creates a new check suite for a specific commit (`head sha`) in an original repository (not a fork); github dispatches a `check suite` webhook event with the `requested` action upon success.

Action Parameters

head_sha
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Creates a github codespace for the authenticated user, requiring a json request body with either `repository id` (integer) or a `pull request` object (containing `pull request number` (integer) and `repository id` (integer)).

Action Parameters

Action Response

data
object
error
successful
boolean
Creates a github codespace for an open pull request in a codespaces-enabled repository, with options to customize its configuration.

Action Parameters

client_ip
string
devcontainer_path
string
display_name
string
geo
string
idle_timeout_minutes
integer
location
string
machine
string
multi_repo_permissions_opt_out
boolean
owner
stringRequired
pull_number
integerRequired
repo
stringRequired
retention_period_minutes
integer
working_directory
string

Action Response

data
object
error
successful
boolean
Creates a github codespace for the authenticated user in a specified repository, which must be accessible and use a valid `devcontainer.json` if `devcontainer path` is specified.

Action Parameters

client_ip
string
devcontainer_path
string
display_name
string
geo
string
idle_timeout_minutes
integer
location
string
machine
string
multi_repo_permissions_opt_out
boolean
owner
stringRequired
ref
string
repo
stringRequired
retention_period_minutes
integer
working_directory
string

Action Response

data
object
error
successful
boolean
Creates a new commit in a github repository; the `tree` sha and any `parents` shas must already exist in the repository.

Action Parameters

author__date
string
author__email
string
author__name
string
committer__date
string
committer__email
string
committer__name
string
message
stringRequired
owner
stringRequired
parents
array
repo
stringRequired
signature
string
tree
stringRequired

Action Response

data
object
error
successful
boolean
Creates a comment on a specific commit, or on a specific line if `path` and `position` are provided.

Action Parameters

body
stringRequired
commit_sha
stringRequired
line
integer
owner
stringRequired
path
string
position
integer
repo
stringRequired

Action Response

data
object
error
successful
boolean
Sets a commit's status (e.g., error, failure, pending, success from ci/cd) for a given sha; max 1000 statuses per sha/context.

Action Parameters

context
stringDefaults to default
description
string
owner
stringRequired
repo
stringRequired
sha
stringRequired
state
stringRequired
target_url
string

Action Response

data
object
error
successful
boolean
Creates a custom role with defined permissions within a github organization.

Action Parameters

description
string
name
stringRequired
org
stringRequired
permissions
arrayRequired

Action Response

data
object
error
successful
boolean
Creates a github deployment for an existing repository, targeting a specific ref (branch, tag, or sha) that must also exist within the repository.

Action Parameters

auto_merge
booleanDefaults to True
description
string
environment
stringDefaults to production
owner
stringRequired
payload
string
production_environment
boolean
ref
stringRequired
repo
stringRequired
required_contexts
array
task
stringDefaults to deploy
transient_environment
boolean

Action Response

data
object
error
successful
boolean
Creates a deployment branch or tag policy for an existing environment in a github repository, using a ruby file.fnmatch pattern (where `*` doesn't match `/`) to specify which branches or tags are deployable.

Action Parameters

environment_name
stringRequired
name
stringRequired
owner
stringRequired
repo
stringRequired
type
string

Action Response

data
object
error
successful
boolean
Creates a status for an existing deployment, updating its operational state, associated urls, and description.

Action Parameters

auto_inactive
boolean
deployment_id
integerRequired
description
string
environment
string
environment_url
string
log_url
string
owner
stringRequired
repo
stringRequired
state
stringRequired
target_url
string

Action Response

data
object
error
successful
boolean
Creates a deploy key for a repository; the repository must exist and be accessible, and the provided key must be a valid public ssh key.

Action Parameters

key
stringRequired
owner
stringRequired
read_only
boolean
repo
stringRequired
title
string

Action Response

data
object
error
successful
boolean
Creates a new discussion post on a specific team's page within an organization.

Action Parameters

body
stringRequired
org
stringRequired
private
boolean
team_slug
stringRequired
title
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new comment on an existing team discussion within a github organization.

Action Parameters

body
stringRequired
discussion_number
integerRequired
org
stringRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Posts a new comment to a specific team discussion using a legacy github api endpoint; note that this endpoint is deprecated and scheduled for removal.

Action Parameters

body
stringRequired
discussion_number
integerRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Creates a team discussion (title, body, private) for an existing team `team id` using a deprecated github legacy endpoint; consider newer apis for stability.

Action Parameters

body
stringRequired
private
boolean
team_id
integerRequired
title
stringRequired

Action Response

data
object
error
successful
boolean
Creates a fork of an accessible repository, optionally into a specific organization, with a new name, or copying only the default branch.

Action Parameters

default_branch_only
boolean
name
string
organization
string
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new gist on github with provided files, an optional description, and public/secret visibility.

Action Parameters

description
string
files
objectRequired
public
boolean

Action Response

data
object
error
successful
boolean
Creates a new comment on a specified github gist.

Action Parameters

body
stringRequired
gist_id
stringRequired

Action Response

data
object
error
successful
boolean
Use this action to finalize a github app's creation by exchanging the temporary `code` (received as a url parameter during the app manifest setup redirection) for the app's full configuration details.

Action Parameters

code
stringRequired

Action Response

data
object
error
successful
boolean
Creates a github pages deployment for a repository using a specified artifact and oidc token, provided github pages is enabled and the artifact (containing static assets) is accessible.

Action Parameters

artifact_id
integer
artifact_url
string
environment
stringDefaults to github-pages
oidc_token
stringRequired
owner
stringRequired
pages_build_version
stringDefaults to GITHUB_SHA
repo
stringRequired

Action Response

data
object
error
successful
boolean
Configures or updates github pages for a repository, setting build type and source; ensure a pages workflow exists for 'workflow' `build type`, or `source branch` exists for 'legacy' or unspecified `build type`.

Action Parameters

build_type
string
owner
stringRequired
repo
stringRequired
source__branch
string
source__path
stringDefaults to /

Action Response

data
object
error
successful
boolean
Adds a gpg key to the authenticated user's github account for signing commits and tags.

Action Parameters

armored_public_key
stringRequired
name
string

Action Response

data
object
error
successful
boolean
Creates a new label in a specified github repository, provided the repository exists and the user has write permissions.

Action Parameters

color
string
description
string
name
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Creates a milestone in a github repository for tracking progress on issues or pull requests; requires repository existence and user write permissions.

Action Parameters

description
string
due_on
string
owner
stringRequired
repo
stringRequired
state
stringDefaults to open
title
stringRequired

Action Response

data
object
error
successful
boolean
Creates a project card in a github project column; the request body must contain either a `note` for a note-only card, or both `content id` (id of an issue or pull request) and `content type` (e.g., 'issue', 'pullrequest').

Action Parameters

column_id
integerRequired

Action Response

data
object
error
successful
boolean
Creates a new column in a github project (classic).

Action Parameters

name
stringRequired
project_id
integerRequired

Action Response

data
object
error
successful
boolean
Adds a new, unencrypted public ssh key to the authenticated user's github account; the key must not already be registered to any github account.

Action Parameters

key
stringRequired
title
string

Action Response

data
object
error
successful
boolean
Creates a pull request in a github repository, requiring existing `base` and `head` branches; `title` or `issue` must be provided.

Action Parameters

base
stringRequired
body
string
draft
boolean
head
stringRequired
head_repo
string
issue
integer
maintainer_can_modify
boolean
owner
stringRequired
repo
stringRequired
title
string

Action Response

data
object
error
successful
boolean
Creates a git reference (e.g., a branch or tag) in a repository; the repository must not be empty prior to this operation.

Action Parameters

owner
stringRequired
ref
stringRequired
repo
stringRequired
sha
stringRequired

Action Response

data
object
error
successful
boolean
Generates a temporary (one-hour) registration token to add a new self-hosted runner to an organization for github actions.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Generates a time-limited token required to register a new self-hosted runner with a specific repository.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Creates 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.

Action Parameters

body
string
discussion_category_name
string
draft
boolean
generate_release_notes
boolean
make_latest
stringDefaults to true
name
string
owner
stringRequired
prerelease
boolean
repo
stringRequired
tag_name
stringRequired
target_commitish
string

Action Response

data
object
error
successful
boolean
Generates a token, valid for one hour, to authenticate removing a self-hosted runner from an organization.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Generates a temporary (one-hour validity) token required to unregister and remove a self-hosted runner from a repository.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Posts a reply to a specific review comment on a github pull request, requiring the repository, pull request, and original comment to exist, and a non-empty reply body.

Action Parameters

body
stringRequired
comment_id
integerRequired
owner
stringRequired
pull_number
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Triggers a github actions workflow or a webhook on a repository by creating a repository dispatch event, allowing programmatic triggering of workflows based on events outside of github.

Action Parameters

client_payload
object
event_type
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new repository for the authenticated user, optionally within an organization if `team id` is specified.

Action Parameters

allow_auto_merge
boolean
allow_merge_commit
booleanDefaults to True
allow_rebase_merge
booleanDefaults to True
allow_squash_merge
booleanDefaults to True
auto_init
boolean
delete_branch_on_merge
boolean
description
string
gitignore_template
string
has_discussions
boolean
has_downloads
booleanDefaults to True
has_issues
booleanDefaults to True
has_projects
booleanDefaults to True
has_wiki
booleanDefaults to True
homepage
string
is_template
boolean
license_template
string
merge_commit_message
string
merge_commit_title
string
name
stringRequired
private
boolean
squash_merge_commit_message
string
squash_merge_commit_title
string
team_id
integer

Action Response

data
object
error
successful
boolean
Publishes the specified codespace to a new repository, using the codespace's current state as the initial commit.

Action Parameters

codespace_name
stringRequired
name
string
private
boolean

Action Response

data
object
error
successful
boolean
Creates a new classic project board within a specified repository; classic projects must be enabled for the target repository.

Action Parameters

body
string
name
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Creates a uniquely named ruleset for a repository, defining rules for branches or tags with specified enforcement, conditions, and bypass actors.

Action Parameters

bypass_actors
array
conditions__ref__name__exclude
array
conditions__ref__name__include
array
enforcement
stringRequired
name
stringRequired
owner
stringRequired
repo
stringRequired
rules
array
target
string

Action Response

data
object
error
successful
boolean
Creates a new draft security advisory for a repository, enabling private collaboration on fixes before public disclosure; requires specifying impact using either `severity` or `cvss vector string` (not both).

Action Parameters

credits
array
cve_id
string
cvss_vector_string
string
cwe_ids
array
description
stringRequired
owner
stringRequired
repo
stringRequired
severity
string
start_private_fork
boolean
summary
stringRequired
vulnerabilities
arrayRequired

Action Response

data
object
error
successful
boolean
Creates 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.

Action Parameters

description
string
include_all_branches
boolean
name
stringRequired
owner
string
private
boolean
template_owner
stringRequired
template_repo
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new, unencrypted variable in a repository for github actions workflows; fails if a variable with the same name already exists.

Action Parameters

name
stringRequired
owner
stringRequired
repo
stringRequired
value
stringRequired

Action Response

data
object
error
successful
boolean
Creates a webhook for a specified repository; requires admin permissions on the repository.

Action Parameters

active
booleanDefaults to True
config__content__type
string
config__insecure__ssl
string
config__secret
string
config__url
string
events
arrayDefaults to ['push']
name
string
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Creates a review comment on a pull request's diff, targeting a specific line, range of lines, an entire file, or replying to an existing comment.

Action Parameters

body
stringRequired
commit_id
stringRequired
in_reply_to
integer
line
integer
owner
stringRequired
path
stringRequired
position
integer
pull_number
integerRequired
repo
stringRequired
side
string
start_line
integer
start_side
string
subject_type
string

Action Response

data
object
error
successful
boolean
Creates 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`.

Action Parameters

body
string
comments
array
commit_id
string
event
string
owner
stringRequired
pull_number
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Exchanges a user-to-server token for a new, fine-grained scoped access token for a github app, requiring `client id`, `access token`, either `target` or `target id`, and at least one permission; for repository-specific scoping, provide either `repositories` (names) or `repository ids` (ids), but not both.

Action Parameters

access_token
stringRequired
client_id
stringRequired
permissions__actions
string
permissions__administration
string
permissions__checks
string
permissions__codespaces
string
permissions__contents
string
permissions__dependabot__secrets
string
permissions__deployments
string
permissions__email__addresses
string
permissions__environments
string
permissions__followers
string
permissions__git__ssh__keys
string
permissions__gpg__keys
string
permissions__interaction__limits
string
permissions__issues
string
permissions__members
string
permissions__metadata
string
permissions__organization__administration
string
permissions__organization__announcement__banners
string
permissions__organization__copilot__seat__management
string
permissions__organization__custom__org__roles
string
permissions__organization__custom__properties
string
permissions__organization__custom__roles
string
permissions__organization__events
string
permissions__organization__hooks
string
permissions__organization__packages
string
permissions__organization__personal__access__token__requests
string
permissions__organization__personal__access__tokens
string
permissions__organization__plan
string
permissions__organization__projects
string
permissions__organization__secrets
string
permissions__organization__self__hosted__runners
string
permissions__organization__user__blocking
string
permissions__packages
string
permissions__pages
string
permissions__profile
string
permissions__pull__requests
string
permissions__repository__custom__properties
string
permissions__repository__hooks
string
permissions__repository__projects
string
permissions__secret__scanning__alerts
string
permissions__secrets
string
permissions__security__events
string
permissions__single__file
string
permissions__starring
string
permissions__statuses
string
permissions__team__discussions
string
permissions__vulnerability__alerts
string
permissions__workflows
string
repositories
array
repository_ids
array
target
string
target_id
integer

Action Response

data
object
error
successful
boolean
Creates 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.

Action Parameters

detector__name
string
detector__url
string
detector__version
string
job__correlator
string
job__html__url
string
job__id
string
manifests
object
metadata
object
owner
stringRequired
ref
stringRequired
repo
stringRequired
scanned
stringRequired
sha
stringRequired
version
integerRequired

Action Response

data
object
error
successful
boolean
Adds a new public ssh key to the authenticated user's github account for signing commits or tags.

Action Parameters

key
stringRequired
title
string

Action Response

data
object
error
successful
boolean
Creates an annotated git tag object in a repository, pointing to an existing git object (commit, tree, or blob) defined by its sha and ensuring the `type` field correctly specifies the object's type.

Action Parameters

message
stringRequired
object
stringRequired
owner
stringRequired
repo
stringRequired
tag
stringRequired
tagger__date
string
tagger__email
string
tagger__name
string
type
stringRequired

Action Response

data
object
error
successful
boolean
Creates a tag protection rule for a repository using a glob pattern; note: tag protections are deprecated (sunset august 30, 2024), migrate to repository rulesets.

Action Parameters

owner
stringRequired
pattern
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Creates 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'.

Action Parameters

description
string
maintainers
array
name
stringRequired
notification_setting
string
org
stringRequired
parent_team_id
integer
permission
stringDefaults to pull
privacy
string
repo_names
array

Action Response

data
object
error
successful
boolean
Creates a temporary private fork of the specified repository to address a security vulnerability, linking the fork to a ghsa id that must be specifically associated with this repository; the fork may take up to 5 minutes to become accessible.

Action Parameters

ghsa_id
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Creates 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.

Action Parameters

base_tree
string
owner
stringRequired
repo
stringRequired
tree
arrayRequired

Action Response

data
object
error
successful
boolean
Creates a new github project board for the authenticated user to organize and track issues, pull requests, and notes.

Action Parameters

body
string
name
stringRequired

Action Response

data
object
error
successful
boolean
Manually triggers a github actions workflow identified by `workflow id` at a given `ref`, if the workflow is configured to accept `workflow dispatch` events.

Action Parameters

inputs
object
owner
stringRequired
ref
stringRequired
repo
stringRequired
workflow_id
integerRequired

Action Response

data
object
error
successful
boolean
Enables commit signature protection for a specified branch, requiring all new commits to be signed.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Enables a custom deployment protection rule for an existing environment in a repository by linking a configured github app (via `integration id`) to control deployments.

Action Parameters

environment_name
stringRequired
integration_id
integer
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Generates 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.

Action Parameters

labels
arrayRequired
name
stringRequired
owner
stringRequired
repo
stringRequired
runner_group_id
integerRequired
work_folder
stringDefaults to _work

Action Response

data
object
error
successful
boolean
Creates a new environment or updates an existing one in a github repository, allowing configuration of deployment protection rules such as wait timers and reviewers; ensure `environment name` is url-encoded if it contains special characters.

Action Parameters

deployment__branch__policy__custom__branch__policies
boolean
deployment__branch__policy__protected__branches
boolean
environment_name
stringRequired
owner
stringRequired
prevent_self_review
boolean
repo
stringRequired
reviewers
array
wait_timer
integer

Action Response

data
object
error
successful
boolean
Creates or updates an environment secret with an `encrypted value` that was encrypted using the public key identified by `key id` for the specified environment.

Action Parameters

encrypted_value
stringRequired
environment_name
stringRequired
key_id
stringRequired
owner
stringRequired
repo
stringRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Creates or updates an organization secret for github actions, requiring its value to be pre-encrypted via libsodium using the organization's public key.

Action Parameters

encrypted_value
string
key_id
string
org
stringRequired
secret_name
stringRequired
selected_repository_ids
array
visibility
stringRequired

Action Response

data
object
error
successful
boolean
Creates or updates a github actions secret within a specific repository; use `encrypted value` and `key id` to set or change its value.

Action Parameters

encrypted_value
string
key_id
string
owner
stringRequired
repo
stringRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Creates new custom property schemas or updates existing ones in bulk for a specified organization; each property definition must include `property name` and `value type`.

Action Parameters

org
stringRequired
properties
arrayRequired

Action Response

data
object
error
successful
boolean
Creates a new custom property (name must be unique for creation) or updates an existing one for an organization to define metadata for its repositories.

Action Parameters

allowed_values
array
custom_property_name
stringRequired
default_value
string
description
string
org
stringRequired
required
boolean
value_type
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new file or updates an existing file in a github repository; provide `sha` to update an existing file, otherwise a new file is created.

Action Parameters

author__date
string
author__email
string
author__name
string
branch
string
committer__date
string
committer__email
string
committer__name
string
content
stringRequired
message
stringRequired
owner
stringRequired
path
stringRequired
repo
stringRequired
sha
string

Action Response

data
object
error
successful
boolean
Creates or updates a dependabot secret in a repository using an `encrypted value` (pre-encrypted with libsodium using the repository's dependabot public key) and its corresponding `key id`.

Action Parameters

encrypted_value
string
key_id
string
owner
stringRequired
repo
stringRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Creates or updates a codespaces secret for the authenticated user; `encrypted value` must be encrypted with the public key (id: `key id`) from github's 'get public key for the authenticated user' endpoint.

Action Parameters

encrypted_value
string
key_id
stringRequired
secret_name
stringRequired
selected_repository_ids
array

Action Response

data
object
error
successful
boolean
Creates a reaction for a specified issue within a github repository.

Action Parameters

content
stringRequired
issue_number
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Creates a reaction for a specific comment on an issue within a github repository.

Action Parameters

comment_id
integerRequired
content
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Creates an emoji reaction for a commit comment; if the user has already reacted with the same content, details of the existing reaction are returned.

Action Parameters

comment_id
integerRequired
content
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Adds a specified reaction to a pull request review comment within a github repository.

Action Parameters

comment_id
integerRequired
content
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Creates an emoji reaction for a specific, existing release in a github repository.

Action Parameters

content
stringRequired
owner
stringRequired
release_id
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Creates a reaction for a team discussion within a github organization.

Action Parameters

content
stringRequired
discussion_number
integerRequired
org
stringRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Adds a reaction to a team discussion comment, requiring the specified organization, team, discussion, and comment to exist.

Action Parameters

comment_number
integerRequired
content
stringRequired
discussion_number
integerRequired
org
stringRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Adds a reaction to a team discussion using a legacy github api endpoint; the specified `team id` and `discussion number` must correspond to an existing team and discussion.

Action Parameters

content
stringRequired
discussion_number
integerRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Adds a reaction to a specific comment within a team discussion using a legacy github api endpoint, requiring valid team, discussion, and comment identifiers.

Action Parameters

comment_number
integerRequired
content
stringRequired
discussion_number
integerRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Creates or updates a dependabot organization secret, requiring the secret value to be pre-encrypted with libsodium using the organization's public key obtained from the 'get an organization public key' endpoint.

Action Parameters

encrypted_value
string
key_id
string
org
stringRequired
secret_name
stringRequired
selected_repository_ids
array
visibility
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the openid connect (oidc) subject claim customization template for a repository, which defines the `sub` claim structure in oidc tokens for github actions workflows; returns the default configuration if no customization is applied.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the openid connect (oidc) subject claim customization template for a github organization, which defines how the `sub` claim in oidc tokens for workflows is constructed.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Sets 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`.

Action Parameters

include_claim_keys
array
owner
stringRequired
repo
stringRequired
use_default
booleanRequired

Action Response

data
object
error
successful
boolean
Declines a specific, pending repository invitation for the authenticated user, identified by its `invitation id`.

Action Parameters

invitation_id
integerRequired

Action Response

data
object
error
successful
boolean
Removes all user, team, and app-based access restrictions from a protected branch.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Removes admin enforcement from a protected branch (branch name cannot contain wildcard characters) in a repository.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Revokes a single, specific oauth access token for an oauth app, not all authorizations for the app.

Action Parameters

access_token
stringRequired
client_id
stringRequired

Action Response

data
object
error
successful
boolean
Revokes an oauth access token for a github app, if the app exists and the token was issued to it.

Action Parameters

access_token
stringRequired
client_id
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a github artifact by its id within a repository, typically resulting in an empty response (http 204 no content) on success.

Action Parameters

artifact_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Sends an empty request body to `delete /user/emails` to attempt deletion of user email addresses; the api typically requires specific emails, so outcome may vary.

Action Parameters

Action Response

data
object
error
successful
boolean
Deletes an existing deployment environment from an existing repository.

Action Parameters

environment_name
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes an existing and accessible secret from a specified environment within a github repository, returning an empty dictionary on success or error details otherwise.

Action Parameters

environment_name
stringRequired
owner
stringRequired
repo
stringRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a named environment variable from a specified, existing environment within a github repository.

Action Parameters

environment_name
stringRequired
name
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a specific comment by its id from an issue or pull request, if the repository exists and the comment id is valid.

Action Parameters

comment_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a reaction from an issue comment in a repository; the repository, comment, and reaction must exist.

Action Parameters

comment_id
integerRequired
owner
stringRequired
reaction_id
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Permanently removes a specific reaction from an issue in a github repository.

Action Parameters

issue_number
integerRequired
owner
stringRequired
reaction_id
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a github organization and its repositories; this is a destructive action and the organization name will be unavailable for reuse for approximately 90 days.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Deletes an existing migration archive for an organization, useful for removal before github's automatic 7-day deletion.

Action Parameters

migration_id
integerRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a repository ruleset from an organization; fails if the ruleset is currently applied to any repositories.

Action Parameters

org
stringRequired
ruleset_id
integerRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a secret from a github organization, making it inaccessible to github actions workflows or other tools.

Action Parameters

org
stringRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a named github actions variable from a specified organization.

Action Parameters

name
stringRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a specific webhook, identified by `hook id`, from an existing organization.

Action Parameters

hook_id
integerRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a specific codespace owned by the authenticated user; this is a destructive action and the codespace must exist.

Action Parameters

codespace_name
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a specific codespace belonging to a member of the specified organization.

Action Parameters

codespace_name
stringRequired
org
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Deletes 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.

Action Parameters

analysis_id
integerRequired
confirm_delete
string
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a specific commit comment, identified by its `comment id`, from the specified repository; the comment must exist.

Action Parameters

comment_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a reaction from a commit comment in a github repository.

Action Parameters

comment_id
integerRequired
owner
stringRequired
reaction_id
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a custom organization role (which should not be actively assigned) by its id; a 204 no content response indicates success.

Action Parameters

org
stringRequired
role_id
integerRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a specified *inactive* deployment from a repository.

Action Parameters

deployment_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a specific deployment branch or tag policy, identified by its id, from a given environment within a repository.

Action Parameters

branch_policy_id
integerRequired
environment_name
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes 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.

Action Parameters

key_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
error
successful
boolean
Deletes a specific team discussion, identified by its number, from an organization's team.

Action Parameters

discussion_number
integerRequired
org
stringRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a specific comment from an existing team discussion within an organization, provided the specified organization, team, discussion, and comment all exist.

Action Parameters

comment_number
integerRequired
discussion_number
integerRequired
org
stringRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a specific comment from a team discussion using a legacy github api endpoint.

Action Parameters

comment_number
integerRequired
discussion_number
integerRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Deletes a specific team discussion using a deprecated legacy api endpoint; requires `team id` of an existing team and `discussion number` of an existing discussion within that team.

Action Parameters

discussion_number
integerRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Deletes a file by path from a github repository, requiring a commit message and the file's current blob sha to confirm the deletion.

Action Parameters

author__email
string
author__name
string
branch
string
committer__email
string
committer__name
string
message
stringRequired
owner
stringRequired
path
stringRequired
repo
stringRequired
sha
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes an existing github gist, specified by its `gist id`; this action is destructive and cannot be undone.

Action Parameters

gist_id
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a specific comment from a github gist using its `gist id` and `comment id`.

Action Parameters

comment_id
integerRequired
gist_id
stringRequired

Action Response

data
object
error
successful
boolean
Deletes the github pages site for the specified repository; completes without error if no site is currently enabled.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes an existing gpg key, specified by its `gpg key id`, that belongs to the authenticated user.

Action Parameters

gpg_key_id
integerRequired

Action Response

data
object
error
successful
boolean
Permanently removes an existing label from a repository.

Action Parameters

name
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes the specified milestone if it exists; this operation is idempotent, typically returning a 404 if the milestone is not found or already deleted.

Action Parameters

milestone_number
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a specific package in an organization; cannot delete public packages with over 5,000 downloads.

Action Parameters

org
stringRequired
package_name
stringRequired
package_type
stringRequired

Action Response

data
object
error
successful
boolean
Deletes 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.

Action Parameters

package_name
stringRequired
package_type
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a specific package owned by the authenticated user; public packages downloaded over 5,000 times cannot be deleted via this api.

Action Parameters

package_name
stringRequired
package_type
stringRequired

Action Response

data
object
error
successful
boolean
Deletes an existing package version associated with the authenticated user.

Action Parameters

package_name
stringRequired
package_type
stringRequired
package_version_id
integerRequired

Action Response

data
object
error
successful
boolean
Deletes a pending (unsubmitted) review from a pull request; this is only possible if the review has not yet been submitted.

Action Parameters

owner
stringRequired
pull_number
integerRequired
repo
stringRequired
review_id
integerRequired

Action Response

data
object
error
successful
boolean
Deletes the github project specified by `project id` if the project exists and the projects feature is enabled for its repository or organization; a successful deletion results in a 204 no content response.

Action Parameters

project_id
integerRequired

Action Response

data
object
error
successful
boolean
Deletes a project card from a github 'project (classic)'; this operation is idempotent.

Action Parameters

card_id
integerRequired

Action Response

data
object
error
successful
boolean
Deletes a project column by its id from a github project (classic); this is a destructive operation.

Action Parameters

column_id
integerRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a public ssh key, identified by its `key id`, from the authenticated user's github account, provided the key exists and belongs to the user.

Action Parameters

key_id
integerRequired

Action Response

data
object
error
successful
boolean
Deletes a specific reaction from a pull request review comment, provided the comment and reaction exist on that comment within the specified repository.

Action Parameters

comment_id
integerRequired
owner
stringRequired
reaction_id
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a git reference from a repository; 'ref' must be fully qualified (e.g., 'refs/heads/branch' or 'refs/tags/tag').

Action Parameters

owner
stringRequired
ref
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a specific release, its assets, and potentially its associated git tag from a repository.

Action Parameters

owner
stringRequired
release_id
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a specific release asset from a github repository; this action is idempotent.

Action Parameters

asset_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a reaction from a github release, provided the repository, release, and reaction exist.

Action Parameters

owner
stringRequired
reaction_id
integerRequired
release_id
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes the specified repository; this is a destructive, irreversible action that requires admin privileges for the repository.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes an active repository invitation, permanently revoking a user's access to collaborate on the specified repository.

Action Parameters

invitation_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a repository ruleset.

Action Parameters

owner
stringRequired
repo
stringRequired
ruleset_id
integerRequired

Action Response

data
object
error
successful
boolean
Deletes a named github actions secret from a specified repository; this operation is destructive and idempotent, and requires the repository to exist.

Action Parameters

owner
stringRequired
repo
stringRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Deletes the authenticated user's subscription to a specified repository if it exists, effectively 'unwatching' it.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a named variable (e.g., for github actions workflows) from a repository; the repository and the variable must already exist.

Action Parameters

name
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a specific webhook from a repository.

Action Parameters

hook_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a specific pull request review comment.

Action Parameters

comment_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes an existing codespaces secret for the authenticated user by `secret name`; this is a destructive, irreversible, and idempotent operation.

Action Parameters

secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Deletes an existing and registered self-hosted runner from an organization, typically returning 204 no content on success.

Action Parameters

org
stringRequired
runner_id
integerRequired

Action Response

data
object
error
successful
boolean
Removes a specific self-hosted runner (by `runner id`) from a repository, if registered there; this is idempotent.

Action Parameters

owner
stringRequired
repo
stringRequired
runner_id
integerRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a specific tag protection rule, identified by its id, from the given repository.

Action Parameters

owner
stringRequired
repo
stringRequired
tag_protection_id
integerRequired

Action Response

data
object
error
successful
boolean
Deletes a team (and any child teams) from an organization.

Action Parameters

org
stringRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a team using a deprecated legacy github api endpoint; requires organization owner or team maintainer (with delete rights) privileges.

Action Parameters

team_id
integerRequired

Action Response

data
object
error
successful
boolean
Call 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.

Action Parameters

thread_id
integerRequired

Action Response

data
object
error
successful
boolean
Deletes a user migration archive, allowing for removal before github's automatic 7-day deletion period ends.

Action Parameters

migration_id
integerRequired

Action Response

data
object
error
successful
boolean
Deletes a specific workflow run from a repository.

Action Parameters

owner
stringRequired
repo
stringRequired
run_id
integerRequired

Action Response

data
object
error
successful
boolean
Removes all protection rules from a specific branch in a github repository; the branch must currently have protection rules enabled.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Disables gpg commit signature protection for a specific branch in a github repository, meaning commits pushed to this branch no longer require gpg signing.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a specific dependabot secret, identified by its name, from a given repository if both the repository and secret exist.

Action Parameters

owner
stringRequired
repo
stringRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a specific github actions cache from a repository using its unique `cache id`.

Action Parameters

cache_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a specific package version within an organization; requires admin permissions for packages with over 5,000 downloads.

Action Parameters

org
stringRequired
package_name
stringRequired
package_type
stringRequired
package_version_id
integerRequired

Action Response

data
object
error
successful
boolean
Permanently and irreversibly deletes a specific version of a package owned by the specified user.

Action Parameters

package_name
stringRequired
package_type
stringRequired
package_version_id
integerRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Disables 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.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a specific codespace secret from a repository by its name; this action is idempotent and will succeed even if the secret doesn't exist.

Action Parameters

owner
stringRequired
repo
stringRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Deletes currently linked social media account urls from the authenticated user's github profile.

Action Parameters

account_urls
arrayRequired

Action Response

data
object
error
successful
boolean
Deletes an ssh signing key, identified by `ssh signing key id`, belonging to the authenticated user.

Action Parameters

ssh_signing_key_id
integerRequired

Action Response

data
object
error
successful
boolean
Deletes a reaction from a team discussion comment, given the organization name, team slug, discussion number, comment number, and reaction id.

Action Parameters

comment_number
integerRequired
discussion_number
integerRequired
org
stringRequired
reaction_id
integerRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a specific reaction from a team discussion within an organization.

Action Parameters

discussion_number
integerRequired
org
stringRequired
reaction_id
integerRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Deletes all logs for a specific workflow run in a github repository, provided the repository and run exist.

Action Parameters

owner
stringRequired
repo
stringRequired
run_id
integerRequired

Action Response

data
object
error
successful
boolean
Disables automated security fixes (github's automatic pull requests for vulnerable dependencies) for a repository; primarily for github enterprise cloud/server.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Disables a specific, currently active custom deployment protection rule for an existing environment within a github repository.

Action Parameters

environment_name
stringRequired
owner
stringRequired
protection_rule_id
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Disables a specified workflow (by id or filename) in a given github repository, preventing new automatic triggers; any in-progress runs will continue.

Action Parameters

owner
stringRequired
repo
stringRequired
workflow_id
integerRequired

Action Response

data
object
error
successful
boolean
Disables github actions for a specific repository within an organization; this action is only effective if the organization's github actions `enabled repositories` setting is configured to `selected`.

Action Parameters

org
stringRequired
repository_id
integerRequired

Action Response

data
object
error
successful
boolean
Disables dependabot alerts for a specified repository, preventing github from scanning its dependencies for vulnerabilities and generating new alerts.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Dismisses a review on a pull request with a mandatory explanatory message.

Action Parameters

event
string
message
stringRequired
owner
stringRequired
pull_number
integerRequired
repo
stringRequired
review_id
integerRequired

Action Response

data
object
error
successful
boolean
Downloads a specific github repository artifact, returning a temporary url to its 'zip' archive, valid for one minute.

Action Parameters

archive_format
stringRequired
artifact_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a 302 redirect url to download a completed and available organization migration archive.

Action Parameters

migration_id
integerRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Downloads a repository's source code as a tarball (.tar.gz) archive for a specific git reference, if the repository is accessible.

Action Parameters

owner
stringRequired
ref
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Downloads a repository's source code as a zip archive for a specific git reference (branch, tag, or commit sha).

Action Parameters

owner
stringRequired
ref
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Downloads a user's migration archive (a .tar.gz file containing repositories and associated data) if the migration's status is 'exported'.

Action Parameters

migration_id
integerRequired

Action Response

data
object
error
successful
boolean
Downloads logs for a specific job in a github actions workflow run, contingent on the repository's existence and the job id being valid and having produced logs.

Action Parameters

job_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Downloads a zip archive of logs for a specific workflow run attempt.

Action Parameters

attempt_number
integerRequired
owner
stringRequired
repo
stringRequired
run_id
integerRequired

Action Response

data
object
error
successful
boolean
Downloads logs for a specific github actions workflow run, typically archived as a zip file, if logs are available (e.g., not expired and the workflow has produced output).

Action Parameters

owner
stringRequired
repo
stringRequired
run_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists all emojis available for use on github; deprecated, use `get emojis` instead.

Action Parameters

Action Response

data
object
error
successful
boolean
Enables automated security fixes for a repository using dependabot, requiring active dependency graph and dependabot alerts.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Reactivates a currently disabled github actions workflow within a repository using its numerical id.

Action Parameters

owner
stringRequired
repo
stringRequired
workflow_id
integerRequired

Action Response

data
object
error
successful
boolean
Sets 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'.

Action Parameters

org
stringRequired
selected_repository_ids
arrayRequired

Action Response

data
object
error
successful
boolean
Enables or disables a specific security product (like `dependabot alerts` or `code scanning default setup`) for all eligible repositories in a github organization.

Action Parameters

enablement
stringRequired
org
stringRequired
query_suite
string
security_product
stringRequired

Action Response

data
object
error
successful
boolean
Enables github actions for a repository if the organization's actions permissions are set to allow for 'selected repositories'.

Action Parameters

org
stringRequired
repository_id
integerRequired

Action Response

data
object
error
successful
boolean
Enables vulnerability alerts and, if necessary, the dependency graph for an existing repository; this operation is idempotent.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Creates or updates a repository's development environment secret using an `encrypted value` and its corresponding `key id`; the secret must be pre-encrypted with the repository's codespaces public key.

Action Parameters

encrypted_value
string
key_id
string
owner
stringRequired
repo
stringRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Creates or updates an organization's github codespaces secret using an encrypted value and its corresponding public key id.

Action Parameters

encrypted_value
string
key_id
string
org
stringRequired
secret_name
stringRequired
selected_repository_ids
array
visibility
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves an organization's public key, which must be used to encrypt secret values before they are configured for codespaces.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Triggers an export of a user's specified codespace, automatically stopping it if active, and returns its export status and download url.

Action Parameters

codespace_name
stringRequired

Action Response

data
object
error
successful
boolean
Exports the software bill of materials (sbom) in spdx json format for a repository, if its dependency graph is enabled and it has at least one commit.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the public key for an existing github organization, required for encrypting dependabot secrets.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Identifies packages conflicting with a github user's docker migration; the specified username must correspond to an existing github account.

Action Parameters

username
stringRequired

Action Response

data
object
error
successful
boolean
Allows the authenticated user to follow the github user specified by `username`; this action is idempotent and the user cannot follow themselves.

Action Parameters

username
stringRequired

Action Response

data
object
error
successful
boolean
Forcefully cancels an existing github actions workflow run, bypassing normal cancellation conditions; requires write permissions to the repository.

Action Parameters

owner
stringRequired
repo
stringRequired
run_id
integerRequired

Action Response

data
object
error
successful
boolean
Forks a specified public gist, creating a copy under the authenticated user's account.

Action Parameters

gist_id
stringRequired

Action Response

data
object
error
successful
boolean
Generates markdown release notes content (listing changes, pull requests, and contributors) for a github repository release, customizable via tags and a configuration file.

Action Parameters

configuration_file_path
string
owner
stringRequired
previous_tag_name
string
repo
stringRequired
tag_name
stringRequired
target_commitish
string

Action Response

data
object
error
successful
boolean
Lists users, teams, and github apps with push access to a branch; this branch must be protected in repository settings for detailed restrictions, otherwise expect a 404 or empty response.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Checks if repository administrators are subject to the branch protection rules on a specific branch.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the github actions permissions policy, including allowed actions and reusable workflows, for a specified organization.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all officially supported, date-based (e.g., "2022-11-28") versions of the github rest api from the /versions endpoint.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves all available codes of conduct from github, often used to select one for a repository.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves a list of commonly used software licenses from github, optionally filtering for 'featured' licenses whose specific selection criteria by github may vary.

Action Parameters

featured
boolean
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Retrieves 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.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets the schema definitions for all custom properties configured for an organization, not the specific values assigned to repositories.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Gets all custom property values for a repository, which may include default values or be empty if no properties are explicitly set.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all enabled custom deployment protection rules for a specific environment in a repository; the environment must exist and be configured for deployments.

Action Parameters

environment_name
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all available .gitignore template names from github (e.g., 'python', 'node', 'java'), used for generating .gitignore files.

Action Parameters

Action Response

data
object
error
successful
boolean
Fetches all repository rulesets for an existing github organization, which define interaction policies for branches and tags across multiple repositories.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists all custom organization roles for an existing github organization.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all rulesets for a github repository, which define conditions and actions for repository interactions (e.g., branch protections).

Action Parameters

includes_parents
booleanDefaults to True
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all topics for a specified, existing, and accessible repository.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets all users and teams requested to review a specific pull request in a repository.

Action Parameters

owner
stringRequired
pull_number
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Fetches all required status check contexts for a protected branch; returns an empty list if the branch isn't protected or has no required checks.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves publicly available information for an existing github app, identified by its unique url-friendly `app slug`.

Action Parameters

app_slug
stringRequired

Action Response

data
object
error
successful
boolean
Gets a specific artifact for a repository by `artifact id`.

Action Parameters

artifact_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for a specific github classroom assignment if the authenticated user is an administrator of the classroom.

Action Parameters

assignment_id
integerRequired

Action Response

data
object
error
successful
boolean
Gets a github repository's deployment environment by name, including its protection rules and any deployment branch policies.

Action Parameters

environment_name
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the public key for a specified github repository environment, used to encrypt secrets for github actions.

Action Parameters

environment_name
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves metadata (not the value) for a specific secret within an existing environment of a github repository.

Action Parameters

environment_name
stringRequired
owner
stringRequired
repo
stringRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific plain environment variable (not secrets), including its name, value, and timestamps, from a github actions environment within a repository.

Action Parameters

environment_name
stringRequired
name
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the status of an ongoing or completed repository import, which must have been previously initiated; this action will be deprecated by github on april 12, 2024.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information about a specific issue within a github repository.

Action Parameters

issue_number
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific issue comment by its id from a repository.

Action Parameters

comment_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific issue event (e.g., label addition, assignment, commit reference) by its id from a repository.

Action Parameters

event_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed public information for a specified github organization if it exists.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the status (e.g., 'pending', 'exporting', 'exported', 'failed') of a previously initiated github organization migration, optionally excluding repository details for performance.

Action Parameters

exclude
array
migration_id
integerRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Gets an organization's public key, required for encrypting secrets for use with github actions, dependabot, or codespaces.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific repository ruleset for an organization.

Action Parameters

org
stringRequired
ruleset_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific github organization role by its id.

Action Parameters

org
stringRequired
role_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for a specific rule suite in an organization, which represents the evaluation results of a github ruleset.

Action Parameters

org
stringRequired
rule_suite_id
integerRequired

Action Response

data
object
error
successful
boolean
Gets an organization secret's metadata (e.g., name, creation/update dates, visibility), but not its encrypted value.

Action Parameters

org
stringRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves details (name, value, visibility, timestamps) of a specific, existing variable for an existing github organization.

Action Parameters

name
stringRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the full configuration, including subscribed events and delivery settings, for an existing organization webhook.

Action Parameters

hook_id
integerRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific, existing ssh signing key (used for signing commits and tags) for the authenticated user by its `ssh signing key id`.

Action Parameters

ssh_signing_key_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists github apps with push access to a repository's protected branch.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all grades for an existing github classroom assignment.

Action Parameters

assignment_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves the raw, typically base64-encoded, content of a file (blob) from a github repository using its sha hash, if the repository and blob sha exist.

Action Parameters

file_sha
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for a specified branch within a github repository.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for a specific check run within a github repository.

Action Parameters

check_run_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific check suite (a collection of check runs) by its id from a repository accessible to the authenticated user.

Action Parameters

check_suite_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves details for a specific github classroom; the classroom id must correspond to an existing classroom.

Action Parameters

classroom_id
integerRequired

Action Response

data
object
error
successful
boolean
Call to retrieve detailed information for a `codespace name` belonging to the authenticated user, ensuring the codespace exists and is accessible.

Action Parameters

codespace_name
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the full details of a specific github code of conduct using its unique key.

Action Parameters

key
stringRequired

Action Response

data
object
error
successful
boolean
Gets an existing codeql database (including a download url) for a specified language in an accessible repository, if one has been successfully built for that language.

Action Parameters

language
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific code scanning alert, which identifies potential code vulnerabilities or errors, by its number from the specified github repository.

Action Parameters

alert_number
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for a specific code scanning analysis on an accessible repository, identified by its `analysis id`.

Action Parameters

analysis_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets the default setup configuration for code scanning in a repository, including state, languages, query suite, and schedule for a repository if it exists.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific commit from a repository by its owner, name, and a valid commit reference (sha, branch, or tag), supporting pagination for large diffs.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
ref
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the full details of a specific commit comment in a github repository, using its unique identifier.

Action Parameters

comment_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information (including author, committer, message, tree, parents, verification) for a specific commit in a github repository, identified by its sha.

Action Parameters

commit_sha
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific custom deployment protection rule (used by github apps for external validation or manual approval of deployments) for a given environment in a repository.

Action Parameters

environment_name
stringRequired
owner
stringRequired
protection_rule_id
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the definition (schema) of a specific, existing custom property for an organization.

Action Parameters

custom_property_name
stringRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific delivery for a repository webhook, identified by its `hook id` and `delivery id`.

Action Parameters

delivery_id
integerRequired
hook_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets a specific dependabot alert by its number from a repository, which must have dependabot alerts enabled.

Action Parameters

alert_number
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets a specific deployment by id from a repository, provided the repository and deployment id exist.

Action Parameters

deployment_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific deployment branch policy for an environment in a repository, identified by its unique id.

Action Parameters

branch_policy_id
integerRequired
environment_name
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific deployment status by its id for a given deployment within a github repository.

Action Parameters

deployment_id
integerRequired
owner
stringRequired
repo
stringRequired
status_id
integerRequired

Action Response

data
object
error
successful
boolean
Gets a specific deploy key, identified by its `key id`, for the github repository specified by `owner` and `repo`.

Action Parameters

key_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets the dependency diff between two git revisions in a repository, where 'basehead' specifies the revisions and 'name' can optionally scope to a specific manifest file.

Action Parameters

basehead
stringRequired
name
string
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Fetches a specific discussion by its number from a team within an organization.

Action Parameters

discussion_number
integerRequired
org
stringRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Fetches a specific comment from a team discussion within a specific organization.

Action Parameters

comment_number
integerRequired
discussion_number
integerRequired
org
stringRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific comment from a team discussion by its team id, discussion number, and comment number; this action uses a deprecated legacy github api endpoint.

Action Parameters

comment_number
integerRequired
discussion_number
integerRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific team discussion using its `discussion number` and the `team id` via a legacy github api endpoint.

Action Parameters

discussion_number
integerRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves 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.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Fetches a specific github gist by its `gist id`, returning comprehensive details if the gist exists.

Action Parameters

gist_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific gist comment by its id and the gist's id.

Action Parameters

comment_id
integerRequired
gist_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific revision of a gist.

Action Parameters

gist_id
stringRequired
sha
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves information for a github pages site, which must be enabled for the repository.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific .gitignore template from github by its name, which must be an existing template in github's collection.

Action Parameters

name
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information about a specific global security advisory from the github advisory database using its unique ghsa id.

Action Parameters

ghsa_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for a specific gpg key (identified by `gpg key id`) belonging to the authenticated user.

Action Parameters

gpg_key_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for a specific job within a github actions workflow run, given its `job id` which must be valid for the specified repository's workflow.

Action Parameters

job_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific label by its name from a specified github repository.

Action Parameters

name
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Call this action to retrieve comprehensive details for a specific software license recognized by github, using its unique license key.

Action Parameters

license
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for a specific milestone within a github repository by its number.

Action Parameters

milestone_number
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific package (by type and name) from an organization, if both the package and organization exist.

Action Parameters

org
stringRequired
package_name
stringRequired
package_type
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves metadata for a specific package owned by a github user, using package type, name, and username as identifiers.

Action Parameters

package_name
stringRequired
package_type
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for a specific package owned by the authenticated user.

Action Parameters

package_name
stringRequired
package_type
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for a specific version of a package within an organization.

Action Parameters

org
stringRequired
package_name
stringRequired
package_type
stringRequired
package_version_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific public package version associated with a github user.

Action Parameters

package_name
stringRequired
package_type
stringRequired
package_version_id
integerRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for an existing specific package version associated with the authenticated user, identified by its type, name, and version id.

Action Parameters

package_name
stringRequired
package_type
stringRequired
package_version_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for a specific github project using its unique `project id`.

Action Parameters

project_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves all details of a specific project card, given its unique `card id`.

Action Parameters

card_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for a specific project column; the column must exist.

Action Parameters

column_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific public ssh key (identified by `key id`) for the authenticated user.

Action Parameters

key_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific pull request from a github repository using its owner, repository name, and pull request number.

Action Parameters

owner
stringRequired
pull_number
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific git reference (e.g., a branch, tag, or fully qualified like 'heads/main') from a github repository.

Action Parameters

owner
stringRequired
ref
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets a specific release from a github repository, provided the repository is accessible and the release exists.

Action Parameters

owner
stringRequired
release_id
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets metadata for a specific release asset in a github repository, including a `browser download url` for downloading the asset.

Action Parameters

asset_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets a release from a github repository by its tag name; the repository and a release with this tag must already exist.

Action Parameters

owner
stringRequired
repo
stringRequired
tag
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information about an existing and accessible github repository.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets a repository's public key for encrypting secrets to be used in github actions, if the repository exists and is accessible.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Fetches the readme file (if it exists and is accessible) from a specified github repository, returning its base64-encoded content and metadata.

Action Parameters

owner
stringRequired
ref
string
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the readme file from a specified directory within a github repository, optionally at a given commit, branch, or tag.

Action Parameters

dir
stringRequired
owner
stringRequired
ref
string
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves 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.

Action Parameters

includes_parents
booleanDefaults to True
owner
stringRequired
repo
stringRequired
ruleset_id
integerRequired

Action Response

data
object
error
successful
boolean
Gets detailed information for a specific repository rule suite by its id, including its evaluation status and the results of its individual rules.

Action Parameters

owner
stringRequired
repo
stringRequired
rule_suite_id
integerRequired

Action Response

data
object
error
successful
boolean
Gets metadata (name, creation/update timestamps) for an existing repository secret, excluding its encrypted value.

Action Parameters

owner
stringRequired
repo
stringRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a security advisory for a repository using its ghsa id, which must be valid for the specified repository.

Action Parameters

ghsa_id
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets the authenticated user's subscription details for a repository, indicating if they receive notifications.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets a specific github actions variable by name from an accessible repository.

Action Parameters

name
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Returns the configuration of an existing webhook for a given repository.

Action Parameters

hook_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific pull request review comment by its id, provided the repository exists, is accessible, and the comment id is valid.

Action Parameters

comment_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific review for a pull request using its owner, repository, pull request number, and review id.

Action Parameters

owner
stringRequired
pull_number
integerRequired
repo
stringRequired
review_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves metadata (name, timestamps, visibility; not the value) for a specific, existing development environment secret associated with the authenticated user's github codespaces.

Action Parameters

secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for a specific secret scanning alert within a repository, identified by its alert number.

Action Parameters

alert_number
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information about a specific self-hosted runner registered within a github organization.

Action Parameters

org
stringRequired
runner_id
integerRequired

Action Response

data
object
error
successful
boolean
Gets a specific self-hosted runner for a repository by its unique id.

Action Parameters

owner
stringRequired
repo
stringRequired
runner_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for a specific git tag object from a github repository, using the sha of the tag object itself.

Action Parameters

owner
stringRequired
repo
stringRequired
tag_sha
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a github team by its slug from a specific organization.

Action Parameters

org
stringRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Gets a team by its unique id using a deprecated github api endpoint; prefer current team retrieval methods if possible.

Action Parameters

team_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific github notification thread using its unique `thread id`.

Action Parameters

thread_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves a git tree (directory listing) from a github repository using its sha, branch name, or tag name, optionally fetching all nested items recursively.

Action Parameters

owner
stringRequired
recursive
string
repo
stringRequired
tree_sha
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the public profile information for an existing github user, specified by their username.

Action Parameters

username
stringRequired

Action Response

data
object
error
successful
boolean
Fetches the status of a previously initiated data migration for the authenticated user.

Action Parameters

exclude
array
migration_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves the configuration for a specific webhook associated with a github organization.

Action Parameters

hook_id
integerRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Returns the configuration for an existing webhook on the specified repository.

Action Parameters

hook_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Returns detailed information for a specific delivery attempt of a webhook configured for the specified github organization.

Action Parameters

delivery_id
integerRequired
hook_id
integerRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for a specific github actions workflow in a repository, identified by either its numeric id or its filename.

Action Parameters

owner
stringRequired
repo
stringRequired
workflow_id
integer
workflow_name
string

Action Response

data
object
error
successful
boolean
Gets a specific workflow run by its id from a github repository.

Action Parameters

exclude_pull_requests
boolean
owner
stringRequired
repo
stringRequired
run_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for a specific attempt of a workflow run in a github repository, including its status, conclusion, and timings.

Action Parameters

attempt_number
integerRequired
exclude_pull_requests
boolean
owner
stringRequired
repo
stringRequired
run_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves branch protection settings for a specific, existing, and accessible branch in a github repository; protection feature availability varies by github product plan.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Fetches commit authors identified during a repository import, used to map authors from an external vcs to github accounts.

Action Parameters

owner
stringRequired
repo
stringRequired
since
integer

Action Response

data
object
error
successful
boolean
Gets the commit signature protection status for a branch in a repository.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a repository's community profile metrics, including health percentage and the presence of key community files (e.g., readme, license).

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets contextual hovercard information for a github user; `subject type` and `subject id` can be jointly provided for more specific details.

Action Parameters

subject_id
string
subject_type
string
username
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves github copilot seat assignment details for a specific user who is a member of the organization, which must have copilot enabled.

Action Parameters

org
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Gets an organization's github copilot seat information and settings; the organization must have an active copilot subscription.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Get pre-flight data (e.g., default location, devcontainer path) for creating a codespace in a given repository (must exist and be accessible), optionally for a specific git ref.

Action Parameters

client_ip
string
owner
stringRequired
ref
string
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets the default workflow permissions (`read` or `write`) for the github token and whether it can approve pull request reviews in an existing and accessible repository.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets the default github token workflow permissions and settings for a github organization.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information about a specific export of a codespace.

Action Parameters

codespace_name
stringRequired
export_id
stringRequired

Action Response

data
object
error
successful
boolean
Lists all emojis available for use on github, including custom and unicode emojis.

Action Parameters

Action Response

data
object
error
successful
boolean
Fetches a list of available github feed urls for the authenticated user.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves the github actions billing summary (total/paid/included minutes, os breakdown) for an existing github organization.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves github actions billing information for a specified user, focusing on minute usage in private repositories.

Action Parameters

username
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves total github actions cache usage statistics for an organization, including active cache count and size across all repositories.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the total count of active github actions caches and their combined size in bytes for a specified repository.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets the github actions permissions for a specified organization, detailing repository enablement and allowed actions policies.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Gets the github actions permissions policy for a repository, including its enabled status and the scope of allowed actions.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Fetches github's publicly available metadata, useful for configuring network security policies or ip allow-listing.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves github packages billing information for an organization, including detailed bandwidth usage metrics.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Gets a user's github packages billing, detailing free and paid storage usage in gb (paid typically relates to private repositories).

Action Parameters

username
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information about a specific github pages build for a repository, which must have github pages enabled.

Action Parameters

build_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information, including processing status and results url, about a specific sarif (static analysis results interchange format) upload for a repository, uniquely identified by its sarif id.

Action Parameters

owner
stringRequired
repo
stringRequired
sarif_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves 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.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves active interaction restrictions for a repository, detailing which user groups are limited from activities like commenting or creating pull requests, and when these restrictions expire.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves currently active interaction restrictions for the authenticated user's public repositories.

Action Parameters

Action Response

data
object
error
successful
boolean
Lists files larger than 100mb identified during a previous source import for the specified repository; this endpoint is deprecated and will be removed on april 12, 2024.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves information about the most recent github pages build for a repository, which must exist, be accessible, have github pages enabled, and have at least one prior build.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Fetches an ascii art representation of github's octocat, suitable for text-based displays.

Action Parameters

s
string

Action Response

data
object
error
successful
boolean
Retrieves the membership details (role, state) for a user within a github organization; the authenticated user must be an organization member to view other users' memberships.

Action Parameters

org
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves metadata for a specific secret available to an organization's github codespaces without exposing its encrypted value.

Action Parameters

org
stringRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the authenticated user's membership state and role within a named github organization; the organization must exist.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves page view statistics for a repository over the last 14 days, including total views, unique visitors, and a daily or weekly breakdown.

Action Parameters

owner
stringRequired
per
stringDefaults to day
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves pending deployment environments for a specific workflow run that are awaiting approval due to protection rules.

Action Parameters

owner
stringRequired
repo
stringRequired
run_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves a collaborator's permission level (admin, write, read, or none) for an existing github project.

Action Parameters

project_id
integerRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a repository's public key for encrypting github codespaces secrets; requires `repo` scope or equivalent read access to codespaces secrets for private repositories.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the authenticated user's public github key, used to encrypt secrets for github codespaces.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves the pull request review protection settings for a specific branch in a github repository, if such protection is configured.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the authenticated user's current github api rate limit status, including usage and limits across different resource categories.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves the total number of clones and a breakdown of clone activity (daily or weekly) for a specified repository over the preceding 14 days.

Action Parameters

owner
stringRequired
per
stringDefaults to day
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a file's base64 encoded content or a directory's metadata (but not a listing of its contents) from a github repository path.

Action Parameters

owner
stringRequired
path
stringRequired
ref
string
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific user's permission level ('admin', 'write', 'read', or 'none') for a given repository, where 'maintain' role is reported as 'write' and 'triage' as 'read'.

Action Parameters

owner
stringRequired
repo
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves metadata for an existing dependabot secret in a repository, without exposing its encrypted value.

Action Parameters

owner
stringRequired
repo
stringRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Gets the settings for allowed actions and reusable workflows that can be run in the specified repository.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets metadata (name, creation/update timestamps) for a specific, existing development environment secret (codespaces secret) in a repository, without exposing its value.

Action Parameters

owner
stringRequired
repo
stringRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all active rules for a specific branch in a github repository, excluding rules in 'evaluate' or 'disabled' status.

Action Parameters

branch
stringRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Fetches billing details for an organization's shared storage (github actions and packages), primarily for private repository usage.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a github user's shared storage billing information, detailing estimated paid/total storage usage and days remaining in the current billing cycle.

Action Parameters

username
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves metadata (e.g., name, creation/update timestamps, visibility) for an organization's dependabot secret, without its encrypted value.

Action Parameters

org
stringRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the status check protection settings for a specific branch in a github repository, if status check protection is enabled for it.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists teams with explicit push access to a protected branch, provided team restrictions are configured in the branch's protection settings; returns an empty list otherwise.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a user's role and membership status within a specific team in an organization.

Action Parameters

org
stringRequired
team_slug
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Checks a user's team membership status and role using a legacy github api endpoint; prefer the "get team membership for a user" action.

Action Parameters

team_id
integerRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: prefer 'get team membership for a user'; this legacy action checks if a user is a github team member, with 204 (empty `data`) for membership and 404 for non-membership or invalid team/user.

Action Parameters

team_id
integerRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Gets the profile information for the currently authenticated github user, including potentially private details based on user settings.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves the aggregated commit status (e.g., success, failure, pending) from all checks for a specific reference (sha, branch, or tag) in a github repository.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
ref
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the 'punch card' data, showing hourly commit counts for each day of the week for an existing and accessible repository.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Fetches weekly commit totals and daily commit counts for the last 52 weeks for a specified github repository.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Fetches the latest official (non-prerelease, non-draft) release for a github repository; requires at least one such published release.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the license file and its details for a repository, optionally from a specific git reference (branch, tag, or commit sha).

Action Parameters

owner
stringRequired
ref
string
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the detailed approval history for a specific workflow run in a github repository, detailing each review's environment, state, reviewer, and comments, to track the approval process for workflows, particularly automated deployments.

Action Parameters

owner
stringRequired
repo
stringRequired
run_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves the status of a specific github pages deployment for a repository, which must have github pages enabled.

Action Parameters

owner
stringRequired
pages_deployment_id
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Fetches the weekly commit activity (additions and deletions per week) for a repository over the past year; best for repositories with under 10,000 commits.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves 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.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a random quote from github's 'zen of github' collection, reflecting github's design philosophies and offering humorous insights, useful for displaying github wisdom or a lighthearted message.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves the authenticated user's subscription details for a specific notification thread, identified by `thread id`.

Action Parameters

thread_id
integerRequired

Action Response

data
object
error
successful
boolean
Fetches the top 10 most viewed content paths for a repository from the last 14 days.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Fetches the top 10 websites that referred traffic to a repository within the last 14 days.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists users with explicit push access to a protected branch, provided its protection rule restricts pushes to specific users.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets the access level settings for a private repository, determining how workflows outside this repository can use its actions and reusable workflows.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Gets the billable time, in milliseconds, for a specific workflow run, detailing time spent on various operating systems.

Action Parameters

owner
stringRequired
repo
stringRequired
run_id
integerRequired

Action Response

data
object
error
successful
boolean
Gets the billable time (in milliseconds, broken down by runner os) for a specific workflow within a repository for the current billing cycle.

Action Parameters

owner
stringRequired
repo
stringRequired
workflow_id
integerRequired

Action Response

data
object
error
successful
boolean
Deprecated: use `create a gist` instead. creates a new github gist with specified files, content, an optional description, and public visibility.

Action Parameters

description
string
files
objectRequired
public
boolean

Action Response

data
object
error
successful
boolean
(deprecated: use `list public gists` instead) lists public gists from github, optionally filtering by a 'since' timestamp and supporting pagination; results are generally newest first.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
since
string

Action Response

data
object
error
successful
boolean
Retrieves a map of all top-level github rest api resource urls and their templates.

Action Parameters

Action Response

data
object
error
successful
boolean
Disables private vulnerability reporting for an existing github repository, preventing direct private vulnerability reports to maintainers via github's interface for this repository.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Enables private vulnerability reporting for a repository, allowing security researchers to privately submit vulnerability reports to maintainers.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: use `check if a pull request has been merged` instead. checks if a github pull request has been merged, indicated by a 204 http status (merged) or 404 (not merged/found).

Action Parameters

owner
stringRequired
pull_number
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
(deprecated: use `create an issue` instead) creates a new issue in a github repository, provided issues are enabled and the user has sufficient permissions.

Action Parameters

assignee
string
assignees
array
body
string
labels
array
milestone
string
owner
stringRequired
repo
stringRequired
title
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: use `create an issue comment` to create a comment on an existing github issue or pull request.

Action Parameters

body
stringRequired
issue_number
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: use the `get an issue` action instead to retrieve details for a specific issue in a repository.

Action Parameters

issue_number
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: use `list assignees`. lists users who can be assigned to issues in a repository, typically those with push access.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all issue events for a specified repository. <<deprecated: this action is deprecated. use `list issue events for a repository` instead.>>

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 1
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all issues (including pull requests) in a github repository; deprecated: use list repository issues.

Action Parameters

assignee
string
creator
string
direction
stringDefaults to desc
labels
string
mentioned
string
milestone
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 1
repo
stringRequired
since
string
sort
stringDefaults to created
state
stringDefaults to open

Action Response

data
object
error
successful
boolean
Lists accepted assignments (student repositories created after acceptance) for an existing github classroom assignment, identified by its unique `assignment id`.

Action Parameters

assignment_id
integerRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists github app installations accessible to the specified organization, including those in its repositories or where the app has been granted access, useful for auditing application access.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists github app installations accessible to the authenticated user via their access token, including installation details, permissions, and repository access.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists github actions workflow artifacts for a specified repository, which must exist.

Action Parameters

name
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists users who can be assigned to issues in a repository, typically those with push access.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all assignments for a given github classroom `classroom id`; the classroom must exist and be accessible.

Action Parameters

classroom_id
integerRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists machine types available for github codespaces in a repository, optionally using a git ref to check compatibility based on prebuild availability and devcontainer configurations.

Action Parameters

client_ip
string
location
string
owner
stringRequired
ref
string
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists branches for an existing github repository, with an option to filter by protection status.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
protected
boolean
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists branches in an accessible repository where the provided commit sha is the head, useful for identifying development lines based on that commit.

Action Parameters

commit_sha
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists check runs for a given git reference within a repository; ensure the reference exists and the repository is accessible.

Action Parameters

app_id
integer
check_name
string
filter
stringDefaults to latest
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
ref
stringRequired
repo
stringRequired
status
string

Action Response

data
object
error
successful
boolean
Lists check runs for a specific check suite in a github repository, optionally filtering by check name or status.

Action Parameters

check_name
string
check_suite_id
integerRequired
filter
stringDefaults to latest
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired
status
string

Action Response

data
object
error
successful
boolean
Lists annotations for a specific check run in a github repository, detailing issues like errors or warnings on particular code lines.

Action Parameters

check_run_id
integerRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists check suites for a git reference (commit sha, branch, or tag) in a repository, optionally filtering by github app id or check run name.

Action Parameters

app_id
integer
check_name
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
ref
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists the immediate child teams of a parent team within an organization.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Lists immediate child teams for a specified, existing parent team id using a deprecated legacy github api endpoint; prefer non-legacy alternatives if available.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists github classrooms to which the authenticated user has administrative access.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists syntax errors in a repository's codeowners file, which must be located at the root, `.github/`, or `docs/` directory for the specified ref.

Action Parameters

owner
stringRequired
ref
string
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all github codespaces owned by a specified member of a given organization.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists github codespaces for the authenticated user, optionally filtering by repository id and supporting pagination.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
repository_id
integer

Action Response

data
object
error
successful
boolean
Lists active/pending github codespaces for an existing organization; admins list all, members list their own.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists all codeql databases for a repository where codeql analysis has been previously run and completed.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists code scanning alerts for a github organization; use either `tool name` or `tool guid` if filtering by tool, not both.

Action Parameters

after
string
before
string
direction
stringDefaults to desc
org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
severity
string
sort
stringDefaults to created
state
string
tool_guid
string
tool_name
string

Action Response

data
object
error
successful
boolean
Lists code scanning alerts for a repository, optionally filtering by tool (which must have produced scan results for the repository), git reference, state, or severity.

Action Parameters

direction
stringDefaults to desc
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
ref
string
repo
stringRequired
severity
string
sort
stringDefaults to created
state
string
tool_guid
string
tool_name
string

Action Response

data
object
error
successful
boolean
Lists code scanning analyses for an existing repository, optionally filtering by tool (name or guid), git reference, or sarif id.

Action Parameters

direction
stringDefaults to desc
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
ref
string
repo
stringRequired
sarif_id
string
sort
stringDefaults to created
tool_guid
string
tool_name
string

Action Response

data
object
error
successful
boolean
Lists all comments for a specific review on a github pull request.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
pull_number
integerRequired
repo
stringRequired
review_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves commits for a repository, optionally filtering by sha (must be valid commit sha or existing branch), path, author, committer, or date range.

Action Parameters

author
string
committer
string
owner
stringRequired
page
integerDefaults to 1
path
string
per_page
integerDefaults to 1
repo
stringRequired
sha
string
since
string
until
string

Action Response

data
object
error
successful
boolean
Lists commits for a pull request; requires the repository and pull request to exist and be accessible, and supports pagination.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
pull_number
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all comments for a specific commit in a github repository, supporting pagination.

Action Parameters

commit_sha
stringRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all commit comments for a specified repository, which must exist and be accessible.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists commit statuses for a specific reference (commit sha, branch, or tag) in a repository, useful for tracking ci/test outcomes.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
ref
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all github copilot seat assignments and their billing status for an organization with an active github copilot business subscription.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 50

Action Response

data
object
error
successful
boolean
Lists custom property values for repositories in a specified, existing organization, optionally filtered by a repository query.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repository_query
string

Action Response

data
object
error
successful
boolean
Retrieves a list of webhook deliveries for a specific webhook in an organization, allowing inspection of delivery history and details.

Action Parameters

cursor
string
hook_id
integerRequired
org
stringRequired
per_page
integerDefaults to 30
redelivery
boolean

Action Response

data
object
error
successful
boolean
Retrieves delivery attempts for a specific repository webhook to inspect its history; ensure the webhook id exists.

Action Parameters

cursor
string
hook_id
integerRequired
owner
stringRequired
per_page
integerDefaults to 30
redelivery
boolean
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists dependabot alerts for repositories owned by organizations within an enterprise, provided dependabot alerts are enabled for it.

Action Parameters

after
string
before
string
direction
stringDefaults to desc
ecosystem
string
enterprise
stringRequired
first
integerDefaults to 30
last
integer
package
string
per_page
integerDefaults to 30
scope
string
severity
string
sort
stringDefaults to created
state
string

Action Response

data
object
error
successful
boolean
Lists dependabot alerts for a github organization, with options to filter, sort, and paginate alerts to identify security vulnerabilities in code dependencies.

Action Parameters

after
string
before
string
direction
stringDefaults to desc
ecosystem
string
first
integerDefaults to 30
last
integer
org
stringRequired
package
string
per_page
integerDefaults to 30
scope
string
severity
string
sort
stringDefaults to created
state
string

Action Response

data
object
error
successful
boolean
Lists dependabot alerts for a repository if dependabot alerts are enabled, with options for filtering, sorting, and cursor-based pagination; use `per page` with `before` or `after` instead of deprecated `page`, `first`, and `last` parameters.

Action Parameters

after
string
before
string
direction
stringDefaults to desc
ecosystem
string
first
integerDefaults to 30
last
integer
manifest
string
owner
stringRequired
package
string
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired
scope
string
severity
string
sort
stringDefaults to created
state
string

Action Response

data
object
error
successful
boolean
Lists deployments for a specified repository; repository must exist.

Action Parameters

environment
stringDefaults to none
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
ref
stringDefaults to none
repo
stringRequired
sha
stringDefaults to none
task
stringDefaults to none

Action Response

data
object
error
successful
boolean
Lists all deployment branch policies for a specified environment in a github repository.

Action Parameters

environment_name
stringRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all statuses for a given deployment in a repository.

Action Parameters

deployment_id
integerRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists deploy ssh keys for a specified repository; the repository must exist.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists discussions for a specific team within an organization, with options for sorting, pagination, and filtering by pinned status.

Action Parameters

direction
stringDefaults to desc
org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
pinned
string
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Lists discussions for a team (by `team id`) via a deprecated github legacy endpoint; prefer current endpoints for new integrations.

Action Parameters

direction
stringDefaults to desc
page
integerDefaults to 1
per_page
integerDefaults to 30
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists all comments for a specific team discussion within an organization.

Action Parameters

direction
stringDefaults to desc
discussion_number
integerRequired
org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Lists comments for a specific team discussion using a legacy github api endpoint; the specified team and discussion must exist.

Action Parameters

direction
stringDefaults to desc
discussion_number
integerRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists docker packages in an organization that encountered conflicts during migration to the github container registry.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Lists all email addresses for the authenticated user, including their primary status, verification status, and visibility.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Retrieves all deployment environments for a specified repository, which are used to configure protection rules and secrets for different software lifecycle stages.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all custom deployment protection rule integrations for a repository environment; the `environment name` must be url-encoded.

Action Parameters

environment_name
stringRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists the names and metadata (not values) of secrets for a specified, existing environment within an existing github repository.

Action Parameters

environment_name
stringRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all environment variables, which are plaintext key-value pairs for github actions workflows, for a specified environment within a github repository.

Action Parameters

environment_name
stringRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 10
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists public events for the specified github user, or private events if authenticated as that user, in reverse chronological order.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists events a specific github user received from followed users and watched repositories; returns private events if authenticated for `username`, otherwise public.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists all failed invitations to join a github organization, including failure reasons and timestamps.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists followers for a specified, existing github user.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists users following the authenticated github user, returning an empty list if the user has no followers.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists forks for a specified repository, which must exist, with options for sorting and pagination.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired
sort
stringDefaults to newest

Action Response

data
object
error
successful
boolean
Lists public gists for a specified github user.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
since
string
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists gists for the authenticated user, with optional filtering by update time and pagination.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
since
string

Action Response

data
object
error
successful
boolean
Lists comments for a specified github gist.

Action Parameters

gist_id
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists all commits for a specified gist.

Action Parameters

gist_id
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists all forks for a given github gist id.

Action Parameters

gist_id
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists github actions caches for a repository, with options to filter by git reference or cache key, and to sort and paginate results.

Action Parameters

direction
stringDefaults to desc
key
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
ref
string
repo
stringRequired
sort
stringDefaults to last_accessed_at

Action Response

data
object
error
successful
boolean
Lists github pages builds for a repository; github pages must be enabled on the repository for builds to be listed.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists github's global security advisories, filterable by various attributes including id, type, ecosystem, severity, and dates.

Action Parameters

affects
array
after
string
before
string
cve_id
string
cwes
array
direction
stringDefaults to desc
ecosystem
string
ghsa_id
string
is_withdrawn
boolean
modified
string
per_page
integerDefaults to 30
published
string
severity
string
sort
stringDefaults to published
type
stringDefaults to reviewed
updated
string

Action Response

data
object
error
successful
boolean
Lists an existing github user's gpg keys, used for signing commits and tags.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists gpg (gnu privacy guard) keys associated with the authenticated user's github account.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists pending installation requests made by users or organizations for the authenticated github app.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists all instances of a specific code scanning alert, optionally filtered by git ref; requires code scanning to be enabled on the repository.

Action Parameters

alert_number
integerRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
ref
string
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists 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.

Action Parameters

collab
boolean
direction
stringDefaults to desc
filter
stringDefaults to assigned
labels
string
orgs
boolean
owned
boolean
page
integerDefaults to 1
per_page
integerDefaults to 30
pulls
boolean
since
string
sort
stringDefaults to created
state
stringDefaults to open

Action Response

data
object
error
successful
boolean
Lists comments for a specified issue in a github repository.

Action Parameters

issue_number
integerRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired
since
string

Action Response

data
object
error
successful
boolean
Lists issue comments, including those on pull requests, for an accessible repository.

Action Parameters

direction
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired
since
string
sort
stringDefaults to created

Action Response

data
object
error
successful
boolean
Retrieves a list of all events for a specific issue within a github repository.

Action Parameters

issue_number
integerRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all issue events (e.g., closed, reopened, assigned) for a specified repository.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 1
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists jobs for a specific workflow run in a github repository.

Action Parameters

filter
stringDefaults to latest
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired
run_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists jobs, including details like id, status, and steps, for a specific attempt of a github actions workflow run.

Action Parameters

attempt_number
integerRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired
run_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists all labels for a specified issue in a github repository.

Action Parameters

issue_number
integerRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all labels for a specified, existing github repository.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
array
error
successful
boolean
Lists all labels for issues within a specific milestone in a repository.

Action Parameters

milestone_number
integerRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all labels assigned to a specific self-hosted runner registered with the given repository.

Action Parameters

owner
stringRequired
repo
stringRequired
runner_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists all labels assigned to a specific self-hosted runner within a github organization, which are used to route workflows.

Action Parameters

org
stringRequired
runner_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists all locations for a specific secret scanning alert in a repository; requires secret scanning to be enabled.

Action Parameters

alert_number
integerRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists available machine types for a specific, accessible codespace, enabling it to be transitioned to a new hardware configuration.

Action Parameters

codespace_name
stringRequired

Action Response

data
object
error
successful
boolean
Lists all git references (branches or tags) in a repository that start with the provided partial reference path (e.g., `heads/my-feature` or `tags/v1.2`).

Action Parameters

owner
stringRequired
ref
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists milestones, which track progress for groups of issues and pull requests, for an existing repository, allowing filtering by state and sorting.

Action Parameters

direction
stringDefaults to asc
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired
sort
stringDefaults to due_on
state
stringDefaults to open

Action Response

data
object
error
successful
boolean
Lists notifications for the authenticated user, sorted by most recent update, with filtering and pagination options.

Action Parameters

all
boolean
before
string
page
integerDefaults to 1
participating
boolean
per_page
integerDefaults to 50
since
string

Action Response

data
object
error
successful
boolean
Lists github organizations for the authenticated user, sorted by id in ascending order.

Action Parameters

per_page
integerDefaults to 30
since
integer

Action Response

data
object
error
successful
boolean
Lists public organizations for a specified github user; the `username` must be a valid github handle.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists organizations the authenticated github user is a member of, returning details for each organization.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists events within a specified organization that were performed by the authenticated user, whose `username` (path parameter) must match the api request credentials.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists teams associated with a specific pending organization invitation, to inspect team memberships granted if accepted.

Action Parameters

invitation_id
integerRequired
org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists public and concealed members of a github organization; viewing concealed members requires authenticated user to be an organization member.

Action Parameters

filter
stringDefaults to all
org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
role
stringDefaults to all

Action Response

data
object
error
successful
boolean
Lists recent source export and import migrations (including their status, id, and url) for a specified github organization, which must exist.

Action Parameters

exclude
array
org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists projects for a specified github organization, optionally filtering by state and supporting pagination.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
state
stringDefaults to open

Action Response

data
object
error
successful
boolean
Retrieves a list of repositories for a specified github organization, allowing filtering by type and sorting.

Action Parameters

direction
string
org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 1
sort
stringDefaults to created
type
stringDefaults to all

Action Response

data
object
error
successful
boolean
Lists rule suite evaluations for a github organization; if filtering by `repository name` (repository id), it must be a valid repository within that organization.

Action Parameters

actor_name
string
org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repository_name
integer
rule_suite_result
stringDefaults to all
time_period
stringDefaults to day

Action Response

data
object
error
successful
boolean
Lists github actions secrets available for a specified organization.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists all github actions variables for a specified organization.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 10

Action Response

data
object
error
successful
boolean
Lists all webhooks for a specified github organization; the organization must exist.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Retrieves all fine-grained permissions for a specified github organization, essential for creating or updating custom roles.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Lists issues for the authenticated user within a specified github organization, with options to filter by involvement type, state, labels, and to sort results.

Action Parameters

direction
stringDefaults to desc
filter
stringDefaults to assigned
labels
string
org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
since
string
sort
stringDefaults to created
state
stringDefaults to open

Action Response

data
object
error
successful
boolean
Lists all codespaces secrets available for a specified organization, which must exist.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists the authenticated user's organization memberships, optionally filtering by state.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
state
string

Action Response

data
object
error
successful
boolean
Lists repositories in an organization with github actions enabled, for use when the organization's policy restricts actions to a specific list of repositories rather than enabling it for all.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Retrieves a list of an organization's fine-grained personal access token requests (pending, approved, or denied), with options for filtering and sorting.

Action Parameters

direction
stringDefaults to desc
last_used_after
string
last_used_before
string
org
stringRequired
owner
array
page
integerDefaults to 1
per_page
integerDefaults to 30
permission
string
repository
string
sort
stringDefaults to created_at

Action Response

data
object
error
successful
boolean
Lists approved fine-grained personal access tokens (pats) with access to resources in a github organization, optionally filtering by owner, repository, permissions, or last usage time.

Action Parameters

direction
stringDefaults to desc
last_used_after
string
last_used_before
string
org
stringRequired
owner
array
page
integerDefaults to 1
per_page
integerDefaults to 30
permission
string
repository
string
sort
stringDefaults to created_at

Action Response

data
object
error
successful
boolean
Lists all dependabot secrets (metadata like names, creation/update timestamps, but not their encrypted values) for a specified organization, which must exist.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists outside collaborators for a github organization, with options to filter (e.g., by 2fa status) and paginate results.

Action Parameters

filter
stringDefaults to all
org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists all versions for an existing package owned by the authenticated user, identified by its type and name.

Action Parameters

package_name
stringRequired
package_type
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
state
stringDefaults to active

Action Response

data
object
error
successful
boolean
Lists github packages for an organization, noting specific interpretations for package type and visibility parameters.

Action Parameters

org
stringRequired
package_type
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
visibility
string

Action Response

data
object
error
successful
boolean
Lists packages for a specified github user, filterable by package type and visibility.

Action Parameters

package_type
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
username
stringRequired
visibility
string

Action Response

data
object
error
successful
boolean
Lists packages of a specific type and visibility within the authenticated user's namespace on github.

Action Parameters

package_type
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
visibility
string

Action Response

data
object
error
successful
boolean
Lists all versions of a public package owned by a specific github user, identified by package type, package name, and username.

Action Parameters

package_name
stringRequired
package_type
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists all versions for a specified package, if it exists and is owned by the given github organization.

Action Parameters

org
stringRequired
package_name
stringRequired
package_type
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
state
stringDefaults to active

Action Response

data
object
error
successful
boolean
Lists all pending membership invitations for a specified organization, which must exist.

Action Parameters

invitation_source
stringDefaults to all
org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
role
stringDefaults to all

Action Response

data
object
error
successful
boolean
Lists all pending membership invitations for a specified team within an organization.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Lists pending membership invitations for a github team using a legacy (deprecated) endpoint.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists all project cards for a given `column id`, which must correspond to an existing project column.

Action Parameters

archived_state
stringDefaults to not_archived
column_id
integerRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Fetches a list of collaborators for a specified, existing github project.

Action Parameters

affiliation
stringDefaults to all
page
integerDefaults to 1
per_page
integerDefaults to 30
project_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists all of a github project's columns (e.g., 'to do', 'in progress'); project id must identify a valid, accessible project.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
project_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists the public email addresses for the authenticated user.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists public github events, which may be delayed by up to 5 minutes, with support for pagination.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Retrieves public events (up to 90 days old, newest first) for a github repository network, including the repository and its forks.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a list of public events for a specified github user, in reverse chronological order.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists 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.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists public gists from github, optionally filtering by a 'since' timestamp and supporting pagination; results are generally newest first.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
since
string

Action Response

data
object
error
successful
boolean
Lists the verified public ssh keys for a specified github user.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists public events for a specified github organization, which must exist.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists users who have publicly declared their membership in a specified, existing github organization.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 1

Action Response

data
object
error
successful
boolean
Lists all public repositories on github; use the `since` parameter with a repository id from a previous result for pagination.

Action Parameters

since
integer

Action Response

data
object
error
successful
boolean
Lists the public ssh keys for the authenticated user's github account, with support for pagination.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists pull requests for a specified github repository.

Action Parameters

base
string
direction
string
head
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 1
repo
stringRequired
sort
stringDefaults to created
state
stringDefaults to open

Action Response

data
object
error
successful
boolean
Lists 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.

Action Parameters

commit_sha
stringRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all files (including additions, modifications, and removals) associated with a specific pull request in a github repository.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
pull_number
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists reactions for a specific, existing issue within an accessible github repository, optionally filtering by content type.

Action Parameters

content
string
issue_number
integerRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists reactions for a specific issue comment in a github repository, optionally filtering by content type.

Action Parameters

comment_id
integerRequired
content
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists reactions for a specific commit comment; this is a read-only operation.

Action Parameters

comment_id
integerRequired
content
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists reactions for a pull request review comment in a repository, optionally filtering by reaction type.

Action Parameters

comment_id
integerRequired
content
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all reactions, or optionally filters reactions by a specific content type, for a given github release.

Action Parameters

content
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
release_id
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists reactions for an existing team discussion within an organization.

Action Parameters

content
string
discussion_number
integerRequired
org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Lists reactions for a specific comment in a team discussion within an organization, optionally filtering by content type.

Action Parameters

comment_number
integerRequired
content
string
discussion_number
integerRequired
org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: lists reactions for a specific comment on a team discussion, provided the team, discussion, and comment exist.

Action Parameters

comment_number
integerRequired
content
string
discussion_number
integerRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists reactions for a team discussion using a deprecated github legacy endpoint; use with caution as this endpoint may be removed.

Action Parameters

content
string
discussion_number
integerRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves a list of all releases (published, draft, and prerelease) for a specified repository.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists 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.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
release_id
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists public repositories for a specified github user, who must have an existing account.

Action Parameters

direction
string
page
integerDefaults to 1
per_page
integerDefaults to 30
sort
stringDefaults to full_name
type
stringDefaults to owner
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists repositories for an existing user migration, identified by `migration id`.

Action Parameters

migration_id
integerRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists repositories for the authenticated user; using 'type' with 'visibility' or 'affiliation' api parameters (not in this model) can cause a 422 error.

Action Parameters

before
string
direction
string
page
integerDefaults to 1
per_page
integerDefaults to 30
since
string
sort
stringDefaults to full_name
type
stringDefaults to all

Action Response

data
object
error
successful
boolean
Lists repositories in a specific github organization migration, allowing tracking of migration progress and contents.

Action Parameters

migration_id
integerRequired
org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists repositories a valid and existing github user has starred.

Action Parameters

direction
stringDefaults to desc
page
integerDefaults to 1
per_page
integerDefaults to 1
sort
stringDefaults to created
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists repositories the authenticated user has starred, optionally sorted and paginated, including star creation timestamps via 'application/vnd.github.star+json' media type.

Action Parameters

direction
stringDefaults to desc
page
integerDefaults to 1
per_page
integerDefaults to 1
sort
stringDefaults to created

Action Response

data
object
error
successful
boolean
Lists repositories a given github user is watching; the username must be a valid and existing github user handle.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists repositories the authenticated user is watching (subscribed to for notifications).

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists activities for a github repository, ensuring the repository exists and is accessible.

Action Parameters

activity_type
string
actor
string
after
string
before
string
direction
stringDefaults to desc
owner
stringRequired
per_page
integerDefaults to 1
ref
string
repo
stringRequired
time_period
string

Action Response

data
object
error
successful
boolean
Lists collaborators for a specified repository, provided it exists and is accessible to the authenticated user.

Action Parameters

affiliation
stringDefaults to all
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
permission
string
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists contributors to a specified repository, sorted by number of contributions in descending order; the repository must exist and be accessible.

Action Parameters

anon
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists chronological events (e.g., code pushes, issue activities, pr actions, forks) for a specified, existing github repository.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all pending (unaccepted or undeclined) collaboration invitations for a specified github repository.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists issues (which include pull requests) for a specified, existing github repository, with options for filtering, sorting, and pagination.

Action Parameters

assignee
string
creator
string
direction
stringDefaults to desc
labels
string
mentioned
string
milestone
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 1
repo
stringRequired
since
string
sort
stringDefaults to created
state
stringDefaults to open

Action Response

data
object
error
successful
boolean
Lists the programming languages used in a github repository, returning a byte count for each language.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists names of organization-level secrets shared with the specified repository; actual secret values are not returned and visibility depends on token access.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists organization variables accessible to a specific repository; the repository must exist.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 10
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists projects associated with a specific repository.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired
state
stringDefaults to open

Action Response

data
object
error
successful
boolean
Lists rule suite evaluations for a repository, allowing filtering by ref (non-wildcard), time period, actor, and result.

Action Parameters

actor_name
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
ref
string
repo
stringRequired
rule_suite_result
stringDefaults to all
time_period
stringDefaults to day

Action Response

data
object
error
successful
boolean
Lists metadata for all secrets in a github repository, excluding their encrypted values.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists metadata (e.g., name, creation/update dates) for all dependabot secrets in a repository; secret values are not included.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists security advisories (notifications about software vulnerabilities) for a specified repository.

Action Parameters

after
string
before
string
direction
stringDefaults to desc
owner
stringRequired
per_page
integerDefaults to 30
repo
stringRequired
sort
stringDefaults to created
state
string

Action Response

data
object
error
successful
boolean
Lists tags for a specified github repository.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all teams with explicit permission to access the specified repository; the repository must exist.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
array
error
successful
boolean
Lists plain text key-value variables for github actions workflows within a specific, accessible repository.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 10
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a list of webhooks for a repository, which must exist and be accessible.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all github actions workflows for a specified repository, which must exist and be accessible.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists repositories an app installation can access; 'total count' in response is zero if none are accessible.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists repositories accessible to the authenticated user through a specific github app installation (identified by `installation id`).

Action Parameters

installation_id
integerRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Retrieves a paginated list of github actions cache usage statistics for repositories within an existing github organization.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists repositories in an organization that a fine-grained personal access token (`pat request id`) has requested access to; must be performed by a github app.

Action Parameters

org
stringRequired
page
integerDefaults to 1
pat_request_id
integerRequired
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists codespaces the authenticated user can access within a specified, existing repository.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists the `devcontainer.json` configurations available in a specified repository for use with github codespaces.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all pending repository invitations for the authenticated user.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Retrieves notifications for the authenticated user from a specified repository, to which the user must have access.

Action Parameters

all
boolean
before
string
owner
stringRequired
page
integerDefaults to 1
participating
boolean
per_page
integerDefaults to 30
repo
stringRequired
since
string

Action Response

data
object
error
successful
boolean
Lists all codespaces secrets available in a specific repository, without their encrypted values.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists repository security advisories for an existing organization, with options for filtering by state, sorting, and pagination.

Action Parameters

after
string
before
string
direction
stringDefaults to desc
org
stringRequired
per_page
integerDefaults to 30
sort
stringDefaults to created
state
string

Action Response

data
object
error
successful
boolean
Lists submitted reviews chronologically for a specific pull request within a github repository.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
pull_number
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all review comments on all pull requests within a specified repository.

Action Parameters

direction
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired
since
string
sort
string

Action Response

data
object
error
successful
boolean
Lists all review comments on a specific pull request within a github repository.

Action Parameters

direction
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
pull_number
integerRequired
repo
stringRequired
since
string
sort
stringDefaults to created

Action Response

data
object
error
successful
boolean
Lists downloadable github actions runner application binaries, used for setting up self-hosted runners, for an existing github organization.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Lists available self-hosted runner application binaries for a specific repository, including their os, architecture, and download url.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists all codespaces secrets accessible to the authenticated user for use within github codespaces.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists secret scanning alerts for a github enterprise, identifiable by its slug or id; secret scanning must be enabled on the enterprise for alerts to be listed.

Action Parameters

after
string
before
string
direction
stringDefaults to desc
enterprise
stringRequired
per_page
integerDefaults to 30
resolution
string
secret_type
string
sort
stringDefaults to created
state
string
validity
string

Action Response

data
object
error
successful
boolean
Lists secret scanning alerts for a specified github organization, which must exist and have secret scanning enabled with detected secrets.

Action Parameters

after
string
before
string
direction
stringDefaults to desc
org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
resolution
string
secret_type
string
sort
stringDefaults to created
state
string
validity
string

Action Response

data
object
error
successful
boolean
Lists secret scanning alerts for a repository, requiring secret scanning to be enabled; github advanced security is needed for `secret type` or `resolution` filters on private/internal repositories.

Action Parameters

after
string
before
string
direction
stringDefaults to desc
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired
resolution
string
secret_type
string
sort
stringDefaults to created
state
string
validity
string

Action Response

data
object
error
successful
boolean
Lists all teams granted security manager permissions within a specified github organization.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Lists repositories that have access to the specified user secret for the authenticated user's codespaces, provided the user has codespaces access.

Action Parameters

secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Lists repositories within an organization that have explicit access to a specific organization secret, which must have its visibility set to 'selected'.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Lists repositories within a specified organization that have been granted access to a particular dependabot secret.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Lists 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.

Action Parameters

name
stringRequired
org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists 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.

Action Parameters

name
string
org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists all self-hosted runners configured for a repository.

Action Parameters

name
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists social media accounts publicly linked to an existing github user's profile.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists all social media accounts linked to the authenticated user's github profile.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists the ssh signing keys for a specified github user; the user must exist.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists ssh signing keys for the authenticated user's github account.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists users who have starred the specified github repository, which must exist.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a list of gists starred by the authenticated user.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
since
string

Action Response

data
object
error
successful
boolean
Lists the authenticated user's active github marketplace subscriptions.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists the authenticated user's stubbed (test/example data, not live) github marketplace subscriptions, useful for development or testing.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists all active tag protection rules for a repository, defining patterns to prevent matching tags from being created or deleted; requires repository admin permissions.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists teams for a specified github organization.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists teams assigned to a specific role within a github organization.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
role_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists all teams across all organizations to which the authenticated user belongs, supporting pagination.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists members of a specific team within an organization, including members of child teams.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
role
stringDefaults to all
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Lists members of a github team using a deprecated legacy api endpoint; a non-legacy alternative should be preferred if available.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
role
stringDefaults to all
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists github projects accessible to a specific team within an organization.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Lists projects for a team using a deprecated legacy github api endpoint; ensure `team id` corresponds to an existing, accessible team.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists repositories accessible to a specific team within a github organization.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Lists repositories for a github team using a deprecated legacy endpoint; prefer 'list team repositories' for up-to-date functionality.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists github users that a valid github `username` is following, supporting pagination.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
username
stringRequired

Action Response

data
object
error
successful
boolean
Lists people the authenticated user follows.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists chronological events (e.g., comments, commits, label changes) for a specific issue in a github repository.

Action Parameters

issue_number
integerRequired
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists repositories in an organization accessible by a specific fine-grained personal access token; this action is for github apps.

Action Parameters

org
stringRequired
page
integerDefaults to 1
pat_id
integerRequired
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Retrieves all github users (individuals and organizations) in chronological order of their sign-up date.

Action Parameters

per_page
integerDefaults to 30
since
integer

Action Response

data
object
error
successful
boolean
Lists users assigned to a specific role within a github organization.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
role_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists users blocked by a specified github organization.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists users blocked by the authenticated user, returning an empty list if no users are blocked.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Lists github issues for the authenticated user, defaulting to 'assigned' but filterable by other interactions, state, labels, and time, with sorting and pagination.

Action Parameters

direction
stringDefaults to desc
filter
stringDefaults to assigned
labels
string
page
integerDefaults to 1
per_page
integerDefaults to 30
since
string
sort
stringDefaults to created
state
stringDefaults to open

Action Response

data
object
error
successful
boolean
Lists all data migrations (repository and user data exports) initiated by the authenticated user.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Retrieves a list of projects for a specified github user, optionally filtering by state and supporting pagination; the username must be a valid github handle.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
state
stringDefaults to open
username
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a list of users watching a specific repository; the repository must be accessible to the authenticated user.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Lists 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.

Action Parameters

actor
string
branch
string
check_suite_id
integer
created
string
event
string
exclude_pull_requests
boolean
head_sha
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired
status
string

Action Response

data
object
error
successful
boolean
Lists runs for a specified, existing workflow (identified by id or filename like `main.yml`) in a github repository, with filtering options.

Action Parameters

actor
string
branch
string
check_suite_id
integer
created
string
event
string
exclude_pull_requests
boolean
head_sha
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired
status
string
workflow_id
integerRequired

Action Response

data
object
error
successful
boolean
Lists artifacts (e.g., build outputs, test results) for a specific workflow run in a github repository.

Action Parameters

name
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired
run_id
integerRequired

Action Response

data
object
error
successful
boolean
Locks an existing github issue's conversation, preventing further comments; an optional reason can be specified.

Action Parameters

issue_number
integerRequired
lock_reason
string
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Sets the codespaces access control policy for a github organization, determining which members can use them.

Action Parameters

org
stringRequired
selected_usernames
array
visibility
stringRequired

Action Response

data
object
error
successful
boolean
Creates or updates values for an organization's predefined custom properties across multiple repositories (up to 30).

Action Parameters

org
stringRequired
properties
arrayRequired
repository_names
arrayRequired

Action Response

data
object
error
successful
boolean
Lists repositories within an organization that have been explicitly granted access to a specific organization secret.

Action Parameters

org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Updates git author information (name and/or email) for an `author id` obtained during a repository import, to correctly attribute commits.

Action Parameters

author_id
integerRequired
email
string
name
string
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Marks the github notification thread (identified by `thread id`) as done or read for the authenticated user, effectively archiving it.

Action Parameters

thread_id
integerRequired

Action Response

data
object
error
successful
boolean
Marks an existing github notification thread, identified by its `thread id`, as read.

Action Parameters

thread_id
integerRequired

Action Response

data
object
error
successful
boolean
Marks notifications as read or unread, optionally for those updated at or before a `last read at` timestamp.

Action Parameters

last_read_at
string
read
boolean

Action Response

data
object
error
successful
boolean
Marks notifications in a repository as read; if 'last read at' is specified, notifications updated after this timestamp are not marked as read.

Action Parameters

last_read_at
string
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Merges a head branch or commit sha into a base branch in a repository; fails if there are merge conflicts requiring manual resolution.

Action Parameters

base
stringRequired
commit_message
string
head
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Merges an open and mergeable pull request in a repository, optionally specifying merge commit details, a merge method, and a required head sha for safety.

Action Parameters

commit_message
string
commit_title
string
merge_method
string
owner
stringRequired
pull_number
integerRequired
repo
stringRequired
sha
string

Action Response

data
object
error
successful
boolean
Deprecated: retrieves github rest api root endpoint details; use `github api root` instead.

Action Parameters

Action Response

data
object
error
successful
boolean
Moves a project card to a specified position, optionally into a new column.

Action Parameters

card_id
integerRequired
column_id
integer
position
stringRequired

Action Response

data
object
error
successful
boolean
Moves a column within a github project (classic) to a new position; `position` can be 'first', 'last', or 'after:<target column id>', where `target column id` must reference an existing column in the same project.

Action Parameters

column_id
integerRequired
position
stringRequired

Action Response

data
object
error
successful
boolean
Sends a 'ping' event to a specified, existing organization webhook to test its configuration and ensure it correctly receives events.

Action Parameters

hook_id
integerRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Pings an existing webhook on a repository to test its configuration and reachability by github.

Action Parameters

hook_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Privately reports a security vulnerability for a repository; specify either `severity` or `cvss vector string`, but not both.

Action Parameters

cvss_vector_string
string
cwe_ids
array
description
stringRequired
owner
stringRequired
repo
stringRequired
severity
string
start_private_fork
boolean
summary
stringRequired
vulnerabilities
array

Action Response

data
object
error
successful
boolean
Deprecated: use `create a pull request` instead. creates a pull request, requiring existing `base` and `head` branches.

Action Parameters

base
stringRequired
body
string
draft
boolean
head
stringRequired
head_repo
string
issue
integer
maintainer_can_modify
boolean
owner
stringRequired
repo
stringRequired
title
string

Action Response

data
object
error
successful
boolean
Deprecated: use `create a review for a pull request` for creating pull request reviews; supports `pending` for drafts and comment positioning.

Action Parameters

body
string
comments
array
commit_id
string
event
string
owner
stringRequired
pull_number
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: creates a review comment on a pull request's diff. use `create a review comment for a pull request` instead.

Action Parameters

body
stringRequired
commit_id
stringRequired
in_reply_to
integer
line
integer
owner
stringRequired
path
stringRequired
position
integer
pull_number
integerRequired
repo
stringRequired
side
string
start_line
integer
start_side
string
subject_type
string

Action Response

data
object
error
successful
boolean
Deprecated: retrieves details of a specific pull request; prefer using the `get a pull request` action.

Action Parameters

owner
stringRequired
pull_number
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
(deprecated: use `list pull requests`) lists pull requests for a specified github repository.

Action Parameters

base
string
direction
string
head
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 1
repo
stringRequired
sort
stringDefaults to created
state
stringDefaults to open

Action Response

data
object
error
successful
boolean
Redelivers a specific webhook delivery for a webhook within an organization, to resend an event that previously failed or was not processed.

Action Parameters

delivery_id
integerRequired
hook_id
integerRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Redelivers a specific, previously made webhook delivery (`delivery id`) for a repository's webhook (`hook id`).

Action Parameters

delivery_id
integerRequired
hook_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Removes all labels from a specified issue in a github repository; this operation is idempotent.

Action Parameters

issue_number
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Revokes all organization roles for a team in an organization; this is destructive and succeeds even if the team initially has no roles.

Action Parameters

org
stringRequired
team_slug
stringRequired

Action Response

data
error
successful
boolean
Revokes 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.

Action Parameters

org
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Removes a user, who must currently be a member, from a github organization, revoking their membership and access rights.

Action Parameters

org
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Revokes an organization role that a team currently possesses within an organization.

Action Parameters

org
stringRequired
role_id
integerRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Removes 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.

Action Parameters

org
stringRequired
role_id
integerRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Removes all github app access restrictions from a protected branch in a repository; the branch must have protection rules configured, and this action does not alter user or team restrictions.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Removes specified assignees from a github issue; requires push access, and invalid removal attempts are silently ignored.

Action Parameters

assignees
array
issue_number
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deletes 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.

Action Parameters

custom_property_name
stringRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Removes a label currently applied to a specific issue in a repository.

Action Parameters

issue_number
integerRequired
name
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Removes a project from a team within an organization; this action requires the project to be currently associated with the team.

Action Parameters

org
stringRequired
project_id
integerRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Removes an associated project from a team using a deprecated legacy github api endpoint.

Action Parameters

project_id
integerRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Removes a collaborator from a specified github repository, provided the repository exists and the user is an existing collaborator.

Action Parameters

owner
stringRequired
repo
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Removes 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.

Action Parameters

installation_id
integerRequired
repository_id
integerRequired

Action Response

data
object
error
successful
boolean
Disassociates a repository from a team; team members may lose access permissions, but the repository and team are not deleted.

Action Parameters

org
stringRequired
owner
stringRequired
repo
stringRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Removes a repository from a team using a legacy, idempotent github api endpoint; ensure the repository is currently assigned to the team, and be aware this endpoint may be deprecated.

Action Parameters

owner
stringRequired
repo
stringRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Removes a team's security manager role in a github organization, revoking its special permissions to manage security alerts and settings for repositories, if the team currently holds this role.

Action Parameters

org
stringRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Removes a selected repository's access to a user's codespaces secret; the secret must exist and the repository must have previously been granted access.

Action Parameters

repository_id
integerRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Removes github copilot access for specified teams within an organization; requires an active copilot business/enterprise subscription for the organization and admin privileges for its copilot settings.

Action Parameters

org
stringRequired
selected_teams
arrayRequired

Action Response

data
object
error
successful
boolean
Removes 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.

Action Parameters

owner
stringRequired
repo
stringRequired
runner_id
integerRequired

Action Response

data
object
error
successful
boolean
Removes a custom label from a repository's self-hosted runner; this operation is idempotent.

Action Parameters

name
stringRequired
owner
stringRequired
repo
stringRequired
runner_id
integerRequired

Action Response

data
object
error
successful
boolean
Removes a currently assigned custom label (`name`) from a self-hosted runner (`runner id`) in an organization (`org`).

Action Parameters

name
stringRequired
org
stringRequired
runner_id
integerRequired

Action Response

data
object
error
successful
boolean
Removes all interaction restrictions from public repositories in the specified github organization, allowing all users to resume interactions.

Action Parameters

org
stringRequired

Action Response

data
object
error
successful
boolean
Removes all interaction restrictions for a repository, enabling all users to comment, open issues, and create pull requests by lifting any existing temporary interaction limits.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Removes a user's membership from a specified github organization, permanently revoking their access to its repositories and teams; the organization must exist and the user must be a current member.

Action Parameters

org
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a github codespaces secret from an organization by its name; this operation is idempotent.

Action Parameters

org
stringRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Permanently removes a specific dependabot secret, by its `secret name`, from the github `org`, making it unavailable to dependabot for that organization.

Action Parameters

org
stringRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Removes a user, who must be an outside collaborator, from the specified github organization, revoking their access to all its repositories.

Action Parameters

org
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Makes an authenticated user's public membership in an organization private (without removing them from the organization); the user must currently be a public member of that organization.

Action Parameters

org
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Removes a repository's access to an organization-level codespaces secret, if it was previously granted.

Action Parameters

org
stringRequired
repository_id
integerRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Revokes 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.

Action Parameters

org
stringRequired
repository_id
integerRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Removes currently assigned user logins and/or team slugs from a github pull request's list of requested reviewers.

Action Parameters

owner
stringRequired
pull_number
integerRequired
repo
stringRequired
reviewers
arrayRequired
team_reviewers
array

Action Response

data
object
error
successful
boolean
Removes a specific repository's access to an organization-level secret; the repository must have been previously granted access to this secret.

Action Parameters

org
stringRequired
repository_id
integerRequired
secret_name
stringRequired

Action Response

data
object
error
successful
boolean
Removes a repository's access to an organization variable, if the variable's visibility is 'selected' and the repository is in its access list.

Action Parameters

name
stringRequired
org
stringRequired
repository_id
integerRequired

Action Response

data
object
error
successful
boolean
Removes specified status check contexts (passed in the request body as an array of strings) from a protected branch in a repository.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Removes 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.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Removes all team-based access restrictions from a specified protected branch; the branch must be protected and have existing team restrictions for this action to change settings.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Removes a user from a specific team within an organization; this action fails if team synchronization with an identity provider (idp) is enabled, and may delete the team if the user is its last member and the team is not nested.

Action Parameters

org
stringRequired
team_slug
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Removes a user from a specified team using the deprecated github legacy api; this action is idempotent.

Action Parameters

team_id
integerRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Removes a user from a team using a deprecated legacy api; fails if team synchronization with an identity provider (idp) is enabled for the organization.

Action Parameters

team_id
integerRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Removes selected users from github codespaces billing access for an existing organization.

Action Parameters

org
stringRequired
selected_usernames
arrayRequired

Action Response

data
object
error
successful
boolean
Cancels github copilot seat assignments for specified users in an organization; requires the organization to have an active copilot subscription and the users to be members with currently assigned seats.

Action Parameters

org
stringRequired
selected_usernames
arrayRequired

Action Response

data
object
error
successful
boolean
Removes active user-level access restrictions from a specified protected branch, enabling users with repository write access to push or merge if no other team or app restrictions apply.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Removes a user as a collaborator from an organization project; the user must already be a collaborator on the specified project.

Action Parameters

project_id
integerRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Removes all interaction restrictions (limitations on comments, issues, or pull requests) from all public repositories owned by the authenticated user.

Action Parameters

Action Response

data
object
error
successful
boolean
Renames 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.

Action Parameters

branch
stringRequired
new_name
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Renders markdown to html; for 'gfm' mode, provide 'context' (owner/repo) to correctly link issues, pull requests, and user mentions.

Action Parameters

context
string
mode
stringDefaults to markdown
text
stringRequired

Action Response

data
object
error
successful
boolean
Replaces all topics of a repository.

Action Parameters

names
arrayRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Sets an existing dependabot organization secret's visibility to 'selected' and replaces the full list of repositories that can access it with the ids provided.

Action Parameters

org
stringRequired
secret_name
stringRequired
selected_repository_ids
arrayRequired

Action Response

data
object
error
successful
boolean
Replaces the list of repositories that can access an existing organization-level codespaces secret with the provided valid repository ids owned by the organization.

Action Parameters

org
stringRequired
secret_name
stringRequired
selected_repository_ids
arrayRequired

Action Response

data
object
error
successful
boolean
(deprecated: use `create a fork` instead) creates a fork of a specified repository.

Action Parameters

default_branch_only
boolean
name
string
organization
string
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: use 'create a repository for the authenticated user' instead. creates a new repository for the authenticated user.

Action Parameters

allow_auto_merge
boolean
allow_merge_commit
booleanDefaults to True
allow_rebase_merge
booleanDefaults to True
allow_squash_merge
booleanDefaults to True
auto_init
boolean
delete_branch_on_merge
boolean
description
string
gitignore_template
string
has_discussions
boolean
has_downloads
booleanDefaults to True
has_issues
booleanDefaults to True
has_projects
booleanDefaults to True
has_wiki
booleanDefaults to True
homepage
string
is_template
boolean
license_template
string
merge_commit_message
string
merge_commit_title
string
name
stringRequired
private
boolean
squash_merge_commit_message
string
squash_merge_commit_title
string
team_id
integer

Action Response

data
object
error
successful
boolean
Deprecated: use `create an organization repository` instead. creates a new repository in the specified organization.

Action Parameters

allow_auto_merge
boolean
allow_merge_commit
booleanDefaults to True
allow_rebase_merge
booleanDefaults to True
allow_squash_merge
booleanDefaults to True
auto_init
boolean
custom_properties
object
delete_branch_on_merge
boolean
description
string
gitignore_template
string
has_downloads
booleanDefaults to True
has_issues
booleanDefaults to True
has_projects
booleanDefaults to True
has_wiki
booleanDefaults to True
homepage
string
is_template
boolean
license_template
string
merge_commit_message
string
merge_commit_title
string
name
stringRequired
org
stringRequired
private
boolean
squash_merge_commit_message
string
squash_merge_commit_title
string
team_id
integer
use_squash_pr_title_as_default
boolean
visibility
string

Action Response

data
object
error
successful
boolean
Deprecated: use `create or update file contents` instead; creates or replaces a file in a repository.

Action Parameters

author__date
string
author__email
string
author__name
string
branch
string
committer__date
string
committer__email
string
committer__name
string
content
stringRequired
message
stringRequired
owner
stringRequired
path
stringRequired
repo
stringRequired
sha
string

Action Response

data
object
error
successful
boolean
Deprecated: use `get the weekly commit activity` instead. fetches weekly commit statistics (additions/deletions) for a repository; less reliable for over 10,000 commits.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: use `get a commit`. retrieves a specific commit from a repository by its owner, name, and a valid commit reference (sha, branch, or tag), supporting pagination for large diffs.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
ref
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: gets repository file content or directory metadata; use `get repository content` instead.

Action Parameters

owner
stringRequired
path
stringRequired
ref
string
repo
stringRequired

Action Response

data
object
error
successful
boolean
(deprecated: use `getallcontributorcommitactivity`) fetches commit activity (total commits, weekly additions/deletions/commits) for all repository contributors; retry if github returns 202.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
(deprecated: use 'list branches' instead) lists branches for an existing github repository, with an option to filter by protection status.

Action Parameters

owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
protected
boolean
repo
stringRequired

Action Response

data
object
error
successful
boolean
(deprecated: use `listrepositorycollaborators`) lists repository collaborators, especially for organization-owned repositories including team members from child teams; requires repository access and potentially `read:org`/`repo` scopes for organization repos.

Action Parameters

affiliation
stringDefaults to all
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
permission
string
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: use `list commits` instead; lists repository commits, including gpg/s/mime signature verification details if available.

Action Parameters

author
string
committer
string
owner
stringRequired
page
integerDefaults to 1
path
string
per_page
integerDefaults to 1
repo
stringRequired
sha
string
since
string
until
string

Action Response

data
object
error
successful
boolean
Deprecated: use `list repository contributors`. lists repository contributors, sorted by contributions; repository must exist and be accessible.

Action Parameters

anon
string
owner
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30
repo
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: use `list repositories for the authenticated user` to list the authenticated user's repositories.

Action Parameters

before
string
direction
string
page
integerDefaults to 1
per_page
integerDefaults to 30
since
string
sort
stringDefaults to full_name
type
stringDefaults to all

Action Response

data
object
error
successful
boolean
Deprecated: lists repositories for a github organization; use `list organization repositories` instead.

Action Parameters

direction
string
org
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 1
sort
stringDefaults to created
type
stringDefaults to all

Action Response

data
object
error
successful
boolean
Deprecated: lists public repositories for the specified github user; use `list repositories for a user` instead.

Action Parameters

direction
string
page
integerDefaults to 1
per_page
integerDefaults to 30
sort
stringDefaults to full_name
type
stringDefaults to owner
username
stringRequired

Action Response

data
object
error
successful
boolean
Requests a common vulnerabilities and exposures (cve) identification number for a published repository security advisory.

Action Parameters

ghsa_id
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Manually triggers a github pages build for a repository if github pages is enabled, useful for deployments not automatically built or for retrying failed builds.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Requests user and/or team reviewers for an open pull request in a repository; requires `owner`, `repo`, `pull number`, and at least one of `reviewers` or `team reviewers`.

Action Parameters

owner
stringRequired
pull_number
integerRequired
repo
stringRequired
reviewers
array
team_reviewers
array

Action Response

data
object
error
successful
boolean
Triggers a re-run of a specific check run in a github repository, which resets its status to 'queued', clears its conclusion, and triggers the `check run` webhook with `rerequested`.

Action Parameters

check_run_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Triggers a new run of an existing check suite within a repository, useful for re-running checks without new code.

Action Parameters

check_suite_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Invalidates the provided oauth `access token` and generates a new one for the github oauth app identified by `client id`, used for token compromise or security rotation.

Action Parameters

access_token
stringRequired
client_id
stringRequired

Action Response

data
object
error
successful
boolean
Restores a package in an organization, provided it was deleted within the last 30 days.

Action Parameters

org
stringRequired
package_name
stringRequired
package_type
stringRequired
token
string

Action Response

data
object
error
successful
boolean
Restores a user-owned package previously deleted from github packages, if restorable under github's data retention policy (typically within 30 days of deletion).

Action Parameters

package_name
stringRequired
package_type
stringRequired
token
string
username
stringRequired

Action Response

data
object
error
successful
boolean
Restores a package deleted by the authenticated user within the last 30 days, if its namespace and version are still available.

Action Parameters

package_name
stringRequired
package_type
stringRequired
token
string

Action Response

data
object
error
successful
boolean
Restores a package version for an organization, provided it was deleted within the last 30 days.

Action Parameters

org
stringRequired
package_name
stringRequired
package_type
stringRequired
package_version_id
integerRequired

Action Response

data
object
error
successful
boolean
Restores a package version that was deleted by the authenticated user within the last 30 days.

Action Parameters

package_name
stringRequired
package_type
stringRequired
package_version_id
integerRequired

Action Response

data
object
error
successful
boolean
Restores 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.

Action Parameters

package_name
stringRequired
package_type
stringRequired
package_version_id
integerRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Gets a repository's public key, used to encrypt secrets for dependabot.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Approves or denies a pending fine-grained personal access token request for organization resources; must be performed by a github app.

Action Parameters

action
stringRequired
org
stringRequired
pat_request_id
integerRequired
reason
string

Action Response

data
object
error
successful
boolean
Approves or rejects pending custom deployment protection rules for a workflow run by posting a review with `environment name` (str), `state` (str: 'approved'/'rejected'), and optional `comment` (str) in the request body, targeting a run with rules awaiting review.

Action Parameters

owner
stringRequired
repo
stringRequired
run_id
integerRequired

Action Response

data
object
error
successful
boolean
Approves or rejects pending deployments for a specific workflow run that are in a 'waiting' state within specified, configured environments.

Action Parameters

comment
stringRequired
environment_ids
arrayRequired
owner
stringRequired
repo
stringRequired
run_id
integerRequired
state
stringRequired

Action Response

data
object
error
successful
boolean
Approves or denies fine-grained personal access token requests for an organization; any specified `pat request ids` must refer to currently pending requests.

Action Parameters

action
stringRequired
org
stringRequired
pat_request_ids
array
reason
string

Action Response

data
object
error
successful
boolean
Revokes the github app's current installation access token, immediately invalidating it for api authentication.

Action Parameters

Action Response

data
object
error
successful
boolean
Re-runs a specific job and any dependent jobs from a github actions workflow run in the specified repository, optionally enabling debug logging.

Action Parameters

enable_debug_logging
boolean
job_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Re-runs a specific github actions workflow run identified by its owner, repository, and run id, optionally enabling debug logging.

Action Parameters

enable_debug_logging
boolean
owner
stringRequired
repo
stringRequired
run_id
integerRequired

Action Response

data
object
error
successful
boolean
Re-runs all failed jobs and their dependent jobs from a specified workflow run if the run contains previously failed jobs.

Action Parameters

enable_debug_logging
boolean
owner
stringRequired
repo
stringRequired
run_id
integerRequired

Action Response

data
object
error
successful
boolean
Searches 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.

Action Parameters

order
stringDefaults to desc
page
integerDefaults to 1
per_page
integerDefaults to 30
q
stringRequired
sort
string

Action Response

data
object
error
successful
boolean
Finds commits on github using a query string (q) supporting keywords and qualifiers, with options for sorting and pagination.

Action Parameters

order
stringDefaults to desc
page
integerDefaults to 1
per_page
integerDefaults to 30
q
stringRequired
sort
string

Action Response

data
object
error
successful
boolean
Searches github for issues and pull requests using a query `q` that must strictly follow github's search syntax and available qualifiers.

Action Parameters

order
stringDefaults to desc
page
integerDefaults to 1
per_page
integerDefaults to 30
q
stringRequired
sort
string

Action Response

data
object
error
successful
boolean
Searches for labels within a github repository by keywords in their names or descriptions.

Action Parameters

order
stringDefaults to desc
page
integerDefaults to 1
per_page
integerDefaults to 30
q
stringRequired
repository_id
integerRequired
sort
string

Action Response

data
object
error
successful
boolean
Searches github repositories using a flexible query (keywords, qualifiers) with sorting, ordering, and pagination.

Action Parameters

order
stringDefaults to desc
page
integerDefaults to 1
per_page
integerDefaults to 30
q
stringRequired
sort
string

Action Response

data
object
error
successful
boolean
Deprecated: use `search repositories`; this version finds repositories by criteria, including text match metadata and pagination. example: `q="tetris language:assembly", sort="stars"`

Action Parameters

order
stringDefaults to desc
page
integerDefaults to 1
per_page
integerDefaults to 30
q
stringRequired
sort
string

Action Response

data
object
error
successful
boolean
Finds topics on github using keywords and qualifiers with github's search syntax, supporting pagination.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
q
stringRequired

Action Response

data
object
error
successful
boolean
Searches for users on github by criteria like username, email, location, followers, or repository associations, using a flexible query string `q`.

Action Parameters

order
stringDefaults to desc
page
integerDefaults to 1
per_page
integerDefaults to 30
q
stringRequired
sort
string

Action Response

data
object
error
successful
boolean
tags = ["openworldhint", "readonlyhint"] the text describes how to find global security advisories with specific parameters. by default, it excludes malware advisories, which can be included by setting the `type` parameter to `malware`. more on advisory types at github docs.<<DEPRECATED use list_global_security_advisories>>

Action Parameters

affects
array
after
string
before
string
cve_id
string
cwes
array
direction
stringDefaults to desc
ecosystem
string
ghsa_id
string
is_withdrawn
boolean
modified
string
per_page
integerDefaults to 30
published
string
severity
string
sort
stringDefaults to published
type
stringDefaults to reviewed
updated
string

Action Response

data
object
error
successful
boolean
Enables administrator enforcement on a branch, making existing protection rules also apply to administrators; branch protection rules must already be configured.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Sets the github actions permissions for an existing organization, specifying allowed github-owned actions, verified creator actions, and action/workflow patterns from public repositories.

Action Parameters

github_owned_allowed
boolean
org
stringRequired
patterns_allowed
array
verified_allowed
boolean

Action Response

data
object
error
successful
boolean
Replaces the list of github apps permitted to push to a protected branch; the branch must already be protected and apps must be installed with 'contents' permission.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Sets the authenticated user's notification subscription for a repository.

Action Parameters

ignored
boolean
owner
stringRequired
repo
stringRequired
subscribed
boolean

Action Response

data
object
error
successful
boolean
Sets whether a github notification thread is ignored (muted) or unignored (unmuted), for a `thread id` that must identify an existing notification thread.

Action Parameters

ignored
boolean
thread_id
integerRequired

Action Response

data
object
error
successful
boolean
Sets the default permissions for the github token within a repository and configures whether github actions can approve pull requests.

Action Parameters

can_approve_pull_request_reviews
boolean
default_workflow_permissions
string
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Updates 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.

Action Parameters

can_approve_pull_request_reviews
boolean
default_workflow_permissions
string
org
stringRequired

Action Response

data
object
error
successful
boolean
Sets the visibility ('public' or 'private') of the authenticated user's primary email address on github, if one is configured.

Action Parameters

visibility
stringRequired

Action Response

data
object
error
successful
boolean
Sets 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.

Action Parameters

allowed_actions
string
enabled_repositories
stringRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Sets github actions permissions for a repository, enabling/disabling actions and defining the policy for allowed actions and reusable workflows.

Action Parameters

allowed_actions
string
enabled
booleanRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Limits interactions (comments, new issues, prs) in an organization's public repositories by user type and duration, typically to mitigate high traffic or unwanted activity.

Action Parameters

expiry
string
limit
stringRequired
org
stringRequired

Action Response

data
object
error
successful
boolean
Temporarily 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.

Action Parameters

expiry
string
limit
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Sets or updates temporary interaction restrictions for all public repositories owned by the authenticated user, overriding any repository-specific limits.

Action Parameters

expiry
string
limit
stringRequired

Action Response

data
object
error
successful
boolean
Replaces all existing labels on a github issue with a new set of labels.

Action Parameters

issue_number
integerRequired
labels
arrayRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Invites a user to an organization or updates their existing membership role; new invitations result in a 'pending' status until accepted.

Action Parameters

org
stringRequired
role
stringDefaults to member
username
stringRequired

Action Response

data
object
error
successful
boolean
Sets 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').

Action Parameters

labels
arrayRequired
org
stringRequired
runner_id
integerRequired

Action Response

data
object
error
successful
boolean
Publicizes the authenticated user's existing membership in the specified organization.

Action Parameters

org
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Sets 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).

Action Parameters

github_owned_allowed
boolean
owner
stringRequired
patterns_allowed
array
repo
stringRequired
verified_allowed
boolean

Action Response

data
object
error
successful
boolean
Replaces all custom labels for a specific self-hosted runner in a repository; an empty list for `labels` removes all existing custom labels.

Action Parameters

labels
arrayRequired
owner
stringRequired
repo
stringRequired
runner_id
integerRequired

Action Response

data
object
error
successful
boolean
Defines the list of repositories permitted to access a specific codespaces secret for the authenticated user.

Action Parameters

secret_name
stringRequired
selected_repository_ids
arrayRequired

Action Response

data
object
error
successful
boolean
Replaces the list of repositories that can access an organization secret; only effective if the secret's visibility is 'selected'.

Action Parameters

org
stringRequired
secret_name
stringRequired
selected_repository_ids
arrayRequired

Action Response

data
object
error
successful
boolean
Replaces the list of repositories that can access an organization-level variable; the variable's visibility must be 'selected'.

Action Parameters

name
stringRequired
org
stringRequired
selected_repository_ids
arrayRequired

Action Response

data
object
error
successful
boolean
Replaces required status check contexts for a protected branch, requiring admin permissions; an empty `contexts` array removes all checks.

Action Parameters

branch
stringRequired
contexts
arrayRequired
owner
stringRequired
repo
stringRequired

Action Response

data
array
error
successful
boolean
Sets team push access for a protected branch by replacing all current teams with a new list of valid team slugs (provided in the request body); an empty list of slugs removes all team restrictions.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Replaces the list of users with push access to a protected branch using a request body (not in this schema) containing an array of github usernames; this enables branch protection if not already active.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Sets the access level for workflows outside a repository to use actions and reusable workflows within that repository.

Action Parameters

access_level
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Initiates a source import to an existing github repository from an external vcs (subversion, git, mercurial, or tfvc, where tfvc requires `tfvc project`), using the provided vcs url and optional credentials; this github feature was deprecated april 12, 2024, and may no longer be operational.

Action Parameters

owner
stringRequired
repo
stringRequired
tfvc_project
string
vcs
string
vcs_password
string
vcs_url
stringRequired
vcs_username
string

Action Response

data
object
error
successful
boolean
Initiates generation of a migration archive for an organization, allowing selective migration of repositories and their data; if `org metadata only` is true, `repositories` must be empty.

Action Parameters

exclude
array
exclude_attachments
boolean
exclude_git_data
boolean
exclude_metadata
boolean
exclude_owner_projects
boolean
exclude_releases
boolean
lock_repositories
boolean
org
stringRequired
org_metadata_only
boolean
repositories
arrayRequired

Action Response

data
object
error
successful
boolean
Initiates the startup process for an existing github codespace (identified by `codespace name`) if it's in a startable state like 'available' or 'stopped'.

Action Parameters

codespace_name
stringRequired

Action Response

data
object
error
successful
boolean
Starts a migration for the authenticated user's repositories into a downloadable archive, with flags to exclude specific data components; the `repositories` list must be empty if `org metadata only` is true.

Action Parameters

exclude
array
exclude_attachments
boolean
exclude_git_data
boolean
exclude_metadata
boolean
exclude_owner_projects
boolean
exclude_releases
boolean
lock_repositories
boolean
org_metadata_only
boolean
repositories
arrayRequired

Action Response

data
object
error
successful
boolean
Stars 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.

Action Parameters

gist_id
stringRequired

Action Response

data
object
error
successful
boolean
Stars an existing and accessible repository for the authenticated user; this action is idempotent and succeeds even if the repository is already starred.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Stops a codespace, which must be currently running, for a specified member of an organization.

Action Parameters

codespace_name
stringRequired
org
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Stops a running or available codespace for the authenticated user, pausing its execution and billing.

Action Parameters

codespace_name
stringRequired

Action Response

data
object
error
successful
boolean
Finalizes a pending pull request review (identified by `review id`) with a required `event` (approve, request changes, comment) and an optional `body`.

Action Parameters

body
string
event
stringRequired
owner
stringRequired
pull_number
integerRequired
repo
stringRequired
review_id
integerRequired

Action Response

data
object
error
successful
boolean
Synchronizes 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.

Action Parameters

branch
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Triggers 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.

Action Parameters

hook_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Initiates 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.

Action Parameters

new_name
string
new_owner
stringRequired
owner
stringRequired
repo
stringRequired
team_ids
array

Action Response

data
object
error
successful
boolean
Unblocks a github user, provided they are currently blocked by the authenticated user.

Action Parameters

username
stringRequired

Action Response

data
object
error
successful
boolean
Unblocks a user from an organization, allowing renewed interaction with its resources, provided the user is currently blocked (otherwise, a 404 error may occur).

Action Parameters

org
stringRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Unfollows an existing github user; this action is idempotent, succeeding even if the authenticated user is not currently following them.

Action Parameters

username
stringRequired

Action Response

data
object
error
successful
boolean
Unlocks a currently locked github issue in the specified repository, allowing new comments and interactions.

Action Parameters

issue_number
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Unlocks an organization repository previously locked by a github migration.

Action Parameters

migration_id
integerRequired
org
stringRequired
repo_name
stringRequired

Action Response

data
object
error
successful
boolean
Unlocks 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.

Action Parameters

migration_id
integerRequired
repo_name
stringRequired

Action Response

data
object
error
successful
boolean
Removes a star from the specified gist; the action is idempotent and will not error if the gist was not previously starred by the user.

Action Parameters

gist_id
stringRequired

Action Response

data
object
error
successful
boolean
Removes the authenticated user's star from a specified repository, which must already be starred by the user.

Action Parameters

owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Updates 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.

Action Parameters

environment_name
stringRequired
name
stringRequired
owner
stringRequired
repo
stringRequired
value
string

Action Response

data
object
error
successful
boolean
Updates an existing project card's note and/or archived status, identified by its `card id`.

Action Parameters

archived
boolean
card_id
integerRequired
note
string

Action Response

data
object
error
successful
boolean
Updates the name of an existing column, identified by `column id`, in a github project (classic).

Action Parameters

column_id
integerRequired
name
stringRequired

Action Response

data
object
error
successful
boolean
Updates an existing source import, allowing modification of vcs credentials, vcs type, or tfvc project, to correct settings or restart a stalled import.

Action Parameters

owner
stringRequired
repo
stringRequired
tfvc_project
string
vcs
string
vcs_password
string
vcs_username
string

Action Response

data
object
error
successful
boolean
Updates an existing github issue's title, body, state, milestone, labels, or assignees; `state reason` is only processed if `state` also changes, and use `null` or `[]` to clear applicable fields.

Action Parameters

assignee
string
assignees
array
body
string
issue_number
integerRequired
labels
array
milestone
string
owner
stringRequired
repo
stringRequired
state
string
state_reason
string
title
string

Action Response

data
object
error
successful
boolean
Updates an existing comment on an issue or pull request within a specified repository.

Action Parameters

body
stringRequired
comment_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Updates an organization's settings; changing security-related fields requires admin, owner, or security manager permissions.

Action Parameters

advanced_security_enabled_for_new_repositories
boolean
billing_email
string
blog
string
company
string
default_repository_permission
stringDefaults to read
dependabot_alerts_enabled_for_new_repositories
boolean
dependabot_security_updates_enabled_for_new_repositories
boolean
dependency_graph_enabled_for_new_repositories
boolean
description
string
email
string
has_organization_projects
boolean
has_repository_projects
boolean
location
string
members_allowed_repository_creation_type
string
members_can_create_internal_repositories
boolean
members_can_create_pages
booleanDefaults to True
members_can_create_private_pages
booleanDefaults to True
members_can_create_private_repositories
boolean
members_can_create_public_pages
booleanDefaults to True
members_can_create_public_repositories
boolean
members_can_create_repositories
booleanDefaults to True
members_can_fork_private_repositories
boolean
name
string
org
stringRequired
secret_scanning_enabled_for_new_repositories
boolean
secret_scanning_push_protection_custom_link
string
secret_scanning_push_protection_custom_link_enabled
boolean
secret_scanning_push_protection_enabled_for_new_repositories
boolean
twitter_username
string
web_commit_signoff_required
boolean

Action Response

data
object
error
successful
boolean
Updates an existing repository ruleset in a github organization, allowing partial updates to its name, target, enforcement level (where 'evaluate' mode is github enterprise only), bypass actors, or rules; unspecified fields retain their current values.

Action Parameters

bypass_actors
array
enforcement
string
name
string
org
stringRequired
rules
array
ruleset_id
integerRequired
target
string

Action Response

data
object
error
successful
boolean
Updates 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`.

Action Parameters

name
stringRequired
org
stringRequired
selected_repository_ids
array
value
string
visibility
string

Action Response

data
object
error
successful
boolean
Updates the configuration (url, content type, secret, ssl verification), subscribed events, active status, or name of an existing webhook for a specified organization.

Action Parameters

active
booleanDefaults to True
config__content__type
string
config__insecure__ssl
string
config__secret
string
config__url
string
events
arrayDefaults to ['push']
hook_id
integerRequired
name
string
org
stringRequired

Action Response

data
object
error
successful
boolean
Updates an existing check run for a specific commit in a repository, allowing modifications to its status, conclusion, output, and other details.

Action Parameters

actions
array
check_run_id
integerRequired
completed_at
string
conclusion
string
details_url
string
external_id
string
name
string
output__annotations
array
output__images
array
output__summary
string
output__text
string
output__title
string
owner
stringRequired
repo
stringRequired
started_at
string
status
string

Action Response

data
object
error
successful
boolean
Updates 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.

Action Parameters

codespace_name
stringRequired
display_name
string
machine
string
recent_folders
array

Action Response

data
object
error
successful
boolean
Updates a specific code scanning alert in a github repository, primarily to change its state (e.g., 'open' or 'dismissed').

Action Parameters

alert_number
integerRequired
dismissed_comment
string
dismissed_reason
string
owner
stringRequired
repo
stringRequired
state
stringRequired

Action Response

data
object
error
successful
boolean
Updates the default setup configuration for code scanning in a repository; github advanced security must be enabled for the repository.

Action Parameters

languages
array
owner
stringRequired
query_suite
string
repo
stringRequired
state
string

Action Response

data
object
error
successful
boolean
Changes the body of an existing commit comment.

Action Parameters

body
stringRequired
comment_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Updates an existing custom role in an organization by modifying its name, description, or permissions; at least one of these fields must be provided.

Action Parameters

description
string
name
string
org
stringRequired
permissions
array
role_id
integerRequired

Action Response

data
object
error
successful
boolean
Updates the state of a dependabot alert, requiring `dismissed reason` if `state` is 'dismissed'.

Action Parameters

alert_number
integerRequired
dismissed_comment
string
dismissed_reason
string
owner
stringRequired
repo
stringRequired
state
stringRequired

Action Response

data
object
error
successful
boolean
Updates the name pattern of an existing deployment branch policy for a specific environment in a repository.

Action Parameters

branch_policy_id
integerRequired
environment_name
stringRequired
name
stringRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Updates the title and/or body of a specific team discussion within an organization.

Action Parameters

body
string
discussion_number
integerRequired
org
stringRequired
team_slug
stringRequired
title
string

Action Response

data
object
error
successful
boolean
Updates the body of a comment in a team's discussion within an organization.

Action Parameters

body
stringRequired
comment_number
integerRequired
discussion_number
integerRequired
org
stringRequired
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Updates the body of a specific comment within a team discussion using a deprecated legacy endpoint; prefer newer alternatives if available.

Action Parameters

body
stringRequired
comment_number
integerRequired
discussion_number
integerRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Updates an existing team discussion's title and/or body using a legacy github api endpoint for older team discussion functionalities; at least `title` or `body` must be provided.

Action Parameters

body
string
discussion_number
integerRequired
team_id
integerRequired
title
string

Action Response

data
object
error
successful
boolean
Updates a gist's description, and/or its files (including content, filename changes, or deletion).

Action Parameters

description
string
files
object
gist_id
stringRequired

Action Response

data
object
error
successful
boolean
Updates an existing comment on a specified gist.

Action Parameters

body
stringRequired
comment_id
integerRequired
gist_id
stringRequired

Action Response

data
object
error
successful
boolean
Updates an existing label's name, color, or description within a specified repository.

Action Parameters

color
string
description
string
name
stringRequired
new_name
string
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Updates a milestone in a repository, identified by `owner`, `repo`, and `milestone number`, by allowing modification of its `title`, `state`, `description`, or `due on`; at least one of these four attributes must be provided to perform an update.

Action Parameters

description
string
due_on
string
milestone_number
integerRequired
owner
stringRequired
repo
stringRequired
state
stringDefaults to open
title
string

Action Response

data
object
error
successful
boolean
Updates an existing github project's attributes if the github projects feature is enabled and at least one modifiable field is provided.

Action Parameters

body
string
name
string
organization_permission
string
private
boolean
project_id
integerRequired
state
string

Action Response

data
object
error
successful
boolean
Updates an existing pull request, allowing changes to attributes like title, body, state, base branch, and maintainer modification settings.

Action Parameters

base
string
body
string
maintainer_can_modify
boolean
owner
stringRequired
pull_number
integerRequired
repo
stringRequired
state
string
title
string

Action Response

data
object
error
successful
boolean
Updates an open pull request's head branch by merging the latest changes from its base branch, if mergeable and repository merging is enabled; operates asynchronously.

Action Parameters

expected_head_sha
string
owner
stringRequired
pull_number
integerRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Updates a git reference (e.g., a branch or tag) to a specific commit sha, creating the reference if it doesn't exist; use `force` for non-fast-forward updates.

Action Parameters

force
boolean
owner
stringRequired
ref
stringRequired
repo
stringRequired
sha
stringRequired

Action Response

data
object
error
successful
boolean
Updates 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.

Action Parameters

body
string
discussion_category_name
string
draft
boolean
make_latest
stringDefaults to True
name
string
owner
stringRequired
prerelease
boolean
release_id
integerRequired
repo
stringRequired
tag_name
string
target_commitish
string

Action Response

data
object
error
successful
boolean
Updates 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.

Action Parameters

asset_id
integerRequired
label
string
name
string
owner
stringRequired
repo
stringRequired
state
string

Action Response

data
object
error
successful
boolean
Updates settings for an existing github repository, such as name, description, visibility, merge strategies, and security configurations.

Action Parameters

allow_auto_merge
boolean
allow_forking
boolean
allow_merge_commit
booleanDefaults to True
allow_rebase_merge
booleanDefaults to True
allow_squash_merge
booleanDefaults to True
allow_update_branch
boolean
archived
boolean
default_branch
string
delete_branch_on_merge
boolean
description
string
has_issues
booleanDefaults to True
has_projects
booleanDefaults to True
has_wiki
booleanDefaults to True
homepage
string
is_template
boolean
merge_commit_message
string
merge_commit_title
string
name
string
owner
stringRequired
private
boolean
repo
stringRequired
security__and__analysis__advanced__security__status
string
security__and__analysis__secret__scanning__push__protection__status
string
security__and__analysis__secret__scanning__status
string
squash_merge_commit_message
string
squash_merge_commit_title
string
use_squash_pr_title_as_default
boolean
visibility
string
web_commit_signoff_required
boolean

Action Response

data
object
error
successful
boolean
Updates an active repository invitation to modify the invited user's permissions; the specified repository and invitation must exist.

Action Parameters

invitation_id
integerRequired
owner
stringRequired
permissions
string
repo
stringRequired

Action Response

data
object
error
successful
boolean
Updates 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.

Action Parameters

bypass_actors
array
conditions__ref__name__exclude
array
conditions__ref__name__include
array
enforcement
string
name
string
owner
stringRequired
repo
stringRequired
rules
array
ruleset_id
integerRequired
target
string

Action Response

data
object
error
successful
boolean
Updates an existing repository security advisory, identified by its ghsa id, allowing modification of its details; only one of `severity` or `cvss vector string` can be provided, and only one of `collaborating users` or `collaborating teams`.

Action Parameters

collaborating_teams
array
collaborating_users
array
credits
array
cve_id
string
cvss_vector_string
string
cwe_ids
array
description
string
ghsa_id
stringRequired
owner
stringRequired
repo
stringRequired
severity
string
state
string
summary
string
vulnerabilities
array

Action Response

data
object
error
successful
boolean
Updates the name and/or value of an existing github actions variable in a repository.

Action Parameters

name
string
owner
stringRequired
repo
stringRequired
value
string

Action Response

data
object
error
successful
boolean
Updates the url, content type, secret, ssl verification, events, or active status for an existing repository webhook, specified by `owner`, `repo`, and `hook id`.

Action Parameters

active
booleanDefaults to True
add_events
array
config__content__type
string
config__insecure__ssl
string
config__secret
string
config__url
string
events
arrayDefaults to ['push']
hook_id
integerRequired
owner
stringRequired
remove_events
array
repo
stringRequired

Action Response

data
object
error
successful
boolean
Updates the body of an existing review comment on a pull request.

Action Parameters

body
stringRequired
comment_id
integerRequired
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Updates the body text of an existing pull request review.

Action Parameters

body
stringRequired
owner
stringRequired
pull_number
integerRequired
repo
stringRequired
review_id
integerRequired

Action Response

data
object
error
successful
boolean
Updates a github secret scanning alert's state; `resolution` is required if `state` is 'resolved', and `resolution comment` must be null or omitted if `state` is 'open'.

Action Parameters

alert_number
integerRequired
owner
stringRequired
repo
stringRequired
resolution
string
resolution_comment
string
state
stringRequired

Action Response

data
object
error
successful
boolean
Updates a team's settings (e.g., name, description, privacy, parent team) within a github organization, identified by its slug and organization name.

Action Parameters

description
string
name
string
notification_setting
string
org
stringRequired
parent_team_id
integer
permission
stringDefaults to pull
privacy
string
team_slug
stringRequired

Action Response

data
object
error
successful
boolean
Updates an existing team's attributes (name, description, privacy, notification settings, parent team) using the deprecated github legacy teams api; the team must exist.

Action Parameters

description
string
name
stringRequired
notification_setting
string
parent_team_id
integer
permission
stringDefaults to pull
privacy
string
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Updates the configuration (url, content type, secret, ssl verification) for an existing webhook within a specified organization.

Action Parameters

content_type
string
hook_id
integerRequired
insecure_ssl
string
org
stringRequired
secret
string
url
string

Action Response

data
object
error
successful
boolean
Updates the configuration (e.g., payload url, content type, secret, ssl verification) for an existing webhook in a specified repository.

Action Parameters

content_type
string
hook_id
integerRequired
insecure_ssl
string
owner
stringRequired
repo
stringRequired
secret
string
url
string

Action Response

data
object
error
successful
boolean
Updates the protection settings for an existing branch in a repository, which must not contain wildcard characters.

Action Parameters

allow_deletions
boolean
allow_force_pushes
boolean
allow_fork_syncing
boolean
block_creations
boolean
branch
stringRequired
enforce_admins
booleanRequired
lock_branch
boolean
owner
stringRequired
repo
stringRequired
required__pull__request__reviews__bypass__pull__request__allowances__apps
array
required__pull__request__reviews__bypass__pull__request__allowances__teams
array
required__pull__request__reviews__bypass__pull__request__allowances__users
array
required__pull__request__reviews__dismiss__stale__reviews
boolean
required__pull__request__reviews__dismissal__restrictions__apps
array
required__pull__request__reviews__dismissal__restrictions__teams
array
required__pull__request__reviews__dismissal__restrictions__users
array
required__pull__request__reviews__require__code__owner__reviews
boolean
required__pull__request__reviews__require__last__push__approval
boolean
required__pull__request__reviews__required__approving__review__count
integer
required__status__checks__checks
array
required__status__checks__contexts
array
required__status__checks__strict
boolean
required_conversation_resolution
boolean
required_linear_history
boolean
restrictions__apps
array
restrictions__teams
array
restrictions__users
array

Action Response

data
object
error
successful
boolean
Sets the git large file storage (lfs) preference for a repository, typically before initiating a source import.

Action Parameters

owner
stringRequired
repo
stringRequired
use_lfs
stringRequired

Action Response

data
object
error
successful
boolean
Updates the configuration for a github pages site (e.g., custom domain, https, build type, source); requires github pages to be enabled for the repository, and if `build type` is 'workflow', a corresponding github actions workflow must be configured.

Action Parameters

build_type
string
cname
string
https_enforced
boolean
owner
stringRequired
repo
stringRequired
source
string

Action Response

data
object
error
successful
boolean
Activates the authenticated user's organization membership.

Action Parameters

org
stringRequired
state
stringRequired

Action Response

data
object
error
successful
boolean
Updates pull request review protection settings (e.g., required approvals, review dismissal, bypass allowances) for a branch; branch protection features must be available for the repository.

Action Parameters

branch
stringRequired
bypass__pull__request__allowances__apps
array
bypass__pull__request__allowances__teams
array
bypass__pull__request__allowances__users
array
dismiss_stale_reviews
boolean
dismissal__restrictions__apps
array
dismissal__restrictions__teams
array
dismissal__restrictions__users
array
owner
stringRequired
repo
stringRequired
require_code_owner_reviews
boolean
require_last_push_approval
boolean
required_approving_review_count
integer

Action Response

data
object
error
successful
boolean
Updates 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.

Action Parameters

auto_trigger_checks
array
owner
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
Revokes 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.

Action Parameters

action
stringRequired
org
stringRequired
pat_ids
arrayRequired

Action Response

data
object
error
successful
boolean
Updates required status checks for a branch, optionally requiring it to be up-to-date before merging.

Action Parameters

branch
stringRequired
checks
array
contexts
array
owner
stringRequired
repo
stringRequired
strict
boolean

Action Response

data
object
error
successful
boolean
Updates the authenticated user's github profile; a new public email must be verified, and existing private emails remain private even if specified.

Action Parameters

bio
string
blog
string
company
string
email
string
hireable
boolean
location
string
name
string
twitter_username
string

Action Response

data
object
error
successful
boolean
Revokes a fine-grained personal access token's access to an organization, usable only by github apps when the token has existing access to that organization.

Action Parameters

action
stringRequired
org
stringRequired
pat_id
integerRequired

Action Response

data
object
error
successful
boolean
Uploads 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.

Action Parameters

checkout_uri
string
commit_sha
stringRequired
owner
stringRequired
ref
stringRequired
repo
stringRequired
sarif
stringRequired
started_at
string
tool_name
string
validate
boolean

Action Response

data
object
error
successful
boolean
Creates 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.

Action Parameters

owner
stringRequired
properties
arrayRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean
[deprecated] retrieves the authenticated user's information; use `get the authenticated user` instead.

Action Parameters

Action Response

data
object
error
successful
boolean
Deprecated: use the `getauser` action to retrieve a github user's public profile by username.

Action Parameters

username
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves contextual hovercard information for a github user. (deprecated: please use the `get contextual information for a user` action instead).

Action Parameters

subject_id
string
subject_type
string
username
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: lists all email addresses for the authenticated user, specifying which ones are public; use `listemailaddressesfortheauthenticateduser` instead.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Deprecated: lists users following the authenticated github user; use `list followers of the authenticated user` instead.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Deprecated: use `listpublicemailaddressesfortheauthenticateduser` instead; lists public email addresses for the authenticated user.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
object
error
successful
boolean
Deprecated: lists social media accounts for an existing github user; use 'list social accounts for a user' instead.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 30
username
stringRequired

Action Response

data
object
error
successful
boolean
Verifies 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.

Action Parameters

devcontainer_path
stringRequired
owner
stringRequired
ref
stringRequired
repo
stringRequired

Action Response

data
object
error
successful
boolean