GitHub (Personal Access Token) connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

   .env

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>

3. Make your first call

   Node.js

   quickstart.ts

   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   
   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENV_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions
   
   const connector = 'githubpat'
   const identifier = 'user_123'
   
   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'githubpat_gists_list',
     toolInput: {},
   })
   console.log(result)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "githubpat"
   identifier = "user_123"
   
   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="githubpat_gists_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)

What you can do

Connect this agent connector to let your agent:

• Get workflow, webhook, team membership — Get a single workflow by its ID or filename
• Enable workflow — Enable a workflow that was previously disabled
• Disable workflow — Disable a workflow, preventing it from running until re-enabled
• List webhooks, sub issues, secret scanning alerts — List webhooks configured on a repository
• Update webhook, team, repo variable — Update the configuration, events, or active state of an existing repository webhook
• Ping webhook — Trigger a ping event to test that a repository webhook is configured correctly

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

githubpat_artifact_delete#Delete a workflow run artifact.3 params▾

Delete a workflow run artifact.

NameTypeRequiredDescription

artifact_idnumberrequiredThe unique identifier of the artifact

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_artifact_get#Get a single workflow run artifact's metadata by its ID.3 params▾

Get a single workflow run artifact's metadata by its ID.

NameTypeRequiredDescription

artifact_idnumberrequiredThe unique identifier of the artifact

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_artifacts_list#List artifacts produced by workflow runs in a repository.5 params▾

List artifacts produced by workflow runs in a repository.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

namestringoptionalFilter artifacts by exact match on their name

pagenumberoptionalPage number of the results to fetch

per_pagenumberoptionalThe number of results per page (max 100)

githubpat_branch_create#Create a new branch in a GitHub repository. Requires the SHA of the commit to branch from (typically the HEAD of main).4 params▾

Create a new branch in a GitHub repository. Requires the SHA of the commit to branch from (typically the HEAD of main).

NameTypeRequiredDescription

branch_namestringrequiredName of the new branch to create

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

shastringrequiredThe SHA of the commit to branch from. Use the HEAD SHA of the base branch (e.g. main).

githubpat_branch_get#Get details of a specific branch in a GitHub repository. Returns the branch name, latest commit SHA, and protection status.3 params▾

Get details of a specific branch in a GitHub repository. Returns the branch name, latest commit SHA, and protection status.

NameTypeRequiredDescription

branchstringrequiredThe name of the branch to retrieve

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_branch_merge#Merge a branch (or commit) into another branch, creating a merge commit. Returns 204 when the base branch is already up to date and no merge was necessary.5 params▾

Merge a branch (or commit) into another branch, creating a merge commit. Returns 204 when the base branch is already up to date and no merge was necessary.

NameTypeRequiredDescription

basestringrequiredThe name of the base branch that the head will be merged into

headstringrequiredThe head to merge. This can be a branch name or a commit SHA1

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

commit_messagestringoptionalCommit message to use for the merge commit. If omitted, a default message is used

githubpat_branch_merge_upstream#Sync a branch of a forked repository to keep it up-to-date with the upstream repository.3 params▾

Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

NameTypeRequiredDescription

branchstringrequiredThe name of the branch which should be updated to match upstream

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_branch_protection_delete#Remove all branch protection settings from a branch.3 params▾

Remove all branch protection settings from a branch.

NameTypeRequiredDescription

branchstringrequiredThe name of the branch

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_branch_protection_get#Get the branch protection settings currently configured for a branch.3 params▾

Get the branch protection settings currently configured for a branch.

NameTypeRequiredDescription

branchstringrequiredThe name of the branch

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_branch_protection_update#Protect a branch, or update an existing branch's protection settings. Protecting a branch requires admin or owner permissions.14 params▾

Protect a branch, or update an existing branch's protection settings. Protecting a branch requires admin or owner permissions.

NameTypeRequiredDescription

branchstringrequiredThe name of the branch

enforce_adminsbooleanrequiredEnforce all configured restrictions for administrators. Set to null to disable

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

required_pull_request_reviewsobjectrequiredRequire at least one approving review before merging. Set to null to disable. Pass the object as null to disable that protection. Provide the object as an opaque JSON value; see GitHub's branch protection documentation for the full nested schema.

required_status_checksobjectrequiredRequire status checks to pass before merging. Set to null to disable. Pass the object as null to disable that protection. Provide the object as an opaque JSON value; see GitHub's branch protection documentation for the full nested schema.

restrictionsobjectrequiredRestrict who can push to the protected branch. Set to null to disable. Pass the object as null to disable that protection. Provide the object as an opaque JSON value; see GitHub's branch protection documentation for the full nested schema.

allow_deletionsbooleanoptionalAllow users with push access to delete the branch

allow_force_pushesbooleanoptionalPermit force pushes for all users with push access

allow_fork_syncingbooleanoptionalWhether users can pull changes from upstream when the branch is locked

block_creationsbooleanoptionalRestrict pushes that create matching branches

lock_branchbooleanoptionalWhether to set the branch as read-only, preventing any pushes to it

required_conversation_resolutionbooleanoptionalRequire all conversations on code to be resolved before a pull request can be merged

required_linear_historybooleanoptionalEnforce a linear commit history and prevent merge commits from being pushed

githubpat_branch_rename#Rename a branch in a repository. Tags and releases are not updated by this operation.4 params▾

Rename a branch in a repository. Tags and releases are not updated by this operation.

NameTypeRequiredDescription

branchstringrequiredThe name of the branch

new_namestringrequiredThe new name of the branch

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_branches_list#List all branches in a GitHub repository. Returns branch names, commit SHAs, and protection status. Supports pagination.5 params▾

List all branches in a GitHub repository. Returns branch names, commit SHAs, and protection status. Supports pagination.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pageintegeroptionalPage number of results to return (default 1)

per_pageintegeroptionalNumber of results per page (max 100, default 30)

protectedbooleanoptionalFilter to only protected branches

githubpat_check_run_create#Create a new check run for a specific commit in a repository. Creating a check run requires a GitHub App; OAuth apps and authenticated users are not able to create a check suite.8 params▾

Create a new check run for a specific commit in a repository. Creating a check run requires a GitHub App; OAuth apps and authenticated users are not able to create a check suite.

NameTypeRequiredDescription

head_shastringrequiredThe SHA of the commit

namestringrequiredThe name of the check. For example, 'code-coverage'.

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

conclusionstringoptionalThe final conclusion of the check. Required if you provide completed_at or a status of completed.

outputobjectoptionalCheck runs can accept a variety of data in the output object, including a title and summary, and can optionally provide descriptive details about the run.

started_atstringoptionalThe time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

statusstringoptionalThe current status of the check run. Only GitHub Actions can set a status of waiting, pending, or requested.

githubpat_check_run_get#Get a single check run using its id. OAuth app tokens and personal access tokens (classic) need the repo scope for private repositories.3 params▾

Get a single check run using its id. OAuth app tokens and personal access tokens (classic) need the repo scope for private repositories.

NameTypeRequiredDescription

check_run_idnumberrequiredThe unique identifier of the check run

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_check_runs_list_for_ref#List check runs for a commit ref. The ref can be a SHA, branch name, or tag name.7 params▾

List check runs for a commit ref. The ref can be a SHA, branch name, or tag name.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

refstringrequiredThe commit reference. Can be a commit SHA, branch name (heads/BRANCH_NAME), or tag name (tags/TAG_NAME)

repostringrequiredThe name of the repository

check_namestringoptionalReturns check runs with the specified name

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

statusstringoptionalReturns check runs with the specified status

githubpat_code_scanning_alerts_list#List code scanning alerts for a repository. To use this endpoint, you must have read access to the repository, and for private/internal repositories your token needs the security_events scope (public_repo is sufficient for public repositories).15 params▾

List code scanning alerts for a repository. To use this endpoint, you must have read access to the repository, and for private/internal repositories your token needs the security_events scope (public_repo is sufficient for public repositories).

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

afterstringoptionalA cursor, as given in the Link response header. Only search for results after this cursor.

assigneesstringoptionalComma-separated list of user handles to filter by, or '*' for alerts with at least one assignee, or 'none' for unassigned alerts

beforestringoptionalA cursor, as given in the Link response header. Only search for results before this cursor.

directionstringoptionalThe direction to sort the results by

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

prnumberoptionalOnly list alerts for this pull request number

refstringoptionalThe Git reference for the results, e.g. refs/heads/main or simply main. Use refs/pull/<number>/merge for a pull request.

severitystringoptionalOnly list alerts with this severity

sortstringoptionalThe property by which to sort the results

statestringoptionalOnly list alerts with this state

tool_guidstringoptionalOnly list alerts from the code scanning tool with this GUID. Cannot be used together with tool_name.

tool_namestringoptionalOnly list alerts from this code scanning tool. Cannot be used together with tool_guid.

githubpat_collaborator_add#Add a user as a collaborator to a repository with a specified permission level. On organization-owned repositories this may create an invitation.4 params▾

Add a user as a collaborator to a repository with a specified permission level. On organization-owned repositories this may create an invitation.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

usernamestringrequiredThe username of the collaborator to add

permissionstringoptionalThe permission to grant the collaborator (only valid on organization-owned repositories)

githubpat_collaborator_check#Check if a user is a collaborator on a repository. Returns a 404 if the user is not a collaborator.3 params▾

Check if a user is a collaborator on a repository. Returns a 404 if the user is not a collaborator.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

usernamestringrequiredThe handle for the GitHub user account

githubpat_collaborator_remove#Remove a collaborator from a repository. Requires admin access to the repository.3 params▾

Remove a collaborator from a repository. Requires admin access to the repository.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

usernamestringrequiredThe username of the collaborator to remove

githubpat_collaborators_list#List collaborators for a repository, optionally filtered by affiliation or permission level.6 params▾

List collaborators for a repository, optionally filtered by affiliation or permission level.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

affiliationstringoptionalFilter collaborators by affiliation: outside, direct, or all

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

permissionstringoptionalFilter collaborators by permission level

githubpat_commit_combined_status_get#Access a combined view of commit statuses for a given ref (SHA, branch name, or tag name). Returns a combined state of failure, pending, or success.5 params▾

Access a combined view of commit statuses for a given ref (SHA, branch name, or tag name). Returns a combined state of failure, pending, or success.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

refstringrequiredThe commit SHA, branch name, or tag name

repostringrequiredThe name of the repository

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

githubpat_commit_comment_create#Create a comment for a commit using its SHA. Triggers notifications.7 params▾

Create a comment for a commit using its SHA. Triggers notifications.

NameTypeRequiredDescription

bodystringrequiredThe contents of the comment

commit_shastringrequiredThe SHA of the commit to comment on

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

linenumberoptionalLine number in the file to comment on (deprecated, use position instead)

pathstringoptionalRelative path of the file to comment on

positionnumberoptionalLine index in the diff to comment on

githubpat_commit_comment_delete#Delete a commit comment.3 params▾

Delete a commit comment.

NameTypeRequiredDescription

comment_idnumberrequiredThe unique identifier of the comment

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_commit_comment_get#Get a single commit comment by its ID.3 params▾

Get a single commit comment by its ID.

NameTypeRequiredDescription

comment_idnumberrequiredThe unique identifier of the comment

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_commit_comment_update#Update the text of an existing commit comment.4 params▾

Update the text of an existing commit comment.

NameTypeRequiredDescription

bodystringrequiredThe contents of the comment

comment_idnumberrequiredThe unique identifier of the comment

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_commit_comments_list#Lists the comments for a specified commit.5 params▾

Lists the comments for a specified commit.

NameTypeRequiredDescription

commit_shastringrequiredThe SHA of the commit

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

githubpat_commit_get#Get the contents of a single commit reference, including files changed and stats.5 params▾

Get the contents of a single commit reference, including files changed and stats.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

refstringrequiredThe commit reference. Can be a commit SHA, branch name, or tag name

repostringrequiredThe name of the repository

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

githubpat_commit_pull_requests_list#List the merged pull request that introduced a commit to a repository, plus unmerged pull requests that reference the commit.5 params▾

List the merged pull request that introduced a commit to a repository, plus unmerged pull requests that reference the commit.

NameTypeRequiredDescription

commit_shastringrequiredThe SHA of the commit

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of the results to fetch

per_pagenumberoptionalThe number of results per page (max 100)

githubpat_commit_status_create#Create a commit status for a given SHA. Requires push access to the repository. Limited to 1000 statuses per sha and context.7 params▾

Create a commit status for a given SHA. Requires push access to the repository. Limited to 1000 statuses per sha and context.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

shastringrequiredThe commit SHA to create a status for

statestringrequiredThe state of the status

contextstringoptionalA string label to differentiate this status from the status of other systems

descriptionstringoptionalA short description of the status

target_urlstringoptionalThe target URL to associate with this status, linked from the GitHub UI

githubpat_commit_statuses_list#Lists commit statuses for a given ref (SHA, branch name, or tag name). Statuses are returned in reverse chronological order; the first status is the latest.5 params▾

Lists commit statuses for a given ref (SHA, branch name, or tag name). Statuses are returned in reverse chronological order; the first status is the latest.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

refstringrequiredThe commit SHA, branch name, or tag name

repostringrequiredThe name of the repository

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

githubpat_commits_compare#Compare two commits against one another. Equivalent to running 'git log BASE..HEAD', returning commits in chronological order along with details of changed files.5 params▾

Compare two commits against one another. Equivalent to running 'git log BASE..HEAD', returning commits in chronological order along with details of changed files.

NameTypeRequiredDescription

baseheadstringrequiredThe base branch and head branch to compare, in the format BASE...HEAD. Both must be branch names in repo, or USERNAME:BASE...USERNAME:HEAD to compare across forks

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

githubpat_commits_list#List commits on a repository, optionally filtered by SHA/branch, file path, author, or a date range.9 params▾

List commits on a repository, optionally filtered by SHA/branch, file path, author, or a date range.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

authorstringoptionalGitHub username or email address to use to filter by commit author

pagenumberoptionalPage number of results to fetch

pathstringoptionalOnly commits containing this file path will be returned

per_pagenumberoptionalNumber of results per page (max 100)

shastringoptionalSHA or branch to start listing commits from. Default: the repository's default branch (usually main).

sincestringoptionalOnly show results that were last updated after the given time. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

untilstringoptionalOnly commits before this date will be returned. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

githubpat_dependabot_alerts_list#List Dependabot alerts for a repository. To use this endpoint, you must have read access to the repository, and for private repositories your token needs the security_events scope (public_repo is sufficient for public repositories).18 params▾

List Dependabot alerts for a repository. To use this endpoint, you must have read access to the repository, and for private repositories your token needs the security_events scope (public_repo is sufficient for public repositories).

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

afterstringoptionalA cursor, as given in the Link response header. Only search for results after this cursor.

assigneestringoptionalFilter by assignee username, '*' for any assignee, or 'none' for unassigned

beforestringoptionalA cursor, as given in the Link response header. Only search for results before this cursor.

classificationstringoptionalComma-separated list of vulnerability classifications to filter by

directionstringoptionalThe direction to sort the results by

ecosystemstringoptionalComma-separated list of package ecosystems to filter by

epss_percentagestringoptionalFilter by EPSS percentage: an exact number, a comparator expression (>n, <n, >=n, <=n), or a range (n..n), where n is between 0.0 and 1.0

hasstringoptionalFilter alerts that have the given attribute. Currently only 'patch' is supported (alerts for which a patch is available).

manifeststringoptionalComma-separated list of full manifest file paths to filter by

packagestringoptionalComma-separated list of package names to filter by

per_pagenumberoptionalNumber of results per page (max 100)

relationshipstringoptionalComma-separated list of relationships of the vulnerable dependency to your project (e.g. direct, transitive) to filter by

scopestringoptionalThe scope of the vulnerable dependency to filter by

severitystringoptionalComma-separated list of severities to filter by

sortstringoptionalThe property by which to sort the results

statestringoptionalComma-separated list of states to filter by

githubpat_deployment_create#Create a deployment for a ref (branch, tag, or SHA). Deployments offer a way to track the status of code as it is deployed to different environments.11 params▾

Create a deployment for a ref (branch, tag, or SHA). Deployments offer a way to track the status of code as it is deployed to different environments.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

refstringrequiredThe ref to deploy. This can be a branch, tag, or SHA

repostringrequiredThe name of the repository

auto_mergebooleanoptionalAttempts to automatically merge the default branch into the requested ref, if it is behind the default branch

descriptionstringoptionalShort description of the deployment

environmentstringoptionalName for the target deployment environment (e.g., production, staging, qa)

payloadobjectoptionalJSON payload with extra information about the deployment

production_environmentbooleanoptionalSpecifies if the given environment is one that end-users directly interact with

required_contextsarrayoptionalStatus contexts to verify against commit status checks. Pass an empty array to bypass checking entirely. Defaults to all unique contexts

taskstringoptionalSpecifies a task to execute (e.g., deploy or deploy:migrations)

transient_environmentbooleanoptionalSpecifies if the given environment is specific to this deployment and will no longer exist at some point in the future

githubpat_deployment_delete#Delete a deployment. Only inactive deployments can be deleted; transition the deployment to inactive first.3 params▾

Delete a deployment. Only inactive deployments can be deleted; transition the deployment to inactive first.

NameTypeRequiredDescription

deployment_idnumberrequiredThe unique identifier of the deployment

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_deployment_get#Get a single deployment by its ID.3 params▾

Get a single deployment by its ID.

NameTypeRequiredDescription

deployment_idnumberrequiredThe unique identifier of the deployment

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_deployment_status_create#Create a new status for a deployment, used to track the deployment's progress through states like in_progress, success, or failure.9 params▾

Create a new status for a deployment, used to track the deployment's progress through states like in_progress, success, or failure.

NameTypeRequiredDescription

deployment_idnumberrequiredThe unique identifier of the deployment

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

statestringrequiredThe state of the status

auto_inactivebooleanoptionalAdds an inactive status to all prior non-transient, non-production deployments with the same repository and environment name

descriptionstringoptionalA short description of the status. Maximum 140 characters

environmentstringoptionalName for the target deployment environment, which can be changed when setting a deploy status

environment_urlstringoptionalSets the URL for accessing your environment

log_urlstringoptionalThe full URL of the deployment's output, shown while the task runs or as historical information afterward

githubpat_deployments_list#List deployments for a repository, optionally filtered by ref, task, or environment.8 params▾

List deployments for a repository, optionally filtered by ref, task, or environment.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

environmentstringoptionalThe name of the environment that was deployed to (e.g., staging or production)

pagenumberoptionalPage number of the results to fetch

per_pagenumberoptionalThe number of results per page (max 100)

refstringoptionalThe name of the ref, branch, or tag

shastringoptionalThe SHA recorded at creation time

taskstringoptionalThe name of the task for the deployment (e.g., deploy or deploy:migrations)

githubpat_environment_create_update#Create a new deployment environment on a repository, or update an existing one's protection rules (wait timer, required reviewers, deployment branch policy). Environment creation requires admin access to the repository.7 params▾

Create a new deployment environment on a repository, or update an existing one's protection rules (wait timer, required reviewers, deployment branch policy). Environment creation requires admin access to the repository.

NameTypeRequiredDescription

environment_namestringrequiredThe name of the environment to create or update

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

deployment_branch_policyobjectoptionalRestricts which branches/tags can deploy to this environment. Set to null to allow all branches to deploy. Shape: {"protected_branches": bool, "custom_branch_policies": bool} — exactly one of the two booleans may be true.

prevent_self_reviewbooleanoptionalWhether or not a user who created the job is prevented from approving their own job

reviewersarrayoptionalUp to 6 users or teams that must approve deployments to this environment. Each item is an object like {"type": "User", "id": 123} or {"type": "Team", "id": 456}, where id is the numeric user or team id.

wait_timernumberoptionalThe amount of time (in minutes, 0-43200) to delay a job after the job is initially triggered

githubpat_environments_list#List the deployment environments configured for a repository (e.g. staging, production), including their protection rules.4 params▾

List the deployment environments configured for a repository (e.g. staging, production), including their protection rules.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

githubpat_file_contents_get#Get the contents of a file or directory from a GitHub repository. Returns Base64 encoded content for files.4 params▾

Get the contents of a file or directory from a GitHub repository. Returns Base64 encoded content for files.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

pathstringrequiredThe content path (file or directory path in the repository)

repostringrequiredThe name of the repository

refstringoptionalThe name of the commit/branch/tag

githubpat_file_create_update#Create a new file or update an existing file in a GitHub repository. Content must be Base64 encoded. Requires SHA when updating existing files.9 params▾

Create a new file or update an existing file in a GitHub repository. Content must be Base64 encoded. Requires SHA when updating existing files.

NameTypeRequiredDescription

contentstringrequiredThe new file content (Base64 encoded)

messagestringrequiredThe commit message for this change

ownerstringrequiredThe account owner of the repository

pathstringrequiredThe file path in the repository

repostringrequiredThe name of the repository

authorobjectoptionalAuthor information object with name and email

branchstringoptionalThe branch name

committerobjectoptionalCommitter information object with name and email

shastringoptionalThe blob SHA of the file being replaced (required when updating existing files)

githubpat_file_delete#Delete a file in a repository. Requires the blob SHA of the file being deleted.6 params▾

Delete a file in a repository. Requires the blob SHA of the file being deleted.

NameTypeRequiredDescription

messagestringrequiredThe commit message

ownerstringrequiredThe account owner of the repository

pathstringrequiredThe path to the file to delete

repostringrequiredThe name of the repository

shastringrequiredThe blob SHA of the file being deleted

branchstringoptionalThe branch name. Default: the repository's default branch

githubpat_gist_comment_create#Create a comment on a gist.2 params▾

Create a comment on a gist.

NameTypeRequiredDescription

bodystringrequiredThe comment text

gist_idstringrequiredThe unique identifier of the gist

githubpat_gist_comment_delete#Delete a gist comment.2 params▾

Delete a gist comment.

NameTypeRequiredDescription

comment_idnumberrequiredThe unique identifier of the comment

gist_idstringrequiredThe unique identifier of the gist

githubpat_gist_comment_update#Update the text of an existing gist comment.3 params▾

Update the text of an existing gist comment.

NameTypeRequiredDescription

bodystringrequiredThe comment text

comment_idnumberrequiredThe unique identifier of the comment

gist_idstringrequiredThe unique identifier of the gist

githubpat_gist_comments_list#List comments left on a gist.3 params▾

List comments left on a gist.

NameTypeRequiredDescription

gist_idstringrequiredThe unique identifier of the gist

pagenumberoptionalPage number of the results to fetch

per_pagenumberoptionalThe number of results per page (max 100)

githubpat_gist_create#Create a new gist with one or more files. Files are provided as a map of filename to an object containing the file's content.3 params▾

Create a new gist with one or more files. Files are provided as a map of filename to an object containing the file's content.

NameTypeRequiredDescription

filesobjectrequiredNames and content for the files that make up the gist. Each key is a filename, mapped to an object with a 'content' field.

descriptionstringoptionalDescription of the gist

publicbooleanoptionalFlag indicating whether the gist is public

githubpat_gist_delete#Permanently delete a gist owned by the authenticated user.1 param▾

Permanently delete a gist owned by the authenticated user.

NameTypeRequiredDescription

gist_idstringrequiredThe unique identifier of the gist to delete

githubpat_gist_get#Get a specified gist by its ID.1 param▾

Get a specified gist by its ID.

NameTypeRequiredDescription

gist_idstringrequiredThe unique identifier of the gist

githubpat_gist_star#Star a gist for the authenticated user.1 param▾

Star a gist for the authenticated user.

NameTypeRequiredDescription

gist_idstringrequiredThe unique identifier of the gist

githubpat_gist_unstar#Unstar a gist for the authenticated user.1 param▾

Unstar a gist for the authenticated user.

NameTypeRequiredDescription

gist_idstringrequiredThe unique identifier of the gist

githubpat_gist_update#Update a gist's description and/or update, rename, or delete its files. Files from the previous version that aren't explicitly changed remain unchanged. At least one of description or files is required.3 params▾

Update a gist's description and/or update, rename, or delete its files. Files from the previous version that aren't explicitly changed remain unchanged. At least one of description or files is required.

NameTypeRequiredDescription

gist_idstringrequiredThe unique identifier of the gist to update

descriptionstringoptionalThe description of the gist

filesobjectoptionalThe gist files to be updated, renamed, or deleted. Each key must match the current filename of the targeted gist file. To delete a file, set its value to null.

githubpat_gists_list#List the authenticated user's gists, sorted by most recently updated to least recently updated.3 params▾

List the authenticated user's gists, sorted by most recently updated to least recently updated.

NameTypeRequiredDescription

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

sincestringoptionalOnly show results updated after the given time (ISO 8601 format)

githubpat_git_blob_create#Create a Git blob object in a repository. Requires push access to the repository.4 params▾

Create a Git blob object in a repository. Requires push access to the repository.

NameTypeRequiredDescription

contentstringrequiredThe new blob's content

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

encodingstringoptionalThe encoding used for content. Currently utf-8 and base64 are supported

githubpat_git_commit_create#Creates a new Git commit object. Requires push access to the repository.6 params▾

Creates a new Git commit object. Requires push access to the repository.

NameTypeRequiredDescription

messagestringrequiredThe commit message

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

treestringrequiredThe SHA of the tree object this commit points to

authorobjectoptionalInformation about the author of the commit: name, email, and optional ISO 8601 date. By default the author is the authenticated user and the current date. Expected shape: {"name": "Monalisa Octocat", "email": "octocat@github.com", "date": "2008-07-09T16:13:30+12:00"}

parentsarrayoptionalThe full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit is written as a root commit. Provide an array of one SHA for a normal commit, or more than one for a merge commit. Expected shape: ["7d1b31e74ee336d15cbd21741bc88a537ed063a0"]

githubpat_git_ref_delete#Deletes the provided reference. This permanently removes a branch or tag ref from the Git database.3 params▾

Deletes the provided reference. This permanently removes a branch or tag ref from the Git database.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

refstringrequiredThe reference name, formatted as heads/<branch name> or tags/<tag name>

repostringrequiredThe name of the repository

githubpat_git_ref_get#Returns a single reference from the Git database. The ref must be formatted as heads/<branch name> for branches and tags/<tag name> for tags.3 params▾

Returns a single reference from the Git database. The ref must be formatted as heads/<branch name> for branches and tags/<tag name> for tags.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

refstringrequiredThe reference name, formatted as heads/<branch name> or tags/<tag name>

repostringrequiredThe name of the repository

githubpat_git_ref_update#Updates the provided reference to point to a new SHA. Leaving force out or false ensures the update is a fast-forward update.5 params▾

Updates the provided reference to point to a new SHA. Leaving force out or false ensures the update is a fast-forward update.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

refstringrequiredThe reference name, formatted as heads/<branch name> or tags/<tag name>

repostringrequiredThe name of the repository

shastringrequiredThe SHA1 value to set this reference to

forcebooleanoptionalIndicates whether to force the update or to make sure the update is a fast-forward update

githubpat_git_tag_create#Create a Git tag object in the repository's low-level Git database (an annotated tag). Note this only creates the tag object itself — to make it a real ref you can list/checkout, also create a matching reference at refs/tags/<tag> pointing at this tag object's SHA.9 params▾

Create a Git tag object in the repository's low-level Git database (an annotated tag). Note this only creates the tag object itself — to make it a real ref you can list/checkout, also create a matching reference at refs/tags/<tag> pointing at this tag object's SHA.

NameTypeRequiredDescription

messagestringrequiredThe tag message

objectstringrequiredThe SHA of the git object this is tagging

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

tagstringrequiredThe tag's name, typically a version such as 'v0.0.1'

typestringrequiredThe type of the object being tagged

tagger_datestringoptionalWhen this tag was created, in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

tagger_emailstringoptionalEmail of the person creating the tag. Required if any tagger field is provided.

tagger_namestringoptionalName of the person creating the tag. Required if any tagger field is provided.

githubpat_git_tag_get#Get a single Git tag object from the repository's low-level Git database by its SHA. Note this returns the annotated tag object, not the tag ref itself.3 params▾

Get a single Git tag object from the repository's low-level Git database by its SHA. Note this returns the annotated tag object, not the tag ref itself.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

tag_shastringrequiredThe SHA of the tag object to retrieve

githubpat_git_tree_create#Creates a Git tree object, accepting nested entries. If both a tree and a nested path modifying that tree are specified, this overwrites the contents of the tree and creates a new tree structure. Returns an error if trying to delete a file that does not exist.4 params▾

Creates a Git tree object, accepting nested entries. If both a tree and a nested path modifying that tree are specified, this overwrites the contents of the tree and creates a new tree structure. Returns an error if trying to delete a file that does not exist.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

treearrayrequiredArray of objects specifying a tree structure, each with path, mode (100644 file, 100755 executable, 040000 subdirectory, 160000 submodule, 120000 symlink), type (blob, tree, or commit), and either sha or content. Expected shape: [{"path": "file.rb", "mode": "100644", "type": "blob", "sha": "44b4fc6d56897b048c772eb4087f854f46256132"}]

base_treestringoptionalThe SHA1 of an existing Git tree object to use as the base for the new tree. If provided, a new tree is created from entries in base_tree plus entries in the tree parameter (which overwrite base_tree entries with the same path). If omitted, only entries in tree are used, and any files from the parent commit not defined in tree will be listed as deleted.

githubpat_git_tree_get#Get a Git tree by its SHA or ref. Optionally return the full recursive tree including all subtrees.4 params▾

Get a Git tree by its SHA or ref. Optionally return the full recursive tree including all subtrees.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

tree_shastringrequiredThe SHA1 value or ref (branch or tag) name of the tree

recursivebooleanoptionalWhether to recursively return objects or subtrees referenced by the tree

githubpat_gitignore_template_get#Get the content of a gitignore template by name.1 param▾

Get the content of a gitignore template by name.

NameTypeRequiredDescription

namestringrequiredThe name of the gitignore template

githubpat_gitignore_templates_list#List all gitignore templates available to pass as an option when creating a repository.0 params▾

List all gitignore templates available to pass as an option when creating a repository.

githubpat_issue_assignees_add#Add up to 10 assignees to an issue. Users already assigned remain assigned; only users with push access are actually added.4 params▾

Add up to 10 assignees to an issue. Users already assigned remain assigned; only users with push access are actually added.

NameTypeRequiredDescription

issue_numbernumberrequiredThe number that identifies the issue

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

assigneesarrayoptionalUsernames of people to assign to this issue

githubpat_issue_assignees_remove#Remove one or more assignees from an issue.4 params▾

Remove one or more assignees from an issue.

NameTypeRequiredDescription

issue_numbernumberrequiredThe number that identifies the issue

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

assigneesarrayoptionalUsernames of assignees to remove from the issue

githubpat_issue_comment_create#Create a comment on an issue or pull request. Every pull request is an issue, but not every issue is a pull request.4 params▾

Create a comment on an issue or pull request. Every pull request is an issue, but not every issue is a pull request.

NameTypeRequiredDescription

bodystringrequiredThe contents of the comment

issue_numbernumberrequiredThe number that identifies the issue

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_issue_comment_delete#Delete a comment on an issue or pull request. Every pull request is an issue, but not every issue is a pull request.3 params▾

Delete a comment on an issue or pull request. Every pull request is an issue, but not every issue is a pull request.

NameTypeRequiredDescription

comment_idnumberrequiredThe unique identifier of the comment

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_issue_comment_get#Get a single issue comment by its ID.3 params▾

Get a single issue comment by its ID.

NameTypeRequiredDescription

comment_idnumberrequiredThe unique identifier of the comment

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_issue_comment_update#Update a comment on an issue or pull request. Every pull request is an issue, but not every issue is a pull request.4 params▾

Update a comment on an issue or pull request. Every pull request is an issue, but not every issue is a pull request.

NameTypeRequiredDescription

bodystringrequiredThe contents of the comment

comment_idnumberrequiredThe unique identifier of the comment

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_issue_comments_list#List comments on an issue or pull request, ordered by ascending ID. Every pull request is an issue, but not every issue is a pull request.6 params▾

List comments on an issue or pull request, ordered by ascending ID. Every pull request is an issue, but not every issue is a pull request.

NameTypeRequiredDescription

issue_numbernumberrequiredThe number that identifies the issue

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

sincestringoptionalOnly show comments updated after this timestamp (ISO 8601 format)

githubpat_issue_create#Create a new issue in a repository. Requires push access to set assignees, milestones, and labels.8 params▾

Create a new issue in a repository. Requires push access to set assignees, milestones, and labels.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

titlestringrequiredThe title of the issue

assigneesarrayoptionalGitHub usernames to assign to the issue

bodystringoptionalThe contents of the issue

labelsarrayoptionalLabels to associate with the issue

milestonenumberoptionalMilestone number to associate with the issue

typestringoptionalThe name of the issue type

githubpat_issue_events_list#List events for an issue, such as labeling, assignment, and milestone changes.5 params▾

List events for an issue, such as labeling, assignment, and milestone changes.

NameTypeRequiredDescription

issue_numbernumberrequiredThe number that identifies the issue

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of the results to fetch

per_pagenumberoptionalThe number of results per page (max 100)

githubpat_issue_get#Get a single issue in a repository by its number. Both issues and pull requests are returned as issues in the GitHub API.3 params▾

Get a single issue in a repository by its number. Both issues and pull requests are returned as issues in the GitHub API.

NameTypeRequiredDescription

issue_numbernumberrequiredThe number that identifies the issue

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_issue_label_remove#Remove a single label from an issue.4 params▾

Remove a single label from an issue.

NameTypeRequiredDescription

issue_numbernumberrequiredThe number that identifies the issue

label_namestringrequiredThe name of the label

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_issue_labels_add#Add labels to an issue, appending to any existing labels. To replace all labels instead, use github_issue_labels_set.4 params▾

Add labels to an issue, appending to any existing labels. To replace all labels instead, use github_issue_labels_set.

NameTypeRequiredDescription

issue_numbernumberrequiredThe number that identifies the issue

labelsarrayrequiredThe names of the labels to add to the issue's existing labels

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_issue_labels_remove_all#Remove all labels from an issue.3 params▾

Remove all labels from an issue.

NameTypeRequiredDescription

issue_numbernumberrequiredThe number that identifies the issue

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_issue_labels_set#Remove any previous labels and set the new labels for an issue. Pass an empty array to remove all labels.4 params▾

Remove any previous labels and set the new labels for an issue. Pass an empty array to remove all labels.

NameTypeRequiredDescription

issue_numbernumberrequiredThe number that identifies the issue

labelsarrayrequiredThe names of the labels to set for the issue, replacing any existing labels. Pass an empty array to remove all labels

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_issue_lock#Lock an issue or pull request conversation to prevent further comments from being added. Only users with push access can lock an issue or pull request conversation.4 params▾

Lock an issue or pull request conversation to prevent further comments from being added. Only users with push access can lock an issue or pull request conversation.

NameTypeRequiredDescription

issue_numbernumberrequiredThe number that identifies the issue

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

lock_reasonstringoptionalThe reason for locking the issue or pull request conversation

githubpat_issue_reaction_create#Create a reaction (emoji) to an issue. If you create a reaction that already exists on this issue, GitHub responds with a 200 OK and returns the existing reaction instead of creating a duplicate.4 params▾

Create a reaction (emoji) to an issue. If you create a reaction that already exists on this issue, GitHub responds with a 200 OK and returns the existing reaction instead of creating a duplicate.

NameTypeRequiredDescription

contentstringrequiredThe reaction type to add to the issue

issue_numbernumberrequiredThe number that identifies the issue

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_issue_reaction_list#List the reactions (emoji) left on an issue. Optionally filter to a single reaction type.6 params▾

List the reactions (emoji) left on an issue. Optionally filter to a single reaction type.

NameTypeRequiredDescription

issue_numbernumberrequiredThe number that identifies the issue

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

contentstringoptionalFilter results to only include reactions of this type

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

githubpat_issue_timeline_list#List timeline events for an issue, including comments, cross-references, and state changes, in chronological order.5 params▾

List timeline events for an issue, including comments, cross-references, and state changes, in chronological order.

NameTypeRequiredDescription

issue_numbernumberrequiredThe number that identifies the issue

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of the results to fetch

per_pagenumberoptionalThe number of results per page (max 100)

githubpat_issue_unlock#Unlock an issue, allowing new comments from users who are not collaborators.3 params▾

Unlock an issue, allowing new comments from users who are not collaborators.

NameTypeRequiredDescription

issue_numbernumberrequiredThe number that identifies the issue

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_issue_update#Update an existing issue in a repository. Issue owners and users with push access or Triage role can edit an issue.10 params▾

Update an existing issue in a repository. Issue owners and users with push access or Triage role can edit an issue.

NameTypeRequiredDescription

issue_numbernumberrequiredThe number that identifies the issue

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

assigneesarrayoptionalUsernames to replace the set of assignees on this issue. Send an empty array to clear all assignees

bodystringoptionalThe contents of the issue

labelsarrayoptionalLabels to replace the set of labels on this issue. Send an empty array to clear all labels

milestonenumberoptionalMilestone number to associate with the issue, or null to remove the current milestone

statestringoptionalThe open or closed state of the issue

state_reasonstringoptionalThe reason for the state change. Ignored unless state is changed

titlestringoptionalThe title of the issue

githubpat_issues_list#List issues in a repository. Both issues and pull requests are returned as issues in the GitHub API.12 params▾

List issues in a repository. Both issues and pull requests are returned as issues in the GitHub API.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

assigneestringoptionalFilter by assigned user

creatorstringoptionalFilter by issue creator

directionstringoptionalSort order

labelsstringoptionalFilter by comma-separated list of label names

milestonestringoptionalFilter by milestone number or state

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

sincestringoptionalShow issues updated after this timestamp (ISO 8601 format)

sortstringoptionalProperty to sort issues by

statestringoptionalFilter by issue state

githubpat_label_create#Create a label for a repository with the given name and color. The name and color are required; color must be a hexadecimal code without the leading '#'.5 params▾

Create a label for a repository with the given name and color. The name and color are required; color must be a hexadecimal code without the leading '#'.

NameTypeRequiredDescription

namestringrequiredThe name of the label

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

colorstringoptionalThe hexadecimal color code for the label, without the leading '#'

descriptionstringoptionalA short description of the label. Must be 100 characters or fewer

githubpat_label_delete#Delete a label from a repository using the given label name.3 params▾

Delete a label from a repository using the given label name.

NameTypeRequiredDescription

namestringrequiredThe name of the label to delete

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_label_get#Get a single label by name.3 params▾

Get a single label by name.

NameTypeRequiredDescription

label_namestringrequiredThe name of the label

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_label_update#Update a label in a repository using its current name.6 params▾

Update a label in a repository using its current name.

NameTypeRequiredDescription

namestringrequiredThe current name of the label to update

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

colorstringoptionalThe hexadecimal color code for the label, without the leading '#'

descriptionstringoptionalA short description of the label. Must be 100 characters or fewer

new_namestringoptionalThe new name of the label

githubpat_labels_list#List all labels for a repository.4 params▾

List all labels for a repository.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

githubpat_license_get#Get information about a specific open source license by its SPDX keyword (e.g. 'mit').1 param▾

Get information about a specific open source license by its SPDX keyword (e.g. 'mit').

NameTypeRequiredDescription

licensestringrequiredThe license keyword (SPDX id)

githubpat_milestone_create#Create a milestone in a repository.6 params▾

Create a milestone in a repository.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

titlestringrequiredThe title of the milestone

descriptionstringoptionalA description of the milestone

due_onstringoptionalThe milestone due date, in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

statestringoptionalThe state of the milestone. Either open or closed

githubpat_milestone_delete#Delete a milestone from a repository using the given milestone number.3 params▾

Delete a milestone from a repository using the given milestone number.

NameTypeRequiredDescription

milestone_numbernumberrequiredThe number that identifies the milestone

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_milestone_get#Get a single milestone by its number.3 params▾

Get a single milestone by its number.

NameTypeRequiredDescription

milestone_numbernumberrequiredThe number that identifies the milestone

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_milestone_update#Update a milestone in a repository using the given milestone number. All fields are optional.7 params▾

Update a milestone in a repository using the given milestone number. All fields are optional.

NameTypeRequiredDescription

milestone_numbernumberrequiredThe number that identifies the milestone

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

descriptionstringoptionalA description of the milestone

due_onstringoptionalThe milestone due date, in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

statestringoptionalThe state of the milestone. Either open or closed

titlestringoptionalThe title of the milestone

githubpat_milestones_list#List milestones for a repository, with optional filtering by state and sorting.7 params▾

List milestones for a repository, with optional filtering by state and sorting.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

directionstringoptionalThe direction of the sort. Either asc or desc

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

sortstringoptionalWhat to sort results by. Either due_on or completeness

statestringoptionalThe state of the milestone. Either open, closed, or all

githubpat_notifications_list#List notifications for the authenticated user across all repositories they have access to. By default only unread notifications are returned.6 params▾

List notifications for the authenticated user across all repositories they have access to. By default only unread notifications are returned.

NameTypeRequiredDescription

allbooleanoptionalIf true, show notifications marked as read

beforestringoptionalOnly show notifications updated before this time, in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

pagenumberoptionalPage number of results to fetch

participatingbooleanoptionalIf true, only show notifications in which the user is directly participating or mentioned

per_pagenumberoptionalNumber of results per page (max 50)

sincestringoptionalOnly show results updated after this time, in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

githubpat_org_get#Get information about an organization, including its profile details, billing settings visibility, and security settings.1 param▾

Get information about an organization, including its profile details, billing settings visibility, and security settings.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

githubpat_org_issue_types_list#List the issue types (e.g. Bug, Feature, Task) configured for an organization. Issue types can be assigned to issues to categorize them.1 param▾

List the issue types (e.g. Bug, Feature, Task) configured for an organization. Issue types can be assigned to issues to categorize them.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

githubpat_org_issues_list#List issues in an organization assigned to the authenticated user, across all visible repositories.9 params▾

List issues in an organization assigned to the authenticated user, across all visible repositories.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

directionstringoptionalThe direction to sort the results by

filterstringoptionalIndicates which sorts of issues to return

labelsstringoptionalA list of comma separated label names

pagenumberoptionalPage number of the results to fetch

per_pagenumberoptionalThe number of results per page (max 100)

sincestringoptionalOnly show results updated after this time (ISO 8601 format)

sortstringoptionalWhat to sort results by

statestringoptionalIndicates the state of the issues to return

githubpat_org_member_remove#Remove a member from an organization. Removing them will also remove them from all teams and revoke access to organization repositories.2 params▾

Remove a member from an organization. Removing them will also remove them from all teams and revoke access to organization repositories.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

usernamestringrequiredThe handle for the GitHub user account

githubpat_org_members_list#List all users who are members of an organization. If the authenticated user is also a member, both concealed and public members are returned.5 params▾

List all users who are members of an organization. If the authenticated user is also a member, both concealed and public members are returned.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

filterstringoptionalFilter members returned in the list. 2fa_disabled means only members without two-factor authentication enabled will be returned (organization owners only).

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

rolestringoptionalFilter members returned by their role

githubpat_org_membership_get#Get a user's membership with an organization. The authenticated user must be an organization member. The response's 'state' field identifies the user's membership status.2 params▾

Get a user's membership with an organization. The authenticated user must be an organization member. The response's 'state' field identifies the user's membership status.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

usernamestringrequiredThe handle for the GitHub user account

githubpat_org_membership_set#Add or update a user's membership in an organization, optionally inviting them if they are not already a member.3 params▾

Add or update a user's membership in an organization, optionally inviting them if they are not already a member.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

usernamestringrequiredThe handle for the GitHub user account

rolestringoptionalThe role to give the user in the organization

githubpat_org_update#Update the profile and settings of an organization. Requires admin access.11 params▾

Update the profile and settings of an organization. Requires admin access.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

billing_emailstringoptionalBilling email address; not publicized

companystringoptionalThe company name

default_repository_permissionstringoptionalDefault permission level members have for organization repositories

descriptionstringoptionalThe description of the company. Maximum 160 characters

emailstringoptionalThe publicly visible email address

has_organization_projectsbooleanoptionalWhether an organization can use organization projects

has_repository_projectsbooleanoptionalWhether repositories that belong to the organization can use repository projects

locationstringoptionalThe location

members_can_create_repositoriesbooleanoptionalWhether non-admin organization members can create repositories

namestringoptionalThe shorthand name of the company

githubpat_public_repos_list#List public repositories for a specified user. Does not require authentication.6 params▾

List public repositories for a specified user. Does not require authentication.

NameTypeRequiredDescription

usernamestringrequiredThe GitHub username to list repositories for

directionstringoptionalSort order

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

sortstringoptionalProperty to sort repositories by

typestringoptionalFilter repositories by type

githubpat_pull_request_branch_update#Update a pull request branch with the latest upstream changes by merging the base branch into the head branch, asynchronously.4 params▾

Update a pull request branch with the latest upstream changes by merging the base branch into the head branch, asynchronously.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

expected_head_shastringoptionalThe expected SHA of the pull request's HEAD ref. Default: the SHA of the pull request's current HEAD ref

githubpat_pull_request_comment_create#Create a review comment on the diff of a specified pull request at a specific line. Use line and side (and optionally start_line/start_side for multi-line comments); the position parameter is deprecated in favor of line.11 params▾

Create a review comment on the diff of a specified pull request at a specific line. Use line and side (and optionally start_line/start_side for multi-line comments); the position parameter is deprecated in favor of line.

NameTypeRequiredDescription

bodystringrequiredThe text of the review comment

commit_idstringrequiredThe SHA of the commit needing a comment. Not using the latest commit SHA may render the comment outdated if a later commit modifies the specified line

ownerstringrequiredThe account owner of the repository

pathstringrequiredThe relative path to the file that necessitates a comment

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

linenumberoptionalThe line of the blob in the pull request diff that the comment applies to. Required unless using subject_type:file. For a multi-line comment, the last line of the range

positionnumberoptionalDeprecated. The position in the diff where you want to add a review comment, counted from the first @@ hunk header. Use line instead

sidestringoptionalIn a split diff view, the side of the diff the changes appear on. LEFT for deletions, RIGHT for additions or unchanged context lines

start_linenumberoptionalRequired when using multi-line comments unless using in_reply_to. The first line in the pull request diff that the multi-line comment applies to

start_sidestringoptionalRequired when using multi-line comments unless using in_reply_to. The starting side of the diff the comment applies to

githubpat_pull_request_commits_list#List the commits on a pull request. Results may not include all commits on very large pull requests.5 params▾

List the commits on a pull request. Results may not include all commits on very large pull requests.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

pagenumberoptionalPage number of the results to fetch

per_pagenumberoptionalThe number of results per page (max 100)

githubpat_pull_request_create#Create a new pull request in a repository. Requires write access to the head branch.8 params▾

Create a new pull request in a repository. Requires write access to the head branch.

NameTypeRequiredDescription

basestringrequiredThe name of the branch you want the changes pulled into

headstringrequiredThe name of the branch where your changes are implemented (format: user:branch)

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

bodystringoptionalThe contents of the pull request description

draftbooleanoptionalIndicates whether the pull request is a draft

maintainer_can_modifybooleanoptionalIndicates whether maintainers can modify the pull request

titlestringoptionalThe title of the pull request

githubpat_pull_request_files_list#List the files changed in a specified pull request. Responses include a maximum of 3000 files, paginated at 30 files per page by default.5 params▾

List the files changed in a specified pull request. Responses include a maximum of 3000 files, paginated at 30 files per page by default.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

githubpat_pull_request_get#Get details of a pull request by its number, including mergeable status, commits, and metadata.3 params▾

Get details of a pull request by its number, including mergeable status, commits, and metadata.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

githubpat_pull_request_merge#Merge a pull request into its base branch using the merge, squash, or rebase method.7 params▾

Merge a pull request into its base branch using the merge, squash, or rebase method.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

commit_messagestringoptionalExtra detail to append to automatic merge commit message

commit_titlestringoptionalTitle for the automatic merge commit message

merge_methodstringoptionalThe merge method to use

shastringoptionalSHA that pull request head must match to allow merge

githubpat_pull_request_merge_check#Checks if a pull request has been merged into the base branch. GitHub signals this via HTTP status only: 204 means merged, 404 means the pull request has not been merged (this is a normal, non-error outcome, not a failure).3 params▾

Checks if a pull request has been merged into the base branch. GitHub signals this via HTTP status only: 204 means merged, 404 means the pull request has not been merged (this is a normal, non-error outcome, not a failure).

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

githubpat_pull_request_requested_reviewers_list#Get the users and teams whose review has been requested but not yet given for a pull request.3 params▾

Get the users and teams whose review has been requested but not yet given for a pull request.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

githubpat_pull_request_review_comment_delete#Delete a pull request review comment.3 params▾

Delete a pull request review comment.

NameTypeRequiredDescription

comment_idnumberrequiredThe unique identifier of the comment

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_pull_request_review_comment_get#Get a single review comment on a pull request by its ID.3 params▾

Get a single review comment on a pull request by its ID.

NameTypeRequiredDescription

comment_idnumberrequiredThe unique identifier of the comment

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_pull_request_review_comment_update#Update the text of a pull request review comment.4 params▾

Update the text of a pull request review comment.

NameTypeRequiredDescription

bodystringrequiredThe text of the reply to the review comment

comment_idnumberrequiredThe unique identifier of the comment

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_pull_request_review_comments_list#List review comments left on a pull request's diff.8 params▾

List review comments left on a pull request's diff.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

directionstringoptionalThe direction to sort results by

pagenumberoptionalPage number of the results to fetch

per_pagenumberoptionalThe number of results per page (max 100)

sincestringoptionalOnly show results updated after this time (ISO 8601 format)

sortstringoptionalThe property to sort results by

githubpat_pull_request_review_create#Create a review on a pull request. Leave event blank to create a PENDING review that must later be submitted, or set event to APPROVE, REQUEST_CHANGES, or COMMENT to submit it immediately.7 params▾

Create a review on a pull request. Leave event blank to create a PENDING review that must later be submitted, or set event to APPROVE, REQUEST_CHANGES, or COMMENT to submit it immediately.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

bodystringoptionalThe body text of the review. Required when event is REQUEST_CHANGES or COMMENT

commentsarrayoptionalDraft review comments specifying the location, destination, and contents of inline comments. Each item needs path and body, plus line/position to locate the diff line

commit_idstringoptionalThe SHA of the commit that needs a review. Defaults to the most recent commit in the pull request when not specified

eventstringoptionalThe review action to perform. Leave blank to create a PENDING review

githubpat_pull_request_review_delete#Delete a pull request review that is still pending (has not been submitted).4 params▾

Delete a pull request review that is still pending (has not been submitted).

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

review_idnumberrequiredThe unique identifier of the review

githubpat_pull_request_review_dismiss#Dismiss a review on a pull request. Dismissed reviews no longer count toward required review approvals.6 params▾

Dismiss a review on a pull request. Dismissed reviews no longer count toward required review approvals.

NameTypeRequiredDescription

messagestringrequiredThe message for the pull request review dismissal

ownerstringrequiredThe account owner of the repository

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

review_idnumberrequiredThe unique identifier of the review

eventstringoptionalThe dismissal event

githubpat_pull_request_review_get#Get a single review left on a pull request by its ID.4 params▾

Get a single review left on a pull request by its ID.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

review_idnumberrequiredThe unique identifier of the review

githubpat_pull_request_review_submit#Submit a pending review for a pull request that was previously created without an event (PENDING state).6 params▾

Submit a pending review for a pull request that was previously created without an event (PENDING state).

NameTypeRequiredDescription

eventstringrequiredThe review action to perform. Leaving this blank returns HTTP 422 since a submitted review requires an action

ownerstringrequiredThe account owner of the repository

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

review_idnumberrequiredThe unique identifier of the pending review to submit

bodystringoptionalThe body text of the pull request review

githubpat_pull_request_review_update#Update the body text of an existing pull request review.5 params▾

Update the body text of an existing pull request review.

NameTypeRequiredDescription

bodystringrequiredThe body text of the pull request review

ownerstringrequiredThe account owner of the repository

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

review_idnumberrequiredThe unique identifier of the review

githubpat_pull_request_reviewers_remove#Remove requested reviewers, users and/or teams, from a pull request.5 params▾

Remove requested reviewers, users and/or teams, from a pull request.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

reviewersarrayrequiredAn array of user logins whose review requests will be removed

team_reviewersarrayoptionalAn array of team slugs whose review requests will be removed

githubpat_pull_request_reviewers_request#Request reviews for a pull request from a given set of users and/or teams. Triggers notifications to the requested reviewers.5 params▾

Request reviews for a pull request from a given set of users and/or teams. Triggers notifications to the requested reviewers.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

reviewersarrayoptionalAn array of user logins that will be requested to review

team_reviewersarrayoptionalAn array of team slugs that will be requested to review

githubpat_pull_request_reviews_list#List all reviews for a specified pull request, returned in chronological order.5 params▾

List all reviews for a specified pull request, returned in chronological order.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

githubpat_pull_request_update#Update a pull request's title, body, state, or base branch. Requires write access to the head or source branch.7 params▾

Update a pull request's title, body, state, or base branch. Requires write access to the head or source branch.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

pull_numbernumberrequiredThe number that identifies the pull request

repostringrequiredThe name of the repository

basestringoptionalThe name of the branch you want your changes pulled into. Must be an existing branch on the current repository

bodystringoptionalThe contents of the pull request

statestringoptionalState of this pull request. Either open or closed

titlestringoptionalThe title of the pull request

githubpat_pull_requests_list#List pull requests in a repository with optional filtering by state, head, and base branches.9 params▾

List pull requests in a repository with optional filtering by state, head, and base branches.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

basestringoptionalFilter by base branch name

directionstringoptionalSort order

headstringoptionalFilter by head branch (format: user:ref-name)

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

sortstringoptionalProperty to sort pull requests by

statestringoptionalFilter by pull request state

githubpat_readme_get#Get the preferred README for a repository.3 params▾

Get the preferred README for a repository.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

refstringoptionalThe name of the commit/branch/tag. Default: the repository's default branch

githubpat_release_asset_delete#Delete a release asset from a repository. This permanently removes the uploaded binary file from the release.3 params▾

Delete a release asset from a repository. This permanently removes the uploaded binary file from the release.

NameTypeRequiredDescription

asset_idnumberrequiredThe unique identifier of the release asset

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_release_asset_get#Get a single release asset's metadata by its ID.3 params▾

Get a single release asset's metadata by its ID.

NameTypeRequiredDescription

asset_idnumberrequiredThe unique identifier of the release asset

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_release_assets_list#List the assets (binary files) attached to a release in a repository.5 params▾

List the assets (binary files) attached to a release in a repository.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

release_idnumberrequiredThe unique identifier of the release

repostringrequiredThe name of the repository

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

githubpat_release_create#Create a new release in a repository. Requires push access to the repository.9 params▾

Create a new release in a repository. Requires push access to the repository.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

tag_namestringrequiredThe name of the tag

bodystringoptionalText describing the contents of the tag

draftbooleanoptionaltrue to create a draft (unpublished) release, false to create a published one

generate_release_notesbooleanoptionalWhether to automatically generate the name and body for this release. If name is specified, it will be used; otherwise a name is auto-generated. If body is specified, it is pre-pended to the automatically generated notes

namestringoptionalThe name of the release

prereleasebooleanoptionaltrue to identify the release as a prerelease, false to identify the release as a full release

target_commitishstringoptionalSpecifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch

githubpat_release_delete#Delete a release. Requires push access to the repository. This action cannot be undone.3 params▾

Delete a release. Requires push access to the repository. This action cannot be undone.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

release_idnumberrequiredThe unique identifier of the release

repostringrequiredThe name of the repository

githubpat_release_get#Get a public release with the specified release ID.3 params▾

Get a public release with the specified release ID.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

release_idnumberrequiredThe unique identifier of the release

repostringrequiredThe name of the repository

githubpat_release_get_by_tag#Get a published release with the specified tag.3 params▾

Get a published release with the specified tag.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

tagstringrequiredThe name of the tag

githubpat_release_get_latest#View the latest published full release for the repository. The latest release is the most recent non-prerelease, non-draft release, sorted by created_at.2 params▾

View the latest published full release for the repository. The latest release is the most recent non-prerelease, non-draft release, sorted by created_at.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_release_update#Update an existing release. Requires push access to the repository. All fields except owner, repo, and release_id are optional.10 params▾

Update an existing release. Requires push access to the repository. All fields except owner, repo, and release_id are optional.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

release_idnumberrequiredThe unique identifier of the release

repostringrequiredThe name of the repository

bodystringoptionalText describing the contents of the tag

draftbooleanoptionaltrue makes the release a draft, and false publishes the release

generate_release_notesbooleanoptionalWhether to automatically generate the name and body for this release. If name is specified, it will be used; otherwise a name is auto-generated. If body is specified, it is pre-pended to the automatically generated notes

namestringoptionalThe name of the release

prereleasebooleanoptionaltrue to identify the release as a prerelease, false to identify the release as a full release

tag_namestringoptionalThe name of the tag

target_commitishstringoptionalSpecifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch

githubpat_releases_list#List releases for a repository. Does not include Git tags that have not been associated with a release.4 params▾

List releases for a repository. Does not include Git tags that have not been associated with a release.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

githubpat_repo_contributors_list#List contributors to a repository, sorted by number of commits, and including anonymous contributors when requested.5 params▾

List contributors to a repository, sorted by number of commits, and including anonymous contributors when requested.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

anonstringoptionalSet to '1' or 'true' to include anonymous contributors in the results

pagenumberoptionalPage number of the results to fetch

per_pagenumberoptionalThe number of results per page (max 100)

githubpat_repo_create_for_user#Create a new repository for the authenticated user.11 params▾

Create a new repository for the authenticated user.

NameTypeRequiredDescription

namestringrequiredThe name of the repository

auto_initbooleanoptionalWhether the repository is initialized with a minimal README

descriptionstringoptionalA short description of the repository

gitignore_templatestringoptionalThe desired language or platform to apply to the .gitignore

has_issuesbooleanoptionalWhether issues are enabled

has_projectsbooleanoptionalWhether projects are enabled

has_wikibooleanoptionalWhether the wiki is enabled

homepagestringoptionalA URL with more information about the repository

is_templatebooleanoptionalWhether this repository acts as a template that can be used to generate new repositories

license_templatestringoptionalThe license keyword of the open source license for this repository

privatebooleanoptionalWhether the repository is private

githubpat_repo_create_from_template#Create a new repository using a repository template. The authenticated user must own or be a member of an organization that owns the template.7 params▾

Create a new repository using a repository template. The authenticated user must own or be a member of an organization that owns the template.

NameTypeRequiredDescription

namestringrequiredThe name of the new repository

template_ownerstringrequiredThe account owner of the template repository

template_repostringrequiredThe name of the template repository

descriptionstringoptionalA short description of the new repository

include_all_branchesbooleanoptionalSet to true to include the directory structure and files from all branches in the template, not just the default branch

ownerstringoptionalThe organization or person who will own the new repository

privatebooleanoptionalEither true to create a new private repository or false to create a new public one

githubpat_repo_create_in_org#Create a new repository in the specified organization. The authenticated user must be a member of the organization.12 params▾

Create a new repository in the specified organization. The authenticated user must be a member of the organization.

NameTypeRequiredDescription

namestringrequiredThe name of the repository

orgstringrequiredThe organization name

auto_initbooleanoptionalPass true to create an initial commit with empty README

descriptionstringoptionalA short description of the repository

gitignore_templatestringoptionalDesired language or platform .gitignore template to apply

has_issuesbooleanoptionalEither true to enable issues for this repository or false to disable them

has_projectsbooleanoptionalEither true to enable projects for this repository or false to disable them

has_wikibooleanoptionalEither true to enable the wiki for this repository or false to disable it

homepagestringoptionalA URL with more information about the repository

is_templatebooleanoptionalEither true to make this repo available as a template repository or false to prevent it

license_templatestringoptionalLicense keyword such as mit or mpl-2.0

privatebooleanoptionalWhether the repository is private

githubpat_repo_delete#Delete a repository. Deleting a repository requires admin access. This action is irreversible.2 params▾

Delete a repository. Deleting a repository requires admin access. This action is irreversible.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_repo_dispatch_event_create#Trigger a repository_dispatch webhook event that workflows listening for the repository_dispatch event can use to run a workflow.4 params▾

Trigger a repository_dispatch webhook event that workflows listening for the repository_dispatch event can use to run a workflow.

NameTypeRequiredDescription

event_typestringrequiredA custom webhook event name. Must be 100 characters or fewer

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

client_payloadobjectoptionalJSON payload with extra information about the event. Maximum 10 top-level properties and 64KB total size

githubpat_repo_fork_create#Create a fork of a repository for the authenticated user. Forking happens asynchronously; git objects may not be immediately accessible.5 params▾

Create a fork of a repository for the authenticated user. Forking happens asynchronously; git objects may not be immediately accessible.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

default_branch_onlybooleanoptionalWhen forking from an existing repository, fork with only the default branch

namestringoptionalWhen forking from an existing repository, a new name for the fork

organizationstringoptionalOptional parameter to specify the organization name if forking into an organization

githubpat_repo_forks_list#List forks of a repository.5 params▾

List forks of a repository.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of the results to fetch

per_pagenumberoptionalThe number of results per page (max 100)

sortstringoptionalThe sort order for the results

githubpat_repo_get#Get detailed information about a GitHub repository including metadata, settings, and statistics.2 params▾

Get detailed information about a GitHub repository including metadata, settings, and statistics.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository (case-insensitive)

repostringrequiredThe name of the repository without the .git extension (case-insensitive)

githubpat_repo_invitation_delete#Delete a repository invitation, revoking the invite before it is accepted.3 params▾

Delete a repository invitation, revoking the invite before it is accepted.

NameTypeRequiredDescription

invitation_idnumberrequiredThe unique identifier of the repository invitation

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_repo_invitation_update#Update an existing repository invitation, changing the permission level the invitee will receive when they accept.4 params▾

Update an existing repository invitation, changing the permission level the invitee will receive when they accept.

NameTypeRequiredDescription

invitation_idnumberrequiredThe unique identifier of the repository invitation

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

permissionsstringoptionalThe permissions that the associated user will have on the repository

githubpat_repo_invitations_list#List all currently open repository invitations.4 params▾

List all currently open repository invitations.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of the results to fetch

per_pagenumberoptionalThe number of results per page (max 100)

githubpat_repo_languages_list#List the programming languages used in a repository, with the number of bytes of code written in each language.2 params▾

List the programming languages used in a repository, with the number of bytes of code written in each language.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_repo_license_get#Get the contents of the repository's license file, if one is detected.3 params▾

Get the contents of the repository's license file, if one is detected.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

refstringoptionalThe name of the commit/branch/tag. Default: the repository's default branch

githubpat_repo_org_repos_list#List repositories for the specified organization.6 params▾

List repositories for the specified organization.

NameTypeRequiredDescription

orgstringrequiredThe organization name

directionstringoptionalThe order to sort by. Default: asc when using full_name, otherwise desc

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

sortstringoptionalThe property to sort the results by

typestringoptionalSpecifies the types of repositories you want returned

githubpat_repo_secret_delete#Delete an Actions secret from a repository.3 params▾

Delete an Actions secret from a repository.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

secret_namestringrequiredThe name of the secret

githubpat_repo_secret_get#Get metadata about a single Actions secret on a repository. The value is never returned by the GitHub API.3 params▾

Get metadata about a single Actions secret on a repository. The value is never returned by the GitHub API.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

secret_namestringrequiredThe name of the secret

githubpat_repo_secrets_list#List the names of Actions secrets configured on a repository. Secret values are never returned by the GitHub API.4 params▾

List the names of Actions secrets configured on a repository. Secret values are never returned by the GitHub API.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of the results to fetch

per_pagenumberoptionalThe number of results per page (max 100)

githubpat_repo_star#Star a repository for the authenticated user.2 params▾

Star a repository for the authenticated user.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_repo_subscription_set#Watch or unwatch a repository. Set 'subscribed' to true to watch the repository, or 'ignored' to true to stop notifications from it.4 params▾

Watch or unwatch a repository. Set 'subscribed' to true to watch the repository, or 'ignored' to true to stop notifications from it.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

ignoredbooleanoptionalDetermines if all notifications should be blocked from this repository

subscribedbooleanoptionalDetermines if notifications should be received from this repository

githubpat_repo_topics_get#Get all topics associated with a repository.4 params▾

Get all topics associated with a repository.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of the results to fetch

per_pagenumberoptionalThe number of results per page (max 100)

githubpat_repo_topics_replace#Replace all topics for a repository. Send an empty array to clear all topics. Topic names are saved as lowercase.3 params▾

Replace all topics for a repository. Send an empty array to clear all topics. Topic names are saved as lowercase.

NameTypeRequiredDescription

namesarrayrequiredAn array of topics to add to the repository, replacing the existing set of topics

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_repo_transfer#Transfer a repository owned by an organization or personal account to a new owner. Requires admin access, and the new owner must accept the transfer if it is not owned by an org you also own.5 params▾

Transfer a repository owned by an organization or personal account to a new owner. Requires admin access, and the new owner must accept the transfer if it is not owned by an org you also own.

NameTypeRequiredDescription

new_ownerstringrequiredThe username or organization name the repository will be transferred to

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

new_namestringoptionalThe new name to be given to the repository

team_idsarrayoptionalID of the team or teams to add to the repository (organization-owned repositories only)

githubpat_repo_unstar#Unstar a repository that the authenticated user has previously starred.2 params▾

Unstar a repository that the authenticated user has previously starred.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_repo_update#Update a repository's settings such as name, description, visibility, default branch, and issue/wiki features.17 params▾

Update a repository's settings such as name, description, visibility, default branch, and issue/wiki features.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

allow_auto_mergebooleanoptionalEither true to allow auto-merge on pull requests, or false to disallow auto-merge

allow_forkingbooleanoptionalEither true to allow private forks, or false to prevent private forks

allow_merge_commitbooleanoptionalEither true to allow merging pull requests with a merge commit, or false to prevent it

allow_rebase_mergebooleanoptionalEither true to allow rebase-merging pull requests, or false to prevent it

allow_squash_mergebooleanoptionalEither true to allow squash-merging pull requests, or false to prevent squash-merging

archivedbooleanoptionalWhether to archive this repository. false will unarchive a previously archived repository

default_branchstringoptionalUpdates the default branch for this repository

delete_branch_on_mergebooleanoptionalEither true to allow automatically deleting head branches when pull requests are merged, or false to prevent it

descriptionstringoptionalA short description of the repository

has_issuesbooleanoptionalEither true to enable issues for this repository or false to disable them

has_projectsbooleanoptionalEither true to enable projects for this repository or false to disable them

has_wikibooleanoptionalEither true to enable the wiki for this repository or false to disable it

homepagestringoptionalA URL with more information about the repository

namestringoptionalThe name of the repository

privatebooleanoptionalEither true to make the repository private or false to make it public

githubpat_repo_variable_create#Create a new Actions variable on a repository, for use in GitHub Actions workflows.4 params▾

Create a new Actions variable on a repository, for use in GitHub Actions workflows.

NameTypeRequiredDescription

namestringrequiredThe name of the variable

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

valuestringrequiredThe value of the variable

githubpat_repo_variable_delete#Delete an Actions variable from a repository.3 params▾

Delete an Actions variable from a repository.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

variable_namestringrequiredThe name of the variable

githubpat_repo_variable_get#Get a single Actions variable's name and value from a repository.3 params▾

Get a single Actions variable's name and value from a repository.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

variable_namestringrequiredThe name of the variable

githubpat_repo_variable_update#Update the name or value of an existing Actions variable on a repository.5 params▾

Update the name or value of an existing Actions variable on a repository.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

variable_namestringrequiredThe name of the variable

namestringoptionalThe name of the variable

valuestringoptionalThe value of the variable

githubpat_repo_variables_list#List the Actions variables configured on a repository, including their values.4 params▾

List the Actions variables configured on a repository, including their values.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of the results to fetch

per_pagenumberoptionalThe number of results per page (max 100)

githubpat_search_code#Search for code across GitHub using search qualifiers (e.g. 'addClass in:file language:js repo:jquery/jquery'). Returns up to 100 results per page. Requires authentication and is limited to 10 requests per minute.5 params▾

Search for code across GitHub using search qualifiers (e.g. 'addClass in:file language:js repo:jquery/jquery'). Returns up to 100 results per page. Requires authentication and is limited to 10 requests per minute.

NameTypeRequiredDescription

qstringrequiredSearch query with optional qualifiers (e.g. 'addClass in:file language:js repo:jquery/jquery')

orderstringoptionalSort order

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

sortstringoptionalSort results by indexed (how recently the file was indexed)

githubpat_search_commits#Search for commits across all of GitHub, or scoped with search qualifiers.5 params▾

Search for commits across all of GitHub, or scoped with search qualifiers.

NameTypeRequiredDescription

qstringrequiredThe search query, using GitHub search syntax

orderstringoptionalDetermines whether the first search result returned is the highest or lowest number of matches

pagenumberoptionalPage number of the results to fetch

per_pagenumberoptionalThe number of results per page (max 100)

sortstringoptionalSorts the results by author-date or committer-date. Default: best match

githubpat_search_issues#Search for issues and pull requests across GitHub by state and keyword (e.g. 'windows label:bug language:python state:open'). Returns up to 100 results per page, sortable by comments, reactions, interactions, created, or updated.5 params▾

Search for issues and pull requests across GitHub by state and keyword (e.g. 'windows label:bug language:python state:open'). Returns up to 100 results per page, sortable by comments, reactions, interactions, created, or updated.

NameTypeRequiredDescription

qstringrequiredSearch query with optional qualifiers (e.g. 'windows label:bug language:python state:open')

orderstringoptionalSort order

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

sortstringoptionalSort results by comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, interactions, created, or updated

githubpat_search_repos#Search for repositories via GitHub's search qualifiers (e.g. 'tetris language:assembly'). Returns up to 100 results per page, sortable by stars, forks, help-wanted-issues, or updated.5 params▾

Search for repositories via GitHub's search qualifiers (e.g. 'tetris language:assembly'). Returns up to 100 results per page, sortable by stars, forks, help-wanted-issues, or updated.

NameTypeRequiredDescription

qstringrequiredSearch query with optional qualifiers (e.g. 'tetris language:assembly')

orderstringoptionalSort order

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

sortstringoptionalSort results by stars, forks, help-wanted-issues, or updated

githubpat_search_topics#Search for topics defined on GitHub.3 params▾

Search for topics defined on GitHub.

NameTypeRequiredDescription

qstringrequiredThe search query, using GitHub search syntax

pagenumberoptionalPage number of the results to fetch

per_pagenumberoptionalThe number of results per page (max 100)

githubpat_search_users#Search for users across GitHub via search qualifiers (e.g. 'tom repos:>42 followers:>1000'). Returns up to 100 results per page, sortable by followers, repositories, or joined date.5 params▾

Search for users across GitHub via search qualifiers (e.g. 'tom repos:>42 followers:>1000'). Returns up to 100 results per page, sortable by followers, repositories, or joined date.

NameTypeRequiredDescription

qstringrequiredSearch query with optional qualifiers (e.g. 'tom repos:>42 followers:>1000')

orderstringoptionalSort order

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

sortstringoptionalSort results by followers, repositories, or joined date

githubpat_secret_scanning_alerts_list#List secret scanning alerts for a repository. To use this endpoint, you must have read access to the repository, and your token needs the repo scope (or security_events for public repositories).18 params▾

List secret scanning alerts for a repository. To use this endpoint, you must have read access to the repository, and your token needs the repo scope (or security_events for public repositories).

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

afterstringoptionalA cursor, as given in the Link response header. Only search for results after this cursor.

assigneestringoptionalFilter by assignee username, '*' for any assignee, or 'none' for unassigned

beforestringoptionalA cursor, as given in the Link response header. Only search for results before this cursor.

directionstringoptionalThe direction to sort the results by

exclude_providersstringoptionalComma-separated list of provider slugs to exclude. Cannot be combined with providers.

exclude_secret_typesstringoptionalComma-separated list of secret types to exclude. Cannot be combined with secret_type.

is_multi_repobooleanoptionalFilter alerts by whether the multi-repo tag is present

is_publicly_leakedbooleanoptionalFilter alerts by whether the publicly-leaked tag is present

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

providersstringoptionalComma-separated list of provider slugs to filter by. Cannot be combined with exclude_providers.

resolutionstringoptionalComma-separated list of resolutions to filter by

secret_typestringoptionalComma-separated list of secret types to return. All default secret patterns are returned when omitted.

sortstringoptionalThe property by which to sort the results

statestringoptionalSet to filter alerts by state

validitystringoptionalComma-separated list of validities to filter by

githubpat_stargazers_list#Lists the people that have starred the repository.4 params▾

Lists the people that have starred the repository.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

githubpat_starred_repos_list#List repositories the authenticated user has starred.4 params▾

List repositories the authenticated user has starred.

NameTypeRequiredDescription

directionstringoptionalDirection to sort results

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

sortstringoptionalThe property to sort the results by. 'created' means when the repository was starred. 'updated' means when the repository was last pushed to.

githubpat_sub_issue_add#Add an existing issue as a sub-issue of a parent issue, creating a parent/child relationship between them.5 params▾

Add an existing issue as a sub-issue of a parent issue, creating a parent/child relationship between them.

NameTypeRequiredDescription

issue_numbernumberrequiredThe number that identifies the parent issue

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

sub_issue_idnumberrequiredThe internal id (not the issue number) of the issue to add as a sub-issue. Find it in the 'id' field of the get-issue response for the issue you want to add.

replace_parentbooleanoptionalWhen true, replaces the sub-issue's current parent issue (if it already has one) with this parent

githubpat_sub_issue_remove#Remove a sub-issue from its parent issue, breaking the parent/child relationship between them. The issue itself is not deleted.4 params▾

Remove a sub-issue from its parent issue, breaking the parent/child relationship between them. The issue itself is not deleted.

NameTypeRequiredDescription

issue_numbernumberrequiredThe number that identifies the parent issue

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

sub_issue_idnumberrequiredThe internal id (not the issue number) of the sub-issue to remove from the parent

githubpat_sub_issues_list#List the sub-issues that have been added underneath a parent issue.5 params▾

List the sub-issues that have been added underneath a parent issue.

NameTypeRequiredDescription

issue_numbernumberrequiredThe number that identifies the parent issue

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

githubpat_tags_list#List repository tags.4 params▾

List repository tags.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

githubpat_team_create#Create a new team in an organization. The authenticated user must be an organization owner or a team maintainer.7 params▾

Create a new team in an organization. The authenticated user must be an organization owner or a team maintainer.

NameTypeRequiredDescription

namestringrequiredThe name of the team

orgstringrequiredThe organization name (case-insensitive)

descriptionstringoptionalThe description of the team

maintainersarrayoptionalGitHub usernames of organization members who will become team maintainers

parent_team_idnumberoptionalThe ID of a team to set as the parent team

privacystringoptionalThe level of privacy this team should have

repo_namesarrayoptionalFull name (e.g., 'org/repo') of repositories to add the team to

githubpat_team_delete#Delete a team from an organization. This does not delete the repositories the team had access to; only the team itself.2 params▾

Delete a team from an organization. This does not delete the repositories the team had access to; only the team itself.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

team_slugstringrequiredThe slug of the team name

githubpat_team_get#Get a team using the team's slug. To create the slug, GitHub replaces special characters in the name, lowercases all words, and replaces spaces with a '-' separator.2 params▾

Get a team using the team's slug. To create the slug, GitHub replaces special characters in the name, lowercases all words, and replaces spaces with a '-' separator.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

team_slugstringrequiredThe slug of the team name

githubpat_team_member_remove#Remove a user from a team. Does not remove them from the organization itself.3 params▾

Remove a user from a team. Does not remove them from the organization itself.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

team_slugstringrequiredThe slug of the team name

usernamestringrequiredThe handle for the GitHub user account

githubpat_team_members_list#List a team's members, including members of child teams. Each member includes their role on the team (member or maintainer) and whether the membership is inherited. The team must be visible to the authenticated user.5 params▾

List a team's members, including members of child teams. Each member includes their role on the team (member or maintainer) and whether the membership is inherited. The team must be visible to the authenticated user.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

team_slugstringrequiredThe slug of the team name

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

rolestringoptionalFilters members returned by their role in the team

githubpat_team_membership_get#Get a user's membership state and role (member or maintainer) on a team.3 params▾

Get a user's membership state and role (member or maintainer) on a team.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

team_slugstringrequiredThe slug of the team name

usernamestringrequiredThe handle for the GitHub user account

githubpat_team_membership_set#Add an organization member to a team, or update their role on the team. An authenticated organization owner or team maintainer can perform this action. If the user is not an organization member, this sends an email invitation and the membership stays 'pending' until accepted.4 params▾

Add an organization member to a team, or update their role on the team. An authenticated organization owner or team maintainer can perform this action. If the user is not an organization member, this sends an email invitation and the membership stays 'pending' until accepted.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

team_slugstringrequiredThe slug of the team name

usernamestringrequiredThe handle for the GitHub user account

rolestringoptionalThe role that this user should have in the team

githubpat_team_repo_add#Add a repository to a team, or update the team's permission level on a repository it already has access to.5 params▾

Add a repository to a team, or update the team's permission level on a repository it already has access to.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

team_slugstringrequiredThe slug of the team name

permissionstringoptionalThe permission to grant the team on this repository. Custom repository roles are also accepted if the organization has defined any

githubpat_team_repo_remove#Remove a repository from a team. The repository itself is not deleted, only the team's access to it.4 params▾

Remove a repository from a team. The repository itself is not deleted, only the team's access to it.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

team_slugstringrequiredThe slug of the team name

githubpat_team_repos_list#List a team's repositories visible to the authenticated user.4 params▾

List a team's repositories visible to the authenticated user.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

team_slugstringrequiredThe slug of the team name

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

githubpat_team_update#Update a team's name, description, privacy, or parent team.6 params▾

Update a team's name, description, privacy, or parent team.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

team_slugstringrequiredThe slug of the team name

descriptionstringoptionalThe description of the team

namestringoptionalThe name of the team

parent_team_idnumberoptionalThe ID of a team to set as the parent team

privacystringoptionalThe level of privacy this team should have

githubpat_teams_list#List all teams in an organization that are visible to the authenticated user.3 params▾

List all teams in an organization that are visible to the authenticated user.

NameTypeRequiredDescription

orgstringrequiredThe organization name (case-insensitive)

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

githubpat_user_get_authenticated#Get the profile information for the currently authenticated user. OAuth app tokens and personal access tokens (classic) need the 'user' scope to include private profile information.0 params▾

Get the profile information for the currently authenticated user. OAuth app tokens and personal access tokens (classic) need the 'user' scope to include private profile information.

githubpat_user_get_by_username#Get publicly available profile information about a user with a GitHub account.1 param▾

Get publicly available profile information about a user with a GitHub account.

NameTypeRequiredDescription

usernamestringrequiredThe handle for the GitHub user account

githubpat_user_issues_list#List issues assigned to the authenticated user across all visible repositories, including owned, member, and organization repositories. Use the filter parameter to fetch issues not necessarily assigned to you.8 params▾

List issues assigned to the authenticated user across all visible repositories, including owned, member, and organization repositories. Use the filter parameter to fetch issues not necessarily assigned to you.

NameTypeRequiredDescription

directionstringoptionalSort order

filterstringoptionalIndicates which sorts of issues to return. 'assigned' means issues assigned to you, 'created' means issues created by you, 'mentioned' means issues mentioning you, 'subscribed' means issues you're subscribed to updates for, 'all' or 'repos' means all issues you can see

labelsstringoptionalFilter by comma-separated list of label names

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

sincestringoptionalShow issues updated after this timestamp (ISO 8601 format)

sortstringoptionalProperty to sort issues by

statestringoptionalIndicates the state of the issues to return

githubpat_user_repos_list#List repositories for the authenticated user. Requires authentication.5 params▾

List repositories for the authenticated user. Requires authentication.

NameTypeRequiredDescription

directionstringoptionalSort order

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

sortstringoptionalProperty to sort repositories by

typestringoptionalFilter repositories by type

githubpat_webhook_create#Create a webhook on a repository. Repositories can have up to 20 webhooks.6 params▾

Create a webhook on a repository. Repositories can have up to 20 webhooks.

NameTypeRequiredDescription

configobjectrequiredKey/value pairs to provide settings for this webhook, including url, content_type, secret, and insecure_ssl

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

activebooleanoptionalDetermines if notifications are sent when the webhook is triggered

eventsarrayoptionalDetermines what events the hook is triggered for

namestringoptionalUse 'web' to create a webhook. Default: web. This parameter only accepts the value 'web'

githubpat_webhook_delete#Delete a repository webhook.3 params▾

Delete a repository webhook.

NameTypeRequiredDescription

hook_idnumberrequiredThe unique identifier of the webhook

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_webhook_get#Get a single repository webhook by its ID.3 params▾

Get a single repository webhook by its ID.

NameTypeRequiredDescription

hook_idnumberrequiredThe unique identifier of the webhook

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_webhook_ping#Trigger a ping event to test that a repository webhook is configured correctly.3 params▾

Trigger a ping event to test that a repository webhook is configured correctly.

NameTypeRequiredDescription

hook_idnumberrequiredThe unique identifier of the webhook

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

githubpat_webhook_update#Update the configuration, events, or active state of an existing repository webhook.8 params▾

Update the configuration, events, or active state of an existing repository webhook.

NameTypeRequiredDescription

hook_idnumberrequiredThe unique identifier of the webhook

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

activebooleanoptionalDetermines if notifications are sent when the webhook is triggered

add_eventsarrayoptionalA list of events to be added to the list of events that the hook triggers for

configobjectoptionalKey/value pairs to provide settings for this webhook, including url, content_type, secret, and insecure_ssl

eventsarrayoptionalDetermines what events the hook is triggered for. This replaces the entire array of events

remove_eventsarrayoptionalA list of events to be removed from the list of events that the hook triggers for

githubpat_webhooks_list#List webhooks configured on a repository.4 params▾

List webhooks configured on a repository.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of the results to fetch

per_pagenumberoptionalThe number of results per page (max 100)

githubpat_workflow_disable#Disable a workflow, preventing it from running until re-enabled.3 params▾

Disable a workflow, preventing it from running until re-enabled.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

workflow_idstringrequiredThe ID of the workflow, or the workflow file name

githubpat_workflow_dispatch#Trigger a workflow run using the workflow's ID or filename. The workflow must declare a workflow_dispatch trigger to be dispatched this way.5 params▾

Trigger a workflow run using the workflow's ID or filename. The workflow must declare a workflow_dispatch trigger to be dispatched this way.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

refstringrequiredThe git reference for the workflow. The reference can be a branch or tag name

repostringrequiredThe name of the repository

workflow_idstringrequiredThe ID of the workflow, or the workflow file name

inputsobjectoptionalInput keys and values configured in the workflow file. The maximum number of properties is 25

githubpat_workflow_enable#Enable a workflow that was previously disabled.3 params▾

Enable a workflow that was previously disabled.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

workflow_idstringrequiredThe ID of the workflow, or the workflow file name

githubpat_workflow_get#Get a single workflow by its ID or filename.3 params▾

Get a single workflow by its ID or filename.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

workflow_idstringrequiredThe ID of the workflow, or the workflow file name

githubpat_workflow_run_cancel#Cancel a workflow run using its ID. You can use this endpoint to cancel a workflow run that is either in_progress or queued.3 params▾

Cancel a workflow run using its ID. You can use this endpoint to cancel a workflow run that is either in_progress or queued.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

run_idnumberrequiredThe unique identifier of the workflow run

githubpat_workflow_run_get#Get a specific workflow run for a repository.3 params▾

Get a specific workflow run for a repository.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

run_idnumberrequiredThe unique identifier of the workflow run

githubpat_workflow_run_jobs_list#List all jobs for a workflow run, including jobs from old executions of the run if requested.6 params▾

List all jobs for a workflow run, including jobs from old executions of the run if requested.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

run_idnumberrequiredThe unique identifier of the workflow run

filterstringoptionalFilters jobs by their completed_at timestamp. latest returns jobs from the most recent execution; all returns every job including old executions

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

githubpat_workflow_run_rerun#Trigger a re-run of all the jobs in a workflow run using its ID.4 params▾

Trigger a re-run of all the jobs in a workflow run using its ID.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

run_idnumberrequiredThe unique identifier of the workflow run

enable_debug_loggingbooleanoptionalWhether to enable debug logging for the re-run

githubpat_workflow_runs_list#List all workflow runs for a repository. You can filter by actor, branch, event, and status.8 params▾

List all workflow runs for a repository. You can filter by actor, branch, event, and status.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

actorstringoptionalReturns someone's workflow runs. Use the login for the user who created the push

branchstringoptionalReturns workflow runs associated with a branch. Use the name of the branch of the push

eventstringoptionalReturns workflow runs triggered by the event you specify, e.g. push, pull_request, or issue

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)

statusstringoptionalReturns workflow runs with the check run status or conclusion that you specify

githubpat_workflows_list#List the workflows defined in a repository.4 params▾

List the workflows defined in a repository.

NameTypeRequiredDescription

ownerstringrequiredThe account owner of the repository

repostringrequiredThe name of the repository

pagenumberoptionalPage number of results to fetch

per_pagenumberoptionalNumber of results per page (max 100)