Skip to content

GitHub

Updated View as Markdown

Review pull requests, investigate issues and inspect repository activity. Bring source code and discussion into your agent's workflow.

Example workflows

Copy a prompt into your connected AI client after connecting this integration. Choose resources you can access and review the supported command before running it.

Review a pull request

Review pull request #42 in acme/website. Inspect the changed files and its review comments. Explain what changed, identify the highest-impact risks, and suggest focused verification with file references. Do not post a review or change the pull request.

Explore this command: github.pulls.list-files

Triage repository issues

Read one page of issues in acme/website. Group open issues by problem area and highlight items that need clarification. Include the original issue numbers and links. Do not assign, label or close anything.

Explore this command: github.issues.list-for-repo

Draft a release brief

Read the published releases for acme/website. Prepare a short release brief covering the latest release, its changes and source links. Distinguish release notes from your interpretation. Do not create or publish a release.

Explore this command: github.repos.list-releases

What you can do (1196)

What you can do

Available commands: 1196 (624 read, 572 write). Enable only the commands your application needs.

Command Effect
GitHub API Root — github.meta.root Read
List global security advisories — github.security-advisories.list-global-advisories Read
Get a global security advisory — github.security-advisories.get-global-advisory Read
List automations for user — github.agent-automations.list-automations Read
List automations for a repository — github.agent-automations.list-repo-automations Read
Create an automation for a repository — github.agent-automations.create-repo-automation Write
List available automation tools for a repository — github.agent-automations.list-available-repo-automation-tools Read
List available automation triggers for a repository — github.agent-automations.list-available-repo-automation-triggers Read
Get an automation — github.agent-automations.get-repo-automation Read
Update an automation — github.agent-automations.edit-repo-automation Write
Delete an automation — github.agent-automations.delete-repo-automation Write
List tasks for an automation in a repository — github.agent-automations.list-repo-automation-tasks Read
Run an automation — github.agent-automations.create-repo-automation-task Write
Get Agent Merge configuration for a pull request — github.agent-merge.get-agent-merge-enrollment Read
Update Agent Merge configuration for a pull request — github.agent-merge.put-agent-merge-enrollment Write
Disable Agent Merge for a pull request — github.agent-merge.delete-agent-merge-enrollment Write
List tasks for repository — github.agent-tasks.list-tasks-for-repo Read
Start a task — github.agent-tasks.create-task-in-repo Write
Get a task by repo — github.agent-tasks.get-task-by-repo-and-id Read
List tasks — github.agent-tasks.list-tasks Read
Get a task by ID — github.agent-tasks.get-task-by-id Read
Get the authenticated app — github.apps.get-authenticated Read
Create a GitHub App from a manifest — github.apps.create-from-manifest Write
Get a webhook configuration for an app — github.apps.get-webhook-config-for-app Read
Update a webhook configuration for an app — github.apps.update-webhook-config-for-app Write
List deliveries for an app webhook — github.apps.list-webhook-deliveries Read
Get a delivery for an app webhook — github.apps.get-webhook-delivery Read
Redeliver a delivery for an app webhook — github.apps.redeliver-webhook-delivery Write
List installation requests for the authenticated app — github.apps.list-installation-requests-for-authenticated-app Read
List installations for the authenticated app — github.apps.list-installations Read
Get an installation for the authenticated app — github.apps.get-installation Read
Delete an installation for the authenticated app — github.apps.delete-installation Write
Create an installation access token for an app — github.apps.create-installation-access-token Write
Suspend an app installation — github.apps.suspend-installation Write
Unsuspend an app installation — github.apps.unsuspend-installation Write
Delete an app authorization — github.apps.delete-authorization Write
Check a token — github.apps.check-token Write
Reset a token — github.apps.reset-token Write
Delete an app token — github.apps.delete-token Write
Create a scoped access token — github.apps.scope-token Write
Get an app — github.apps.get-by-slug Read
Get all codes of conduct — github.codes-of-conduct.get-all-codes-of-conduct Read
Get a code of conduct — github.codes-of-conduct.get-conduct-code Read
Revoke a list of credentials — github.credentials.revoke Write
Get emojis — github.emojis.get Read
Get GitHub Actions cache retention limit for an enterprise — github.actions.get-actions-cache-retention-limit-for-enterprise Read
Set GitHub Actions cache retention limit for an enterprise — github.actions.set-actions-cache-retention-limit-for-enterprise Write
Get GitHub Actions cache storage limit for an enterprise — github.actions.get-actions-cache-storage-limit-for-enterprise Read
Set GitHub Actions cache storage limit for an enterprise — github.actions.set-actions-cache-storage-limit-for-enterprise Write
List OIDC custom property inclusions for an enterprise — github.oidc.list-oidc-custom-property-inclusions-for-enterprise Read
Create an OIDC custom property inclusion for an enterprise — github.oidc.create-oidc-custom-property-inclusion-for-enterprise Write
Delete an OIDC custom property inclusion for an enterprise — github.oidc.delete-oidc-custom-property-inclusion-for-enterprise Write
Get code security configurations for an enterprise — github.code-security.get-configurations-for-enterprise Read
Create a code security configuration for an enterprise — github.code-security.create-configuration-for-enterprise Write
Get default code security configurations for an enterprise — github.code-security.get-default-configurations-for-enterprise Read
Retrieve a code security configuration of an enterprise — github.code-security.get-single-configuration-for-enterprise Read
Update a custom code security configuration for an enterprise — github.code-security.update-enterprise-configuration Write
Delete a code security configuration for an enterprise — github.code-security.delete-configuration-for-enterprise Write
Attach an enterprise configuration to repositories — github.code-security.attach-enterprise-configuration Write
Set a code security configuration as a default for an enterprise — github.code-security.set-configuration-as-default-for-enterprise Write
Get repositories associated with an enterprise code security configuration — github.code-security.get-repositories-for-enterprise-configuration Read
Get Copilot enterprise usage metrics for a specific day — github.copilot.copilot-enterprise-one-day-usage-metrics Read
Get Copilot enterprise usage metrics — github.copilot.copilot-enterprise-usage-metrics Read
Get Copilot enterprise repository report for a specific day — github.copilot.copilot-enterprise-repos-one-day-report Read
Get Copilot enterprise user-teams report for a specific day — github.copilot.copilot-enterprise-user-teams-one-day-report Read
Get Copilot users usage metrics for a specific day — github.copilot.copilot-users-one-day-usage-metrics Read
Get Copilot users usage metrics — github.copilot.copilot-users-usage-metrics Read
Set the coding agent policy for an enterprise — github.copilot.set-enterprise-coding-agent-policy Write
Add organizations to the enterprise coding agent policy — github.copilot.add-organizations-to-enterprise-coding-agent-policy Write
Remove organizations from the enterprise coding agent policy — github.copilot.remove-organizations-from-enterprise-coding-agent-policy Write
List Dependabot alerts for an enterprise — github.dependabot.list-alerts-for-enterprise Read
Lists the repositories Dependabot can access in an enterprise — github.dependabot.repository-access-for-enterprise Read
Updates Dependabot's repository access list for an enterprise — github.dependabot.update-repository-access-for-enterprise Write
Set the default repository access level for Dependabot in an enterprise — github.dependabot.set-repository-access-default-level-for-enterprise Write
List public events — github.activity.list-public-events Read
Get feeds — github.activity.get-feeds Read
List gists for the authenticated user — github.gists.list Read
Create a gist — github.gists.create Write
List public gists — github.gists.list-public Read
List starred gists — github.gists.list-starred Read
Get a gist — github.gists.get Read
Update a gist — github.gists.update Write
Delete a gist — github.gists.delete Write
List gist comments — github.gists.list-comments Read
Create a gist comment — github.gists.create-comment Write
Get a gist comment — github.gists.get-comment Read
Update a gist comment — github.gists.update-comment Write
Delete a gist comment — github.gists.delete-comment Write
List gist commits — github.gists.list-commits Read
List gist forks — github.gists.list-forks Read
Fork a gist — github.gists.fork Write
Check if a gist is starred — github.gists.check-is-starred Read
Star a gist — github.gists.star Write
Unstar a gist — github.gists.unstar Write
Get a gist revision — github.gists.get-revision Read
Get all gitignore templates — github.gitignore.get-all-templates Read
Get a gitignore template — github.gitignore.get-template Read
List repositories accessible to the app installation — github.apps.list-repos-accessible-to-installation Read
Revoke an installation access token — github.apps.revoke-installation-access-token Write
List issues assigned to the authenticated user — github.issues.list Read
Get all commonly used licenses — github.licenses.get-all-commonly-used Read
Get a license — github.licenses.get Read
Render a Markdown document — github.markdown.render Write
Get a subscription plan for an account — github.apps.get-subscription-plan-for-account Read
List plans — github.apps.list-plans Read
List accounts for a plan — github.apps.list-accounts-for-plan Read
Get a subscription plan for an account (stubbed) — github.apps.get-subscription-plan-for-account-stubbed Read
List plans (stubbed) — github.apps.list-plans-stubbed Read
List accounts for a plan (stubbed) — github.apps.list-accounts-for-plan-stubbed Read
Get GitHub meta information — github.meta.get Read
List public events for a network of repositories — github.activity.list-public-events-for-repo-network Read
List notifications for the authenticated user — github.activity.list-notifications-for-authenticated-user Read
Mark notifications as read — github.activity.mark-notifications-as-read Write
Get a thread — github.activity.get-thread Read
Mark a thread as read — github.activity.mark-thread-as-read Write
Mark a thread as done — github.activity.mark-thread-as-done Write
Get a thread subscription for the authenticated user — github.activity.get-thread-subscription-for-authenticated-user Read
Set a thread subscription — github.activity.set-thread-subscription Write
Delete a thread subscription — github.activity.delete-thread-subscription Write
Get Octocat — github.meta.get-octocat Read
List organizations — github.orgs.list Read
Get GitHub Actions cache retention limit for an organization — github.actions.get-actions-cache-retention-limit-for-organization Read
Set GitHub Actions cache retention limit for an organization — github.actions.set-actions-cache-retention-limit-for-organization Write
Get GitHub Actions cache storage limit for an organization — github.actions.get-actions-cache-storage-limit-for-organization Read
Set GitHub Actions cache storage limit for an organization — github.actions.set-actions-cache-storage-limit-for-organization Write
Get billing AI credit usage report for an organization — github.billing.get-github-billing-ai-credit-usage-report-org Read
Get all budgets for an organization — github.billing.get-all-budgets-org Read
Create a budget for an organization — github.billing.create-organization-budget Write
Get a budget by ID for an organization — github.billing.get-budget-org Read
Update a budget for an organization — github.billing.update-budget-org Write
Delete a budget for an organization — github.billing.delete-budget-org Write
Get billing premium request usage report for an organization — github.billing.get-github-billing-premium-request-usage-report-org Read
Get billing usage report for an organization — github.billing.get-github-billing-usage-report-org Read
Get billing usage summary for an organization — github.billing.get-github-billing-usage-summary-report-org Read
Get an organization — github.orgs.get Read
Update an organization — github.orgs.update Write
Delete an organization — github.orgs.delete Write
Get GitHub Actions cache usage for an organization — github.actions.get-actions-cache-usage-for-org Read
List repositories with GitHub Actions cache usage for an organization — github.actions.get-actions-cache-usage-by-repo-for-org Read
List GitHub-hosted runners for an organization — github.actions.list-hosted-runners-for-org Read
Create a GitHub-hosted runner for an organization — github.actions.create-hosted-runner-for-org Write
List custom images for an organization — github.actions.list-custom-images-for-org Read
Get a custom image definition for GitHub Actions Hosted Runners — github.actions.get-custom-image-for-org Read
Delete a custom image from the organization — github.actions.delete-custom-image-from-org Write
List image versions of a custom image for an organization — github.actions.list-custom-image-versions-for-org Read
Get GitHub-owned images for GitHub-hosted runners in an organization — github.actions.get-hosted-runners-github-owned-images-for-org Read
Get partner images for GitHub-hosted runners in an organization — github.actions.get-hosted-runners-partner-images-for-org Read
Get limits on GitHub-hosted runners for an organization — github.actions.get-hosted-runners-limits-for-org Read
Get GitHub-hosted runners machine specs for an organization — github.actions.get-hosted-runners-machine-specs-for-org Read
Get platforms for GitHub-hosted runners in an organization — github.actions.get-hosted-runners-platforms-for-org Read
Get a GitHub-hosted runner for an organization — github.actions.get-hosted-runner-for-org Read
Update a GitHub-hosted runner for an organization — github.actions.update-hosted-runner-for-org Write
Delete a GitHub-hosted runner for an organization — github.actions.delete-hosted-runner-for-org Write
List OIDC custom property inclusions for an organization — github.oidc.list-oidc-custom-property-inclusions-for-org Read
Create an OIDC custom property inclusion for an organization — github.oidc.create-oidc-custom-property-inclusion-for-org Write
Delete an OIDC custom property inclusion for an organization — github.oidc.delete-oidc-custom-property-inclusion-for-org Write
Get the customization template for an OIDC subject claim for an organization — github.oidc.get-oidc-custom-sub-template-for-org Read
Set the customization template for an OIDC subject claim for an organization — github.oidc.update-oidc-custom-sub-template-for-org Write
Get GitHub Actions permissions for an organization — github.actions.get-github-actions-permissions-organization Read
Set GitHub Actions permissions for an organization — github.actions.set-github-actions-permissions-organization Write
Get artifact and log retention settings for an organization — github.actions.get-artifact-and-log-retention-settings-organization Read
Set artifact and log retention settings for an organization — github.actions.set-artifact-and-log-retention-settings-organization Write
Get fork PR contributor approval permissions for an organization — github.actions.get-fork-pr-contributor-approval-permissions-organization Read
Set fork PR contributor approval permissions for an organization — github.actions.set-fork-pr-contributor-approval-permissions-organization Write
Get private repo fork PR workflow settings for an organization — github.actions.get-private-repo-fork-pr-workflows-settings-organization Read
Set private repo fork PR workflow settings for an organization — github.actions.set-private-repo-fork-pr-workflows-settings-organization Write
List selected repositories enabled for GitHub Actions in an organization — github.actions.list-selected-repositories-enabled-github-actions-organization Read
Set selected repositories enabled for GitHub Actions in an organization — github.actions.set-selected-repositories-enabled-github-actions-organization Write
Enable a selected repository for GitHub Actions in an organization — github.actions.enable-selected-repository-github-actions-organization Write
Disable a selected repository for GitHub Actions in an organization — github.actions.disable-selected-repository-github-actions-organization Write
Get allowed actions and reusable workflows for an organization — github.actions.get-allowed-actions-organization Read
Set allowed actions and reusable workflows for an organization — github.actions.set-allowed-actions-organization Write
Get self-hosted runners settings for an organization — github.actions.get-self-hosted-runners-permissions-organization Read
Set self-hosted runners settings for an organization — github.actions.set-self-hosted-runners-permissions-organization Write
List repositories allowed to use self-hosted runners in an organization — github.actions.list-selected-repositories-self-hosted-runners-organization Read
Set repositories allowed to use self-hosted runners in an organization — github.actions.set-selected-repositories-self-hosted-runners-organization Write
Add a repository to the list of repositories allowed to use self-hosted runners in an organization — github.actions.enable-selected-repository-self-hosted-runners-organization Write
Remove a repository from the list of repositories allowed to use self-hosted runners in an organization — github.actions.disable-selected-repository-self-hosted-runners-organization Write
Get default workflow permissions for an organization — github.actions.get-github-actions-default-workflow-permissions-organization Read
Set default workflow permissions for an organization — github.actions.set-github-actions-default-workflow-permissions-organization Write
List organization Actions policies — github.actions.get-org-actions-policies Read
Create an organization Actions policy — github.actions.create-org-actions-policy Write
Get an organization Actions policy — github.actions.get-org-actions-policy Read
Update an organization Actions policy — github.actions.update-org-actions-policy Write
Delete an organization Actions policy — github.actions.delete-org-actions-policy Write
List self-hosted runner groups for an organization — github.actions.list-self-hosted-runner-groups-for-org Read
Create a self-hosted runner group for an organization — github.actions.create-self-hosted-runner-group-for-org Write
Get a self-hosted runner group for an organization — github.actions.get-self-hosted-runner-group-for-org Read
Update a self-hosted runner group for an organization — github.actions.update-self-hosted-runner-group-for-org Write
Delete a self-hosted runner group from an organization — github.actions.delete-self-hosted-runner-group-from-org Write
List GitHub-hosted runners in a group for an organization — github.actions.list-github-hosted-runners-in-group-for-org Read
List repository access to a self-hosted runner group in an organization — github.actions.list-repo-access-to-self-hosted-runner-group-in-org Read
Set repository access for a self-hosted runner group in an organization — github.actions.set-repo-access-to-self-hosted-runner-group-in-org Write
Add repository access to a self-hosted runner group in an organization — github.actions.add-repo-access-to-self-hosted-runner-group-in-org Write
Remove repository access to a self-hosted runner group in an organization — github.actions.remove-repo-access-to-self-hosted-runner-group-in-org Write
List self-hosted runners in a group for an organization — github.actions.list-self-hosted-runners-in-group-for-org Read
Set self-hosted runners in a group for an organization — github.actions.set-self-hosted-runners-in-group-for-org Write
Add a self-hosted runner to a group for an organization — github.actions.add-self-hosted-runner-to-group-for-org Write
Remove a self-hosted runner from a group for an organization — github.actions.remove-self-hosted-runner-from-group-for-org Write
List self-hosted runners for an organization — github.actions.list-self-hosted-runners-for-org Read
Get runner version end-of-life schedule for an organization — github.actions.get-runner-version-deprecation-for-org Read
List runner applications for an organization — github.actions.list-runner-applications-for-org Read
Create configuration for a just-in-time runner for an organization — github.actions.generate-runner-jitconfig-for-org Write
Create a registration token for an organization — github.actions.create-registration-token-for-org Write
Create a remove token for an organization — github.actions.create-remove-token-for-org Write
Get a self-hosted runner for an organization — github.actions.get-self-hosted-runner-for-org Read
Delete a self-hosted runner from an organization — github.actions.delete-self-hosted-runner-from-org Write
List labels for a self-hosted runner for an organization — github.actions.list-labels-for-self-hosted-runner-for-org Read
Add custom labels to a self-hosted runner for an organization — github.actions.add-custom-labels-to-self-hosted-runner-for-org Write
Set custom labels for a self-hosted runner for an organization — github.actions.set-custom-labels-for-self-hosted-runner-for-org Write
Remove all custom labels from a self-hosted runner for an organization — github.actions.remove-all-custom-labels-from-self-hosted-runner-for-org Write
Remove a custom label from a self-hosted runner for an organization — github.actions.remove-custom-label-from-self-hosted-runner-for-org Write
List organization secrets — github.actions.list-org-secrets Read
Get an organization public key — github.actions.get-org-public-key Read
Get an organization secret — github.actions.get-org-secret Read
Create or update an organization secret — github.actions.create-or-update-org-secret Write
Delete an organization secret — github.actions.delete-org-secret Write
List selected repositories for an organization secret — github.actions.list-selected-repos-for-org-secret Read
Set selected repositories for an organization secret — github.actions.set-selected-repos-for-org-secret Write
Add selected repository to an organization secret — github.actions.add-selected-repo-to-org-secret Write
Remove selected repository from an organization secret — github.actions.remove-selected-repo-from-org-secret Write
List organization variables — github.actions.list-org-variables Read
Create an organization variable — github.actions.create-org-variable Write
Get an organization variable — github.actions.get-org-variable Read
Update an organization variable — github.actions.update-org-variable Write
Delete an organization variable — github.actions.delete-org-variable Write
List selected repositories for an organization variable — github.actions.list-selected-repos-for-org-variable Read
Set selected repositories for an organization variable — github.actions.set-selected-repos-for-org-variable Write
Add selected repository to an organization variable — github.actions.add-selected-repo-to-org-variable Write
Remove selected repository from an organization variable — github.actions.remove-selected-repo-from-org-variable Write
List organization secrets — github.agents.list-org-secrets Read
Get an organization public key — github.agents.get-org-public-key Read
Get an organization secret — github.agents.get-org-secret Read
Create or update an organization secret — github.agents.create-or-update-org-secret Write
Delete an organization secret — github.agents.delete-org-secret Write
List selected repositories for an organization secret — github.agents.list-selected-repos-for-org-secret Read
Set selected repositories for an organization secret — github.agents.set-selected-repos-for-org-secret Write
Add selected repository to an organization secret — github.agents.add-selected-repo-to-org-secret Write
Remove selected repository from an organization secret — github.agents.remove-selected-repo-from-org-secret Write
List organization variables — github.agents.list-org-variables Read
Create an organization variable — github.agents.create-org-variable Write
Get an organization variable — github.agents.get-org-variable Read
Update an organization variable — github.agents.update-org-variable Write
Delete an organization variable — github.agents.delete-org-variable Write
List selected repositories for an organization variable — github.agents.list-selected-repos-for-org-variable Read
Set selected repositories for an organization variable — github.agents.set-selected-repos-for-org-variable Write
Add selected repository to an organization variable — github.agents.add-selected-repo-to-org-variable Write
Remove selected repository from an organization variable — github.agents.remove-selected-repo-from-org-variable Write
Create an artifact deployment record — github.orgs.create-artifact-deployment-record Write
Set cluster deployment records — github.orgs.set-cluster-deployment-records Write
Create a cluster deployment records job — github.orgs.create-cluster-deployment-records-job Write
Get cluster deployment records job status — github.orgs.get-cluster-deployment-records-job Read
Create artifact metadata storage record — github.orgs.create-artifact-storage-record Write
List artifact storage records — github.orgs.list-artifact-storage-records Read
List attestations by bulk subject digests — github.orgs.list-attestations-bulk Write
Delete attestations in bulk — github.orgs.delete-attestations-bulk Write
Delete attestations by subject digest — github.orgs.delete-attestations-by-subject-digest Write
List attestation repositories — github.orgs.list-attestation-repositories Read
Delete attestations by ID — github.orgs.delete-attestations-by-id Write
List attestations — github.orgs.list-attestations Read
List users blocked by an organization — github.orgs.list-blocked-users Read
Check if a user is blocked by an organization — github.orgs.check-blocked-user Read
Block a user from an organization — github.orgs.block-user Write
Unblock a user from an organization — github.orgs.unblock-user Write
List campaigns for an organization — github.campaigns.list-org-campaigns Read
Create a campaign for an organization — github.campaigns.create-campaign Write
Get a campaign for an organization — github.campaigns.get-campaign-summary Read
Update a campaign — github.campaigns.update-campaign Write
Delete a campaign for an organization — github.campaigns.delete-campaign Write
Get the AI Scan setting for an organization — github.code-scanning.get-ai-scan-enablement-for-org Read
List code scanning alerts for an organization — github.code-scanning.list-alerts-for-org Read
Get code security configurations for an organization — github.code-security.get-configurations-for-org Read
Create a code security configuration — github.code-security.create-configuration Write
Get default code security configurations — github.code-security.get-default-configurations Read
Detach configurations from repositories — github.code-security.detach-configuration Write
Get a code security configuration — github.code-security.get-configuration Read
Update a code security configuration — github.code-security.update-configuration Write
Delete a code security configuration — github.code-security.delete-configuration Write
Attach a configuration to repositories — github.code-security.attach-configuration Write
Set a code security configuration as a default for an organization — github.code-security.set-configuration-as-default Write
Get repositories associated with a code security configuration — github.code-security.get-repositories-for-configuration Read
List codespaces for the organization — github.codespaces.list-in-organization Read
List organization secrets — github.codespaces.list-org-secrets Read
Get an organization public key — github.codespaces.get-org-public-key Read
Get an organization secret — github.codespaces.get-org-secret Read
Create or update an organization secret — github.codespaces.create-or-update-org-secret Write
Delete an organization secret — github.codespaces.delete-org-secret Write
List selected repositories for an organization secret — github.codespaces.list-selected-repos-for-org-secret Read
Set selected repositories for an organization secret — github.codespaces.set-selected-repos-for-org-secret Write
Add selected repository to an organization secret — github.codespaces.add-selected-repo-to-org-secret Write
Remove selected repository from an organization secret — github.codespaces.remove-selected-repo-from-org-secret Write
List organization Copilot Spaces — github.copilot-spaces.list-for-org Read
Create an organization Copilot Space — github.copilot-spaces.create-for-org Write
Get an organization Copilot Space — github.copilot-spaces.get-for-org Read
Set an organization Copilot Space — github.copilot-spaces.update-for-org Write
Delete an organization Copilot Space — github.copilot-spaces.delete-for-org Write
List collaborators for an organization Copilot Space — github.copilot-spaces.list-collaborators-for-org Read
Add a collaborator to an organization Copilot Space — github.copilot-spaces.add-collaborator-for-org Write
Set a collaborator role for an organization Copilot Space — github.copilot-spaces.update-collaborator-for-org Write
Remove a collaborator from an organization Copilot Space — github.copilot-spaces.remove-collaborator-for-org Write
List resources for an organization Copilot Space — github.copilot-spaces.list-resources-for-org Read
Create a resource for an organization Copilot Space — github.copilot-spaces.create-resource-for-org Write
Get a resource for an organization Copilot Space — github.copilot-spaces.get-resource-for-org Read
Set a resource for an organization Copilot Space — github.copilot-spaces.update-resource-for-org Write
Delete a resource from an organization Copilot Space — github.copilot-spaces.delete-resource-for-org Write
Get Copilot seat information and settings for an organization — github.copilot.get-copilot-organization-details Read
List all Copilot seat assignments for an organization — github.copilot.list-copilot-seats Read
Add teams to the Copilot subscription for an organization — github.copilot.add-copilot-seats-for-teams Write
Remove teams from the Copilot subscription for an organization — github.copilot.cancel-copilot-seat-assignment-for-teams Write
Add users to the Copilot subscription for an organization — github.copilot.add-copilot-seats-for-users Write
Remove users from the Copilot subscription for an organization — github.copilot.cancel-copilot-seat-assignment-for-users Write
Get Copilot cloud agent permissions for an organization — github.copilot.get-copilot-coding-agent-permissions-organization Read
Set Copilot cloud agent permissions for an organization — github.copilot.set-copilot-coding-agent-permissions-organization Write
List repositories enabled for Copilot cloud agent in an organization — github.copilot.list-copilot-coding-agent-selected-repositories-for-organization Read
Set selected repositories for Copilot cloud agent in an organization — github.copilot.set-copilot-coding-agent-selected-repositories-for-organization Write
Enable a repository for Copilot cloud agent in an organization — github.copilot.enable-copilot-coding-agent-for-repository-in-organization Write
Disable a repository for Copilot cloud agent in an organization — github.copilot.disable-copilot-coding-agent-for-repository-in-organization Write
Get Copilot content exclusion rules for an organization — github.copilot.copilot-content-exclusion-for-organization Read
Set Copilot content exclusion rules for an organization — github.copilot.set-copilot-content-exclusion-for-organization Write
Get Copilot organization usage metrics for a specific day — github.copilot.copilot-organization-one-day-usage-metrics Read
Get Copilot organization usage metrics — github.copilot.copilot-organization-usage-metrics Read
Get Copilot organization repository report for a specific day — github.copilot.copilot-organization-repos-one-day-report Read
Get Copilot organization user-teams report for a specific day — github.copilot.copilot-organization-user-teams-one-day-report Read
Get Copilot organization users usage metrics for a specific day — github.copilot.copilot-organization-users-one-day-usage-metrics Read
Get Copilot organization users usage metrics — github.copilot.copilot-organization-users-usage-metrics Read
List Dependabot alerts for an organization — github.dependabot.list-alerts-for-org Read
Lists the repositories Dependabot can access in an organization — github.dependabot.repository-access-for-org Read
Updates Dependabot's repository access list for an organization — github.dependabot.update-repository-access-for-org Write
Set the default repository access level for Dependabot — github.dependabot.set-repository-access-default-level Write
List organization secrets — github.dependabot.list-org-secrets Read
Get an organization public key — github.dependabot.get-org-public-key Read
Get an organization secret — github.dependabot.get-org-secret Read
Create or update an organization secret — github.dependabot.create-or-update-org-secret Write
Delete an organization secret — github.dependabot.delete-org-secret Write
List selected repositories for an organization secret — github.dependabot.list-selected-repos-for-org-secret Read
Set selected repositories for an organization secret — github.dependabot.set-selected-repos-for-org-secret Write
Add selected repository to an organization secret — github.dependabot.add-selected-repo-to-org-secret Write
Remove selected repository from an organization secret — github.dependabot.remove-selected-repo-from-org-secret Write
Get list of conflicting packages during Docker migration for organization — github.packages.list-docker-migration-conflicting-packages-for-organization Read
List public organization events — github.activity.list-public-org-events Read
List failed organization invitations — github.orgs.list-failed-invitations Read
List organization webhooks — github.orgs.list-webhooks Read
Create an organization webhook — github.orgs.create-webhook Write
Get an organization webhook — github.orgs.get-webhook Read
Update an organization webhook — github.orgs.update-webhook Write
Delete an organization webhook — github.orgs.delete-webhook Write
Get a webhook configuration for an organization — github.orgs.get-webhook-config-for-org Read
Update a webhook configuration for an organization — github.orgs.update-webhook-config-for-org Write
List deliveries for an organization webhook — github.orgs.list-webhook-deliveries Read
Get a webhook delivery for an organization webhook — github.orgs.get-webhook-delivery Read
Redeliver a delivery for an organization webhook — github.orgs.redeliver-webhook-delivery Write
Ping an organization webhook — github.orgs.ping-webhook Write
Get route stats by actor — github.api-insights.get-route-stats-by-actor Read
Get subject stats — github.api-insights.get-subject-stats Read
Get summary stats — github.api-insights.get-summary-stats Read
Get summary stats by user — github.api-insights.get-summary-stats-by-user Read
Get summary stats by actor — github.api-insights.get-summary-stats-by-actor Read
Get time stats — github.api-insights.get-time-stats Read
Get time stats by user — github.api-insights.get-time-stats-by-user Read
Get time stats by actor — github.api-insights.get-time-stats-by-actor Read
Get user stats — github.api-insights.get-user-stats Read
Get an organization installation for the authenticated app — github.apps.get-org-installation Read
List app installations for an organization — github.orgs.list-app-installations Read
Get interaction restrictions for an organization — github.interactions.get-restrictions-for-org Read
Set interaction restrictions for an organization — github.interactions.set-restrictions-for-org Write
Remove interaction restrictions for an organization — github.interactions.remove-restrictions-for-org Write
Get pull request creation cap for an org — github.interactions.get-pull-request-creation-cap-for-org Read
Update pull request creation cap for an org — github.interactions.update-pull-request-creation-cap-for-org Write
List pending organization invitations — github.orgs.list-pending-invitations Read
Create an organization invitation — github.orgs.create-invitation Write
Cancel an organization invitation — github.orgs.cancel-invitation Write
List organization invitation teams — github.orgs.list-invitation-teams Read
List issue fields for an organization — github.orgs.list-issue-fields Read
Create issue field for an organization — github.orgs.create-issue-field Write
Update issue field for an organization — github.orgs.update-issue-field Write
Delete issue field for an organization — github.orgs.delete-issue-field Write
List issue types for an organization — github.orgs.list-issue-types Read
Create issue type for an organization — github.orgs.create-issue-type Write
Update issue type for an organization — github.orgs.update-issue-type Write
Delete issue type for an organization — github.orgs.delete-issue-type Write
List organization issues assigned to the authenticated user — github.issues.list-for-org Read
List organization members — github.orgs.list-members Read
Check organization membership for a user — github.orgs.check-membership-for-user Read
Remove an organization member — github.orgs.remove-member Write
List codespaces for a user in organization — github.codespaces.get-codespaces-for-user-in-org Read
Delete a codespace from the organization — github.codespaces.delete-from-organization Write
Stop a codespace for an organization user — github.codespaces.stop-in-organization Write
Get Copilot seat assignment details for a user — github.copilot.get-copilot-seat-details-for-user Read
Get organization membership for a user — github.orgs.get-membership-for-user Read
Set organization membership for a user — github.orgs.set-membership-for-user Write
Remove organization membership for a user — github.orgs.remove-membership-for-user Write
List organization migrations — github.migrations.list-for-org Read
Start an organization migration — github.migrations.start-for-org Write
Get an organization migration status — github.migrations.get-status-for-org Read
Delete an organization migration archive — github.migrations.delete-archive-for-org Write
Unlock an organization repository — github.migrations.unlock-repo-for-org Write
List repositories in an organization migration — github.migrations.list-repos-for-org Read
Get all organization roles for an organization — github.orgs.list-org-roles Read
Remove all organization roles for a team — github.orgs.revoke-all-org-roles-team Write
Assign an organization role to a team — github.orgs.assign-team-to-org-role Write
Remove an organization role from a team — github.orgs.revoke-org-role-team Write
Remove all organization roles for a user — github.orgs.revoke-all-org-roles-user Write
Assign an organization role to a user — github.orgs.assign-user-to-org-role Write
Remove an organization role from a user — github.orgs.revoke-org-role-user Write
Get an organization role — github.orgs.get-org-role Read
List teams that are assigned to an organization role — github.orgs.list-org-role-teams Read
List users that are assigned to an organization role — github.orgs.list-org-role-users Read
List outside collaborators for an organization — github.orgs.list-outside-collaborators Read
Convert an organization member to outside collaborator — github.orgs.convert-member-to-outside-collaborator Write
Remove outside collaborator from an organization — github.orgs.remove-outside-collaborator Write
List packages for an organization — github.packages.list-packages-for-organization Read
Get a package for an organization — github.packages.get-package-for-organization Read
Delete a package for an organization — github.packages.delete-package-for-org Write
Restore a package for an organization — github.packages.restore-package-for-org Write
List package versions for a package owned by an organization — github.packages.get-all-package-versions-for-package-owned-by-org Read
Get a package version for an organization — github.packages.get-package-version-for-organization Read
Delete package version for an organization — github.packages.delete-package-version-for-org Write
Restore package version for an organization — github.packages.restore-package-version-for-org Write
List requests to access organization resources with fine-grained personal access tokens — github.orgs.list-pat-grant-requests Read
Review requests to access organization resources with fine-grained personal access tokens — github.orgs.review-pat-grant-requests-in-bulk Write
Review a request to access organization resources with a fine-grained personal access token — github.orgs.review-pat-grant-request Write
List repositories requested to be accessed by a fine-grained personal access token — github.orgs.list-pat-grant-request-repositories Read
List fine-grained personal access tokens with access to organization resources — github.orgs.list-pat-grants Read
Update the access to organization resources via fine-grained personal access tokens — github.orgs.update-pat-accesses Write
Update the access a fine-grained personal access token has to organization resources — github.orgs.update-pat-access Write
List repositories a fine-grained personal access token has access to — github.orgs.list-pat-grant-repositories Read
List private registries for an organization — github.private-registries.list-org-private-registries Read
Create a private registry for an organization — github.private-registries.create-org-private-registry Write
Get private registries public key for an organization — github.private-registries.get-org-public-key Read
Get a private registry for an organization — github.private-registries.get-org-private-registry Read
Update a private registry for an organization — github.private-registries.update-org-private-registry Write
Delete a private registry for an organization — github.private-registries.delete-org-private-registry Write
List projects for organization — github.projects.list-for-org Read
Get project for organization — github.projects.get-for-org Read
Create draft item for organization owned project — github.projects.create-draft-item-for-org Write
List project fields for organization — github.projects.list-fields-for-org Read
Add a field to an organization-owned project. — github.projects.add-field-for-org Write
Get project field for organization — github.projects.get-field-for-org Read
List items for an organization owned project — github.projects.list-items-for-org Read
Add item to organization owned project — github.projects.add-item-for-org Write
Get an item for an organization owned project — github.projects.get-org-item Read
Update project item for organization — github.projects.update-item-for-org Write
Delete project item for organization — github.projects.delete-item-for-org Write
Create a view for an organization-owned project — github.projects.create-view-for-org Write
List items for an organization project view — github.projects.list-view-items-for-org Read
Get registered app installations for external custom properties — github.orgs.external-properties-for-repos-get-organization-app-installations Read
Register an app installation for external custom properties — github.orgs.external-properties-for-repos-register-organization-app-installation Write
Get all external custom properties for a GitHub App installation in an organization — github.orgs.external-properties-for-repos-get-organization-definitions Read
Create or update external custom property values for organization repositories — github.orgs.external-properties-for-repos-create-or-update-organization-values Write
Create or update external custom property values for a property across organization repositories — github.orgs.external-properties-for-repos-create-or-update-values-for-6035de2edd Write
Remove all external custom property values for a property across all organization repositories — github.orgs.external-properties-for-repos-delete-organization-values Write
Get all custom properties for an organization — github.orgs.custom-properties-for-repos-get-organization-definitions Read
Create or update custom properties for an organization — github.orgs.custom-properties-for-repos-create-or-update-organization-ed341b3e2b Write
Get a custom property for an organization — github.orgs.custom-properties-for-repos-get-organization-definition Read
Create or update a custom property for an organization — github.orgs.custom-properties-for-repos-create-or-update-organization-definition Write
Remove a custom property for an organization — github.orgs.custom-properties-for-repos-delete-organization-definition Write
List custom property values for organization repositories — github.orgs.custom-properties-for-repos-get-organization-values Read
Create or update custom property values for organization repositories — github.orgs.custom-properties-for-repos-create-or-update-organization-values Write
List public organization members — github.orgs.list-public-members Read
Check public organization membership for a user — github.orgs.check-public-membership-for-user Read
Set public organization membership for the authenticated user — github.orgs.set-public-membership-for-authenticated-user Write
Remove public organization membership for the authenticated user — github.orgs.remove-public-membership-for-authenticated-user Write
List organization repositories — github.repos.list-for-org Read
Create an organization repository — github.repos.create-in-org Write
Get all organization repository rulesets — github.repos.get-org-rulesets Read
Create an organization repository ruleset — github.repos.create-org-ruleset Write
List organization rule suites — github.repos.get-org-rule-suites Read
Get an organization rule suite — github.repos.get-org-rule-suite Read
Get an organization repository ruleset — github.repos.get-org-ruleset Read
Update an organization repository ruleset — github.repos.update-org-ruleset Write
Delete an organization repository ruleset — github.repos.delete-org-ruleset Write
Get organization ruleset history — github.orgs.get-org-ruleset-history Read
Get organization ruleset version — github.orgs.get-org-ruleset-version Read
List secret scanning alerts for an organization — github.secret-scanning.list-alerts-for-org Read
List organization custom patterns — github.secret-scanning.list-org-custom-patterns Read
Bulk create organization custom patterns — github.secret-scanning.bulk-create-org-custom-patterns Write
Bulk delete organization custom patterns — github.secret-scanning.bulk-delete-org-custom-patterns Write
Update an organization custom pattern — github.secret-scanning.update-org-custom-pattern Write
List organization pattern configurations — github.secret-scanning.list-org-pattern-configs Read
Update organization pattern configurations — github.secret-scanning.update-org-pattern-configs Write
List repository security advisories for an organization — github.security-advisories.list-org-repository-advisories Read
Get immutable releases settings for an organization — github.orgs.get-immutable-releases-settings Read
Set immutable releases settings for an organization — github.orgs.set-immutable-releases-settings Write
List selected repositories for immutable releases enforcement — github.orgs.get-immutable-releases-settings-repositories Read
Set selected repositories for immutable releases enforcement — github.orgs.set-immutable-releases-settings-repositories Write
Enable a selected repository for immutable releases in an organization — github.orgs.enable-selected-repository-immutable-releases-organization Write
Disable a selected repository for immutable releases in an organization — github.orgs.disable-selected-repository-immutable-releases-organization Write
List hosted compute network configurations for an organization — github.hosted-compute.list-network-configurations-for-org Read
Create a hosted compute network configuration for an organization — github.hosted-compute.create-network-configuration-for-org Write
Get a hosted compute network configuration for an organization — github.hosted-compute.get-network-configuration-for-org Read
Update a hosted compute network configuration for an organization — github.hosted-compute.update-network-configuration-for-org Write
Delete a hosted compute network configuration from an organization — github.hosted-compute.delete-network-configuration-from-org Write
Get a hosted compute network settings resource for an organization — github.hosted-compute.get-network-settings-for-org Read
List teams — github.teams.list Read
Create a team — github.teams.create Write
Get a team by name — github.teams.get-by-name Read
Update a team — github.teams.update-in-org Write
Delete a team — github.teams.delete-in-org Write
List pending team invitations — github.teams.list-pending-invitations-in-org Read
List team members — github.teams.list-members-in-org Read
Get team membership for a user — github.teams.get-membership-for-user-in-org Read
Add or update team membership for a user — github.teams.add-or-update-membership-for-user-in-org Write
Remove team membership for a user — github.teams.remove-membership-for-user-in-org Write
List team repositories — github.teams.list-repos-in-org Read
Check team permissions for a repository — github.teams.check-permissions-for-repo-in-org Read
Add or update team repository permissions — github.teams.add-or-update-repo-permissions-in-org Write
Remove a repository from a team — github.teams.remove-repo-in-org Write
List child teams — github.teams.list-child-in-org Read
Get rate limit status for the authenticated user — github.rate-limit.get Read
Get a repository — github.repos.get Read
Update a repository — github.repos.update Write
Delete a repository — github.repos.delete Write
List artifacts for a repository — github.actions.list-artifacts-for-repo Read
Get an artifact — github.actions.get-artifact Read
Delete an artifact — github.actions.delete-artifact Write
Get GitHub Actions cache retention limit for a repository — github.actions.get-actions-cache-retention-limit-for-repository Read
Set GitHub Actions cache retention limit for a repository — github.actions.set-actions-cache-retention-limit-for-repository Write
Get GitHub Actions cache storage limit for a repository — github.actions.get-actions-cache-storage-limit-for-repository Read
Set GitHub Actions cache storage limit for a repository — github.actions.set-actions-cache-storage-limit-for-repository Write
Get GitHub Actions cache usage for a repository — github.actions.get-actions-cache-usage Read
List GitHub Actions caches for a repository — github.actions.get-actions-cache-list Read
Delete GitHub Actions caches for a repository (using a cache key) — github.actions.delete-actions-cache-by-key Write
Delete a GitHub Actions cache for a repository (using a cache ID) — github.actions.delete-actions-cache-by-id Write
List concurrency groups for a repository — github.actions.list-concurrency-groups-for-repository Read
Get a concurrency group for a repository — github.actions.get-concurrency-group-for-repository Read
Get a job for a workflow run — github.actions.get-job-for-workflow-run Read
Re-run a job from a workflow run — github.actions.re-run-job-for-workflow-run Write
Get the customization template for an OIDC subject claim for a repository — github.actions.get-custom-oidc-sub-claim-for-repo Read
Set the customization template for an OIDC subject claim for a repository — github.actions.set-custom-oidc-sub-claim-for-repo Write
List repository organization secrets — github.actions.list-repo-organization-secrets Read
List repository organization variables — github.actions.list-repo-organization-variables Read
Get GitHub Actions permissions for a repository — github.actions.get-github-actions-permissions-repository Read
Set GitHub Actions permissions for a repository — github.actions.set-github-actions-permissions-repository Write
Get the level of access for workflows outside of the repository — github.actions.get-workflow-access-to-repository Read
Set the level of access for workflows outside of the repository — github.actions.set-workflow-access-to-repository Write
Get artifact and log retention settings for a repository — github.actions.get-artifact-and-log-retention-settings-repository Read
Set artifact and log retention settings for a repository — github.actions.set-artifact-and-log-retention-settings-repository Write
Get fork PR contributor approval permissions for a repository — github.actions.get-fork-pr-contributor-approval-permissions-repository Read
Set fork PR contributor approval permissions for a repository — github.actions.set-fork-pr-contributor-approval-permissions-repository Write
Get private repo fork PR workflow settings for a repository — github.actions.get-private-repo-fork-pr-workflows-settings-repository Read
Set private repo fork PR workflow settings for a repository — github.actions.set-private-repo-fork-pr-workflows-settings-repository Write
Get allowed actions and reusable workflows for a repository — github.actions.get-allowed-actions-repository Read
Set allowed actions and reusable workflows for a repository — github.actions.set-allowed-actions-repository Write
Get default workflow permissions for a repository — github.actions.get-github-actions-default-workflow-permissions-repository Read
Set default workflow permissions for a repository — github.actions.set-github-actions-default-workflow-permissions-repository Write
List repository Actions policies — github.actions.get-repo-actions-policies Read
Create a repository Actions policy — github.actions.create-repo-actions-policy Write
Get a repository Actions policy — github.actions.get-repo-actions-policy Read
Update a repository Actions policy — github.actions.update-repo-actions-policy Write
Delete a repository Actions policy — github.actions.delete-repo-actions-policy Write
List self-hosted runners for a repository — github.actions.list-self-hosted-runners-for-repo Read
Get runner version end-of-life schedule for a repository — github.actions.get-runner-version-deprecation-for-repo Read
List runner applications for a repository — github.actions.list-runner-applications-for-repo Read
Create configuration for a just-in-time runner for a repository — github.actions.generate-runner-jitconfig-for-repo Write
Create a registration token for a repository — github.actions.create-registration-token-for-repo Write
Create a remove token for a repository — github.actions.create-remove-token-for-repo Write
Get a self-hosted runner for a repository — github.actions.get-self-hosted-runner-for-repo Read
Delete a self-hosted runner from a repository — github.actions.delete-self-hosted-runner-from-repo Write
List labels for a self-hosted runner for a repository — github.actions.list-labels-for-self-hosted-runner-for-repo Read
Add custom labels to a self-hosted runner for a repository — github.actions.add-custom-labels-to-self-hosted-runner-for-repo Write
Set custom labels for a self-hosted runner for a repository — github.actions.set-custom-labels-for-self-hosted-runner-for-repo Write
Remove all custom labels from a self-hosted runner for a repository — github.actions.remove-all-custom-labels-from-self-hosted-runner-for-repo Write
Remove a custom label from a self-hosted runner for a repository — github.actions.remove-custom-label-from-self-hosted-runner-for-repo Write
List workflow runs for a repository — github.actions.list-workflow-runs-for-repo Read
Get a workflow run — github.actions.get-workflow-run Read
Delete a workflow run — github.actions.delete-workflow-run Write
Get the review history for a workflow run — github.actions.get-reviews-for-run Read
Approve a workflow run for a fork pull request — github.actions.approve-workflow-run Write
List workflow run artifacts — github.actions.list-workflow-run-artifacts Read
Get a workflow run attempt — github.actions.get-workflow-run-attempt Read
List jobs for a workflow run attempt — github.actions.list-jobs-for-workflow-run-attempt Read
Cancel a workflow run — github.actions.cancel-workflow-run Write
List concurrency groups for a workflow run — github.actions.list-concurrency-groups-for-workflow-run Read
Review custom deployment protection rules for a workflow run — github.actions.review-custom-gates-for-run Write
Force cancel a workflow run — github.actions.force-cancel-workflow-run Write
List jobs for a workflow run — github.actions.list-jobs-for-workflow-run Read
Delete workflow run logs — github.actions.delete-workflow-run-logs Write
Get pending deployments for a workflow run — github.actions.get-pending-deployments-for-run Read
Review pending deployments for a workflow run — github.actions.review-pending-deployments-for-run Write
Re-run a workflow — github.actions.re-run-workflow Write
Re-run failed jobs from a workflow run — github.actions.re-run-workflow-failed-jobs Write
Get workflow run usage — github.actions.get-workflow-run-usage Read
List repository secrets — github.actions.list-repo-secrets Read
Get a repository public key — github.actions.get-repo-public-key Read
Get a repository secret — github.actions.get-repo-secret Read
Create or update a repository secret — github.actions.create-or-update-repo-secret Write
Delete a repository secret — github.actions.delete-repo-secret Write
List repository variables — github.actions.list-repo-variables Read
Create a repository variable — github.actions.create-repo-variable Write
Get a repository variable — github.actions.get-repo-variable Read
Update a repository variable — github.actions.update-repo-variable Write
Delete a repository variable — github.actions.delete-repo-variable Write
List repository workflows — github.actions.list-repo-workflows Read
Get a workflow — github.actions.get-workflow Read
Disable a workflow — github.actions.disable-workflow Write
Create a workflow dispatch event — github.actions.create-workflow-dispatch Write
Enable a workflow — github.actions.enable-workflow Write
List workflow runs for a workflow — github.actions.list-workflow-runs Read
Get workflow usage — github.actions.get-workflow-usage Read
List repository activities — github.repos.list-activities Read
List repository organization secrets — github.agents.list-repo-organization-secrets Read
List repository organization variables — github.agents.list-repo-organization-variables Read
List repository secrets — github.agents.list-repo-secrets Read
Get a repository public key — github.agents.get-repo-public-key Read
Get a repository secret — github.agents.get-repo-secret Read
Create or update a repository secret — github.agents.create-or-update-repo-secret Write
Delete a repository secret — github.agents.delete-repo-secret Write
List repository variables — github.agents.list-repo-variables Read
Create a repository variable — github.agents.create-repo-variable Write
Get a repository variable — github.agents.get-repo-variable Read
Update a repository variable — github.agents.update-repo-variable Write
Delete a repository variable — github.agents.delete-repo-variable Write
List assignees — github.issues.list-assignees Read
Check if a user can be assigned — github.issues.check-user-can-be-assigned Read
Create an attestation — github.repos.create-attestation Write
List attestations — github.repos.list-attestations Read
Get all autolinks of a repository — github.repos.list-autolinks Read
Create an autolink reference for a repository — github.repos.create-autolink Write
Get an autolink reference of a repository — github.repos.get-autolink Read
Delete an autolink reference from a repository — github.repos.delete-autolink Write
Check if Dependabot security updates are enabled for a repository — github.repos.check-automated-security-fixes Read
Enable Dependabot security updates — github.repos.enable-automated-security-fixes Write
Disable Dependabot security updates — github.repos.disable-automated-security-fixes Write
List branches — github.repos.list-branches Read
Get a branch — github.repos.get-branch Read
Get branch protection — github.repos.get-branch-protection Read
Update branch protection — github.repos.update-branch-protection Write
Delete branch protection — github.repos.delete-branch-protection Write
Get admin branch protection — github.repos.get-admin-branch-protection Read
Set admin branch protection — github.repos.set-admin-branch-protection Write
Delete admin branch protection — github.repos.delete-admin-branch-protection Write
Get pull request review protection — github.repos.get-pull-request-review-protection Read
Update pull request review protection — github.repos.update-pull-request-review-protection Write
Delete pull request review protection — github.repos.delete-pull-request-review-protection Write
Get commit signature protection — github.repos.get-commit-signature-protection Read
Create commit signature protection — github.repos.create-commit-signature-protection Write
Delete commit signature protection — github.repos.delete-commit-signature-protection Write
Get status checks protection — github.repos.get-status-checks-protection Read
Update status check protection — github.repos.update-status-check-protection Write
Remove status check protection — github.repos.remove-status-check-protection Write
Get all status check contexts — github.repos.get-all-status-check-contexts Read
Add status check contexts — github.repos.add-status-check-contexts Write
Set status check contexts — github.repos.set-status-check-contexts Write
Remove status check contexts — github.repos.remove-status-check-contexts Write
Get access restrictions — github.repos.get-access-restrictions Read
Delete access restrictions — github.repos.delete-access-restrictions Write
Get apps with access to the protected branch — github.repos.get-apps-with-access-to-protected-branch Read
Add app access restrictions — github.repos.add-app-access-restrictions Write
Set app access restrictions — github.repos.set-app-access-restrictions Write
Remove app access restrictions — github.repos.remove-app-access-restrictions Write
Get teams with access to the protected branch — github.repos.get-teams-with-access-to-protected-branch Read
Add team access restrictions — github.repos.add-team-access-restrictions Write
Set team access restrictions — github.repos.set-team-access-restrictions Write
Remove team access restrictions — github.repos.remove-team-access-restrictions Write
Get users with access to the protected branch — github.repos.get-users-with-access-to-protected-branch Read
Add user access restrictions — github.repos.add-user-access-restrictions Write
Set user access restrictions — github.repos.set-user-access-restrictions Write
Remove user access restrictions — github.repos.remove-user-access-restrictions Write
Rename a branch — github.repos.rename-branch Write
Create a check run — github.checks.create Write
Get a check run — github.checks.get Read
Update a check run — github.checks.update Write
List check run annotations — github.checks.list-annotations Read
Rerequest a check run — github.checks.rerequest-run Write
Create a check suite — github.checks.create-suite Write
Update repository preferences for check suites — github.checks.set-suites-preferences Write
Get a check suite — github.checks.get-suite Read
List check runs in a check suite — github.checks.list-for-suite Read
Rerequest a check suite — github.checks.rerequest-suite Write
List code quality findings for a repository — github.code-quality.list-findings-for-repo Read
Get a code quality finding — github.code-quality.get-finding Read
Get a code quality setup configuration — github.code-quality.get-setup Read
Update a code quality setup configuration — github.code-quality.update-setup Write
Get AI Scan enablement for a repository — github.code-scanning.get-ai-scan-enablement Read
List code scanning alerts for a repository — github.code-scanning.list-alerts-for-repo Read
Get a code scanning alert — github.code-scanning.get-alert Read
Update a code scanning alert — github.code-scanning.update-alert Write
Get the status of an autofix for a code scanning alert — github.code-scanning.get-autofix Read
Create an autofix for a code scanning alert — github.code-scanning.create-autofix Write
Commit an autofix for a code scanning alert — github.code-scanning.commit-autofix Write
List instances of a code scanning alert — github.code-scanning.list-alert-instances Read
List code scanning analyses for a repository — github.code-scanning.list-recent-analyses Read
Get a code scanning analysis for a repository — github.code-scanning.get-analysis Read
Delete a code scanning analysis from a repository — github.code-scanning.delete-analysis Write
List CodeQL databases for a repository — github.code-scanning.list-codeql-databases Read
Get a CodeQL database for a repository — github.code-scanning.get-codeql-database Read
Delete a CodeQL database — github.code-scanning.delete-codeql-database Write
Create a CodeQL variant analysis — github.code-scanning.create-variant-analysis Write
Get the summary of a CodeQL variant analysis — github.code-scanning.get-variant-analysis Read
Get the analysis status of a repository in a CodeQL variant analysis — github.code-scanning.get-variant-analysis-repo-task Read
Get a code scanning default setup configuration — github.code-scanning.get-default-setup Read
Update a code scanning default setup configuration — github.code-scanning.update-default-setup Write
Upload an analysis as SARIF data — github.code-scanning.upload-sarif Write
Get information about a SARIF upload — github.code-scanning.get-sarif Read
Get the code security configuration associated with a repository — github.code-security.get-configuration-for-repository Read
List CODEOWNERS errors — github.repos.codeowners-errors Read
List codespaces in a repository for the authenticated user — github.codespaces.list-in-repository-for-authenticated-user Read
Create a codespace in a repository — github.codespaces.create-with-repo-for-authenticated-user Write
List devcontainer configurations in a repository for the authenticated user — github.codespaces.list-devcontainers-in-repository-for-authenticated-user Read
List available machine types for a repository — github.codespaces.repo-machines-for-authenticated-user Read
Get default attributes for a codespace — github.codespaces.pre-flight-with-repo-for-authenticated-user Read
Check if permissions defined by a devcontainer have been accepted by the authenticated user — github.codespaces.check-permissions-for-devcontainer Read
List repository secrets — github.codespaces.list-repo-secrets Read
Get a repository public key — github.codespaces.get-repo-public-key Read
Get a repository secret — github.codespaces.get-repo-secret Read
Create or update a repository secret — github.codespaces.create-or-update-repo-secret Write
Delete a repository secret — github.codespaces.delete-repo-secret Write
List repository collaborators — github.repos.list-collaborators Read
Check if a user is a repository collaborator — github.repos.check-collaborator Read
Add a repository collaborator — github.repos.add-collaborator Write
Remove a repository collaborator — github.repos.remove-collaborator Write
Get repository permissions for a user — github.repos.get-collaborator-permission-level Read
List commit comments for a repository — github.repos.list-commit-comments-for-repo Read
Get a commit comment — github.repos.get-commit-comment Read
Update a commit comment — github.repos.update-commit-comment Write
Delete a commit comment — github.repos.delete-commit-comment Write
List reactions for a commit comment — github.reactions.list-for-commit-comment Read
Create reaction for a commit comment — github.reactions.create-for-commit-comment Write
Delete a commit comment reaction — github.reactions.delete-for-commit-comment Write
List commits — github.repos.list-commits Read
List branches for HEAD commit — github.repos.list-branches-for-head-commit Read
List commit comments — github.repos.list-comments-for-commit Read
Create a commit comment — github.repos.create-commit-comment Write
List pull requests associated with a commit — github.repos.list-pull-requests-associated-with-commit Read
Get a commit — github.repos.get-commit Read
List check runs for a Git reference — github.checks.list-for-ref Read
List check suites for a Git reference — github.checks.list-suites-for-ref Read
Get the combined status for a specific reference — github.repos.get-combined-status-for-ref Read
List commit statuses for a reference — github.repos.list-commit-statuses-for-ref Read
Get community profile metrics — github.repos.get-community-profile-metrics Read
Compare two commits — github.repos.compare-commits Read
Create or update file contents — github.repos.create-or-update-file-contents Write
Delete a file — github.repos.delete-file Write
List repository contributors — github.repos.list-contributors Read
Get Copilot cloud agent configuration for a repository — github.copilot.get-copilot-cloud-agent-configuration Read
List Dependabot alerts for a repository — github.dependabot.list-alerts-for-repo Read
Get a Dependabot alert — github.dependabot.get-alert Read
Update a Dependabot alert — github.dependabot.update-alert Write
List repository secrets — github.dependabot.list-repo-secrets Read
Get a repository public key — github.dependabot.get-repo-public-key Read
Get a repository secret — github.dependabot.get-repo-secret Read
Create or update a repository secret — github.dependabot.create-or-update-repo-secret Write
Delete a repository secret — github.dependabot.delete-repo-secret Write
Get a diff of the dependencies between commits — github.dependency-graph.diff-range Read
Fetch a software bill of materials (SBOM) for a repository. — github.dependency-graph.fetch-sbom-report Read
Request generation of a software bill of materials (SBOM) for a repository. — github.dependency-graph.generate-sbom-report Read
Create a snapshot of dependencies for a repository — github.dependency-graph.create-repository-snapshot Write
List deployments — github.repos.list-deployments Read
Create a deployment — github.repos.create-deployment Write
Get a deployment — github.repos.get-deployment Read
Delete a deployment — github.repos.delete-deployment Write
List deployment statuses — github.repos.list-deployment-statuses Read
Create a deployment status — github.repos.create-deployment-status Write
Get a deployment status — github.repos.get-deployment-status Read
Create a repository dispatch event — github.repos.create-dispatch-event Write
List environments — github.repos.get-all-environments Read
Get an environment — github.repos.get-environment Read
Create or update an environment — github.repos.create-or-update-environment Write
Delete an environment — github.repos.delete-an-environment Write
List deployment branch policies — github.repos.list-deployment-branch-policies Read
Create a deployment branch policy — github.repos.create-deployment-branch-policy Write
Get a deployment branch policy — github.repos.get-deployment-branch-policy Read
Update a deployment branch policy — github.repos.update-deployment-branch-policy Write
Delete a deployment branch policy — github.repos.delete-deployment-branch-policy Write
Get all deployment protection rules for an environment — github.repos.get-all-deployment-protection-rules Read
Create a custom deployment protection rule on an environment — github.repos.create-deployment-protection-rule Write
List custom deployment rule integrations available for an environment — github.repos.list-custom-deployment-rule-integrations Read
Get a custom deployment protection rule — github.repos.get-custom-deployment-protection-rule Read
Disable a custom protection rule for an environment — github.repos.disable-deployment-protection-rule Write
List environment secrets — github.actions.list-environment-secrets Read
Get an environment public key — github.actions.get-environment-public-key Read
Get an environment secret — github.actions.get-environment-secret Read
Create or update an environment secret — github.actions.create-or-update-environment-secret Write
Delete an environment secret — github.actions.delete-environment-secret Write
List environment variables — github.actions.list-environment-variables Read
Create an environment variable — github.actions.create-environment-variable Write
Get an environment variable — github.actions.get-environment-variable Read
Update an environment variable — github.actions.update-environment-variable Write
Delete an environment variable — github.actions.delete-environment-variable Write
List repository events — github.activity.list-repo-events Read
List forks — github.repos.list-forks Read
Create a fork — github.repos.create-fork Write
Create a blob — github.git.create-blob Write
Get a blob — github.git.get-blob Read
Create a commit — github.git.create-commit Write
Get a commit object — github.git.get-commit Read
List matching references — github.git.list-matching-refs Read
Get a reference — github.git.get-ref Read
Create a reference — github.git.create-ref Write
Update a reference — github.git.update-ref Write
Delete a reference — github.git.delete-ref Write
Create a tag object — github.git.create-tag Write
Get a tag — github.git.get-tag Read
Create a tree — github.git.create-tree Write
Get a tree — github.git.get-tree Read
Get the hash algorithm for a repository — github.repos.get-hash-algorithm Read
List repository webhooks — github.repos.list-webhooks Read
Create a repository webhook — github.repos.create-webhook Write
Get a repository webhook — github.repos.get-webhook Read
Update a repository webhook — github.repos.update-webhook Write
Delete a repository webhook — github.repos.delete-webhook Write
Get a webhook configuration for a repository — github.repos.get-webhook-config-for-repo Read
Update a webhook configuration for a repository — github.repos.update-webhook-config-for-repo Write
List deliveries for a repository webhook — github.repos.list-webhook-deliveries Read
Get a delivery for a repository webhook — github.repos.get-webhook-delivery Read
Redeliver a delivery for a repository webhook — github.repos.redeliver-webhook-delivery Write
Ping a repository webhook — github.repos.ping-webhook Write
Test the push repository webhook — github.repos.test-push-webhook Write
Check if immutable releases are enabled for a repository — github.repos.check-immutable-releases Read
Enable immutable releases — github.repos.enable-immutable-releases Write
Disable immutable releases — github.repos.disable-immutable-releases Write
Get a repository installation for the authenticated app — github.apps.get-repo-installation Read
Get interaction restrictions for a repository — github.interactions.get-restrictions-for-repo Read
Set interaction restrictions for a repository — github.interactions.set-restrictions-for-repo Write
Remove interaction restrictions for a repository — github.interactions.remove-restrictions-for-repo Write
Get pull request creation cap bypass list for a repository — github.interactions.get-pull-request-bypass-list-for-repo Read
Add users to the pull request creation cap bypass list for a repository — github.interactions.set-pull-request-bypass-list-for-repo Write
Remove users from the pull request creation cap bypass list for a repository — github.interactions.remove-pull-request-bypass-list-for-repo Write
Get pull request creation cap for a repository — github.interactions.get-pull-request-creation-cap-for-repo Read
Update pull request creation cap for a repository — github.interactions.update-pull-request-creation-cap-for-repo Write
List repository invitations — github.repos.list-invitations Read
Update a repository invitation — github.repos.update-invitation Write
Delete a repository invitation — github.repos.delete-invitation Write
List issue types for a repository — github.repos.list-issue-types Read
List repository issues — github.issues.list-for-repo Read
Create an issue — github.issues.create Write
List issue comments for a repository — github.issues.list-comments-for-repo Read
Get an issue comment — github.issues.get-comment Read
Update an issue comment — github.issues.update-comment Write
Delete an issue comment — github.issues.delete-comment Write
Pin an issue comment — github.issues.pin-comment Write
Unpin an issue comment — github.issues.unpin-comment Write
List reactions for an issue comment — github.reactions.list-for-issue-comment Read
Create reaction for an issue comment — github.reactions.create-for-issue-comment Write
Delete an issue comment reaction — github.reactions.delete-for-issue-comment Write
List issue events for a repository — github.issues.list-events-for-repo Read
Get an issue event — github.issues.get-event Read
Get an issue — github.issues.get Read
Update an issue — github.issues.update Write
List issue artifacts — github.issues.list-issue-artifacts Read
Create an issue artifact — github.issues.create-issue-artifact Write
Get an issue artifact — github.issues.get-issue-artifact Read
Update an issue artifact — github.issues.update-issue-artifact Write
Delete an issue artifact — github.issues.delete-issue-artifact Write
Add assignees to an issue — github.issues.add-assignees Write
Remove assignees from an issue — github.issues.remove-assignees Write
Check if a user can be assigned to a issue — github.issues.check-user-can-be-assigned-to-issue Read
List issue comments — github.issues.list-comments Read
Create an issue comment — github.issues.create-comment Write
List dependencies an issue is blocked by — github.issues.list-dependencies-blocked-by Read
Add a dependency an issue is blocked by — github.issues.add-blocked-by-dependency Write
Remove dependency an issue is blocked by — github.issues.remove-dependency-blocked-by Write
List dependencies an issue is blocking — github.issues.list-dependencies-blocking Read
List issue events — github.issues.list-events Read
List issue field values for an issue — github.issues.list-issue-field-values-for-issue Read
Add issue field values to an issue — github.issues.add-issue-field-values Write
Set issue field values for an issue — github.issues.set-issue-field-values Write
Delete an issue field value from an issue — github.issues.delete-issue-field-value Write
List labels for an issue — github.issues.list-labels-on-issue Read
Add labels to an issue — github.issues.add-labels Write
Set labels for an issue — github.issues.set-labels Write
Remove all labels from an issue — github.issues.remove-all-labels Write
Remove a label from an issue — github.issues.remove-label Write
Lock an issue — github.issues.lock Write
Unlock an issue — github.issues.unlock Write
Get parent issue — github.issues.get-parent Read
List reactions for an issue — github.reactions.list-for-issue Read
Create reaction for an issue — github.reactions.create-for-issue Write
Delete an issue reaction — github.reactions.delete-for-issue Write
List issues related to an issue — github.issues.list-relates-to Read
Add a related issue — github.issues.add-relates-to Write
Remove a related issue — github.issues.remove-relates-to Write
Remove sub-issue — github.issues.remove-sub-issue Write
List sub-issues — github.issues.list-sub-issues Read
Add sub-issue — github.issues.add-sub-issue Write
Reprioritize sub-issue — github.issues.reprioritize-sub-issue Write
List issue suggestions — github.issues.list-suggestions Read
Approve an issue suggestion — github.issues.approve-suggestion Write
Dismiss an issue suggestion — github.issues.dismiss-suggestion Write
List timeline events for an issue — github.issues.list-events-for-timeline Read
List deploy keys — github.repos.list-deploy-keys Read
Create a deploy key — github.repos.create-deploy-key Write
Get a deploy key — github.repos.get-deploy-key Read
Delete a deploy key — github.repos.delete-deploy-key Write
List labels for a repository — github.issues.list-labels-for-repo Read
Create a label — github.issues.create-label Write
Get a label — github.issues.get-label Read
Update a label — github.issues.update-label Write
Delete a label — github.issues.delete-label Write
List repository languages — github.repos.list-languages Read
Get the license for a repository — github.licenses.get-for-repo Read
Sync a fork branch with the upstream repository — github.repos.merge-upstream Write
Merge a branch — github.repos.merge Write
List milestones — github.issues.list-milestones Read
Create a milestone — github.issues.create-milestone Write
Get a milestone — github.issues.get-milestone Read
Update a milestone — github.issues.update-milestone Write
Delete a milestone — github.issues.delete-milestone Write
List labels for issues in a milestone — github.issues.list-labels-for-milestone Read
List repository notifications for the authenticated user — github.activity.list-repo-notifications-for-authenticated-user Read
Mark repository notifications as read — github.activity.mark-repo-notifications-as-read Write
Get a GitHub Pages site — github.repos.get-pages Read
Create a GitHub Pages site — github.repos.create-pages-site Write
Update information about a GitHub Pages site — github.repos.update-information-about-pages-site Write
Delete a GitHub Pages site — github.repos.delete-pages-site Write
List GitHub Pages builds — github.repos.list-pages-builds Read
Request a GitHub Pages build — github.repos.request-pages-build Write
Get latest Pages build — github.repos.get-latest-pages-build Read
Get GitHub Pages build — github.repos.get-pages-build Read
Create a GitHub Pages deployment — github.repos.create-pages-deployment Write
Get the status of a GitHub Pages deployment — github.repos.get-pages-deployment Read
Cancel a GitHub Pages deployment — github.repos.cancel-pages-deployment Write
Get a DNS health check for GitHub Pages — github.repos.get-pages-health-check Read
Check if private vulnerability reporting is enabled for a repository — github.repos.check-private-vulnerability-reporting Read
Enable private vulnerability reporting for a repository — github.repos.enable-private-vulnerability-reporting Write
Disable private vulnerability reporting for a repository — github.repos.disable-private-vulnerability-reporting Write
Get all custom property values for a repository — github.repos.custom-properties-for-repos-get-repository-values Read
Create or update custom property values for a repository — github.repos.custom-properties-for-repos-create-or-update-repository-values Write
List pull requests — github.pulls.list Read
Create a pull request — github.pulls.create Write
List review comments in a repository — github.pulls.list-review-comments-for-repo Read
Get a review comment for a pull request — github.pulls.get-review-comment Read
Update a review comment for a pull request — github.pulls.update-review-comment Write
Delete a review comment for a pull request — github.pulls.delete-review-comment Write
List reactions for a pull request review comment — github.reactions.list-for-pull-request-review-comment Read
Create reaction for a pull request review comment — github.reactions.create-for-pull-request-review-comment Write
Delete a pull request comment reaction — github.reactions.delete-for-pull-request-comment Write
Get a pull request — github.pulls.get Read
Update a pull request — github.pulls.update Write
Create a codespace from a pull request — github.codespaces.create-with-pr-for-authenticated-user Write
List review comments on a pull request — github.pulls.list-review-comments Read
Create a review comment for a pull request — github.pulls.create-review-comment Write
Create a reply for a review comment — github.pulls.create-reply-for-review-comment Write
List commits on a pull request — github.pulls.list-commits Read
List pull requests files — github.pulls.list-files Read
Check if a pull request has been merged — github.pulls.check-if-merged Read
Merge a pull request — github.pulls.merge Write
Merge a pull request asynchronously — github.pulls.merge-async Write
Get the result of an asynchronous merge — github.pulls.get-merge-async-result Read
Get all requested reviewers for a pull request — github.pulls.list-requested-reviewers Read
Request reviewers for a pull request — github.pulls.request-reviewers Write
Remove requested reviewers from a pull request — github.pulls.remove-requested-reviewers Write
Rerequest reviewers for a pull request — github.pulls.rerequest-reviewers Write
List reviews for a pull request — github.pulls.list-reviews Read
Create a review for a pull request — github.pulls.create-review Write
Get a review for a pull request — github.pulls.get-review Read
Update a review for a pull request — github.pulls.update-review Write
Delete a pending review for a pull request — github.pulls.delete-pending-review Write
List comments for a pull request review — github.pulls.list-comments-for-review Read
Dismiss a review for a pull request — github.pulls.dismiss-review Write
Submit a review for a pull request — github.pulls.submit-review Write
Update a pull request branch — github.pulls.update-branch Write
Get a repository README — github.repos.get-readme Read
Get a repository README for a directory — github.repos.get-readme-in-directory Read
List releases — github.repos.list-releases Read
Create a release — github.repos.create-release Write
Get a release asset — github.repos.get-release-asset Read
Update a release asset — github.repos.update-release-asset Write
Delete a release asset — github.repos.delete-release-asset Write
Generate release notes content for a release — github.repos.generate-release-notes Write
Get the latest release — github.repos.get-latest-release Read
Get a release by tag name — github.repos.get-release-by-tag Read
Get a release — github.repos.get-release Read
Update a release — github.repos.update-release Write
Delete a release — github.repos.delete-release Write
List release assets — github.repos.list-release-assets Read
List reactions for a release — github.reactions.list-for-release Read
Create reaction for a release — github.reactions.create-for-release Write
Delete a release reaction — github.reactions.delete-for-release Write
Get rules for a branch — github.repos.get-branch-rules Read
Get all repository rulesets — github.repos.get-repo-rulesets Read
Create a repository ruleset — github.repos.create-repo-ruleset Write
List repository rule suites — github.repos.get-repo-rule-suites Read
Get a repository rule suite — github.repos.get-repo-rule-suite Read
Get a repository ruleset — github.repos.get-repo-ruleset Read
Update a repository ruleset — github.repos.update-repo-ruleset Write
Delete a repository ruleset — github.repos.delete-repo-ruleset Write
Get repository ruleset history — github.repos.get-repo-ruleset-history Read
Get repository ruleset version — github.repos.get-repo-ruleset-version Read
List secret scanning alerts for a repository — github.secret-scanning.list-alerts-for-repo Read
Get a secret scanning alert — github.secret-scanning.get-alert Read
Update a secret scanning alert — github.secret-scanning.update-alert Write
List locations for a secret scanning alert — github.secret-scanning.list-locations-for-alert Read
List repository custom patterns — github.secret-scanning.list-repo-custom-patterns Read
Bulk create repository custom patterns — github.secret-scanning.bulk-create-repo-custom-patterns Write
Bulk delete repository custom patterns — github.secret-scanning.bulk-delete-repo-custom-patterns Write
Update a repository custom pattern — github.secret-scanning.update-repo-custom-pattern Write
Create a push protection bypass — github.secret-scanning.create-push-protection-bypass Write
Get secret scanning scan history for a repository — github.secret-scanning.get-scan-history Read
List repository security advisories — github.security-advisories.list-repository-advisories Read
Create a repository security advisory — github.security-advisories.create-repository-advisory Write
Privately report a security vulnerability — github.security-advisories.create-private-vulnerability-report Write
Get a repository security advisory — github.security-advisories.get-repository-advisory Read
Update a repository security advisory — github.security-advisories.update-repository-advisory Write
List repository security advisory comments — github.security-advisories.list-repository-advisory-comments Read
Create a repository advisory comment — github.security-advisories.create-repository-advisory-comment Write
Get a repository advisory comment — github.security-advisories.get-repository-advisory-comment Read
Update a repository advisory comment — github.security-advisories.update-repository-advisory-comment Write
Request a CVE for a repository security advisory — github.security-advisories.create-repository-advisory-cve-request Write
Create a temporary private fork — github.security-advisories.create-fork Write
List pull request stacks — github.pull-request-stacks.list Read
Create a pull request stack — github.pull-request-stacks.create Write
Get a pull request stack — github.pull-request-stacks.get Read
Add pull requests to a pull request stack — github.pull-request-stacks.add Write
Remove pull requests from a pull request stack — github.pull-request-stacks.unstack Write
List stargazers — github.activity.list-stargazers-for-repo Read
Get stargazer count — github.activity.get-stargazer-count-for-repo Read
Get repository star history — github.activity.get-stargazer-history-for-repo Read
Get the weekly commit activity — github.repos.get-code-frequency-stats Read
Get the last year of commit activity — github.repos.get-commit-activity-stats Read
Get all contributor commit activity — github.repos.get-contributors-stats Read
Get the weekly commit count — github.repos.get-participation-stats Read
Get the hourly commit count for each day — github.repos.get-punch-card-stats Read
Create a commit status — github.repos.create-commit-status Write
List watchers — github.activity.list-watchers-for-repo Read
Get a repository subscription — github.activity.get-repo-subscription Read
Set a repository subscription — github.activity.set-repo-subscription Write
Delete a repository subscription — github.activity.delete-repo-subscription Write
List repository tags — github.repos.list-tags Read
List repository teams — github.repos.list-teams Read
Get all repository topics — github.repos.get-all-topics Read
Replace all repository topics — github.repos.replace-all-topics Write
Get repository clones — github.repos.get-clones Read
Get top referral paths — github.repos.get-top-paths Read
Get top referral sources — github.repos.get-top-referrers Read
Get page views — github.repos.get-views Read
Transfer a repository — github.repos.transfer Write
Check if vulnerability alerts are enabled for a repository — github.repos.check-vulnerability-alerts Read
Enable vulnerability alerts — github.repos.enable-vulnerability-alerts Write
Disable vulnerability alerts — github.repos.disable-vulnerability-alerts Write
Create a repository using a template — github.repos.create-using-template Write
List public repositories — github.repos.list-public Read
Search code — github.search.code Read
Search commits — github.search.commits Read
Search issues and pull requests — github.search.issues-and-pull-requests Read
Search labels — github.search.labels Read
Search repositories — github.search.repos Read
Search topics — github.search.topics Read
Search users — github.search.users Read
Get the authenticated user — github.users.get-authenticated Read
Update the authenticated user — github.users.update-authenticated Write
List users blocked by the authenticated user — github.users.list-blocked-by-authenticated-user Read
Check if a user is blocked by the authenticated user — github.users.check-blocked Read
Block a user — github.users.block Write
Unblock a user — github.users.unblock Write
List codespaces for the authenticated user — github.codespaces.list-for-authenticated-user Read
Create a codespace for the authenticated user — github.codespaces.create-for-authenticated-user Write
List secrets for the authenticated user — github.codespaces.list-secrets-for-authenticated-user Read
Get public key for the authenticated user — github.codespaces.get-public-key-for-authenticated-user Read
Get a secret for the authenticated user — github.codespaces.get-secret-for-authenticated-user Read
Create or update a secret for the authenticated user — github.codespaces.create-or-update-secret-for-authenticated-user Write
Delete a secret for the authenticated user — github.codespaces.delete-secret-for-authenticated-user Write
List selected repositories for a user secret — github.codespaces.list-repositories-for-secret-for-authenticated-user Read
Add a selected repository to a user secret — github.codespaces.add-repository-for-secret-for-authenticated-user Write
Remove a selected repository from a user secret — github.codespaces.remove-repository-for-secret-for-authenticated-user Write
Get a codespace for the authenticated user — github.codespaces.get-for-authenticated-user Read
Update a codespace for the authenticated user — github.codespaces.update-for-authenticated-user Write
Delete a codespace for the authenticated user — github.codespaces.delete-for-authenticated-user Write
Export a codespace for the authenticated user — github.codespaces.export-for-authenticated-user Write
Get details about a codespace export — github.codespaces.get-export-details-for-authenticated-user Read
List machine types for a codespace — github.codespaces.codespace-machines-for-authenticated-user Read
Create a repository from an unpublished codespace — github.codespaces.publish-for-authenticated-user Write
Start a codespace for the authenticated user — github.codespaces.start-for-authenticated-user Write
Stop a codespace for the authenticated user — github.codespaces.stop-for-authenticated-user Write
Get list of conflicting packages during Docker migration for authenticated-user — github.packages.list-docker-migration-conflicting-packages-for-authen-63152eb7cf Read
Set primary email visibility for the authenticated user — github.users.set-primary-email-visibility-for-authenticated-user Write
List email addresses for the authenticated user — github.users.list-emails-for-authenticated-user Read
Add an email address for the authenticated user — github.users.add-email-for-authenticated-user Write
Delete an email address for the authenticated user — github.users.delete-email-for-authenticated-user Write
List followers of the authenticated user — github.users.list-followers-for-authenticated-user Read
List the people the authenticated user follows — github.users.list-followed-by-authenticated-user Read
Check if a person is followed by the authenticated user — github.users.check-person-is-followed-by-authenticated Read
Follow a user — github.users.follow Write
Unfollow a user — github.users.unfollow Write
List GPG keys for the authenticated user — github.users.list-gpg-keys-for-authenticated-user Read
Create a GPG key for the authenticated user — github.users.create-gpg-key-for-authenticated-user Write
Get a GPG key for the authenticated user — github.users.get-gpg-key-for-authenticated-user Read
Delete a GPG key for the authenticated user — github.users.delete-gpg-key-for-authenticated-user Write
List app installations accessible to the user access token — github.apps.list-installations-for-authenticated-user Read
List repositories accessible to the user access token — github.apps.list-installation-repos-for-authenticated-user Read
Add a repository to an app installation — github.apps.add-repo-to-installation-for-authenticated-user Write
Remove a repository from an app installation — github.apps.remove-repo-from-installation-for-authenticated-user Write
Get interaction restrictions for your public repositories — github.interactions.get-restrictions-for-authenticated-user Read
Set interaction restrictions for your public repositories — github.interactions.set-restrictions-for-authenticated-user Write
Remove interaction restrictions from your public repositories — github.interactions.remove-restrictions-for-authenticated-user Write
List user account issues assigned to the authenticated user — github.issues.list-for-authenticated-user Read
List public SSH keys for the authenticated user — github.users.list-public-ssh-keys-for-authenticated-user Read
Get a public SSH key for the authenticated user — github.users.get-public-ssh-key-for-authenticated-user Read
Delete a public SSH key for the authenticated user — github.users.delete-public-ssh-key-for-authenticated-user Write
List subscriptions for the authenticated user — github.apps.list-subscriptions-for-authenticated-user Read
List subscriptions for the authenticated user (stubbed) — github.apps.list-subscriptions-for-authenticated-user-stubbed Read
List organization memberships for the authenticated user — github.orgs.list-memberships-for-authenticated-user Read
Get an organization membership for the authenticated user — github.orgs.get-membership-for-authenticated-user Read
Update an organization membership for the authenticated user — github.orgs.update-membership-for-authenticated-user Write
List user migrations — github.migrations.list-for-authenticated-user Read
Start a user migration — github.migrations.start-for-authenticated-user Write
Get a user migration status — github.migrations.get-status-for-authenticated-user Read
Delete a user migration archive — github.migrations.delete-archive-for-authenticated-user Write
Unlock a user repository — github.migrations.unlock-repo-for-authenticated-user Write
List repositories for a user migration — github.migrations.list-repos-for-authenticated-user Read
List organizations for the authenticated user — github.orgs.list-for-authenticated-user Read
List packages for the authenticated user's namespace — github.packages.list-packages-for-authenticated-user Read
Get a package for the authenticated user — github.packages.get-package-for-authenticated-user Read
Delete a package for the authenticated user — github.packages.delete-package-for-authenticated-user Write
Restore a package for the authenticated user — github.packages.restore-package-for-authenticated-user Write
List package versions for a package owned by the authenticated user — github.packages.get-all-package-versions-for-package-owned-by-authenticated-user Read
Get a package version for the authenticated user — github.packages.get-package-version-for-authenticated-user Read
Delete a package version for the authenticated user — github.packages.delete-package-version-for-authenticated-user Write
Restore a package version for the authenticated user — github.packages.restore-package-version-for-authenticated-user Write
List public email addresses for the authenticated user — github.users.list-public-emails-for-authenticated-user Read
List repositories for the authenticated user — github.repos.list-for-authenticated-user Read
Create a repository for the authenticated user — github.repos.create-for-authenticated-user Write
List repository invitations for the authenticated user — github.repos.list-invitations-for-authenticated-user Read
Accept a repository invitation — github.repos.accept-invitation-for-authenticated-user Write
Decline a repository invitation — github.repos.decline-invitation-for-authenticated-user Write
List social accounts for the authenticated user — github.users.list-social-accounts-for-authenticated-user Read
Add social accounts for the authenticated user — github.users.add-social-account-for-authenticated-user Write
Delete social accounts for the authenticated user — github.users.delete-social-account-for-authenticated-user Write
List SSH signing keys for the authenticated user — github.users.list-ssh-signing-keys-for-authenticated-user Read
Get an SSH signing key for the authenticated user — github.users.get-ssh-signing-key-for-authenticated-user Read
Delete an SSH signing key for the authenticated user — github.users.delete-ssh-signing-key-for-authenticated-user Write
List repositories starred by the authenticated user — github.activity.list-repos-starred-by-authenticated-user Read
Check if a repository is starred by the authenticated user — github.activity.check-repo-is-starred-by-authenticated-user Read
Star a repository for the authenticated user — github.activity.star-repo-for-authenticated-user Write
Unstar a repository for the authenticated user — github.activity.unstar-repo-for-authenticated-user Write
List repositories watched by the authenticated user — github.activity.list-watched-repos-for-authenticated-user Read
List teams for the authenticated user — github.teams.list-for-authenticated-user Read
Get a user using their ID — github.users.get-by-id Read
Create draft item for user owned project — github.projects.create-draft-item-for-authenticated-user Write
List users — github.users.list Read
Create a view for a user-owned project — github.projects.create-view-for-user Write
Get a user — github.users.get-by-username Read
List attestations by bulk subject digests — github.users.list-attestations-bulk Write
Delete attestations in bulk — github.users.delete-attestations-bulk Write
Delete attestations by subject digest — github.users.delete-attestations-by-subject-digest Write
Delete attestations by ID — github.users.delete-attestations-by-id Write
List attestations — github.users.list-attestations Read
List Copilot Spaces for a user — github.copilot-spaces.list-for-user Read
Create a Copilot Space for a user — github.copilot-spaces.create-for-user Write
Get a Copilot Space for a user — github.copilot-spaces.get-for-user Read
Set a Copilot Space for a user — github.copilot-spaces.update-for-user Write
Delete a Copilot Space for a user — github.copilot-spaces.delete-for-user Write
List collaborators for a Copilot Space for a user — github.copilot-spaces.list-collaborators-for-user Read
Add a collaborator to a Copilot Space for a user — github.copilot-spaces.add-collaborator-for-user Write
Set a collaborator role for a Copilot Space for a user — github.copilot-spaces.update-collaborator-for-user Write
Remove a collaborator from a Copilot Space for a user — github.copilot-spaces.remove-collaborator-for-user Write
List resources for a Copilot Space for a user — github.copilot-spaces.list-resources-for-user Read
Create a resource for a Copilot Space for a user — github.copilot-spaces.create-resource-for-user Write
Get a resource for a Copilot Space for a user — github.copilot-spaces.get-resource-for-user Read
Set a resource for a Copilot Space for a user — github.copilot-spaces.update-resource-for-user Write
Delete a resource from a Copilot Space for a user — github.copilot-spaces.delete-resource-for-user Write
Get list of conflicting packages during Docker migration for user — github.packages.list-docker-migration-conflicting-packages-for-user Read
List events for the authenticated user — github.activity.list-events-for-authenticated-user Read
List organization events for the authenticated user — github.activity.list-org-events-for-authenticated-user Read
List public events for a user — github.activity.list-public-events-for-user Read
List followers of a user — github.users.list-followers-for-user Read
List the people a user follows — github.users.list-following-for-user Read
Check if a user follows another user — github.users.check-following-for-user Read
List gists for a user — github.gists.list-for-user Read
List GPG keys for a user — github.users.list-gpg-keys-for-user Read
Get contextual information for a user — github.users.get-context-for-user Read
Get a user installation for the authenticated app — github.apps.get-user-installation Read
List public keys for a user — github.users.list-public-keys-for-user Read
List organizations for a user — github.orgs.list-for-user Read
List packages for a user — github.packages.list-packages-for-user Read
Get a package for a user — github.packages.get-package-for-user Read
Delete a package for a user — github.packages.delete-package-for-user Write
Restore a package for a user — github.packages.restore-package-for-user Write
List package versions for a package owned by a user — github.packages.get-all-package-versions-for-package-owned-by-user Read
Get a package version for a user — github.packages.get-package-version-for-user Read
Delete package version for a user — github.packages.delete-package-version-for-user Write
Restore package version for a user — github.packages.restore-package-version-for-user Write
List projects for user — github.projects.list-for-user Read
Get project for user — github.projects.get-for-user Read
List project fields for user — github.projects.list-fields-for-user Read
Add field to user owned project — github.projects.add-field-for-user Write
Get project field for user — github.projects.get-field-for-user Read
List items for a user owned project — github.projects.list-items-for-user Read
Add item to user owned project — github.projects.add-item-for-user Write
Get an item for a user owned project — github.projects.get-user-item Read
Update project item for user — github.projects.update-item-for-user Write
Delete project item for user — github.projects.delete-item-for-user Write
List items for a user project view — github.projects.list-view-items-for-user Read
List events received by the authenticated user — github.activity.list-received-events-for-user Read
List public events received by a user — github.activity.list-received-public-events-for-user Read
List repositories for a user — github.repos.list-for-user Read
Get billing AI credit usage report for a user — github.billing.get-github-billing-ai-credit-usage-report-user Read
Get billing premium request usage report for a user — github.billing.get-github-billing-premium-request-usage-report-user Read
Get billing usage report for a user — github.billing.get-github-billing-usage-report-user Read
Get billing usage summary for a user — github.billing.get-github-billing-usage-summary-report-user Read
List social accounts for a user — github.users.list-social-accounts-for-user Read
List SSH signing keys for a user — github.users.list-ssh-signing-keys-for-user Read
List repositories starred by a user — github.activity.list-repos-starred-by-user Read
List repositories watched by a user — github.activity.list-repos-watched-by-user Read
Get all API versions — github.meta.get-all-versions Read
Get the Zen of GitHub — github.meta.get-zen Read

Connect and use

Connect and use

This connection uses your provider account.

Connect this integration, enter your provider credentials, choose commands and save. Complete provider authorization if prompted.

Get your provider credentials

Follow these steps for GitHub, then enter the issued values in the connection form below.

  1. In GitHub Settings, open Developer settings → Personal access tokens → Fine-grained tokens. Select a resource owner, only the repositories and permissions you need, and an expiry; generate the token and paste it into this connection’s GitHub access token field. Organization approval may be required. Then enable the commands for your client API key. Never paste your GitHub token into an MCP URL or client configuration.

Official credential setup

Where to enter credentials

In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.

Connection field Requirement
GitHub access token Required

Open API keys and create a Tooluse.net key for the enabled commands.

Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.

Configure Claude Code, Codex or Cursor once

Permissions and results

If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.

Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.

Call from your client

Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.

Configure Claude Code, Codex or Cursor once

Discover your enabled tools

List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.

curl 'https://api.tooluse.net/v1/tools' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"

Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.

HTTP call

curl 'https://api.tooluse.net/v1/tool-calls' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: replace-with-a-new-call-id' \
  --data '{
  "type": "tool_use",
  "id": "toolu_example",
  "name": "svc_FROM_YOUR_TOOL_LIST",
  "input": {}
}'

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Commands

GitHub API Root — github.meta.root

Get Hypermedia links to resources accessible in GitHub's REST API

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List global security advisories — github.security-advisories.list-global-advisories

Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.ghsa_id string Optional If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.
query.type string Optional If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware. enum: ["reviewed","malware","unreviewed"]; default: "reviewed"
query.cve_id string Optional If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.
query.ecosystem — Optional If specified, only advisories for these ecosystems will be returned. $ref: "#/definitions/security-advisory-ecosystems"
query.severity string Optional If specified, only advisories with these severities will be returned. enum: ["unknown","low","medium","high","critical"]
query.cwes — Optional If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. Example: cwes=79,284,22 or cwes[]=79&cwes[]=284&cwes[]=22
query.cwes string Optional oneOf[1]
query.cwes array Optional oneOf[2]
query.cwes[] string Optional oneOf[2]
query.is_withdrawn boolean Optional Whether to only return advisories that have been withdrawn.
query.affects — Optional If specified, only return advisories that affect any of package or package@version. A maximum of 1000 packages can be specified. If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. Example: affects=package1,[email protected],[email protected] or affects[]=package1&affects[][email protected]
query.affects string Optional oneOf[1]
query.affects array Optional oneOf[2]; maxItems: 1000
query.affects[] string Optional oneOf[2]
query.published string Optional If specified, only return advisories that were published on a date or date range. For more information on the syntax of the date range, see "Understanding the search syntax."
query.updated string Optional If specified, only return advisories that were updated on a date or date range. For more information on the syntax of the date range, see "Understanding the search syntax."
query.modified string Optional If specified, only show advisories that were updated or published on a date or date range. For more information on the syntax of the date range, see "Understanding the search syntax."
query.epss_percentage string Optional If specified, only return advisories that have an EPSS percentage score that matches the provided value. The EPSS percentage represents the likelihood of a CVE being exploited.
query.epss_percentile string Optional If specified, only return advisories that have an EPSS percentile score that matches the provided value. The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30; minimum: 1; maximum: 100
query.sort string Optional The property to sort the results by. enum: ["updated","published","epss_percentage","epss_percentile"]; default: "published"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a global security advisory — github.security-advisories.get-global-advisory

Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ghsa_id string Required The GHSA (GitHub Security Advisory) identifier of the advisory.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ghsa_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List automations for user — github.agent-automations.list-automations

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. default: 1; minimum: 1
query.per_page integer Optional The number of results per page (max 100). default: 30; minimum: 1; maximum: 100
query.type string Optional Filter automations by type. personal returns automations owned by their creator, shared returns automations owned by the repository. Omit to return both. enum: ["personal","shared"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List automations for a repository — github.agent-automations.list-repo-automations

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository. The name is not case sensitive.
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. default: 1; minimum: 1
query.per_page integer Optional The number of results per page (max 100). default: 30; minimum: 1; maximum: 100
query.type string Optional Filter automations by type. personal returns automations owned by their creator, shared returns automations owned by the repository. Omit to return both. enum: ["personal","shared"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an automation for a repository — github.agent-automations.create-repo-automation

> [!NOTE] > This endpoint is in public preview and is subject to change.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository. The name is not case sensitive.
body object Required Request body for creating an automation.
body.name string Required The name of the automation.
body.triggers object Optional Trigger configuration for the automation. additionalProperties: false
body.triggers.interval object Optional additionalProperties: false
body.triggers.interval.cadence array Required One or more schedules on which the Automation runs. minItems: 1; uniqueItems: true
body.triggers.interval.cadence[] string Optional enum: ["hourly","daily","weekly"]
body.triggers.interval.hour_utc integer Optional UTC hour anchor (0 through 23) for daily and weekly schedules. Omitted daily and weekly values default to 0 (midnight UTC). minimum: 0; maximum: 23
body.triggers.interval.day_of_week integer Optional UTC weekday anchor for weekly schedules, where 0 is Sunday and 6 is Saturday. Omitted weekly values default to Monday (1). minimum: 0; maximum: 6
body.triggers.interval.minute_utc integer Optional UTC minute anchor for daily and weekly schedules. Omitted daily and weekly values default to 0. Must be omitted whenever cadence includes hourly. enum: [0,15,30,45]; default: 0
body.triggers.interval.write_scope string Optional Has no effect: scheduled runs can change any resource in the repository, and an organization or repository policy requiring trigger-scoped writes does not apply to them. enum: ["trigger","repository"]
body.triggers.interval.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.issue_opened object Optional additionalProperties: false
body.triggers.issue_opened.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.issue_opened.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.issue_opened.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.issue_labeled object Optional additionalProperties: false
body.triggers.issue_labeled.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.issue_labeled.labels array Optional Label names matched case-insensitively against the label added by the event. Omit or use an empty array to match every added label. uniqueItems: true
body.triggers.issue_labeled.labels[] string Optional
body.triggers.issue_labeled.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.issue_labeled.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.workflow_run object Optional additionalProperties: false
body.triggers.workflow_run.workflows array Required Workflow names matched against the name in each workflow YAML file. minItems: 1
body.triggers.workflow_run.workflows[] string Optional minLength: 1
body.triggers.workflow_run.conclusions array Required Workflow conclusions to match. The current trigger supports failure. minItems: 1; maxItems: 1
body.triggers.workflow_run.conclusions[] string Optional enum: ["failure"]
body.triggers.workflow_run.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.workflow_run.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.workflow_run.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_opened object Optional additionalProperties: false
body.triggers.pull_request_opened.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_opened.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_opened.paths[] string Optional minLength: 1
body.triggers.pull_request_opened.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_opened.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_synchronize object Optional additionalProperties: false
body.triggers.pull_request_synchronize.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_synchronize.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_synchronize.paths[] string Optional minLength: 1
body.triggers.pull_request_synchronize.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_synchronize.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_merged object Optional additionalProperties: false
body.triggers.pull_request_merged.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_merged.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_merged.paths[] string Optional minLength: 1
body.triggers.pull_request_merged.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_merged.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.issue_comment object Optional additionalProperties: false
body.triggers.issue_comment.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.issue_comment.body_substring string Optional A case-insensitive substring matched against the event body.
body.triggers.issue_comment.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.issue_comment.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_comment object Optional additionalProperties: false
body.triggers.pull_request_comment.comment_types array Required Pull request conversation and inline review comment types to match. minItems: 1; maxItems: 2; uniqueItems: true
body.triggers.pull_request_comment.comment_types[] string Optional enum: ["timeline_comment","review_comment"]
body.triggers.pull_request_comment.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_comment.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_comment.paths[] string Optional minLength: 1
body.triggers.pull_request_comment.body_substring string Optional A case-insensitive substring matched against the event body.
body.triggers.pull_request_comment.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_comment.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.discussion_opened object Optional additionalProperties: false
body.triggers.discussion_opened.categories array Optional Discussion category names matched case-insensitively. minItems: 1; uniqueItems: true
body.triggers.discussion_opened.categories[] string Optional
body.triggers.discussion_opened.body_substring string Optional A case-insensitive substring matched against the event body.
body.triggers.discussion_opened.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.discussion_opened.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.discussion_updated object Optional additionalProperties: false
body.triggers.discussion_updated.categories array Optional Discussion category names matched case-insensitively. minItems: 1; uniqueItems: true
body.triggers.discussion_updated.categories[] string Optional
body.triggers.discussion_updated.body_substring string Optional A case-insensitive substring matched against the event body.
body.triggers.discussion_updated.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.discussion_updated.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.discussion_comment object Optional additionalProperties: false
body.triggers.discussion_comment.comment_types array Optional Top-level discussion comments and replies to match. Omit to match both. minItems: 1; maxItems: 2; uniqueItems: true
body.triggers.discussion_comment.comment_types[] string Optional enum: ["comment","reply"]
body.triggers.discussion_comment.categories array Optional Discussion category names matched case-insensitively. minItems: 1; uniqueItems: true
body.triggers.discussion_comment.categories[] string Optional
body.triggers.discussion_comment.body_substring string Optional A case-insensitive substring matched against the event body.
body.triggers.discussion_comment.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.discussion_comment.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.issue_assigned object Optional additionalProperties: false
body.triggers.issue_assigned.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.issue_assigned.assignees array Optional Affected assignee logins matched case-insensitively. minItems: 1; uniqueItems: true
body.triggers.issue_assigned.assignees[] string Optional
body.triggers.issue_assigned.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.issue_assigned.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_assigned object Optional additionalProperties: false
body.triggers.pull_request_assigned.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_assigned.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_assigned.paths[] string Optional minLength: 1
body.triggers.pull_request_assigned.assignees array Optional Affected assignee logins matched case-insensitively. minItems: 1; uniqueItems: true
body.triggers.pull_request_assigned.assignees[] string Optional
body.triggers.pull_request_assigned.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_assigned.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.sub_issue_added object Optional additionalProperties: false
body.triggers.sub_issue_added.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.sub_issue_added.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.sub_issue_added.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_ready_for_review object Optional additionalProperties: false
body.triggers.pull_request_ready_for_review.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_ready_for_review.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_ready_for_review.paths[] string Optional minLength: 1
body.triggers.pull_request_ready_for_review.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_ready_for_review.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_labeled object Optional additionalProperties: false
body.triggers.pull_request_labeled.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_labeled.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_labeled.paths[] string Optional minLength: 1
body.triggers.pull_request_labeled.labels array Optional Label names matched case-insensitively against the label added by the event. Omit or use an empty array to match every added label. uniqueItems: true
body.triggers.pull_request_labeled.labels[] string Optional
body.triggers.pull_request_labeled.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_labeled.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_merge_conflict object Optional additionalProperties: false
body.triggers.pull_request_merge_conflict.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_merge_conflict.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_merge_conflict.paths[] string Optional minLength: 1
body.triggers.pull_request_merge_conflict.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_merge_conflict.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_review_submitted object Optional additionalProperties: false
body.triggers.pull_request_review_submitted.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_review_submitted.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_review_submitted.paths[] string Optional minLength: 1
body.triggers.pull_request_review_submitted.states array Required Submitted review states to match. minItems: 1; maxItems: 3; uniqueItems: true
body.triggers.pull_request_review_submitted.states[] string Optional enum: ["approved","changes_requested","commented"]
body.triggers.pull_request_review_submitted.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_review_submitted.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_review_requested object Optional additionalProperties: false
body.triggers.pull_request_review_requested.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_review_requested.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_review_requested.paths[] string Optional minLength: 1
body.triggers.pull_request_review_requested.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_review_requested.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.issue_closed object Optional additionalProperties: false
body.triggers.issue_closed.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.issue_closed.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.issue_closed.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.issue_reopened object Optional additionalProperties: false
body.triggers.issue_reopened.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.issue_reopened.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.issue_reopened.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_closed object Optional additionalProperties: false
body.triggers.pull_request_closed.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_closed.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_closed.paths[] string Optional minLength: 1
body.triggers.pull_request_closed.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_closed.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_reopened object Optional additionalProperties: false
body.triggers.pull_request_reopened.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_reopened.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_reopened.paths[] string Optional minLength: 1
body.triggers.pull_request_reopened.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_reopened.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_converted_to_draft object Optional additionalProperties: false
body.triggers.pull_request_converted_to_draft.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_converted_to_draft.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_converted_to_draft.paths[] string Optional minLength: 1
body.triggers.pull_request_converted_to_draft.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_converted_to_draft.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_review_dismissed object Optional additionalProperties: false
body.triggers.pull_request_review_dismissed.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_review_dismissed.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_review_dismissed.paths[] string Optional minLength: 1
body.triggers.pull_request_review_dismissed.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_review_dismissed.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_review_thread_resolved object Optional additionalProperties: false
body.triggers.pull_request_review_thread_resolved.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_review_thread_resolved.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_review_thread_resolved.paths[] string Optional minLength: 1
body.triggers.pull_request_review_thread_resolved.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_review_thread_resolved.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_review_thread_unresolved object Optional additionalProperties: false
body.triggers.pull_request_review_thread_unresolved.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_review_thread_unresolved.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_review_thread_unresolved.paths[] string Optional minLength: 1
body.triggers.pull_request_review_thread_unresolved.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_review_thread_unresolved.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.automation_completed object Optional additionalProperties: false
body.triggers.automation_completed.automation_ids array Required Upstream Automation IDs in the same repository. minItems: 1; maxItems: 3; uniqueItems: true
body.triggers.automation_completed.automation_ids[] string Optional
body.triggers.automation_completed.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.automation_completed.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.automation_failed object Optional additionalProperties: false
body.triggers.automation_failed.automation_ids array Required Upstream Automation IDs in the same repository. An Automation cannot list itself, and a user-owned Automation can only be listed by its creator's user-owned Automations. minItems: 1; maxItems: 3; uniqueItems: true
body.triggers.automation_failed.automation_ids[] string Optional
body.triggers.automation_failed.reasons array Optional Failure reasons to match. Omit to match only reported failures. minItems: 1; maxItems: 3; uniqueItems: true
body.triggers.automation_failed.reasons[] string Optional enum: ["reported","crashed","timed_out"]
body.triggers.automation_failed.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.automation_failed.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.code_scanning_alert object Optional Runs on the default branch when a security alert of this kind is created in the repository. These are system events without an issue, pull request, or human actor, and cannot be run manually. additionalProperties: false
body.triggers.code_scanning_alert.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.code_scanning_alert.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.secret_scanning_alert object Optional Runs on the default branch when a security alert of this kind is created in the repository. These are system events without an issue, pull request, or human actor, and cannot be run manually. additionalProperties: false
body.triggers.secret_scanning_alert.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.secret_scanning_alert.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.dependabot_alert object Optional Runs on the default branch when a security alert of this kind is created in the repository. These are system events without an issue, pull request, or human actor, and cannot be run manually. additionalProperties: false
body.triggers.dependabot_alert.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.dependabot_alert.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.prompt string Required The prompt for the automation. maxLength: 10000
body.model string Optional The model to use for sessions triggered by this automation. Omit or leave empty to let the platform select the model.
body.reasoning_effort — Optional The reasoning effort to use for sessions triggered by this automation. Omit or leave empty to use the model's default.
body.reasoning_effort string Optional oneOf[1]; maxLength: 0
body.reasoning_effort string Optional oneOf[2]; enum: ["none","low","medium","high","xhigh","max"]
body.tools array Optional The tools available to the automation.
body.tools[] string Optional
body.enabled boolean Optional Whether the automation should be created enabled. Defaults to true when omitted. default: true
body.type string Optional The type of automation, fixed at creation. personal keeps it private to its creator and its runs act as that user. shared makes it belong to the repository, visible to anyone with read access to the repository and maintainable by anyone with write access to the repository, and its runs act as the Copilot app rather than as a person. shared is rejected when repository ownership is not available for the repository. Supported values: personal, shared. Defaults to personal. enum: ["personal","shared"]; default: "personal"
body.require_actor_write_permission boolean Optional When true, event-triggered runs require the event actor to have repo write permission, even when the org's allow_read_access_triggers policy is enabled. When policy validation is enabled, explicitly setting false returns 422 if effective organization or repository policy disallows read-access triggers. If omitted, defaults to false when policy permits read-access triggers, otherwise true. The actor requirement does not apply to interval-scheduled runs, which always run as the automation owner.
body.continuous_history boolean Optional When true, runs of this automation build on the session history of its previous runs, and runs of the same automation are serialized. Not tracked in revision history. Defaults to false.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "name": "Issue triage",
    "type": "personal",
    "triggers": {
      "issue_opened": {
        "query": "is:open"
      }
    },
    "prompt": "Inspect the new issue and suggest labels, priority, and next steps.",
    "tools": [
      "github/get_file_contents",
      "github/issue_read"
    ],
    "model": "gpt-6-sol",
    "reasoning_effort": "high"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List available automation tools for a repository — github.agent-automations.list-available-repo-automation-tools

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List available automation triggers for a repository — github.agent-automations.list-available-repo-automation-triggers

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an automation — github.agent-automations.get-repo-automation

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository. The name is not case sensitive.
path.automation_id string Required The unique identifier of the automation.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "automation_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an automation — github.agent-automations.edit-repo-automation

> [!NOTE] > This endpoint is in public preview and is subject to change.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository. The name is not case sensitive.
path.automation_id string Required The unique identifier of the automation.
body object Required Request body for editing an automation. Omitted fields are left unchanged. Explicit null values are rejected.
body.name string Optional The name of the automation.
body.enabled boolean Optional Set to true to enable, false to disable. Omit to leave unchanged.
body.require_actor_write_permission boolean Optional When true, event-triggered runs require the event actor to have repo write permission, even when the org's allow_read_access_triggers policy is enabled. When policy validation is enabled, explicitly setting false returns 422 if effective organization or repository policy disallows read-access triggers. The actor requirement does not apply to interval-scheduled runs, which always run as the automation owner. Omit to leave unchanged.
body.continuous_history boolean Optional When true, runs of this automation build on the session history of its previous runs, and runs of the same automation are serialized. Not tracked in revision history. Omit to leave unchanged.
body.model string Optional The model to use for sessions triggered by this automation. Omit to leave unchanged. Send an empty string to clear the override and let the platform select the model.
body.reasoning_effort — Optional The reasoning effort to use for sessions triggered by this automation. Omit to leave unchanged. Send an empty string to clear the override and use the model's default.
body.reasoning_effort string Optional oneOf[1]; maxLength: 0
body.reasoning_effort string Optional oneOf[2]; enum: ["none","low","medium","high","xhigh","max"]
body.triggers object Optional Trigger configuration for the automation. additionalProperties: false
body.triggers.interval object Optional additionalProperties: false
body.triggers.interval.cadence array Required One or more schedules on which the Automation runs. minItems: 1; uniqueItems: true
body.triggers.interval.cadence[] string Optional enum: ["hourly","daily","weekly"]
body.triggers.interval.hour_utc integer Optional UTC hour anchor (0 through 23) for daily and weekly schedules. Omitted daily and weekly values default to 0 (midnight UTC). minimum: 0; maximum: 23
body.triggers.interval.day_of_week integer Optional UTC weekday anchor for weekly schedules, where 0 is Sunday and 6 is Saturday. Omitted weekly values default to Monday (1). minimum: 0; maximum: 6
body.triggers.interval.minute_utc integer Optional UTC minute anchor for daily and weekly schedules. Omitted daily and weekly values default to 0. Must be omitted whenever cadence includes hourly. enum: [0,15,30,45]; default: 0
body.triggers.interval.write_scope string Optional Has no effect: scheduled runs can change any resource in the repository, and an organization or repository policy requiring trigger-scoped writes does not apply to them. enum: ["trigger","repository"]
body.triggers.interval.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.issue_opened object Optional additionalProperties: false
body.triggers.issue_opened.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.issue_opened.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.issue_opened.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.issue_labeled object Optional additionalProperties: false
body.triggers.issue_labeled.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.issue_labeled.labels array Optional Label names matched case-insensitively against the label added by the event. Omit or use an empty array to match every added label. uniqueItems: true
body.triggers.issue_labeled.labels[] string Optional
body.triggers.issue_labeled.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.issue_labeled.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.workflow_run object Optional additionalProperties: false
body.triggers.workflow_run.workflows array Required Workflow names matched against the name in each workflow YAML file. minItems: 1
body.triggers.workflow_run.workflows[] string Optional minLength: 1
body.triggers.workflow_run.conclusions array Required Workflow conclusions to match. The current trigger supports failure. minItems: 1; maxItems: 1
body.triggers.workflow_run.conclusions[] string Optional enum: ["failure"]
body.triggers.workflow_run.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.workflow_run.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.workflow_run.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_opened object Optional additionalProperties: false
body.triggers.pull_request_opened.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_opened.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_opened.paths[] string Optional minLength: 1
body.triggers.pull_request_opened.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_opened.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_synchronize object Optional additionalProperties: false
body.triggers.pull_request_synchronize.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_synchronize.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_synchronize.paths[] string Optional minLength: 1
body.triggers.pull_request_synchronize.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_synchronize.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_merged object Optional additionalProperties: false
body.triggers.pull_request_merged.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_merged.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_merged.paths[] string Optional minLength: 1
body.triggers.pull_request_merged.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_merged.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.issue_comment object Optional additionalProperties: false
body.triggers.issue_comment.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.issue_comment.body_substring string Optional A case-insensitive substring matched against the event body.
body.triggers.issue_comment.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.issue_comment.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_comment object Optional additionalProperties: false
body.triggers.pull_request_comment.comment_types array Required Pull request conversation and inline review comment types to match. minItems: 1; maxItems: 2; uniqueItems: true
body.triggers.pull_request_comment.comment_types[] string Optional enum: ["timeline_comment","review_comment"]
body.triggers.pull_request_comment.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_comment.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_comment.paths[] string Optional minLength: 1
body.triggers.pull_request_comment.body_substring string Optional A case-insensitive substring matched against the event body.
body.triggers.pull_request_comment.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_comment.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.discussion_opened object Optional additionalProperties: false
body.triggers.discussion_opened.categories array Optional Discussion category names matched case-insensitively. minItems: 1; uniqueItems: true
body.triggers.discussion_opened.categories[] string Optional
body.triggers.discussion_opened.body_substring string Optional A case-insensitive substring matched against the event body.
body.triggers.discussion_opened.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.discussion_opened.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.discussion_updated object Optional additionalProperties: false
body.triggers.discussion_updated.categories array Optional Discussion category names matched case-insensitively. minItems: 1; uniqueItems: true
body.triggers.discussion_updated.categories[] string Optional
body.triggers.discussion_updated.body_substring string Optional A case-insensitive substring matched against the event body.
body.triggers.discussion_updated.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.discussion_updated.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.discussion_comment object Optional additionalProperties: false
body.triggers.discussion_comment.comment_types array Optional Top-level discussion comments and replies to match. Omit to match both. minItems: 1; maxItems: 2; uniqueItems: true
body.triggers.discussion_comment.comment_types[] string Optional enum: ["comment","reply"]
body.triggers.discussion_comment.categories array Optional Discussion category names matched case-insensitively. minItems: 1; uniqueItems: true
body.triggers.discussion_comment.categories[] string Optional
body.triggers.discussion_comment.body_substring string Optional A case-insensitive substring matched against the event body.
body.triggers.discussion_comment.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.discussion_comment.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.issue_assigned object Optional additionalProperties: false
body.triggers.issue_assigned.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.issue_assigned.assignees array Optional Affected assignee logins matched case-insensitively. minItems: 1; uniqueItems: true
body.triggers.issue_assigned.assignees[] string Optional
body.triggers.issue_assigned.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.issue_assigned.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_assigned object Optional additionalProperties: false
body.triggers.pull_request_assigned.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_assigned.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_assigned.paths[] string Optional minLength: 1
body.triggers.pull_request_assigned.assignees array Optional Affected assignee logins matched case-insensitively. minItems: 1; uniqueItems: true
body.triggers.pull_request_assigned.assignees[] string Optional
body.triggers.pull_request_assigned.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_assigned.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.sub_issue_added object Optional additionalProperties: false
body.triggers.sub_issue_added.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.sub_issue_added.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.sub_issue_added.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_ready_for_review object Optional additionalProperties: false
body.triggers.pull_request_ready_for_review.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_ready_for_review.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_ready_for_review.paths[] string Optional minLength: 1
body.triggers.pull_request_ready_for_review.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_ready_for_review.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_labeled object Optional additionalProperties: false
body.triggers.pull_request_labeled.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_labeled.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_labeled.paths[] string Optional minLength: 1
body.triggers.pull_request_labeled.labels array Optional Label names matched case-insensitively against the label added by the event. Omit or use an empty array to match every added label. uniqueItems: true
body.triggers.pull_request_labeled.labels[] string Optional
body.triggers.pull_request_labeled.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_labeled.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_merge_conflict object Optional additionalProperties: false
body.triggers.pull_request_merge_conflict.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_merge_conflict.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_merge_conflict.paths[] string Optional minLength: 1
body.triggers.pull_request_merge_conflict.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_merge_conflict.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_review_submitted object Optional additionalProperties: false
body.triggers.pull_request_review_submitted.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_review_submitted.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_review_submitted.paths[] string Optional minLength: 1
body.triggers.pull_request_review_submitted.states array Required Submitted review states to match. minItems: 1; maxItems: 3; uniqueItems: true
body.triggers.pull_request_review_submitted.states[] string Optional enum: ["approved","changes_requested","commented"]
body.triggers.pull_request_review_submitted.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_review_submitted.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_review_requested object Optional additionalProperties: false
body.triggers.pull_request_review_requested.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_review_requested.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_review_requested.paths[] string Optional minLength: 1
body.triggers.pull_request_review_requested.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_review_requested.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.issue_closed object Optional additionalProperties: false
body.triggers.issue_closed.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.issue_closed.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.issue_closed.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.issue_reopened object Optional additionalProperties: false
body.triggers.issue_reopened.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.issue_reopened.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.issue_reopened.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_closed object Optional additionalProperties: false
body.triggers.pull_request_closed.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_closed.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_closed.paths[] string Optional minLength: 1
body.triggers.pull_request_closed.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_closed.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_reopened object Optional additionalProperties: false
body.triggers.pull_request_reopened.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_reopened.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_reopened.paths[] string Optional minLength: 1
body.triggers.pull_request_reopened.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_reopened.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_converted_to_draft object Optional additionalProperties: false
body.triggers.pull_request_converted_to_draft.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_converted_to_draft.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_converted_to_draft.paths[] string Optional minLength: 1
body.triggers.pull_request_converted_to_draft.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_converted_to_draft.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_review_dismissed object Optional additionalProperties: false
body.triggers.pull_request_review_dismissed.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_review_dismissed.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_review_dismissed.paths[] string Optional minLength: 1
body.triggers.pull_request_review_dismissed.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_review_dismissed.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_review_thread_resolved object Optional additionalProperties: false
body.triggers.pull_request_review_thread_resolved.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_review_thread_resolved.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_review_thread_resolved.paths[] string Optional minLength: 1
body.triggers.pull_request_review_thread_resolved.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_review_thread_resolved.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.pull_request_review_thread_unresolved object Optional additionalProperties: false
body.triggers.pull_request_review_thread_unresolved.query string Optional A GitHub issue or pull request search query. minLength: 1
body.triggers.pull_request_review_thread_unresolved.paths array Optional Gitignore-style changed-file path globs. minItems: 1
body.triggers.pull_request_review_thread_unresolved.paths[] string Optional minLength: 1
body.triggers.pull_request_review_thread_unresolved.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.pull_request_review_thread_unresolved.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.automation_completed object Optional additionalProperties: false
body.triggers.automation_completed.automation_ids array Required Upstream Automation IDs in the same repository. minItems: 1; maxItems: 3; uniqueItems: true
body.triggers.automation_completed.automation_ids[] string Optional
body.triggers.automation_completed.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.automation_completed.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.automation_failed object Optional additionalProperties: false
body.triggers.automation_failed.automation_ids array Required Upstream Automation IDs in the same repository. An Automation cannot list itself, and a user-owned Automation can only be listed by its creator's user-owned Automations. minItems: 1; maxItems: 3; uniqueItems: true
body.triggers.automation_failed.automation_ids[] string Optional
body.triggers.automation_failed.reasons array Optional Failure reasons to match. Omit to match only reported failures. minItems: 1; maxItems: 3; uniqueItems: true
body.triggers.automation_failed.reasons[] string Optional enum: ["reported","crashed","timed_out"]
body.triggers.automation_failed.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.automation_failed.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.code_scanning_alert object Optional Runs on the default branch when a security alert of this kind is created in the repository. These are system events without an issue, pull request, or human actor, and cannot be run manually. additionalProperties: false
body.triggers.code_scanning_alert.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.code_scanning_alert.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.secret_scanning_alert object Optional Runs on the default branch when a security alert of this kind is created in the repository. These are system events without an issue, pull request, or human actor, and cannot be run manually. additionalProperties: false
body.triggers.secret_scanning_alert.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.secret_scanning_alert.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.triggers.dependabot_alert object Optional Runs on the default branch when a security alert of this kind is created in the repository. These are system events without an issue, pull request, or human actor, and cannot be run manually. additionalProperties: false
body.triggers.dependabot_alert.write_scope string Optional Override the Automation write_scope for runs started by this trigger. If omitted, the automation's write_scope is used. Organization or repository policy may restrict the effective scope to trigger. Explicitly setting repository on create or edit returns 422 when policy validation is enabled and that policy applies. enum: ["trigger","repository"]
body.triggers.dependabot_alert.allow_copilot_triggers boolean Optional When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body.prompt string Optional The prompt for the automation. maxLength: 10000
body.tools array Optional The tools available to the automation. Send an empty array to clear all tools.
body.tools[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "automation_id": "example"
  },
  "body": {
    "name": "Issue triage and prioritization",
    "enabled": true,
    "model": "gpt-5.4",
    "reasoning_effort": "high",
    "triggers": {
      "issue_opened": {
        "query": "is:open label:auto-triage"
      }
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an automation — github.agent-automations.delete-repo-automation

> [!NOTE] > This endpoint is in public preview and is subject to change.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository. The name is not case sensitive.
path.automation_id string Required The unique identifier of the automation.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "automation_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tasks for an automation in a repository — github.agent-automations.list-repo-automation-tasks

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository. The name is not case sensitive.
path.automation_id string Required The unique identifier of the automation.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). default: 30; minimum: 1; maximum: 100
query.page integer Optional The page number of the results to fetch. default: 1; minimum: 1
query.sort string Optional The field to sort results by. Can be updated_at or created_at. enum: ["updated_at","created_at"]; default: "updated_at"
query.direction string Optional The direction to sort results. Can be asc or desc. enum: ["asc","desc"]; default: "desc"
query.state string Optional Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.
query.is_archived boolean Optional Filter by archived status. When true, returns only archived tasks. When false or omitted, returns only non-archived tasks. Defaults to false. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "automation_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Run an automation — github.agent-automations.create-repo-automation-task

> [!NOTE] > This endpoint is in public preview and is subject to change.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository. The name is not case sensitive.
path.automation_id string Required The unique identifier of the automation.
body object Required Request body for requesting an automation run.
body.event string Required The event to trigger. Only manual is supported. enum: ["manual"]
body.context string Optional Additional context for this automation run, up to 10,000 characters. Supported only when event is manual. The context supplements the automation's configured instructions. maxLength: 10000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "automation_id": "example"
  },
  "body": {
    "event": "manual",
    "context": "New Sentry issue detected: https://contoso.sentry.io/issues/7796648726"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Agent Merge configuration for a pull request — github.agent-merge.get-agent-merge-enrollment

Gets the Agent Merge configuration for a pull request.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request. minimum: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 42
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Agent Merge configuration for a pull request — github.agent-merge.put-agent-merge-enrollment

Updates the Agent Merge configuration for a pull request, enabling Agent Merge or changing the allowed actions that Copilot is allowed to take on the pull request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request. minimum: 1
body object Required The Agent Merge enrollment configuration additionalProperties: false
body.allowed_actions array Required The set of actions that Copilot may perform on the pull request. minItems: 1; uniqueItems: true
body.allowed_actions[] string Optional An action that Agent Merge is explicitly allowed to perform. enum: ["fix_ci","resolve_merge_conflicts"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 42
  },
  "body": {
    "allowed_actions": [
      "fix_ci"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disable Agent Merge for a pull request — github.agent-merge.delete-agent-merge-enrollment

Disables Agent Merge for a pull request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request. minimum: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 42
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tasks for repository — github.agent-tasks.list-tasks-for-repo

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). default: 30; minimum: 1; maximum: 100
query.page integer Optional The page number of the results to fetch. default: 1; minimum: 1
query.sort string Optional The field to sort results by. Can be updated_at or created_at. enum: ["updated_at","created_at"]; default: "updated_at"
query.direction string Optional The direction to sort results. Can be asc or desc. enum: ["asc","desc"]; default: "desc"
query.state string Optional Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.
query.is_archived boolean Optional Filter by archived status. When true, returns only archived tasks. When false or omitted, returns only non-archived tasks. Defaults to false. default: false
query.since string Optional Only show tasks updated at or after this time (ISO 8601 timestamp) format: "date-time"
query.creator_id array Optional Filter tasks by creator user ID. Accepts one or more user IDs.
query.creator_id[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start a task — github.agent-tasks.create-task-in-repo

> [!NOTE] > This endpoint is in public preview and is subject to change.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository. The name is not case sensitive.
body object Required
body.prompt string Required The user's prompt for the agent
body.model string Optional The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: claude-sonnet-4.6, claude-opus-4.6, gpt-5.2-codex, gpt-5.3-codex, gpt-5.4, claude-sonnet-4.5, claude-opus-4.5
body.custom_agent string Optional Optional identifier for a custom agent to use for this task. Use the custom agent's filename without the extension - for example, for a .github/agents/performance-optimizer.agent.md custom agent, use performance-optimizer.
body.create_pull_request boolean Optional Whether to create a PR. default: false
body.base_ref string Optional Base ref for new branch/PR
body.head_ref string Optional Head ref for existing branch/PR. If provided with base_ref, the agent looks up open PR context for head_ref targeting base_ref and commits to head_ref instead of creating a new branch.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "prompt": "Fix the login button on the homepage",
    "base_ref": "main"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a task by repo — github.agent-tasks.get-task-by-repo-and-id

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository. The name is not case sensitive.
path.task_id string Required The unique identifier of the task.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "task_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tasks — github.agent-tasks.list-tasks

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). default: 30; minimum: 1; maximum: 100
query.page integer Optional The page number of the results to fetch. default: 1; minimum: 1
query.sort string Optional The field to sort results by. Can be updated_at or created_at. enum: ["updated_at","created_at"]; default: "updated_at"
query.direction string Optional The direction to sort results. Can be asc or desc. enum: ["asc","desc"]; default: "desc"
query.state string Optional Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.
query.is_archived boolean Optional Filter by archived status. When true, returns only archived tasks. When false or omitted, returns only non-archived tasks. Defaults to false. default: false
query.since string Optional Only show tasks updated at or after this time (ISO 8601 timestamp) format: "date-time"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a task by ID — github.agent-tasks.get-task-by-id

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.task_id string Required The unique identifier of the task.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "task_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the authenticated app — github.apps.get-authenticated

Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the "List installations for the authenticated app" endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a GitHub App from a manifest — github.apps.create-from-manifest

Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. When you create a GitHub App with the manifest flow, you receive a temporary code used to retrieve the GitHub App's id, pem (private key), and webhook_secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.code string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "code": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a webhook configuration for an app — github.apps.get-webhook-config-for-app

Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "Creating a GitHub App."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a webhook configuration for an app — github.apps.update-webhook-config-for-app

Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "Creating a GitHub App."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Required
body.url — Optional $ref: "#/definitions/webhook-config-url"
body.content_type — Optional $ref: "#/definitions/webhook-config-content-type"
body.secret — Optional $ref: "#/definitions/webhook-config-secret"
body.insecure_ssl — Optional $ref: "#/definitions/webhook-config-insecure-ssl"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "content_type": "json",
    "insecure_ssl": "0",
    "secret": "********",
    "url": "https://example.com/webhook"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List deliveries for an app webhook — github.apps.list-webhook-deliveries

Returns a list of webhook deliveries for the webhook configured for a GitHub App.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.cursor string Optional Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the link header for the next and previous page cursors.
query.status string Optional Returns webhook deliveries filtered by delivery outcome classification based on status_code range. A status of success returns deliveries with a status_code in the 200-399 range (inclusive). A status of failure returns deliveries with a status_code in the 400-599 range (inclusive). enum: ["success","failure"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a delivery for an app webhook — github.apps.get-webhook-delivery

Returns a delivery for the webhook configured for a GitHub App.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.delivery_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "delivery_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Redeliver a delivery for an app webhook — github.apps.redeliver-webhook-delivery

Redeliver a delivery for the webhook configured for a GitHub App.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.delivery_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "delivery_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List installation requests for the authenticated app — github.apps.list-installation-requests-for-authenticated-app

Lists all the pending installation requests for the authenticated GitHub App.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List installations for the authenticated app — github.apps.list-installations

The permissions the installation has are included under the permissions key.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.since string Optional Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.outdated string Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an installation for the authenticated app — github.apps.get-installation

Enables an authenticated GitHub App to find an installation's information using the installation id.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.installation_id integer Required The unique identifier of the installation.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "installation_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an installation for the authenticated app — github.apps.delete-installation

Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "Suspend an app installation" endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.installation_id integer Required The unique identifier of the installation.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "installation_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an installation access token for an app — github.apps.create-installation-access-token

Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.installation_id integer Required The unique identifier of the installation.
body object Optional
body.repositories array Optional List of repository names that the token should have access to
body.repositories[] string Optional
body.repository_ids array Optional List of repository IDs that the token should have access to
body.repository_ids[] integer Optional
body.permissions — Optional $ref: "#/definitions/app-permissions"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "installation_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Suspend an app installation — github.apps.suspend-installation

Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.installation_id integer Required The unique identifier of the installation.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "installation_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Unsuspend an app installation — github.apps.unsuspend-installation

Removes a GitHub App installation suspension.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.installation_id integer Required The unique identifier of the installation.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "installation_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an app authorization — github.apps.delete-authorization

OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth access_token as an input parameter and the grant for the token's owner will be deleted. Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on the application authorizations settings screen within GitHub.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.client_id string Required The client ID of the GitHub app.
body object Required
body.access_token string Required The OAuth access token used to authenticate to the GitHub API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "client_id": "example"
  },
  "body": {
    "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check a token — github.apps.check-token

OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return 404 NOT FOUND.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.client_id string Required The client ID of the GitHub app.
body object Required
body.access_token string Required The access_token of the OAuth or GitHub application.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "client_id": "example"
  },
  "body": {
    "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Reset a token — github.apps.reset-token

OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return 404 NOT FOUND.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.client_id string Required The client ID of the GitHub app.
body object Required
body.access_token string Required The access_token of the OAuth or GitHub application.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "client_id": "example"
  },
  "body": {
    "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an app token — github.apps.delete-token

OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.client_id string Required The client ID of the GitHub app.
body object Required
body.access_token string Required The OAuth access token used to authenticate to the GitHub API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "client_id": "example"
  },
  "body": {
    "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a scoped access token — github.apps.scope-token

Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.client_id string Required The client ID of the GitHub app.
body object Required
body.access_token string Required The access token used to authenticate to the GitHub API.
body.target string Optional The name of the user or organization to scope the user access token to. Required unless target_id is specified.
body.target_id integer Optional The ID of the user or organization to scope the user access token to. Required unless target is specified.
body.repositories array Optional The list of repository names to scope the user access token to. repositories may not be specified if repository_ids is specified.
body.repositories[] string Optional
body.repository_ids array Optional The list of repository IDs to scope the user access token to. repository_ids may not be specified if repositories is specified.
body.repository_ids[] integer Optional
body.permissions — Optional $ref: "#/definitions/app-permissions"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "client_id": "example"
  },
  "body": {
    "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a",
    "target": "octocat",
    "permissions": {
      "metadata": "read",
      "issues": "write",
      "contents": "read"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an app — github.apps.get-by-slug

> [!NOTE] > The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_slug string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_slug": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all codes of conduct — github.codes-of-conduct.get-all-codes-of-conduct

Returns array of all GitHub's codes of conduct.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a code of conduct — github.codes-of-conduct.get-conduct-code

Returns information about the specified GitHub code of conduct.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.key string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "key": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Revoke a list of credentials — github.credentials.revoke

Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Required
body.credentials array Required A list of credentials to be revoked, up to 1000 per request. minItems: 1; maxItems: 1000
body.credentials[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "credentials": [
      "ghp_1234567890abcdef1234567890abcdef12345678",
      "github_pat_0A1B2C3D4E5F6G7H8I9J0K_ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456",
      "gho_1234567890abcdef1234567890abcdef12345678",
      "ghu_1234567890abcdef1234567890abcdef12345678",
      "ghr_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890ab"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get emojis — github.emojis.get

Lists all the emojis available to use on GitHub.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get GitHub Actions cache retention limit for an enterprise — github.actions.get-actions-cache-retention-limit-for-enterprise

Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this enterprise may not set a higher cache retention limit.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set GitHub Actions cache retention limit for an enterprise — github.actions.set-actions-cache-retention-limit-for-enterprise

Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this enterprise may not set a higher cache retention limit.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
body — Required $ref: "#/definitions/actions-cache-retention-limit-for-enterprise"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get GitHub Actions cache storage limit for an enterprise — github.actions.get-actions-cache-storage-limit-for-enterprise

Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this enterprise may not set a higher cache storage limit.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set GitHub Actions cache storage limit for an enterprise — github.actions.set-actions-cache-storage-limit-for-enterprise

Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this enterprise may not set a higher cache storage limit.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
body — Required $ref: "#/definitions/actions-cache-storage-limit-for-enterprise"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List OIDC custom property inclusions for an enterprise — github.oidc.list-oidc-custom-property-inclusions-for-enterprise

Lists the repository custom properties that are included in the OIDC token for repository actions in an enterprise.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an OIDC custom property inclusion for an enterprise — github.oidc.create-oidc-custom-property-inclusion-for-enterprise

Adds a repository custom property to be included in the OIDC token for repository actions in an enterprise.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
body — Required $ref: "#/definitions/oidc-custom-property-inclusion-input"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  },
  "body": {
    "custom_property_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an OIDC custom property inclusion for an enterprise — github.oidc.delete-oidc-custom-property-inclusion-for-enterprise

Removes a repository custom property from being included in the OIDC token for repository actions in an enterprise.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
path.custom_property_name string Required The name of the custom property to remove from OIDC token inclusion

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example",
    "custom_property_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get code security configurations for an enterprise — github.code-security.get-configurations-for-enterprise

Lists all code security configurations available in an enterprise.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a code security configuration for an enterprise — github.code-security.create-configuration-for-enterprise

Creates a code security configuration in an enterprise.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
body object Required additionalProperties: false
body.name string Required The name of the code security configuration. Must be unique within the enterprise.
body.description string Optional A description of the code security configuration maxLength: 255
body.advanced_security string Optional The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features. > [!WARNING] > code_security and secret_protection are deprecated values for this field. Prefer the individual code_security and secret_protection fields to set the status of these features. enum: ["enabled","disabled","code_security","secret_protection"]; default: "disabled"
body.code_security string Optional The enablement status of GitHub Code Security features. enum: ["enabled","disabled","not_set"]
body.dependency_graph string Optional The enablement status of Dependency Graph enum: ["enabled","disabled","not_set"]; default: "enabled"
body.dependency_graph_autosubmit_action string Optional The enablement status of Automatic dependency submission enum: ["enabled","disabled","not_set"]; default: "disabled"
body.dependency_graph_autosubmit_action_options object Optional Feature options for Automatic dependency submission
body.dependency_graph_autosubmit_action_options.labeled_runners boolean Optional Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. default: false
body.dependabot_alerts string Optional The enablement status of Dependabot alerts enum: ["enabled","disabled","not_set"]; default: "disabled"
body.dependabot_reachability string Optional The enablement status of reachability analysis for Dependabot. Only available for enterprises with access to reachability analysis. Requires Dependabot alerts to be enabled when set to enabled. Must be disabled when Dependabot alerts is disabled. not_set leaves existing repository settings unchanged. enum: ["enabled","disabled","not_set"]; default: "disabled"
body.dependabot_security_updates string Optional The enablement status of Dependabot security updates enum: ["enabled","disabled","not_set"]; default: "disabled"
body.code_scanning_options — Optional $ref: "#/definitions/code-scanning-options"
body.code_scanning_default_setup string Optional The enablement status of code scanning default setup enum: ["enabled","disabled","not_set"]; default: "disabled"
body.code_scanning_default_setup_options — Optional $ref: "#/definitions/code-scanning-default-setup-options"
body.code_scanning_delegated_alert_dismissal string Optional The enablement status of code scanning delegated alert dismissal enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_protection string Optional The enablement status of GitHub Secret Protection features. enum: ["enabled","disabled","not_set"]
body.secret_scanning string Optional The enablement status of secret scanning enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_scanning_push_protection string Optional The enablement status of secret scanning push protection enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_scanning_validity_checks string Optional The enablement status of secret scanning validity checks enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_scanning_non_provider_patterns string Optional The enablement status of secret scanning non provider patterns enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_scanning_generic_secrets string Optional The enablement status of Copilot secret scanning enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_scanning_generic_secrets_push_protection string Optional The enablement status of generic secrets push protection enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_scanning_delegated_alert_dismissal string Optional The enablement status of secret scanning delegated alert dismissal enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_scanning_extended_metadata string Optional The enablement status of secret scanning extended metadata enum: ["enabled","disabled","not_set"]; default: "disabled"
body.private_vulnerability_reporting string Optional The enablement status of private vulnerability reporting enum: ["enabled","disabled","not_set"]; default: "disabled"
body.enforcement string Optional The enforcement status for a security configuration enum: ["enforced","unenforced","enterprise_enforced"]; default: "enforced"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  },
  "body": {
    "name": "High rish settings",
    "description": "This is a code security configuration for octo-enterprise",
    "advanced_security": "enabled",
    "dependabot_alerts": "enabled",
    "dependabot_security_updates": "not_set",
    "secret_scanning": "enabled"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get default code security configurations for an enterprise — github.code-security.get-default-configurations-for-enterprise

Lists the default code security configurations for an enterprise.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a code security configuration of an enterprise — github.code-security.get-single-configuration-for-enterprise

Gets a code security configuration available in an enterprise.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
path.configuration_id integer Required The unique identifier of the code security configuration.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example",
    "configuration_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a custom code security configuration for an enterprise — github.code-security.update-enterprise-configuration

Updates a code security configuration in an enterprise.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
path.configuration_id integer Required The unique identifier of the code security configuration.
body object Required additionalProperties: false
body.name string Optional The name of the code security configuration. Must be unique across the enterprise.
body.description string Optional A description of the code security configuration maxLength: 255
body.advanced_security string Optional The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features. > [!WARNING] > code_security and secret_protection are deprecated values for this field. Prefer the individual code_security and secret_protection fields to set the status of these features. enum: ["enabled","disabled","code_security","secret_protection"]
body.code_security string Optional The enablement status of GitHub Code Security features. enum: ["enabled","disabled","not_set"]
body.dependency_graph string Optional The enablement status of Dependency Graph enum: ["enabled","disabled","not_set"]
body.dependency_graph_autosubmit_action string Optional The enablement status of Automatic dependency submission enum: ["enabled","disabled","not_set"]
body.dependency_graph_autosubmit_action_options object Optional Feature options for Automatic dependency submission
body.dependency_graph_autosubmit_action_options.labeled_runners boolean Optional Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.
body.dependabot_alerts string Optional The enablement status of Dependabot alerts enum: ["enabled","disabled","not_set"]
body.dependabot_reachability string Optional The enablement status of reachability analysis for Dependabot. Only available for enterprises with access to reachability analysis. Requires Dependabot alerts to be enabled when set to enabled. Must be disabled when Dependabot alerts is disabled. not_set leaves existing repository settings unchanged. Omit this field to preserve the configuration's current value. enum: ["enabled","disabled","not_set"]
body.dependabot_security_updates string Optional The enablement status of Dependabot security updates enum: ["enabled","disabled","not_set"]
body.code_scanning_default_setup string Optional The enablement status of code scanning default setup enum: ["enabled","disabled","not_set"]
body.code_scanning_default_setup_options — Optional $ref: "#/definitions/code-scanning-default-setup-options"
body.code_scanning_options — Optional $ref: "#/definitions/code-scanning-options"
body.code_scanning_delegated_alert_dismissal string Optional The enablement status of code scanning delegated alert dismissal enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_protection string Optional The enablement status of GitHub Secret Protection features. enum: ["enabled","disabled","not_set"]
body.secret_scanning string Optional The enablement status of secret scanning enum: ["enabled","disabled","not_set"]
body.secret_scanning_push_protection string Optional The enablement status of secret scanning push protection enum: ["enabled","disabled","not_set"]
body.secret_scanning_validity_checks string Optional The enablement status of secret scanning validity checks enum: ["enabled","disabled","not_set"]
body.secret_scanning_non_provider_patterns string Optional The enablement status of secret scanning non-provider patterns enum: ["enabled","disabled","not_set"]
body.secret_scanning_generic_secrets string Optional The enablement status of Copilot secret scanning enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_scanning_generic_secrets_push_protection string Optional The enablement status of generic secrets push protection enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_scanning_delegated_alert_dismissal string Optional The enablement status of secret scanning delegated alert dismissal enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_scanning_extended_metadata string Optional The enablement status of secret scanning extended metadata enum: ["enabled","disabled","not_set"]; default: "disabled"
body.private_vulnerability_reporting string Optional The enablement status of private vulnerability reporting enum: ["enabled","disabled","not_set"]
body.enforcement string Optional The enforcement status for a security configuration enum: ["enforced","unenforced","enterprise_enforced"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example",
    "configuration_id": 1
  },
  "body": {
    "name": "octo-enterprise recommended settings v2",
    "secret_scanning": "disabled",
    "code_scanning_default_setup": "enabled"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a code security configuration for an enterprise — github.code-security.delete-configuration-for-enterprise

Deletes a code security configuration from an enterprise. Repositories attached to the configuration will retain their settings but will no longer be associated with the configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
path.configuration_id integer Required The unique identifier of the code security configuration.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example",
    "configuration_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Attach an enterprise configuration to repositories — github.code-security.attach-enterprise-configuration

Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
path.configuration_id integer Required The unique identifier of the code security configuration.
body object Required additionalProperties: false
body.scope string Required The type of repositories to attach the configuration to. enum: ["all","all_without_configurations"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example",
    "configuration_id": 1
  },
  "body": {
    "scope": "all"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set a code security configuration as a default for an enterprise — github.code-security.set-configuration-as-default-for-enterprise

Sets a code security configuration as a default to be applied to new repositories in your enterprise.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
path.configuration_id integer Required The unique identifier of the code security configuration.
body object Required
body.default_for_new_repos string Optional Specify which types of repository this security configuration should be applied to by default. enum: ["all","none","private_and_internal","public"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example",
    "configuration_id": 1
  },
  "body": {
    "default_for_new_repos": "all"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get repositories associated with an enterprise code security configuration — github.code-security.get-repositories-for-enterprise-configuration

Lists the repositories associated with an enterprise code security configuration in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
path.configuration_id integer Required The unique identifier of the code security configuration.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.status string Optional A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. Can be: all, attached, attaching, removed, enforced, failed, updating, removed_by_enterprise, enterprise_enforced default: "all"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example",
    "configuration_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Copilot enterprise usage metrics for a specific day — github.copilot.copilot-enterprise-one-day-usage-metrics

Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
query object Required additionalProperties: false
query.day string Required The day to request data for, in YYYY-MM-DD format. format: "date"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  },
  "query": {
    "day": "2025-10-13"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Copilot enterprise usage metrics — github.copilot.copilot-enterprise-usage-metrics

Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Copilot enterprise repository report for a specific day — github.copilot.copilot-enterprise-repos-one-day-report

Use this endpoint to retrieve download links for the Copilot enterprise repository report for a specific day. The report provides per-repository pull request metrics for Copilot across the enterprise, with one entry per repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
query object Required additionalProperties: false
query.day string Required The day to request data for, in YYYY-MM-DD format. format: "date"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  },
  "query": {
    "day": "2025-10-13"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Copilot enterprise user-teams report for a specific day — github.copilot.copilot-enterprise-user-teams-one-day-report

Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
query object Required additionalProperties: false
query.day string Required The day to request data for, in YYYY-MM-DD format. format: "date"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  },
  "query": {
    "day": "2025-10-13"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Copilot users usage metrics for a specific day — github.copilot.copilot-users-one-day-usage-metrics

Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
query object Required additionalProperties: false
query.day string Required The day to request data for, in YYYY-MM-DD format. format: "date"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  },
  "query": {
    "day": "2025-10-13"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Copilot users usage metrics — github.copilot.copilot-users-usage-metrics

Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set the coding agent policy for an enterprise — github.copilot.set-enterprise-coding-agent-policy

Sets the policy for Copilot cloud agent usage across an enterprise.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
body object Required
body.policy_state string Required The policy state for Copilot cloud agent in the enterprise. Can be one of enabled_for_all_orgs, disabled_for_all_orgs, enabled_for_selected_orgs, or configured_by_org_admins. enum: ["enabled_for_all_orgs","disabled_for_all_orgs","enabled_for_selected_orgs","configured_by_org_admins"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  },
  "body": {
    "policy_state": "enabled_for_all_orgs"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add organizations to the enterprise coding agent policy — github.copilot.add-organizations-to-enterprise-coding-agent-policy

Enables Copilot cloud agent for the specified organizations within the enterprise.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
body object Required
body.organizations array Optional List of organization logins within the enterprise to enable Copilot cloud agent for.
body.organizations[] string Optional
body.custom_properties array Optional List of custom property filters to match organizations. Organizations matching any of the specified property name/value pairs will be included. This is a one-time operation, setting the property on an organization in the future will not automatically update its coding agent policy.
body.custom_properties[] object Optional
body.custom_properties[].property_name string Required The name of the custom property to filter by.
body.custom_properties[].values array Required The values of the custom property to match.
body.custom_properties[].values[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  },
  "body": {
    "organizations": [
      "my-org-1",
      "my-org-2"
    ],
    "custom_properties": [
      {
        "property_name": "department",
        "values": [
          "engineering",
          "security"
        ]
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove organizations from the enterprise coding agent policy — github.copilot.remove-organizations-from-enterprise-coding-agent-policy

Disables Copilot cloud agent for the specified organizations within the enterprise.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
body object Required
body.organizations array Optional List of organization logins within the enterprise to disable Copilot cloud agent for.
body.organizations[] string Optional
body.custom_properties array Optional List of custom property filters to match organizations. Organizations matching any of the specified property name/value pairs will be included. This is a one-time operation, setting the property on an organization in the future will not automatically update its coding agent policy.
body.custom_properties[] object Optional
body.custom_properties[].property_name string Required The name of the custom property to filter by.
body.custom_properties[].values array Required The values of the custom property to match.
body.custom_properties[].values[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  },
  "body": {
    "organizations": [
      "my-org-1",
      "my-org-2"
    ],
    "custom_properties": [
      {
        "property_name": "department",
        "values": [
          "engineering",
          "security"
        ]
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Dependabot alerts for an enterprise — github.dependabot.list-alerts-for-enterprise

Lists Dependabot alerts for repositories that are owned by the specified enterprise.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
query object Optional additionalProperties: false
query.classification string Optional A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned. Can be: malware, general
query.state string Optional A comma-separated list of states. If specified, only alerts with these states will be returned. Can be: auto_dismissed, dismissed, fixed, open
query.severity string Optional A comma-separated list of severities. If specified, only alerts with these severities will be returned. Can be: low, medium, high, critical
query.ecosystem string Optional A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. Can be: composer, go, maven, npm, nuget, pip, pub, rubygems, rust
query.package string Optional A comma-separated list of package names. If specified, only alerts for these packages will be returned.
query.epss_percentage string Optional CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: - An exact number (n) - Comparators such as >n, <n, >=n, <=n - A range like n..n, where n is a number from 0.0 to 1.0 Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.
query.has — Optional Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. Multiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.
query.has string Optional oneOf[1]
query.has array Optional oneOf[2]
query.has[] string Optional oneOf[2]; enum: ["patch"]
query.assignee string Optional Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot) to return alerts assigned to any of the specified users. Use * to list alerts with at least one assignee or none to list alerts with no assignees.
query.scope string Optional The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. enum: ["development","runtime"]
query.relationship string Optional A comma-separated list of relationships of the vulnerable dependency to your project. If specified, only alerts with these relationships will be returned. > [!NOTE] > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems.
query.sort string Optional The property by which to sort the results. created means when the alert was created. updated means when the alert's state last changed. epss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. enum: ["created","updated","epss_percentage"]; default: "created"
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Lists the repositories Dependabot can access in an enterprise — github.dependabot.repository-access-for-enterprise

Lists repositories that enterprise admins have allowed Dependabot to access when updating dependencies across organizations in the enterprise.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
query object Optional additionalProperties: false
query.page integer Optional The page number of results to fetch. default: 1; minimum: 1
query.per_page integer Optional Number of results per page. default: 30; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Updates Dependabot's repository access list for an enterprise — github.dependabot.update-repository-access-for-enterprise

Updates repositories according to the list of repositories that enterprise admins have given Dependabot access to when they've updated dependencies across organizations in the enterprise.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
body object Required
body.repository_ids_to_add array Optional List of repository IDs to add.
body.repository_ids_to_add[] integer Optional
body.repository_ids_to_remove array Optional List of repository IDs to remove.
body.repository_ids_to_remove[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  },
  "body": {
    "repository_ids_to_add": [
      123,
      456
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set the default repository access level for Dependabot in an enterprise — github.dependabot.set-repository-access-default-level-for-enterprise

Sets the default level of repository access Dependabot will have while performing an update across organizations in the enterprise. Available values are: - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.enterprise string Required The slug version of the enterprise name.
body object Required
body.default_level string Required The default repository access level for Dependabot updates. enum: ["public","internal"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "enterprise": "example"
  },
  "body": {
    "default_level": "public"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List public events — github.activity.list-public-events

> [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 15
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get feeds — github.activity.get-feeds

Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List gists for the authenticated user — github.gists.list

Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.since string Optional Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a gist — github.gists.create

Allows you to add a new gist with one or more files.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Required
body.description string Optional Description of the gist
body.files object Required Names and content for the files that make up the gist additionalProperties: {"type":"object","properties":{"content":{"description":"Content of the file","type":"string"}},"required":["content"]}
body.public — Optional
body.public boolean Optional Flag indicating whether the gist is public oneOf[1]; default: false
body.public string Optional oneOf[2]; enum: ["true","false"]; default: "false"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "description": "Example of a gist",
    "public": false,
    "files": {
      "README.md": {
        "content": "Hello World"
      }
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List public gists — github.gists.list-public

List public gists sorted by most recently updated to least recently updated.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.since string Optional Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List starred gists — github.gists.list-starred

List the authenticated user's starred gists:

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.since string Optional Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a gist — github.gists.get

Gets a specified gist.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gist_id string Required The unique identifier of the gist.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gist_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a gist — github.gists.update

Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gist_id string Required The unique identifier of the gist.
body object | null Required
body.description string Optional The description of the gist.
body.files object Optional The gist files to be updated, renamed, or deleted. Each key must match the current filename (including extension) of the targeted gist file. For example: hello.py. To delete a file, set the whole file to null. For example: hello.py : null. The file will also be deleted if the specified object does not contain at least one of content or filename. additionalProperties: {"type":["object","null"],"properties":{"content":{"description":"The new content of the file.","type":"string"},"filename":{"description":"The new filename for the file.","type":["string","null"]}}}

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gist_id": "example"
  },
  "body": {
    "description": "An updated gist description",
    "files": {
      "README.md": {
        "content": "Hello World from GitHub"
      }
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a gist — github.gists.delete

Run Delete a gist with GitHub. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gist_id string Required The unique identifier of the gist.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gist_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List gist comments — github.gists.list-comments

Lists the comments on a gist.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gist_id string Required The unique identifier of the gist.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gist_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a gist comment — github.gists.create-comment

Creates a comment on a gist.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gist_id string Required The unique identifier of the gist.
body object Required
body.body string Required The comment text. maxLength: 65535

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gist_id": "example"
  },
  "body": {
    "body": "This is a comment to a gist"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a gist comment — github.gists.get-comment

Gets a comment on a gist.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gist_id string Required The unique identifier of the gist.
path.comment_id integer Required The unique identifier of the comment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gist_id": "example",
    "comment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a gist comment — github.gists.update-comment

Updates a comment on a gist.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gist_id string Required The unique identifier of the gist.
path.comment_id integer Required The unique identifier of the comment.
body object Required
body.body string Required The comment text. maxLength: 65535

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gist_id": "example",
    "comment_id": 1
  },
  "body": {
    "body": "This is an update to a comment in a gist"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a gist comment — github.gists.delete-comment

Run Delete a gist comment with GitHub. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gist_id string Required The unique identifier of the gist.
path.comment_id integer Required The unique identifier of the comment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gist_id": "example",
    "comment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List gist commits — github.gists.list-commits

Run List gist commits with GitHub. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gist_id string Required The unique identifier of the gist.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gist_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List gist forks — github.gists.list-forks

Run List gist forks with GitHub. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gist_id string Required The unique identifier of the gist.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gist_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fork a gist — github.gists.fork

Run Fork a gist with GitHub. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gist_id string Required The unique identifier of the gist.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gist_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check if a gist is starred — github.gists.check-is-starred

Run Check if a gist is starred with GitHub. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gist_id string Required The unique identifier of the gist.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gist_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Star a gist — github.gists.star

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP method."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gist_id string Required The unique identifier of the gist.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gist_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Unstar a gist — github.gists.unstar

Run Unstar a gist with GitHub. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gist_id string Required The unique identifier of the gist.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gist_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a gist revision — github.gists.get-revision

Gets a specified gist revision.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gist_id string Required The unique identifier of the gist.
path.sha string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gist_id": "example",
    "sha": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all gitignore templates — github.gitignore.get-all-templates

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

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a gitignore template — github.gitignore.get-template

Get the content of a gitignore template.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.name string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repositories accessible to the app installation — github.apps.list-repos-accessible-to-installation

List repositories that an app installation can access.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Revoke an installation access token — github.apps.revoke-installation-access-token

Revokes the installation token you're using to authenticate as an installation and access this endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List issues assigned to the authenticated user — github.issues.list

List issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories. You can use the filter query parameter to fetch issues that are not necessarily assigned to you.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.filter string Optional Indicates 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, regardless of participation or creation. enum: ["assigned","created","mentioned","subscribed","repos","all"]; default: "assigned"
query.state string Optional Indicates the state of the issues to return. enum: ["open","closed","all"]; default: "open"
query.labels string Optional A list of comma separated label names. Example: bug,ui,@high
query.sort string Optional What to sort results by. enum: ["created","updated","comments"]; default: "created"
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.since string Optional Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.collab boolean Optional
query.orgs boolean Optional
query.owned boolean Optional
query.pulls boolean Optional
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all commonly used licenses — github.licenses.get-all-commonly-used

Lists the most commonly used licenses on GitHub. For more information, see "Licensing a repository ."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.featured boolean Optional
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a license — github.licenses.get

Gets information about a specific license. For more information, see "Licensing a repository ."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.license string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "license": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Render a Markdown document — github.markdown.render

Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as issues:read or pull_requests:read.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Required
body.text string Required The Markdown text to render in HTML.
body.mode string Optional The rendering mode. enum: ["markdown","gfm"]; default: "markdown"
body.context string Optional The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "text": "Hello **world**"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a subscription plan for an account — github.apps.get-subscription-plan-for-account

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id integer Required account_id parameter

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List plans — github.apps.list-plans

Lists all plans that are part of your GitHub Marketplace listing.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List accounts for a plan — github.apps.list-accounts-for-plan

Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.plan_id integer Required The unique identifier of the plan.
query object Optional additionalProperties: false
query.sort string Optional The property to sort the results by. enum: ["created","updated"]; default: "created"
query.direction string Optional To return the oldest accounts first, set to asc. Ignored without the sort parameter. enum: ["asc","desc"]
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "plan_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a subscription plan for an account (stubbed) — github.apps.get-subscription-plan-for-account-stubbed

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id integer Required account_id parameter

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List plans (stubbed) — github.apps.list-plans-stubbed

Lists all plans that are part of your GitHub Marketplace listing.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List accounts for a plan (stubbed) — github.apps.list-accounts-for-plan-stubbed

Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.plan_id integer Required The unique identifier of the plan.
query object Optional additionalProperties: false
query.sort string Optional The property to sort the results by. enum: ["created","updated"]; default: "created"
query.direction string Optional To return the oldest accounts first, set to asc. Ignored without the sort parameter. enum: ["asc","desc"]
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "plan_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get GitHub meta information — github.meta.get

Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "About GitHub's IP addresses."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List public events for a network of repositories — github.activity.list-public-events-for-repo-network

> [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List notifications for the authenticated user — github.activity.list-notifications-for-authenticated-user

List all notifications for the current user, sorted by most recently updated.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.all boolean Optional If true, show notifications marked as read. default: false
query.participating boolean Optional If true, only shows notifications in which the user is directly participating or mentioned. default: false
query.since string Optional Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.before string Optional Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 50). For more information, see "Using pagination in the REST API." default: 50

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Mark notifications as read — github.activity.mark-notifications-as-read

Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the List notifications for the authenticated user endpoint and pass the query parameter all=false.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.last_read_at string Optional Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp. format: "date-time"
body.read boolean Optional Whether the notification has been read.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a thread — github.activity.get-thread

Gets information about a notification thread.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id integer Required The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Mark a thread as read — github.activity.mark-thread-as-read

Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id integer Required The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Mark a thread as done — github.activity.mark-thread-as-done

Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id integer Required The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a thread subscription for the authenticated user — github.activity.get-thread-subscription-for-authenticated-user

This checks to see if the current user is subscribed to a thread. You can also get a repository subscription.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id integer Required The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set a thread subscription — github.activity.set-thread-subscription

If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an @mention.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id integer Required The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).
body object Optional
body.ignored boolean Optional Whether to block all notifications from a thread. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a thread subscription — github.activity.delete-thread-subscription

Mutes all future notifications for a conversation until you comment on the thread or get an @mention. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the Set a thread subscription endpoint and set ignore to true.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id integer Required The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Octocat — github.meta.get-octocat

Get the octocat as ASCII art

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.s string Optional The words to show in Octocat's speech bubble

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organizations — github.orgs.list

Lists all organizations, in the order that they were created.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.since integer Optional An organization ID. Only return organizations with an ID greater than this ID.
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get GitHub Actions cache retention limit for an organization — github.actions.get-actions-cache-retention-limit-for-organization

Gets GitHub Actions cache retention limit for an organization. All repositories under this organization may not set a higher cache retention limit.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set GitHub Actions cache retention limit for an organization — github.actions.set-actions-cache-retention-limit-for-organization

Sets GitHub Actions cache retention limit for an organization. All repositories under this organization may not set a higher cache retention limit.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body — Required $ref: "#/definitions/actions-cache-retention-limit-for-organization"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get GitHub Actions cache storage limit for an organization — github.actions.get-actions-cache-storage-limit-for-organization

Gets GitHub Actions cache storage limit for an organization. All repositories under this organization may not set a higher cache storage limit.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set GitHub Actions cache storage limit for an organization — github.actions.set-actions-cache-storage-limit-for-organization

Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this organization may not set a higher cache storage limit.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body — Required $ref: "#/definitions/actions-cache-storage-limit-for-organization"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get billing AI credit usage report for an organization — github.billing.get-github-billing-ai-credit-usage-report-org

Gets a report of AI credit usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.year integer Optional If specified, only return results for a single year. The value of year is an integer with four digits representing a year. For example, 2025. Default value is the current year.
query.month integer Optional If specified, only return results for a single month. The value of month is an integer between 1 and 12. Default value is the current month. If no year is specified the default year is used.
query.day integer Optional If specified, only return results for a single day. The value of day is an integer between 1 and 31. If no year or month is specified, the default year and month are used.
query.user string Optional The user name to query usage for. The name is not case sensitive.
query.model string Optional The model name to query usage for. The name is not case sensitive.
query.product string Optional The product name to query usage for. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all budgets for an organization — github.billing.get-all-budgets-org

Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. Each page returns up to 100 budgets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. default: 1
query.per_page integer Optional The number of results per page (max 100). default: 10
query.scope string Optional Filter budgets by scope type. - organization: Budgets scoped to the organization. - repository: Budgets scoped to a repository. - multi_user_customer: Universal budgets that apply to all users in the organization. - user: Budgets scoped to an individual user. enum: ["enterprise","organization","repository","cost_center","multi_user_customer","user"]
query.user string Optional Filter consumed amount details for budgets by the specified user login.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a budget for an organization — github.billing.create-organization-budget

Creates a new budget for an organization. The authenticated user must be an organization admin or billing manager.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Optional
body.budget_amount integer Optional The budget amount in whole dollars. For license-based products, this represents the number of licenses.
body.prevent_further_usage boolean Optional Whether to prevent additional spending once the budget is exceeded. For user and multi_user_customer scopes, this must be true.
body.budget_alerting object Optional
body.budget_alerting.will_alert boolean Optional Whether alerts are enabled for this budget. Rejected for user-scope as alerting is always disabled for them.
body.budget_alerting.alert_recipients array Optional Array of user login names who will receive alerts. Rejected for user-scope as alerting is always disabled for them.
body.budget_alerting.alert_recipients[] string Optional
body.budget_scope string Optional The scope of the budget for this organization. - organization: Apply the budget to the organization. - repository: Apply the budget to a specific repository in the organization. - multi_user_customer: Apply a universal budget to all users in the organization. - user: Apply the budget to a single user in the organization. user and multi_user_customer scopes are only supported when budget_product_sku is ai_credits or premium_requests. enum: ["organization","repository","multi_user_customer","user"]
body.budget_entity_name string Optional The entity to apply the budget to. The expected value depends on budget_scope. - repository: The repository name, or owner/repo. - organization, multi_user_customer, and user: Not used. For user, set the user field instead. default: ""
body.budget_type — Optional The type of pricing model used by the budget. Determines how budget_product_sku is interpreted. - BundlePricing: Covers all AI credit SKUs. Set budget_product_sku to ai_credits. - ProductPricing: Covers all SKUs that belong to a product. Set budget_product_sku to a product such as actions or packages. - SkuPricing: Covers a single, specific SKU. Set budget_product_sku to a SKU such as actions_linux.
body.budget_type string Optional oneOf[1]; enum: ["BundlePricing"]
body.budget_type string Optional oneOf[2]; enum: ["ProductPricing"]
body.budget_type string Optional oneOf[3]; enum: ["SkuPricing"]
body.budget_product_sku string Optional A single product or SKU that will be covered in the budget
body.user string Optional The username of the user for user scope budgets. This field is required when budget_scope is user.
body.expires_at string Optional The date the budget will expire in YYYY-MM-DD format. Only dates in the future are accepted. If not provided, the budget will not expire. Only supported for budgets with budget_scope of user format: "date"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a budget by ID for an organization — github.billing.get-budget-org

Gets a budget by ID. The authenticated user must be an organization admin or billing manager.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.budget_id string Required The ID corresponding to the budget.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "budget_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a budget for an organization — github.billing.update-budget-org

Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.budget_id string Required The ID corresponding to the budget.
body object Required
body.budget_amount integer Optional The budget amount in whole dollars. For license-based products, this represents the number of licenses.
body.prevent_further_usage boolean Optional Whether to prevent additional spending once the budget is exceeded. For budgets with user or multi_user_customer scope, this must remain true.
body.budget_alerting object Optional
body.budget_alerting.will_alert boolean Optional Whether alerts are enabled for this budget. Ignored for user-scopes as alerting is always disabled for them.
body.budget_alerting.alert_recipients array Optional Array of user login names who will receive alerts. Ignored for user-scopes as alerting is always disabled for them.
body.budget_alerting.alert_recipients[] string Optional
body.expires_at — Optional The date the budget will expire in YYYY-MM-DD format. Only dates in the future are accepted. If not set, the budget will not expire. Setting to null or 0 will remove the expiration date from a budget if set. Only supported for existing user-scoped budgets.
body.expires_at string | null Optional oneOf[1]; format: "date"
body.expires_at integer Optional oneOf[2]; enum: [0]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "budget_id": "example"
  },
  "body": {
    "prevent_further_usage": false,
    "budget_amount": 10,
    "budget_alerting": {
      "will_alert": false,
      "alert_recipients": []
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a budget for an organization — github.billing.delete-budget-org

Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.budget_id string Required The ID corresponding to the budget.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "budget_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get billing premium request usage report for an organization — github.billing.get-github-billing-premium-request-usage-report-org

Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.year integer Optional If specified, only return results for a single year. The value of year is an integer with four digits representing a year. For example, 2025. Default value is the current year.
query.month integer Optional If specified, only return results for a single month. The value of month is an integer between 1 and 12. Default value is the current month. If no year is specified the default year is used.
query.day integer Optional If specified, only return results for a single day. The value of day is an integer between 1 and 31. If no year or month is specified, the default year and month are used.
query.user string Optional The user name to query usage for. The name is not case sensitive.
query.model string Optional The model name to query usage for. The name is not case sensitive.
query.product string Optional The product name to query usage for. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get billing usage report for an organization — github.billing.get-github-billing-usage-report-org

Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.year integer Optional If specified, only return results for a single year. The value of year is an integer with four digits representing a year. For example, 2025. Default value is the current year.
query.month integer Optional If specified, only return results for a single month. The value of month is an integer between 1 and 12. If no year is specified the default year is used.
query.day integer Optional If specified, only return results for a single day. The value of day is an integer between 1 and 31. If no year or month is specified, the default year and month are used.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get billing usage summary for an organization — github.billing.get-github-billing-usage-summary-report-org

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.year integer Optional If specified, only return results for a single year. The value of year is an integer with four digits representing a year. For example, 2025. Default value is the current year.
query.month integer Optional If specified, only return results for a single month. The value of month is an integer between 1 and 12. Default value is the current month. If no year is specified the default year is used.
query.day integer Optional If specified, only return results for a single day. The value of day is an integer between 1 and 31. If no year or month is specified, the default year and month are used.
query.repository string Optional The repository name to query for usage in the format owner/repository.
query.product string Optional The product name to query usage for. The name is not case sensitive.
query.sku string Optional The SKU to query for usage.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization — github.orgs.get

Gets information about an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an organization — github.orgs.update

> [!WARNING] > Closing down notice: GitHub will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Optional
body.billing_email string Optional Billing email address. This address is not publicized.
body.company string Optional The company name.
body.email string Optional The publicly visible email address.
body.twitter_username string Optional The Twitter username of the company.
body.location string Optional The location.
body.name string Optional The shorthand name of the company.
body.description string Optional The description of the company. The maximum size is 160 characters.
body.has_organization_projects boolean Optional Whether an organization can use organization projects.
body.has_repository_projects boolean Optional Whether repositories that belong to the organization can use repository projects.
body.default_repository_permission string Optional Default permission level members have for organization repositories. enum: ["read","write","admin","none"]; default: "read"
body.members_can_create_repositories boolean Optional Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details. default: true
body.members_can_create_internal_repositories boolean Optional Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.
body.members_can_create_private_repositories boolean Optional Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.
body.members_can_create_public_repositories boolean Optional Whether organization members can create public repositories, which are visible to anyone. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.
body.members_allowed_repository_creation_type string Optional Specifies which types of repositories non-admin organization members can create. private is only available to repositories that are part of an organization on GitHub Enterprise Cloud. Note: This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details. enum: ["all","private","none"]
body.members_can_create_pages boolean Optional Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted. default: true
body.members_can_create_public_pages boolean Optional Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted. default: true
body.members_can_create_private_pages boolean Optional Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted. default: true
body.members_can_fork_private_repositories boolean Optional Whether organization members can fork private organization repositories. default: false
body.web_commit_signoff_required boolean Optional Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface. default: false
body.blog string Optional
body.advanced_security_enabled_for_new_repositories boolean Optional Endpoint closing down notice. Please use code security configurations instead. Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "Managing security managers in your organization." You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
body.dependabot_alerts_enabled_for_new_repositories boolean Optional Endpoint closing down notice. Please use code security configurations instead. Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "Managing security managers in your organization." You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
body.dependabot_security_updates_enabled_for_new_repositories boolean Optional Endpoint closing down notice. Please use code security configurations instead. Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "Managing security managers in your organization." You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
body.dependency_graph_enabled_for_new_repositories boolean Optional Endpoint closing down notice. Please use code security configurations instead. Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "Managing security managers in your organization." You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
body.secret_scanning_enabled_for_new_repositories boolean Optional Endpoint closing down notice. Please use code security configurations instead. Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "Managing security managers in your organization." You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
body.secret_scanning_push_protection_enabled_for_new_repositories boolean Optional Endpoint closing down notice. Please use code security configurations instead. Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "Managing security managers in your organization." You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
body.secret_scanning_push_protection_custom_link_enabled boolean Optional Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.
body.secret_scanning_push_protection_custom_link string Optional If secret_scanning_push_protection_custom_link_enabled is true, the URL that will be displayed to contributors who are blocked from pushing a secret.
body.deploy_keys_enabled_for_repositories boolean Optional Controls whether or not deploy keys may be added and used for repositories in the organization.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an organization — github.orgs.delete

Deletes an organization and all its repositories.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get GitHub Actions cache usage for an organization — github.actions.get-actions-cache-usage-for-org

Gets the total GitHub Actions cache usage for an organization. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repositories with GitHub Actions cache usage for an organization — github.actions.get-actions-cache-usage-by-repo-for-org

Lists repositories and their GitHub Actions cache usage for an organization. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List GitHub-hosted runners for an organization — github.actions.list-hosted-runners-for-org

Lists all GitHub-hosted runners configured in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a GitHub-hosted runner for an organization — github.actions.create-hosted-runner-for-org

Creates a GitHub-hosted runner for an organization. OAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.name string Required Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.
body.image object Required The image of runner. To list all available images, use GET /actions/hosted-runners/images/github-owned or GET /actions/hosted-runners/images/partner.
body.image.id string Optional The unique identifier of the runner image.
body.image.source string Optional The source of the runner image. enum: ["github","partner","custom"]
body.image.version string | null Optional The version of the runner image to deploy. This is relevant only for runners using custom images.
body.size string Required The machine size of the runner. To list available sizes, use GET actions/hosted-runners/machine-sizes
body.runner_group_id integer Required The existing runner group to add this runner to.
body.maximum_runners integer Optional The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.
body.enable_static_ip boolean Optional Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use GET actions/hosted-runners/limits
body.image_gen boolean Optional Whether this runner should be used to generate custom images. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "name": "My Hosted runner",
    "image": {
      "id": "ubuntu-latest",
      "source": "github"
    },
    "runner_group_id": 1,
    "size": "4-core",
    "maximum_runners": 50,
    "enable_static_ip": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List custom images for an organization — github.actions.list-custom-images-for-org

List custom images for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a custom image definition for GitHub Actions Hosted Runners — github.actions.get-custom-image-for-org

Get a custom image definition for GitHub Actions Hosted Runners.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.image_definition_id integer Required Image definition ID of custom image

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "image_definition_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a custom image from the organization — github.actions.delete-custom-image-from-org

Delete a custom image from the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.image_definition_id integer Required Image definition ID of custom image

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "image_definition_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List image versions of a custom image for an organization — github.actions.list-custom-image-versions-for-org

List image versions of a custom image for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.image_definition_id integer Required Image definition ID of custom image
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "image_definition_id": 1,
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get GitHub-owned images for GitHub-hosted runners in an organization — github.actions.get-hosted-runners-github-owned-images-for-org

Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get partner images for GitHub-hosted runners in an organization — github.actions.get-hosted-runners-partner-images-for-org

Get the list of partner images available for GitHub-hosted runners for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get limits on GitHub-hosted runners for an organization — github.actions.get-hosted-runners-limits-for-org

Get the GitHub-hosted runners limits for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get GitHub-hosted runners machine specs for an organization — github.actions.get-hosted-runners-machine-specs-for-org

Get the list of machine specs available for GitHub-hosted runners for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get platforms for GitHub-hosted runners in an organization — github.actions.get-hosted-runners-platforms-for-org

Get the list of platforms available for GitHub-hosted runners for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a GitHub-hosted runner for an organization — github.actions.get-hosted-runner-for-org

Gets a GitHub-hosted runner configured in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.hosted_runner_id integer Required Unique identifier of the GitHub-hosted runner.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "hosted_runner_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a GitHub-hosted runner for an organization — github.actions.update-hosted-runner-for-org

Updates a GitHub-hosted runner for an organization. OAuth app tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.hosted_runner_id integer Required Unique identifier of the GitHub-hosted runner.
body object Required
body.name string Optional Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.
body.runner_group_id integer Optional The existing runner group to add this runner to.
body.maximum_runners integer Optional The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.
body.enable_static_ip boolean Optional Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use GET actions/hosted-runners/limits
body.size string Optional The machine size of the runner. To list available sizes, use GET actions/hosted-runners/machine-sizes
body.image_source string Optional The source type of the runner image to use. Must match the source of the image specified by image_id. Can be one of github, partner, or custom. enum: ["github","partner","custom"]
body.image_id string Optional The unique identifier of the runner image. To list available images, use GET /actions/hosted-runners/images/github-owned, GET /actions/hosted-runners/images/partner, or GET /actions/hosted-runners/images/custom.
body.image_version string | null Optional The version of the runner image to deploy. This is relevant only for runners using custom images.
body.image_gen boolean Optional Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "hosted_runner_id": 1
  },
  "body": {
    "name": "My larger runner",
    "runner_group_id": 1,
    "maximum_runners": 50,
    "enable_static_ip": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a GitHub-hosted runner for an organization — github.actions.delete-hosted-runner-for-org

Deletes a GitHub-hosted runner for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.hosted_runner_id integer Required Unique identifier of the GitHub-hosted runner.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "hosted_runner_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List OIDC custom property inclusions for an organization — github.oidc.list-oidc-custom-property-inclusions-for-org

Lists the repository custom properties that are included in the OIDC token for repository actions in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an OIDC custom property inclusion for an organization — github.oidc.create-oidc-custom-property-inclusion-for-org

Adds a repository custom property to be included in the OIDC token for repository actions in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body — Required $ref: "#/definitions/oidc-custom-property-inclusion-input"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "custom_property_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an OIDC custom property inclusion for an organization — github.oidc.delete-oidc-custom-property-inclusion-for-org

Removes a repository custom property from being included in the OIDC token for repository actions in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.custom_property_name string Required The name of the custom property to remove from OIDC token inclusion

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "custom_property_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the customization template for an OIDC subject claim for an organization — github.oidc.get-oidc-custom-sub-template-for-org

Gets the customization template for an OpenID Connect (OIDC) subject claim.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set the customization template for an OIDC subject claim for an organization — github.oidc.update-oidc-custom-sub-template-for-org

Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required Actions OIDC Subject customization
body.include_claim_keys array Optional Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.
body.include_claim_keys[] string Optional
body.use_immutable_subject boolean Optional Whether to opt in to the immutable OIDC subject claim format for the organization. When true, new OIDC tokens will use a stable, repository-ID-based sub claim instead of the name-based format.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get GitHub Actions permissions for an organization — github.actions.get-github-actions-permissions-organization

Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set GitHub Actions permissions for an organization — github.actions.set-github-actions-permissions-organization

Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.enabled_repositories — Required $ref: "#/definitions/enabled-repositories"
body.allowed_actions — Optional $ref: "#/definitions/allowed-actions"
body.sha_pinning_required — Optional $ref: "#/definitions/sha-pinning-required"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "enabled_repositories": "all",
    "allowed_actions": "selected",
    "sha_pinning_required": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get artifact and log retention settings for an organization — github.actions.get-artifact-and-log-retention-settings-organization

Gets retention settings for checks, workflow runs, commit statuses, artifacts, and logs for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set artifact and log retention settings for an organization — github.actions.set-artifact-and-log-retention-settings-organization

Sets retention settings for checks, workflow runs, commit statuses, artifacts, and logs for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body — Required $ref: "#/definitions/actions-artifact-and-log-retention"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "days": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get fork PR contributor approval permissions for an organization — github.actions.get-fork-pr-contributor-approval-permissions-organization

Gets the fork PR contributor approval policy for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set fork PR contributor approval permissions for an organization — github.actions.set-fork-pr-contributor-approval-permissions-organization

Sets the fork PR contributor approval policy for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body — Required $ref: "#/definitions/actions-fork-pr-contributor-approval"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "approval_policy": "first_time_contributors_new_to_github"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get private repo fork PR workflow settings for an organization — github.actions.get-private-repo-fork-pr-workflows-settings-organization

Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set private repo fork PR workflow settings for an organization — github.actions.set-private-repo-fork-pr-workflows-settings-organization

Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body — Required $ref: "#/definitions/actions-fork-pr-workflows-private-repos-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "run_workflows_from_fork_pull_requests": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List selected repositories enabled for GitHub Actions in an organization — github.actions.list-selected-repositories-enabled-github-actions-organization

Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set selected repositories enabled for GitHub Actions in an organization — github.actions.set-selected-repositories-enabled-github-actions-organization

Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.selected_repository_ids array Required List of repository IDs to enable for GitHub Actions.
body.selected_repository_ids[] integer Optional Unique identifier of the repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "selected_repository_ids": [
      32,
      42
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enable a selected repository for GitHub Actions in an organization — github.actions.enable-selected-repository-github-actions-organization

Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.repository_id integer Required The unique identifier of the repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disable a selected repository for GitHub Actions in an organization — github.actions.disable-selected-repository-github-actions-organization

Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.repository_id integer Required The unique identifier of the repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get allowed actions and reusable workflows for an organization — github.actions.get-allowed-actions-organization

Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set allowed actions and reusable workflows for an organization — github.actions.set-allowed-actions-organization

Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body — Optional $ref: "#/definitions/selected-actions"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get self-hosted runners settings for an organization — github.actions.get-self-hosted-runners-permissions-organization

Gets the settings for self-hosted runners for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set self-hosted runners settings for an organization — github.actions.set-self-hosted-runners-permissions-organization

Sets the settings for self-hosted runners for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.enabled_repositories string Required The policy that controls whether self-hosted runners can be used in the organization enum: ["all","selected","none"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "enabled_repositories": "all"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repositories allowed to use self-hosted runners in an organization — github.actions.list-selected-repositories-self-hosted-runners-organization

Lists repositories that are allowed to use self-hosted runners in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set repositories allowed to use self-hosted runners in an organization — github.actions.set-selected-repositories-self-hosted-runners-organization

Sets repositories that are allowed to use self-hosted runners in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.selected_repository_ids array Required IDs of repositories that can use repository-level self-hosted runners
body.selected_repository_ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "selected_repository_ids": [
      1,
      2,
      3
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a repository to the list of repositories allowed to use self-hosted runners in an organization — github.actions.enable-selected-repository-self-hosted-runners-organization

Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.repository_id integer Required The unique identifier of the repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove a repository from the list of repositories allowed to use self-hosted runners in an organization — github.actions.disable-selected-repository-self-hosted-runners-organization

Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.repository_id integer Required The unique identifier of the repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get default workflow permissions for an organization — github.actions.get-github-actions-default-workflow-permissions-organization

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, as well as whether GitHub Actions can submit approving pull request reviews. For more information, see "Setting the permissions of the GITHUB_TOKEN for your organization."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set default workflow permissions for an organization — github.actions.set-github-actions-default-workflow-permissions-organization

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, and sets if GitHub Actions can submit approving pull request reviews. For more information, see "Setting the permissions of the GITHUB_TOKEN for your organization."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body — Optional $ref: "#/definitions/actions-set-default-workflow-permissions"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization Actions policies — github.actions.get-org-actions-policies

List all Actions policies for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.has_parents boolean Optional Include policies configured at higher levels that apply to this organization default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an organization Actions policy — github.actions.create-org-actions-policy

Create an Actions policy for an organization. Omitting workflow_path targets all workflows without storing an explicit condition.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.name string Required The name of the policy.
body.enforcement — Required $ref: "#/definitions/repository-rule-enforcement"
body.conditions — Optional $ref: "#/definitions/actions-policy-org-conditions"
body.rules array Optional An array of rules within the policy.
body.rules[] — Optional $ref: "#/definitions/actions-rule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "name": "Require approved actors",
    "enforcement": "active",
    "rules": [
      {
        "type": "restrict_actions_actors",
        "parameters": {
          "allowed_actors": [
            {
              "id": 1234,
              "type": "Team"
            }
          ]
        }
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization Actions policy — github.actions.get-org-actions-policy

Get a specific Actions policy for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.policy_id integer Required The ID of the policy.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "policy_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an organization Actions policy — github.actions.update-org-actions-policy

Update an Actions policy for an organization. Omitting workflow_path preserves the policy's existing workflow targeting.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.policy_id integer Required The ID of the policy.
body object Required
body.name string Optional The name of the policy.
body.enforcement — Optional $ref: "#/definitions/repository-rule-enforcement"
body.conditions — Optional $ref: "#/definitions/actions-policy-org-conditions"
body.rules array Optional An array of rules within the policy.
body.rules[] — Optional $ref: "#/definitions/actions-rule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "policy_id": 1
  },
  "body": {
    "name": "Updated policy name",
    "enforcement": "active"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an organization Actions policy — github.actions.delete-org-actions-policy

Delete an Actions policy for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.policy_id integer Required The ID of the policy.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "policy_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List self-hosted runner groups for an organization — github.actions.list-self-hosted-runner-groups-for-org

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.visible_to_repository string Optional Only return runner groups that are allowed to be used by this repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a self-hosted runner group for an organization — github.actions.create-self-hosted-runner-group-for-org

Creates a new self-hosted runner group for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.name string Required Name of the runner group.
body.visibility string Optional Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. enum: ["selected","all","private"]; default: "all"
body.selected_repository_ids array Optional List of repository IDs that can access the runner group.
body.selected_repository_ids[] integer Optional Unique identifier of the repository.
body.runners array Optional List of runner IDs to add to the runner group.
body.runners[] integer Optional Unique identifier of the runner.
body.allows_public_repositories boolean Optional Whether the runner group can be used by public repositories. default: false
body.restricted_to_workflows boolean Optional If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array. default: false
body.selected_workflows array Optional List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
body.selected_workflows[] string Optional Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.
body.network_configuration_id string Optional The identifier of a hosted compute network configuration.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "name": "Expensive hardware runners",
    "visibility": "selected",
    "selected_repository_ids": [
      32,
      91
    ],
    "runners": [
      9,
      2
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a self-hosted runner group for an organization — github.actions.get-self-hosted-runner-group-for-org

Gets a specific self-hosted runner group for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_group_id integer Required Unique identifier of the self-hosted runner group.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_group_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a self-hosted runner group for an organization — github.actions.update-self-hosted-runner-group-for-org

Updates the name and visibility of a self-hosted runner group in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_group_id integer Required Unique identifier of the self-hosted runner group.
body object Required
body.name string Required Name of the runner group.
body.visibility string Optional Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. enum: ["selected","all","private"]
body.allows_public_repositories boolean Optional Whether the runner group can be used by public repositories. default: false
body.restricted_to_workflows boolean Optional If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array. default: false
body.selected_workflows array Optional List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
body.selected_workflows[] string Optional Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.
body.network_configuration_id string | null Optional The identifier of a hosted compute network configuration.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_group_id": 1
  },
  "body": {
    "name": "Expensive hardware runners",
    "visibility": "selected"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a self-hosted runner group from an organization — github.actions.delete-self-hosted-runner-group-from-org

Deletes a self-hosted runner group for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_group_id integer Required Unique identifier of the self-hosted runner group.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_group_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List GitHub-hosted runners in a group for an organization — github.actions.list-github-hosted-runners-in-group-for-org

Lists the GitHub-hosted runners in an organization group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_group_id integer Required Unique identifier of the self-hosted runner group.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_group_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository access to a self-hosted runner group in an organization — github.actions.list-repo-access-to-self-hosted-runner-group-in-org

Lists the repositories with access to a self-hosted runner group configured in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_group_id integer Required Unique identifier of the self-hosted runner group.
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_group_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set repository access for a self-hosted runner group in an organization — github.actions.set-repo-access-to-self-hosted-runner-group-in-org

Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_group_id integer Required Unique identifier of the self-hosted runner group.
body object Required
body.selected_repository_ids array Required List of repository IDs that can access the runner group.
body.selected_repository_ids[] integer Optional Unique identifier of the repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_group_id": 1
  },
  "body": {
    "selected_repository_ids": [
      32,
      91
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add repository access to a self-hosted runner group in an organization — github.actions.add-repo-access-to-self-hosted-runner-group-in-org

Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see "Create a self-hosted runner group for an organization."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_group_id integer Required Unique identifier of the self-hosted runner group.
path.repository_id integer Required The unique identifier of the repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_group_id": 1,
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove repository access to a self-hosted runner group in an organization — github.actions.remove-repo-access-to-self-hosted-runner-group-in-org

Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see "Create a self-hosted runner group for an organization."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_group_id integer Required Unique identifier of the self-hosted runner group.
path.repository_id integer Required The unique identifier of the repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_group_id": 1,
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List self-hosted runners in a group for an organization — github.actions.list-self-hosted-runners-in-group-for-org

Lists self-hosted runners that are in a specific organization group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_group_id integer Required Unique identifier of the self-hosted runner group.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_group_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set self-hosted runners in a group for an organization — github.actions.set-self-hosted-runners-in-group-for-org

Replaces the list of self-hosted runners that are part of an organization runner group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_group_id integer Required Unique identifier of the self-hosted runner group.
body object Required
body.runners array Required List of runner IDs to add to the runner group.
body.runners[] integer Optional Unique identifier of the runner.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_group_id": 1
  },
  "body": {
    "runners": [
      9,
      2
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a self-hosted runner to a group for an organization — github.actions.add-self-hosted-runner-to-group-for-org

Adds a self-hosted runner to a runner group configured in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_group_id integer Required Unique identifier of the self-hosted runner group.
path.runner_id integer Required Unique identifier of the self-hosted runner.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_group_id": 1,
    "runner_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove a self-hosted runner from a group for an organization — github.actions.remove-self-hosted-runner-from-group-for-org

Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_group_id integer Required Unique identifier of the self-hosted runner group.
path.runner_id integer Required Unique identifier of the self-hosted runner.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_group_id": 1,
    "runner_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List self-hosted runners for an organization — github.actions.list-self-hosted-runners-for-org

Lists all self-hosted runners configured in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.name string Optional The name of a self-hosted runner.
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get runner version end-of-life schedule for an organization — github.actions.get-runner-version-deprecation-for-org

Gets the end-of-life schedule for a specific runner version in an organization. Returns the runner version and the dates when registration and runtime support will end.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.version string Required The runner version to look up.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "version": "2.328.0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List runner applications for an organization — github.actions.list-runner-applications-for-org

Lists binaries for the runner application that you can download and run.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create configuration for a just-in-time runner for an organization — github.actions.generate-runner-jitconfig-for-org

Generates a configuration that can be passed to the runner application at startup.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.name string Required The name of the new runner.
body.runner_group_id integer Required The ID of the runner group to register the runner to.
body.labels array Required The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100. minItems: 1; maxItems: 100
body.labels[] string Optional
body.work_folder string Optional The working directory to be used for job execution, relative to the runner install directory. default: "_work"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "name": "New runner",
    "runner_group_id": 1,
    "labels": [
      "self-hosted",
      "X64",
      "macOS",
      "no-gpu"
    ],
    "work_folder": "_work"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a registration token for an organization — github.actions.create-registration-token-for-org

Returns a token that you can pass to the config script. The token expires after one hour.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a remove token for an organization — github.actions.create-remove-token-for-org

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a self-hosted runner for an organization — github.actions.get-self-hosted-runner-for-org

Gets a specific self-hosted runner configured in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_id integer Required Unique identifier of the self-hosted runner.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a self-hosted runner from an organization — github.actions.delete-self-hosted-runner-from-org

Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_id integer Required Unique identifier of the self-hosted runner.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List labels for a self-hosted runner for an organization — github.actions.list-labels-for-self-hosted-runner-for-org

Lists all labels for a self-hosted runner configured in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_id integer Required Unique identifier of the self-hosted runner.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add custom labels to a self-hosted runner for an organization — github.actions.add-custom-labels-to-self-hosted-runner-for-org

Adds custom labels to a self-hosted runner configured in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_id integer Required Unique identifier of the self-hosted runner.
body object Required
body.labels array Required The names of the custom labels to add to the runner. minItems: 1; maxItems: 100
body.labels[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_id": 1
  },
  "body": {
    "labels": [
      "gpu",
      "accelerated"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set custom labels for a self-hosted runner for an organization — github.actions.set-custom-labels-for-self-hosted-runner-for-org

Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_id integer Required Unique identifier of the self-hosted runner.
body object Required
body.labels array Required The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. minItems: 0; maxItems: 100
body.labels[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_id": 1
  },
  "body": {
    "labels": [
      "gpu",
      "accelerated"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove all custom labels from a self-hosted runner for an organization — github.actions.remove-all-custom-labels-from-self-hosted-runner-for-org

Remove all custom labels from a self-hosted runner configured in an organization. Returns the remaining read-only labels from the runner.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_id integer Required Unique identifier of the self-hosted runner.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove a custom label from a self-hosted runner for an organization — github.actions.remove-custom-label-from-self-hosted-runner-for-org

Remove a custom label from a self-hosted runner configured in an organization. Returns the remaining labels from the runner.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.runner_id integer Required Unique identifier of the self-hosted runner.
path.name string Required The name of a self-hosted runner's custom label.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "runner_id": 1,
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization secrets — github.actions.list-org-secrets

Lists all secrets available in an organization without revealing their encrypted values.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization public key — github.actions.get-org-public-key

Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization secret — github.actions.get-org-secret

Gets a single organization secret without revealing its encrypted value.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update an organization secret — github.actions.create-or-update-org-secret

Creates or updates an organization secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
body object Required
body.encrypted_value string Required Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
body.key_id string Required ID of the key you used to encrypt the secret.
body.visibility string Required Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret. enum: ["all","private","selected"]
body.selected_repository_ids array Optional An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
body.selected_repository_ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  },
  "body": {
    "encrypted_value": "c2VjcmV0",
    "key_id": "012345678912345678",
    "visibility": "selected",
    "selected_repository_ids": [
      1296269,
      1296280
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an organization secret — github.actions.delete-org-secret

Deletes a secret in an organization using the secret name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List selected repositories for an organization secret — github.actions.list-selected-repos-for-org-secret

Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set selected repositories for an organization secret — github.actions.set-selected-repos-for-org-secret

Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
body object Required
body.selected_repository_ids array Required An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Add selected repository to an organization secret and Remove selected repository from an organization secret endpoints.
body.selected_repository_ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  },
  "body": {
    "selected_repository_ids": [
      64780797
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add selected repository to an organization secret — github.actions.add-selected-repo-to-org-secret

Adds a repository to an organization secret when the visibility for repository access is set to selected. For more information about setting the visibility, see Create or update an organization secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
path.repository_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove selected repository from an organization secret — github.actions.remove-selected-repo-from-org-secret

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
path.repository_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization variables — github.actions.list-org-variables

Lists all organization variables.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 30). For more information, see "Using pagination in the REST API." default: 10
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an organization variable — github.actions.create-org-variable

Creates an organization variable that you can reference in a GitHub Actions workflow.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.name string Required The name of the variable.
body.value string Required The value of the variable.
body.visibility string Required The type of repositories in the organization that can access the variable. selected means only the repositories specified by selected_repository_ids can access the variable. enum: ["all","private","selected"]
body.selected_repository_ids array Optional An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the visibility is set to selected.
body.selected_repository_ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "name": "USERNAME",
    "value": "octocat",
    "visibility": "selected",
    "selected_repository_ids": [
      1296269,
      1296280
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization variable — github.actions.get-org-variable

Gets a specific variable in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.name string Required The name of the variable.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an organization variable — github.actions.update-org-variable

Updates an organization variable that you can reference in a GitHub Actions workflow.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.name string Required The name of the variable.
body object Required
body.name string Optional The name of the variable.
body.value string Optional The value of the variable.
body.visibility string Optional The type of repositories in the organization that can access the variable. selected means only the repositories specified by selected_repository_ids can access the variable. enum: ["all","private","selected"]
body.selected_repository_ids array Optional An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the visibility is set to selected.
body.selected_repository_ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "name": "example"
  },
  "body": {
    "name": "USERNAME",
    "value": "octocat",
    "visibility": "selected",
    "selected_repository_ids": [
      1296269,
      1296280
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an organization variable — github.actions.delete-org-variable

Deletes an organization variable using the variable name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.name string Required The name of the variable.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List selected repositories for an organization variable — github.actions.list-selected-repos-for-org-variable

Lists all repositories that can access an organization variable that is available to selected repositories.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.name string Required The name of the variable.
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set selected repositories for an organization variable — github.actions.set-selected-repos-for-org-variable

Replaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.name string Required The name of the variable.
body object Required
body.selected_repository_ids array Required The IDs of the repositories that can access the organization variable.
body.selected_repository_ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "name": "example"
  },
  "body": {
    "selected_repository_ids": [
      64780797
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add selected repository to an organization variable — github.actions.add-selected-repo-to-org-variable

Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.name string Required The name of the variable.
path.repository_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "name": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove selected repository from an organization variable — github.actions.remove-selected-repo-from-org-variable

Removes a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.name string Required The name of the variable.
path.repository_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "name": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization secrets — github.agents.list-org-secrets

Lists all secrets available in an organization without revealing their encrypted values.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization public key — github.agents.get-org-public-key

Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization secret — github.agents.get-org-secret

Gets a single organization secret without revealing its encrypted value.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update an organization secret — github.agents.create-or-update-org-secret

Creates or updates an organization secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
body object Required
body.encrypted_value string Required Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
body.key_id string Required ID of the key you used to encrypt the secret.
body.visibility string Required Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret. enum: ["all","private","selected"]
body.selected_repository_ids array Optional An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
body.selected_repository_ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  },
  "body": {
    "encrypted_value": "c2VjcmV0",
    "key_id": "012345678912345678",
    "visibility": "selected",
    "selected_repository_ids": [
      1296269,
      1296280
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an organization secret — github.agents.delete-org-secret

Deletes a secret in an organization using the secret name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List selected repositories for an organization secret — github.agents.list-selected-repos-for-org-secret

Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set selected repositories for an organization secret — github.agents.set-selected-repos-for-org-secret

Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
body object Required
body.selected_repository_ids array Required An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Add selected repository to an organization secret and Remove selected repository from an organization secret endpoints.
body.selected_repository_ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  },
  "body": {
    "selected_repository_ids": [
      64780797
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add selected repository to an organization secret — github.agents.add-selected-repo-to-org-secret

Adds a repository to an organization secret when the visibility for repository access is set to selected. For more information about setting the visibility, see Create or update an organization secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
path.repository_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove selected repository from an organization secret — github.agents.remove-selected-repo-from-org-secret

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
path.repository_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization variables — github.agents.list-org-variables

Lists all agent variables available in an organization. Returned variables include their values.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 30). For more information, see "Using pagination in the REST API." default: 10
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an organization variable — github.agents.create-org-variable

Creates an organization agent variable that you can reference in a GitHub Actions workflow.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.name string Required The name of the variable.
body.value string Required The value of the variable.
body.visibility string Required The type of repositories in the organization that can access the variable. selected means only the repositories specified by selected_repository_ids can access the variable. enum: ["all","private","selected"]
body.selected_repository_ids array Optional An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the visibility is set to selected.
body.selected_repository_ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "name": "USERNAME",
    "value": "octocat",
    "visibility": "selected",
    "selected_repository_ids": [
      1296269,
      1296280
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization variable — github.agents.get-org-variable

Gets a specific agent variable in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.name string Required The name of the variable.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an organization variable — github.agents.update-org-variable

Updates an organization agent variable that you can reference in a GitHub Actions workflow.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.name string Required The name of the variable.
body object Required
body.name string Optional The name of the variable.
body.value string Optional The value of the variable.
body.visibility string Optional The type of repositories in the organization that can access the variable. selected means only the repositories specified by selected_repository_ids can access the variable. enum: ["all","private","selected"]
body.selected_repository_ids array Optional An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the visibility is set to selected.
body.selected_repository_ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "name": "example"
  },
  "body": {
    "name": "USERNAME",
    "value": "octocat",
    "visibility": "selected",
    "selected_repository_ids": [
      1296269,
      1296280
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an organization variable — github.agents.delete-org-variable

Deletes an organization agent variable using the variable name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.name string Required The name of the variable.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List selected repositories for an organization variable — github.agents.list-selected-repos-for-org-variable

Lists all repositories that can access an organization agent variable that is available to selected repositories.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.name string Required The name of the variable.
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set selected repositories for an organization variable — github.agents.set-selected-repos-for-org-variable

Replaces all repositories for an organization agent variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.name string Required The name of the variable.
body object Required
body.selected_repository_ids array Required The IDs of the repositories that can access the organization variable.
body.selected_repository_ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "name": "example"
  },
  "body": {
    "selected_repository_ids": [
      64780797
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add selected repository to an organization variable — github.agents.add-selected-repo-to-org-variable

Adds a repository to an organization agent variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.name string Required The name of the variable.
path.repository_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "name": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove selected repository from an organization variable — github.agents.remove-selected-repo-from-org-variable

Removes a repository from an organization agent variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.name string Required The name of the variable.
path.repository_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "name": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an artifact deployment record — github.orgs.create-artifact-deployment-record

Create or update deployment records for an artifact associated with an organization. This endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment. The deployment name has to be uniqe within a cluster (i.e a combination of logical, physical environment and cluster) as it identifies unique deployment. Multiple requests for the same combination of logical, physical environment, cluster and deployment name will only create one record, successive request will update the existing record. This allows for a stable tracking of a deployment where the actual deployed artifact can change over time.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.name string Required The name of the artifact. minLength: 1; maxLength: 256
body.digest string Required The hex encoded digest of the artifact. minLength: 71; maxLength: 71; pattern: "^sha256:[a-f0-9]{64}$"
body.version string Optional The artifact version. minLength: 1; maxLength: 100
body.status string Required The status of the artifact. Can be either deployed or decommissioned. enum: ["deployed","decommissioned"]
body.logical_environment string Required The stage of the deployment. minLength: 1; maxLength: 128
body.physical_environment string Optional The physical region of the deployment. maxLength: 128
body.cluster string Optional The deployment cluster. maxLength: 128
body.deployment_name string Required The unique identifier for the deployment represented by the new record. To accommodate differing containers and namespaces within a cluster, the following format is recommended: {namespaceName}-{deploymentName}-{containerName}. maxLength: 256
body.tags object Optional The tags associated with the deployment. maxProperties: 5; additionalProperties: {"type":"string"}
body.runtime_risks array Optional A list of runtime risks associated with the deployment. maxItems: 4; uniqueItems: true
body.runtime_risks[] string Optional enum: ["critical-resource","internet-exposed","lateral-movement","sensitive-data"]
body.github_repository string Optional The name of the GitHub repository associated with the artifact. This should be used when there are no provenance attestations available for the artifact. The repository must belong to the organization specified in the path parameter. If a provenance attestation is available for the artifact, the API will use the repository information from the attestation instead of this parameter. minLength: 1; maxLength: 100; pattern: "^[A-Za-z0-9.\\-_]+$"
body.return_records boolean Optional If true, the endpoint will return the created or updated record in the response body. default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "name": "awesome-image",
    "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72",
    "status": "deployed",
    "logical_environment": "prod",
    "physical_environment": "pacific-east",
    "cluster": "moda-1",
    "deployment_name": "deployment-pod",
    "tags": {
      "data-access": "sensitive"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set cluster deployment records — github.orgs.set-cluster-deployment-records

Set deployment records for a given cluster. If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. If no existing records match, new records will be created. Note: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments array resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use the artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can only have one name and version.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.cluster string Required The cluster name. minLength: 1; maxLength: 128; pattern: "^[a-zA-Z0-9._-]+$"
body object Required
body.logical_environment string Required The stage of the deployment. minLength: 1; maxLength: 128
body.physical_environment string Optional The physical region of the deployment. maxLength: 128
body.deployments array Required The list of deployments to record. maxItems: 1000
body.deployments[] object Optional
body.deployments[].name string Required The name of the artifact. minLength: 1; maxLength: 256
body.deployments[].digest string Required The hex encoded digest of the artifact. minLength: 71; maxLength: 71; pattern: "^sha256:[a-f0-9]{64}$"
body.deployments[].version string Optional The artifact version. maxLength: 100
body.deployments[].status string Optional The deployment status of the artifact. enum: ["deployed","decommissioned"]; default: "deployed"
body.deployments[].deployment_name string Required The unique identifier for the deployment represented by the new record. To accommodate differing containers and namespaces within a record set, the following format is recommended: {namespaceName}-{deploymentName}-{containerName}. The deployment_name must be unique across all entries in the deployments array. minLength: 1; maxLength: 256
body.deployments[].github_repository string Optional The name of the GitHub repository associated with the artifact. This should be used when there are no provenance attestations available for the artifact. The repository must belong to the organization specified in the path parameter. If a provenance attestation is available for the artifact, the API will use the repository information from the attestation instead of this parameter. maxLength: 100; pattern: "^[A-Za-z0-9.\\-_]+$"
body.deployments[].tags object Optional Key-value pairs to tag the deployment record. additionalProperties: {"type":"string"}
body.deployments[].runtime_risks array Optional A list of runtime risks associated with the deployment. maxItems: 4; uniqueItems: true
body.deployments[].runtime_risks[] string Optional enum: ["critical-resource","internet-exposed","lateral-movement","sensitive-data"]
body.partial_success boolean Optional When enabled, deployments associated with repositories the actor can write to are processed while deployments associated with repositories that cannot be resolved or written to by the actor are skipped and reported in the errors array. When false (the default), the endpoint returns an error if any targeted repository cannot be resolved, the actor lacks write access, or no matching attestation can be found. default: false
body.return_records boolean Optional If true, the endpoint will return the set records in the response body default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "cluster": "example"
  },
  "body": {
    "logical_environment": "prod",
    "physical_environment": "pacific-east",
    "deployments": [
      {
        "name": "awesome-image",
        "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72",
        "version": "2.1.0",
        "status": "deployed",
        "deployment_name": "deployment-pod",
        "tags": {
          "owning-team": "platform"
        },
        "runtime_risks": [
          "sensitive-data"
        ]
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a cluster deployment records job — github.orgs.create-cluster-deployment-records-job

Create a background job to set deployment records for a given cluster. Performs validation and permission checks synchronously, returning rejected deployments immediately, then enqueues a background job for the actual deployment updates. Use the companion GET endpoint to poll for job status.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.cluster string Required The cluster name. minLength: 1; maxLength: 128; pattern: "^[a-zA-Z0-9._-]+$"
body object Required
body.logical_environment string Required The stage of the deployment. minLength: 1; maxLength: 128
body.physical_environment string Optional The physical region of the deployment. maxLength: 128
body.deployments array Required The list of deployments to record. maxItems: 5000
body.deployments[] object Optional
body.deployments[].name string Required The name of the artifact. minLength: 1; maxLength: 256
body.deployments[].digest string Required The hex encoded digest of the artifact. minLength: 71; maxLength: 71; pattern: "^sha256:[a-f0-9]{64}$"
body.deployments[].version string Optional The artifact version. maxLength: 100
body.deployments[].status string Optional The deployment status of the artifact. enum: ["deployed","decommissioned"]; default: "deployed"
body.deployments[].deployment_name string Required The unique identifier for the deployment represented by the new record. minLength: 1; maxLength: 256
body.deployments[].github_repository string Optional The name of the GitHub repository associated with the artifact. maxLength: 100; pattern: "^[A-Za-z0-9.\\-_]+$"
body.deployments[].tags object Optional Key-value pairs to tag the deployment record. additionalProperties: {"type":"string"}
body.deployments[].runtime_risks array Optional A list of runtime risks associated with the deployment. maxItems: 4; uniqueItems: true
body.deployments[].runtime_risks[] string Optional enum: ["critical-resource","internet-exposed","lateral-movement","sensitive-data"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "cluster": "example"
  },
  "body": {
    "logical_environment": "prod",
    "physical_environment": "pacific-east",
    "deployments": [
      {
        "name": "awesome-image",
        "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72",
        "version": "2.1.0",
        "status": "deployed",
        "deployment_name": "deployment-pod",
        "tags": {
          "owning-team": "platform"
        },
        "runtime_risks": [
          "sensitive-data"
        ]
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get cluster deployment records job status — github.orgs.get-cluster-deployment-records-job

Get the status and results of a previously created cluster deployment records job.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.cluster string Required The cluster name. minLength: 1; maxLength: 128; pattern: "^[a-zA-Z0-9._-]+$"
path.job_id integer Required The ID of the job.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "cluster": "example",
    "job_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create artifact metadata storage record — github.orgs.create-artifact-storage-record

Create metadata storage records for artifacts associated with an organization. This endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and associated with a repository owned by the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.name string Required The name of the artifact. minLength: 1; maxLength: 256
body.digest string Required The digest of the artifact (algorithm:hex-encoded-digest). minLength: 71; maxLength: 71; pattern: "^sha256:[a-f0-9]{64}$"
body.version string Optional The artifact version. minLength: 1; maxLength: 100
body.artifact_url string Optional The URL where the artifact is stored. maxLength: 152; pattern: "^https://"; format: "uri"
body.path string Optional The path of the artifact. maxLength: 512; format: "uri"
body.registry_url string Required The base URL of the artifact registry. minLength: 1; maxLength: 256; pattern: "^https://"; format: "uri"
body.repository string Optional The repository name within the registry. maxLength: 128
body.status string Optional The status of the artifact (e.g., active, inactive). enum: ["active","eol","deleted"]; default: "active"
body.github_repository string Optional The name of the GitHub repository associated with the artifact. This should be used when there are no provenance attestations available for the artifact. The repository must belong to the organization specified in the path parameter. If a provenance attestation is available for the artifact, the API will use the repository information from the attestation instead of this parameter. minLength: 1; maxLength: 100; pattern: "^[A-Za-z0-9.\\-_]+$"
body.return_records boolean Optional If true, the endpoint will return the created record in the response body. default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "name": "libfoo",
    "version": "1.2.3",
    "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72",
    "artifact_url": "https://reg.example.com/artifactory/bar/libfoo-1.2.3",
    "registry_url": "https://reg.example.com/artifactory/",
    "repository": "bar",
    "status": "active"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List artifact storage records — github.orgs.list-artifact-storage-records

List artifact storage records with a given subject digest for repositories owned by an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.subject_digest string Required The parameter should be set to the attestation's subject's SHA256 digest, in the form sha256:HEX_DIGEST. minLength: 71; maxLength: 71; pattern: "^sha256:[a-f0-9]{64}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "subject_digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List attestations by bulk subject digests — github.orgs.list-attestations-bulk

List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.subject_digests array Required List of subject digests to fetch attestations for. minItems: 1; maxItems: 1024
body.subject_digests[] string Optional
body.predicate_type string Optional Optional filter for fetching attestations with a given predicate type. This option accepts provenance, sbom, release, or freeform text for custom predicate types.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "subject_digests": [
      "example"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete attestations in bulk — github.orgs.delete-attestations-bulk

Delete artifact attestations in bulk by either subject digests or unique ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required The request body must include either subject_digests or attestation_ids, but not both.
body object Required oneOf[1]
body.subject_digests array Required List of subject digests associated with the artifact attestations to delete. oneOf[1]; minItems: 1; maxItems: 1024
body.subject_digests[] string Optional oneOf[1]
body object Required oneOf[2]
body.attestation_ids array Required List of unique IDs associated with the artifact attestations to delete. oneOf[2]; minItems: 1; maxItems: 1024
body.attestation_ids[] integer Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "subject_digests": [
      "sha256:abc123",
      "sha512:def456"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete attestations by subject digest — github.orgs.delete-attestations-by-subject-digest

Delete an artifact attestation by subject digest.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.subject_digest string Required Subject Digest

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "subject_digest": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List attestation repositories — github.orgs.list-attestation-repositories

List repositories owned by the provided organization that have created at least one attested artifact Results will be sorted in ascending order by repository ID

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.predicate_type string Optional Optional filter for fetching attestations with a given predicate type. This option accepts provenance, sbom, release, or freeform text for custom predicate types.
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete attestations by ID — github.orgs.delete-attestations-by-id

Delete an artifact attestation by unique ID that is associated with a repository owned by an org.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.attestation_id integer Required Attestation ID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "attestation_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List attestations — github.orgs.list-attestations

List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.predicate_type string Optional Optional filter for fetching attestations with a given predicate type. This option accepts provenance, sbom, release, or freeform text for custom predicate types.
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.subject_digest string Required The parameter should be set to the attestation's subject's SHA256 digest, in the form sha256:HEX_DIGEST.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "subject_digest": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List users blocked by an organization — github.orgs.list-blocked-users

List the users blocked by an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check if a user is blocked by an organization — github.orgs.check-blocked-user

Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Block a user from an organization — github.orgs.block-user

Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Unblock a user from an organization — github.orgs.unblock-user

Unblocks the given user on behalf of the specified organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List campaigns for an organization — github.campaigns.list-org-campaigns

Lists campaigns in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.state — Optional If specified, only campaigns with this state will be returned. $ref: "#/definitions/campaign-state"
query.sort string Optional The property by which to sort the results. enum: ["created","updated","ends_at","published"]; default: "created"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a campaign for an organization — github.campaigns.create-campaign

Create a campaign for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required additionalProperties: false
body.name string Required The name of the campaign minLength: 1; maxLength: 50
body.description string Required A description for the campaign minLength: 1; maxLength: 255
body.managers array Optional The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. maxItems: 10
body.managers[] string Optional The login of each manager
body.team_managers array Optional The slugs of the teams to set as the campaign managers. maxItems: 10
body.team_managers[] string Optional The slug of each team
body.ends_at string Required The end date and time of the campaign. The date must be in the future. format: "date-time"
body.contact_link string | null Optional The contact link of the campaign. Must be a URI. format: "uri"
body.code_scanning_alerts array | null Optional The code scanning alerts to include in this campaign minItems: 1
body.code_scanning_alerts[] object Optional additionalProperties: false
body.code_scanning_alerts[].repository_id integer Required The repository id
body.code_scanning_alerts[].alert_numbers array Required The alert numbers minItems: 1
body.code_scanning_alerts[].alert_numbers[] integer Optional
body.generate_issues boolean Optional If true, will automatically generate issues for the campaign. The default is false. default: false
body — Required oneOf[1]
body — Required oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "name": "Critical CodeQL alerts",
    "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.",
    "managers": [
      "octocat"
    ],
    "ends_at": "2024-03-14T00:00:00Z",
    "code_scanning_alerts": [
      {
        "repository_id": 1296269,
        "alert_numbers": [
          1,
          2
        ]
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a campaign for an organization — github.campaigns.get-campaign-summary

Gets a campaign for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.campaign_number integer Required The campaign number.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "campaign_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a campaign — github.campaigns.update-campaign

Updates a campaign in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.campaign_number integer Required The campaign number.
body object Required additionalProperties: false
body.name string Optional The name of the campaign minLength: 1; maxLength: 50
body.description string Optional A description for the campaign minLength: 1; maxLength: 255
body.managers array Optional The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. maxItems: 10
body.managers[] string Optional
body.team_managers array Optional The slugs of the teams to set as the campaign managers. maxItems: 10
body.team_managers[] string Optional The slug of each team
body.ends_at string Optional The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
body.contact_link string | null Optional The contact link of the campaign. Must be a URI. format: "uri"
body.state — Optional $ref: "#/definitions/campaign-state"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "campaign_number": 1
  },
  "body": {
    "name": "Critical CodeQL alerts"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a campaign for an organization — github.campaigns.delete-campaign

Deletes a campaign in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.campaign_number integer Required The campaign number.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "campaign_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the AI Scan setting for an organization — github.code-scanning.get-ai-scan-enablement-for-org

Gets the AI Scan setting stored on an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List code scanning alerts for an organization — github.code-scanning.list-alerts-for-org

Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "Managing security managers in your organization."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.tool_name — Optional The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both. $ref: "#/definitions/code-scanning-analysis-tool-name"
query.tool_guid — Optional The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both. $ref: "#/definitions/code-scanning-analysis-tool-guid"
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.state — Optional If specified, only code scanning alerts with this state will be returned. $ref: "#/definitions/code-scanning-alert-state-query"
query.sort string Optional The property by which to sort the results. enum: ["created","updated"]; default: "created"
query.severity — Optional If specified, only code scanning alerts with this severity will be returned. $ref: "#/definitions/code-scanning-alert-severity"
query.assignees string Optional Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot). Use * to list alerts with at least one assignee or none to list alerts with no assignees.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get code security configurations for an organization — github.code-security.get-configurations-for-org

Lists all code security configurations available in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.target_type string Optional The target type of the code security configuration enum: ["global","all"]; default: "all"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a code security configuration — github.code-security.create-configuration

Creates a code security configuration in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required additionalProperties: false
body.name string Required The name of the code security configuration. Must be unique within the organization.
body.description string Optional A description of the code security configuration maxLength: 255
body.advanced_security string Optional The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features. > [!WARNING] > code_security and secret_protection are deprecated values for this field. Prefer the individual code_security and secret_protection fields to set the status of these features. enum: ["enabled","disabled","code_security","secret_protection"]; default: "disabled"
body.code_security string Optional The enablement status of GitHub Code Security features. enum: ["enabled","disabled","not_set"]
body.dependency_graph string Optional The enablement status of Dependency Graph enum: ["enabled","disabled","not_set"]; default: "enabled"
body.dependency_graph_autosubmit_action string Optional The enablement status of Automatic dependency submission enum: ["enabled","disabled","not_set"]; default: "disabled"
body.dependency_graph_autosubmit_action_options object Optional Feature options for Automatic dependency submission
body.dependency_graph_autosubmit_action_options.labeled_runners boolean Optional Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. default: false
body.dependabot_alerts string Optional The enablement status of Dependabot alerts enum: ["enabled","disabled","not_set"]; default: "disabled"
body.dependabot_reachability string Optional The enablement status of reachability analysis for Dependabot. Only available for organizations with access to reachability analysis. Requires Dependabot alerts to be enabled when set to enabled. Must be disabled when Dependabot alerts is disabled. not_set leaves existing repository settings unchanged. enum: ["enabled","disabled","not_set"]; default: "disabled"
body.dependabot_security_updates string Optional The enablement status of Dependabot security updates enum: ["enabled","disabled","not_set"]; default: "disabled"
body.dependabot_delegated_alert_dismissal string Optional The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled. enum: ["enabled","disabled","not_set"]; default: "disabled"
body.code_scanning_options — Optional $ref: "#/definitions/code-scanning-options"
body.code_scanning_default_setup string Optional The enablement status of code scanning default setup enum: ["enabled","disabled","not_set"]; default: "disabled"
body.code_scanning_default_setup_options — Optional $ref: "#/definitions/code-scanning-default-setup-options"
body.code_scanning_delegated_alert_dismissal string Optional The enablement status of code scanning delegated alert dismissal enum: ["enabled","disabled","not_set"]; default: "not_set"
body.secret_protection string Optional The enablement status of GitHub Secret Protection features. enum: ["enabled","disabled","not_set"]
body.secret_scanning string Optional The enablement status of secret scanning enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_scanning_push_protection string Optional The enablement status of secret scanning push protection enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_scanning_delegated_bypass string Optional The enablement status of secret scanning delegated bypass enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_scanning_delegated_bypass_options object Optional Feature options for secret scanning delegated bypass
body.secret_scanning_delegated_bypass_options.reviewers array Optional The bypass reviewers for secret scanning delegated bypass
body.secret_scanning_delegated_bypass_options.reviewers[] object Optional
body.secret_scanning_delegated_bypass_options.reviewers[].reviewer_id integer Required The ID of the team or role selected as a bypass reviewer
body.secret_scanning_delegated_bypass_options.reviewers[].reviewer_type string Required The type of the bypass reviewer enum: ["TEAM","ROLE"]
body.secret_scanning_delegated_bypass_options.reviewers[].mode string Optional The bypass mode for the reviewer enum: ["ALWAYS","EXEMPT"]; default: "ALWAYS"
body.secret_scanning_validity_checks string Optional The enablement status of secret scanning validity checks enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_scanning_non_provider_patterns string Optional The enablement status of secret scanning non provider patterns enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_scanning_generic_secrets string Optional The enablement status of Copilot secret scanning enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_scanning_generic_secrets_push_protection string Optional The enablement status of generic secrets push protection enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_scanning_delegated_alert_dismissal string Optional The enablement status of secret scanning delegated alert dismissal enum: ["enabled","disabled","not_set"]
body.secret_scanning_extended_metadata string Optional The enablement status of secret scanning extended metadata enum: ["enabled","disabled","not_set"]
body.private_vulnerability_reporting string Optional The enablement status of private vulnerability reporting enum: ["enabled","disabled","not_set"]; default: "disabled"
body.enforcement string Optional The enforcement status for a security configuration enum: ["enforced","unenforced"]; default: "enforced"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "name": "octo-org recommended settings",
    "description": "This is a code security configuration for octo-org",
    "advanced_security": "enabled",
    "dependabot_alerts": "enabled",
    "dependabot_security_updates": "not_set",
    "secret_scanning": "enabled"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get default code security configurations — github.code-security.get-default-configurations

Lists the default code security configurations for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Detach configurations from repositories — github.code-security.detach-configuration

Detach code security configuration(s) from a set of repositories. Repositories will retain their settings but will no longer be associated with the configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required additionalProperties: false
body.selected_repository_ids array Required An array of repository IDs to detach from configurations. Up to 250 IDs can be provided. minItems: 1; maxItems: 250
body.selected_repository_ids[] integer Optional Unique identifier of the repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "selected_repository_ids": [
      32,
      91
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a code security configuration — github.code-security.get-configuration

Gets a code security configuration available in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.configuration_id integer Required The unique identifier of the code security configuration.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "configuration_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a code security configuration — github.code-security.update-configuration

Updates a code security configuration in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.configuration_id integer Required The unique identifier of the code security configuration.
body object Required additionalProperties: false
body.name string Optional The name of the code security configuration. Must be unique within the organization.
body.description string Optional A description of the code security configuration maxLength: 255
body.advanced_security string Optional The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features. > [!WARNING] > code_security and secret_protection are deprecated values for this field. Prefer the individual code_security and secret_protection fields to set the status of these features. enum: ["enabled","disabled","code_security","secret_protection"]
body.code_security string Optional The enablement status of GitHub Code Security features. enum: ["enabled","disabled","not_set"]
body.dependency_graph string Optional The enablement status of Dependency Graph enum: ["enabled","disabled","not_set"]
body.dependency_graph_autosubmit_action string Optional The enablement status of Automatic dependency submission enum: ["enabled","disabled","not_set"]
body.dependency_graph_autosubmit_action_options object Optional Feature options for Automatic dependency submission
body.dependency_graph_autosubmit_action_options.labeled_runners boolean Optional Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.
body.dependabot_alerts string Optional The enablement status of Dependabot alerts enum: ["enabled","disabled","not_set"]
body.dependabot_reachability string Optional The enablement status of reachability analysis for Dependabot. Only available for organizations with access to reachability analysis. Requires Dependabot alerts to be enabled when set to enabled. Must be disabled when Dependabot alerts is disabled. not_set leaves existing repository settings unchanged. Omit this field to preserve the configuration's current value. enum: ["enabled","disabled","not_set"]
body.dependabot_security_updates string Optional The enablement status of Dependabot security updates enum: ["enabled","disabled","not_set"]
body.dependabot_delegated_alert_dismissal string Optional The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled. enum: ["enabled","disabled","not_set"]
body.code_scanning_default_setup string Optional The enablement status of code scanning default setup enum: ["enabled","disabled","not_set"]
body.code_scanning_default_setup_options — Optional $ref: "#/definitions/code-scanning-default-setup-options"
body.code_scanning_options — Optional $ref: "#/definitions/code-scanning-options"
body.code_scanning_delegated_alert_dismissal string Optional The enablement status of code scanning delegated alert dismissal enum: ["enabled","disabled","not_set"]; default: "disabled"
body.secret_protection string Optional The enablement status of GitHub Secret Protection features. enum: ["enabled","disabled","not_set"]
body.secret_scanning string Optional The enablement status of secret scanning enum: ["enabled","disabled","not_set"]
body.secret_scanning_push_protection string Optional The enablement status of secret scanning push protection enum: ["enabled","disabled","not_set"]
body.secret_scanning_delegated_bypass string Optional The enablement status of secret scanning delegated bypass enum: ["enabled","disabled","not_set"]
body.secret_scanning_delegated_bypass_options object Optional Feature options for secret scanning delegated bypass
body.secret_scanning_delegated_bypass_options.reviewers array Optional The bypass reviewers for secret scanning delegated bypass
body.secret_scanning_delegated_bypass_options.reviewers[] object Optional
body.secret_scanning_delegated_bypass_options.reviewers[].reviewer_id integer Required The ID of the team or role selected as a bypass reviewer
body.secret_scanning_delegated_bypass_options.reviewers[].reviewer_type string Required The type of the bypass reviewer enum: ["TEAM","ROLE"]
body.secret_scanning_delegated_bypass_options.reviewers[].mode string Optional The bypass mode for the reviewer enum: ["ALWAYS","EXEMPT"]; default: "ALWAYS"
body.secret_scanning_validity_checks string Optional The enablement status of secret scanning validity checks enum: ["enabled","disabled","not_set"]
body.secret_scanning_non_provider_patterns string Optional The enablement status of secret scanning non-provider patterns enum: ["enabled","disabled","not_set"]
body.secret_scanning_generic_secrets string Optional The enablement status of Copilot secret scanning enum: ["enabled","disabled","not_set"]
body.secret_scanning_generic_secrets_push_protection string Optional The enablement status of generic secrets push protection enum: ["enabled","disabled","not_set"]
body.secret_scanning_delegated_alert_dismissal string Optional The enablement status of secret scanning delegated alert dismissal enum: ["enabled","disabled","not_set"]
body.secret_scanning_extended_metadata string Optional The enablement status of secret scanning extended metadata enum: ["enabled","disabled","not_set"]
body.private_vulnerability_reporting string Optional The enablement status of private vulnerability reporting enum: ["enabled","disabled","not_set"]
body.enforcement string Optional The enforcement status for a security configuration enum: ["enforced","unenforced"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "configuration_id": 1
  },
  "body": {
    "name": "octo-org recommended settings v2",
    "secret_scanning": "disabled",
    "code_scanning_default_setup": "enabled"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a code security configuration — github.code-security.delete-configuration

Deletes the desired code security configuration from an organization. Repositories attached to the configuration will retain their settings but will no longer be associated with the configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.configuration_id integer Required The unique identifier of the code security configuration.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "configuration_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Attach a configuration to repositories — github.code-security.attach-configuration

Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.configuration_id integer Required The unique identifier of the code security configuration.
body object Required additionalProperties: false
body.scope string Required The type of repositories to attach the configuration to. selected means the configuration will be attached to only the repositories specified by selected_repository_ids enum: ["all","all_without_configurations","public","private_or_internal","selected"]
body.selected_repository_ids array Optional An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the scope is set to selected.
body.selected_repository_ids[] integer Optional Unique identifier of the repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "configuration_id": 1
  },
  "body": {
    "scope": "selected",
    "selected_repository_ids": [
      32,
      91
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set a code security configuration as a default for an organization — github.code-security.set-configuration-as-default

Sets a code security configuration as a default to be applied to new repositories in your organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.configuration_id integer Required The unique identifier of the code security configuration.
body object Required
body.default_for_new_repos string Optional Specify which types of repository this security configuration should be applied to by default. enum: ["all","none","private_and_internal","public"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "configuration_id": 1
  },
  "body": {
    "default_for_new_repos": "all"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get repositories associated with a code security configuration — github.code-security.get-repositories-for-configuration

Lists the repositories associated with a code security configuration in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.configuration_id integer Required The unique identifier of the code security configuration.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.status string Optional A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. Can be: all, attached, attaching, detached, removed, enforced, failed, updating, removed_by_enterprise, enterprise_enforced default: "all"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "configuration_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List codespaces for the organization — github.codespaces.list-in-organization

Lists the codespaces associated to a specified organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization secrets — github.codespaces.list-org-secrets

Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization public key — github.codespaces.get-org-public-key

Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization secret — github.codespaces.get-org-secret

Gets an organization development environment secret without revealing its encrypted value.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update an organization secret — github.codespaces.create-or-update-org-secret

Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
body object Required
body.encrypted_value string Optional The value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
body.key_id string Optional The ID of the key you used to encrypt the secret.
body.visibility string Required Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret. enum: ["all","private","selected"]
body.selected_repository_ids array Optional An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
body.selected_repository_ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  },
  "body": {
    "encrypted_value": "c2VjcmV0",
    "key_id": "012345678912345678",
    "visibility": "selected",
    "selected_repository_ids": [
      1296269,
      1296280
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an organization secret — github.codespaces.delete-org-secret

Deletes an organization development environment secret using the secret name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List selected repositories for an organization secret — github.codespaces.list-selected-repos-for-org-secret

Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set selected repositories for an organization secret — github.codespaces.set-selected-repos-for-org-secret

Replaces all repositories for an organization development environment secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
body object Required
body.selected_repository_ids array Required An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.
body.selected_repository_ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  },
  "body": {
    "selected_repository_ids": [
      64780797
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add selected repository to an organization secret — github.codespaces.add-selected-repo-to-org-secret

Adds a repository to an organization development environment secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
path.repository_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove selected repository from an organization secret — github.codespaces.remove-selected-repo-from-org-secret

Removes a repository from an organization development environment secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
path.repository_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization Copilot Spaces — github.copilot-spaces.list-for-org

Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). default: 30; minimum: 1; maximum: 100
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an organization Copilot Space — github.copilot-spaces.create-for-org

Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.name string Required The name of the Copilot Space.
body.description string Optional A description of the Copilot Space.
body.general_instructions string Optional General instructions for the Copilot Space. maxLength: 4000
body.base_role string Optional The base role that determines default permissions for organization members. - no_access: No default access (default) - reader: Organization members can read the space - writer: Organization members can read and edit the space - admin: Organization members have full admin access to the space enum: ["reader","writer","admin","no_access"]; default: "no_access"
body.resources_attributes array Optional Resources to attach to the space.
body.resources_attributes[] object Optional
body.resources_attributes[].resource_type string Optional The type of resource. enum: ["repository","github_file","free_text","github_issue","github_pull_request","media_content","uploaded_text_file"]
body.resources_attributes[].metadata object Optional Metadata specific to the resource type.
body.resources_attributes[].metadata.repository_id integer Optional Repository ID for repository or file resources.
body.resources_attributes[].metadata.file_path string Optional File path for file resources.
body.resources_attributes[].metadata.text string Optional Text content for free text resources.
body.resources_attributes[].metadata.name string Optional Name for the resource.
body.resources_attributes[].metadata.number integer Optional Issue or PR number.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "name": "Team Planning Space",
    "description": "Organization space for team planning and coordination",
    "general_instructions": "Help the team with planning and coordination tasks",
    "resources_attributes": [
      {
        "resource_type": "github_file",
        "metadata": {
          "repository_id": 123456,
          "file_path": "docs/planning.md"
        }
      },
      {
        "resource_type": "free_text",
        "metadata": {
          "name": "Team Guidelines",
          "text": "Our team follows agile methodology and holds daily standups"
        }
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization Copilot Space — github.copilot-spaces.get-for-org

Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.space_number integer Required The unique identifier of the Copilot Space.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "space_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set an organization Copilot Space — github.copilot-spaces.update-for-org

Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.space_number integer Required The unique identifier of the Copilot Space.
body object Required
body.name string Optional The name of the Copilot Space.
body.description string Optional A description of the Copilot Space.
body.general_instructions string Optional General instructions for the Copilot Space. maxLength: 4000
body.base_role string Optional The base role that determines default permissions for organization members. Changing this field requires admin permissions. - no_access: No default access (default) - reader: Organization members can read the space - writer: Organization members can read and edit the space - admin: Organization members have full admin access to the space enum: ["reader","writer","admin","no_access"]
body.resources_attributes array Optional Resources to attach to the space.
body.resources_attributes[] object Optional
body.resources_attributes[].resource_type string Optional The type of resource. enum: ["repository","github_file","free_text","github_issue","github_pull_request","media_content","uploaded_text_file"]
body.resources_attributes[].metadata object Optional Metadata specific to the resource type.
body.resources_attributes[].metadata.repository_id integer Optional Repository ID for repository or file resources.
body.resources_attributes[].metadata.file_path string Optional File path for file resources.
body.resources_attributes[].metadata.text string Optional Text content for free text resources.
body.resources_attributes[].metadata.name string Optional Name for the resource.
body.resources_attributes[].metadata.number integer Optional Issue or PR number.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "space_number": 1
  },
  "body": {
    "name": "Updated Team Planning Space",
    "description": "Updated organization space for team planning and coordination",
    "general_instructions": "Updated instructions to help the team with planning and coordination tasks",
    "resources_attributes": [
      {
        "resource_type": "github_file",
        "metadata": {
          "repository_id": 123456,
          "file_path": "docs/updated-planning.md"
        }
      },
      {
        "id": 789,
        "_destroy": true
      },
      {
        "id": 456,
        "resource_type": "free_text",
        "metadata": {
          "name": "Updated Team Guidelines",
          "text": "Our updated team follows agile methodology and holds daily standups"
        }
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an organization Copilot Space — github.copilot-spaces.delete-for-org

Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.space_number integer Required The unique identifier of the Copilot Space.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "space_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List collaborators for an organization Copilot Space — github.copilot-spaces.list-collaborators-for-org

Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.space_number integer Required The unique identifier of the Copilot Space.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "space_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a collaborator to an organization Copilot Space — github.copilot-spaces.add-collaborator-for-org

Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.space_number integer Required The unique identifier of the Copilot Space.
body object Required
body.actor_type string Required The type of actor (user or team). enum: ["User","Team"]
body.actor_identifier string Required The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.
body.role string Required The role to grant to the collaborator. enum: ["reader","writer","admin"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "space_number": 1
  },
  "body": {
    "actor_type": "User",
    "actor_identifier": "octocat",
    "role": "writer"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set a collaborator role for an organization Copilot Space — github.copilot-spaces.update-collaborator-for-org

Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.space_number integer Required The unique identifier of the Copilot Space.
path.actor_type string Required The type of actor (user or team). enum: ["User","Team"]
path.actor_identifier string Required The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.
body object Required
body.role string Required The new role to grant to the collaborator. Use no_access to remove the collaborator. enum: ["reader","writer","admin","no_access"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "space_number": 1,
    "actor_type": "User",
    "actor_identifier": "example"
  },
  "body": {
    "role": "admin"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove a collaborator from an organization Copilot Space — github.copilot-spaces.remove-collaborator-for-org

Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.space_number integer Required The unique identifier of the Copilot Space.
path.actor_type string Required The type of actor (user or team). enum: ["User","Team"]
path.actor_identifier string Required The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "space_number": 1,
    "actor_type": "User",
    "actor_identifier": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List resources for an organization Copilot Space — github.copilot-spaces.list-resources-for-org

Lists all resources attached to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view the space.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.space_number integer Required The unique identifier of the Copilot Space.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "space_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a resource for an organization Copilot Space — github.copilot-spaces.create-resource-for-org

Creates a new resource in a specific Copilot Space owned by an organization. The authenticated user must have write permissions on the space.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.space_number integer Required The unique identifier of the Copilot Space.
body object Required
body.resource_type string Required The type of resource to create. enum: ["repository","github_file","free_text","github_issue","github_pull_request"]
body.metadata object Required Resource-specific metadata. additionalProperties: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "space_number": 1
  },
  "body": {
    "resource_type": "free_text",
    "metadata": {
      "name": "notes.txt",
      "text": "Some helpful notes"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a resource for an organization Copilot Space — github.copilot-spaces.get-resource-for-org

Gets a specific resource attached to a Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view the space.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.space_number integer Required The unique identifier of the Copilot Space.
path.space_resource_id integer Required The unique identifier of the resource.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "space_number": 1,
    "space_resource_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set a resource for an organization Copilot Space — github.copilot-spaces.update-resource-for-org

Updates the metadata of a resource in a specific Copilot Space owned by an organization. The authenticated user must have write permissions on the space.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.space_number integer Required The unique identifier of the Copilot Space.
path.space_resource_id integer Required The unique identifier of the resource.
body object Required
body.metadata object Optional Updated resource-specific metadata. additionalProperties: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "space_number": 1,
    "space_resource_id": 1
  },
  "body": {
    "metadata": {
      "name": "updated-notes.txt",
      "text": "Updated content"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a resource from an organization Copilot Space — github.copilot-spaces.delete-resource-for-org

Deletes a resource from a specific Copilot Space owned by an organization. The authenticated user must have write permissions on the space.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.space_number integer Required The unique identifier of the Copilot Space.
path.space_resource_id integer Required The unique identifier of the resource.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "space_number": 1,
    "space_resource_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Copilot seat information and settings for an organization — github.copilot.get-copilot-organization-details

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all Copilot seat assignments for an organization — github.copilot.list-copilot-seats

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 50

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add teams to the Copilot subscription for an organization — github.copilot.add-copilot-seats-for-teams

> [!NOTE] > This endpoint is in public preview and is subject to change.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.selected_teams array Required List of team names within the organization to which to grant access to GitHub Copilot. minItems: 1
body.selected_teams[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "selected_teams": [
      "engteam1",
      "engteam2",
      "engteam3"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove teams from the Copilot subscription for an organization — github.copilot.cancel-copilot-seat-assignment-for-teams

> [!NOTE] > This endpoint is in public preview and is subject to change.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.selected_teams array Required The names of teams from which to revoke access to GitHub Copilot. minItems: 1
body.selected_teams[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "selected_teams": [
      "engteam1",
      "engteam2",
      "engteam3"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add users to the Copilot subscription for an organization — github.copilot.add-copilot-seats-for-users

> [!NOTE] > This endpoint is in public preview and is subject to change.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.selected_usernames array Required The usernames of the organization members to be granted access to GitHub Copilot. minItems: 1
body.selected_usernames[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "selected_usernames": [
      "cooluser1",
      "hacker2",
      "octocat"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove users from the Copilot subscription for an organization — github.copilot.cancel-copilot-seat-assignment-for-users

> [!NOTE] > This endpoint is in public preview and is subject to change.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.selected_usernames array Required The usernames of the organization members for which to revoke access to GitHub Copilot. minItems: 1
body.selected_usernames[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "selected_usernames": [
      "cooluser1",
      "hacker2",
      "octocat"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Copilot cloud agent permissions for an organization — github.copilot.get-copilot-coding-agent-permissions-organization

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set Copilot cloud agent permissions for an organization — github.copilot.set-copilot-coding-agent-permissions-organization

> [!NOTE] > This endpoint is in public preview and is subject to change.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.enabled_repositories string Required The policy for which repositories can use Copilot cloud agent. Can be one of all, selected, or none. enum: ["all","selected","none"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "enabled_repositories": "selected"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repositories enabled for Copilot cloud agent in an organization — github.copilot.list-copilot-coding-agent-selected-repositories-for-organization

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set selected repositories for Copilot cloud agent in an organization — github.copilot.set-copilot-coding-agent-selected-repositories-for-organization

> [!NOTE] > This endpoint is in public preview and is subject to change.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.selected_repository_ids array Required List of repository IDs to enable for Copilot cloud agent.
body.selected_repository_ids[] integer Optional Unique identifier of the repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "selected_repository_ids": [
      32,
      42
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enable a repository for Copilot cloud agent in an organization — github.copilot.enable-copilot-coding-agent-for-repository-in-organization

> [!NOTE] > This endpoint is in public preview and is subject to change.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.repository_id integer Required The unique identifier of the repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disable a repository for Copilot cloud agent in an organization — github.copilot.disable-copilot-coding-agent-for-repository-in-organization

> [!NOTE] > This endpoint is in public preview and is subject to change.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.repository_id integer Required The unique identifier of the repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Copilot content exclusion rules for an organization — github.copilot.copilot-content-exclusion-for-organization

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set Copilot content exclusion rules for an organization — github.copilot.set-copilot-content-exclusion-for-organization

> [!NOTE] > This endpoint is in public preview and is subject to change.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required additionalProperties: {"type":"array","items":{"anyOf":[{"type":"string","description":"The path to the file that will be excluded."},{"type":"object","properties":{"ifAnyMatch":{"type":"array","items":{"type":"string"}}},"required":["ifAnyMatch"],"additionalProperties":false},{"type":"object","properties":{"ifNoneMatch":{"type":"array","items":{"type":"string"}}},"required":["ifNoneMatch"],"additionalProperties":false}]}}

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "octo-repo": [
      "/src/some-dir/kernel.rs"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Copilot organization usage metrics for a specific day — github.copilot.copilot-organization-one-day-usage-metrics

Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Required additionalProperties: false
query.day string Required The day to request data for, in YYYY-MM-DD format. format: "date"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "query": {
    "day": "2025-10-13"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Copilot organization usage metrics — github.copilot.copilot-organization-usage-metrics

Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Copilot organization repository report for a specific day — github.copilot.copilot-organization-repos-one-day-report

Use this endpoint to retrieve download links for the Copilot organization repository report for a specific day. The report provides per-repository pull request metrics for Copilot across the organization, with one entry per repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Required additionalProperties: false
query.day string Required The day to request data for, in YYYY-MM-DD format. format: "date"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "query": {
    "day": "2025-10-13"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Copilot organization user-teams report for a specific day — github.copilot.copilot-organization-user-teams-one-day-report

Use this endpoint to retrieve download links for the Copilot organization user-teams report for a specific day. The report provides user-team join data for Copilot across the organization, with one entry per user-team pair.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Required additionalProperties: false
query.day string Required The day to request data for, in YYYY-MM-DD format. format: "date"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "query": {
    "day": "2025-10-13"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Copilot organization users usage metrics for a specific day — github.copilot.copilot-organization-users-one-day-usage-metrics

Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Required additionalProperties: false
query.day string Required The day to request data for, in YYYY-MM-DD format. format: "date"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "query": {
    "day": "2025-10-13"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Copilot organization users usage metrics — github.copilot.copilot-organization-users-usage-metrics

Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Dependabot alerts for an organization — github.dependabot.list-alerts-for-org

Lists Dependabot alerts for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.classification string Optional A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned. Can be: malware, general
query.state string Optional A comma-separated list of states. If specified, only alerts with these states will be returned. Can be: auto_dismissed, dismissed, fixed, open
query.severity string Optional A comma-separated list of severities. If specified, only alerts with these severities will be returned. Can be: low, medium, high, critical
query.ecosystem string Optional A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. Can be: composer, go, maven, npm, nuget, pip, pub, rubygems, rust
query.package string Optional A comma-separated list of package names. If specified, only alerts for these packages will be returned.
query.epss_percentage string Optional CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: - An exact number (n) - Comparators such as >n, <n, >=n, <=n - A range like n..n, where n is a number from 0.0 to 1.0 Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.
query.artifact_registry_url string Optional A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.
query.artifact_registry string Optional A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned. Can be: jfrog-artifactory
query.has — Optional Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. Multiple has filters can be passed to filter for alerts that have all of the values.
query.has string Optional oneOf[1]
query.has array Optional oneOf[2]
query.has[] string Optional oneOf[2]; enum: ["patch","deployment"]
query.assignee string Optional Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot) to return alerts assigned to any of the specified users. Use * to list alerts with at least one assignee or none to list alerts with no assignees.
query.runtime_risk string Optional A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned. Can be: critical-resource, internet-exposed, sensitive-data, lateral-movement
query.scope string Optional The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. enum: ["development","runtime"]
query.relationship string Optional A comma-separated list of relationships of the vulnerable dependency to your project. If specified, only alerts with these relationships will be returned. > [!NOTE] > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems.
query.sort string Optional The property by which to sort the results. created means when the alert was created. updated means when the alert's state last changed. epss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. enum: ["created","updated","epss_percentage"]; default: "created"
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Lists the repositories Dependabot can access in an organization — github.dependabot.repository-access-for-org

Lists repositories that organization admins have allowed Dependabot to access when updating dependencies. > [!NOTE] > This operation supports both server-to-server and user-to-server access. Unauthorized users will not see the existence of this endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.page integer Optional The page number of results to fetch. default: 1; minimum: 1
query.per_page integer Optional Number of results per page. default: 30; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Updates Dependabot's repository access list for an organization — github.dependabot.update-repository-access-for-org

Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.repository_ids_to_add array Optional List of repository IDs to add.
body.repository_ids_to_add[] integer Optional
body.repository_ids_to_remove array Optional List of repository IDs to remove.
body.repository_ids_to_remove[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "repository_ids_to_add": [
      123,
      456
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set the default repository access level for Dependabot — github.dependabot.set-repository-access-default-level

Sets the default level of repository access Dependabot will have while performing an update. Available values are: - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.default_level string Required The default repository access level for Dependabot updates. enum: ["public","internal"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "default_level": "public"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization secrets — github.dependabot.list-org-secrets

Lists all secrets available in an organization without revealing their encrypted values.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization public key — github.dependabot.get-org-public-key

Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization secret — github.dependabot.get-org-secret

Gets a single organization secret without revealing its encrypted value.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update an organization secret — github.dependabot.create-or-update-org-secret

Creates or updates an organization secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
body object Required
body.encrypted_value string Optional Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
body.key_id string Optional ID of the key you used to encrypt the secret.
body.visibility string Required Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret. enum: ["all","private","selected"]
body.selected_repository_ids array Optional An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
body.selected_repository_ids[] — Optional
body.selected_repository_ids[] integer Optional anyOf[1]
body.selected_repository_ids[] string Optional anyOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  },
  "body": {
    "encrypted_value": "c2VjcmV0",
    "key_id": "012345678912345678",
    "visibility": "selected",
    "selected_repository_ids": [
      1296269,
      1296280
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an organization secret — github.dependabot.delete-org-secret

Deletes a secret in an organization using the secret name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List selected repositories for an organization secret — github.dependabot.list-selected-repos-for-org-secret

Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set selected repositories for an organization secret — github.dependabot.set-selected-repos-for-org-secret

Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
body object Required
body.selected_repository_ids array Required An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.
body.selected_repository_ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  },
  "body": {
    "selected_repository_ids": [
      64780797
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add selected repository to an organization secret — github.dependabot.add-selected-repo-to-org-secret

Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
path.repository_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove selected repository from an organization secret — github.dependabot.remove-selected-repo-from-org-secret

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
path.repository_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get list of conflicting packages during Docker migration for organization — github.packages.list-docker-migration-conflicting-packages-for-organization

Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List public organization events — github.activity.list-public-org-events

> [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List failed organization invitations — github.orgs.list-failed-invitations

The return hash contains failed_at and failed_reason fields which represent the time at which the invitation failed and the reason for the failure.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization webhooks — github.orgs.list-webhooks

List webhooks for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an organization webhook — github.orgs.create-webhook

Create a hook that posts payloads in JSON format.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.name string Required Must be passed as "web".
body.config object Required Key/value pairs to provide settings for this webhook.
body.config.url — Required $ref: "#/definitions/webhook-config-url"
body.config.content_type — Optional $ref: "#/definitions/webhook-config-content-type"
body.config.secret — Optional $ref: "#/definitions/webhook-config-secret"
body.config.insecure_ssl — Optional $ref: "#/definitions/webhook-config-insecure-ssl"
body.config.username string Optional
body.config.password string Optional
body.events array Optional Determines what events the hook is triggered for. Set to ["*"] to receive all possible events. default: ["push"]
body.events[] string Optional
body.active boolean Optional Determines if notifications are sent when the webhook is triggered. Set to true to send notifications. default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "name": "web",
    "active": true,
    "events": [
      "push",
      "pull_request"
    ],
    "config": {
      "url": "http://example.com/webhook",
      "content_type": "json"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization webhook — github.orgs.get-webhook

Returns a webhook configured in an organization. To get only the webhook config properties, see "Get a webhook configuration for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "hook_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an organization webhook — github.orgs.update-webhook

Updates a webhook configured in an organization. When you update a webhook, the secret will be overwritten. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use "Update a webhook configuration for an organization".

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.
body object Optional
body.config object Optional Key/value pairs to provide settings for this webhook.
body.config.url — Required $ref: "#/definitions/webhook-config-url"
body.config.content_type — Optional $ref: "#/definitions/webhook-config-content-type"
body.config.secret — Optional $ref: "#/definitions/webhook-config-secret"
body.config.insecure_ssl — Optional $ref: "#/definitions/webhook-config-insecure-ssl"
body.events array Optional Determines what events the hook is triggered for. default: ["push"]
body.events[] string Optional
body.active boolean Optional Determines if notifications are sent when the webhook is triggered. Set to true to send notifications. default: true
body.name string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "hook_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an organization webhook — github.orgs.delete-webhook

Delete a webhook for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "hook_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a webhook configuration for an organization — github.orgs.get-webhook-config-for-org

Returns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use "Get an organization webhook ."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "hook_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a webhook configuration for an organization — github.orgs.update-webhook-config-for-org

Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use "Update an organization webhook ."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.
body object Optional
body.url — Optional $ref: "#/definitions/webhook-config-url"
body.content_type — Optional $ref: "#/definitions/webhook-config-content-type"
body.secret — Optional $ref: "#/definitions/webhook-config-secret"
body.insecure_ssl — Optional $ref: "#/definitions/webhook-config-insecure-ssl"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "hook_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List deliveries for an organization webhook — github.orgs.list-webhook-deliveries

Returns a list of webhook deliveries for a webhook configured in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.cursor string Optional Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the link header for the next and previous page cursors.
query.status string Optional Returns webhook deliveries filtered by delivery outcome classification based on status_code range. A status of success returns deliveries with a status_code in the 200-399 range (inclusive). A status of failure returns deliveries with a status_code in the 400-599 range (inclusive). enum: ["success","failure"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "hook_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a webhook delivery for an organization webhook — github.orgs.get-webhook-delivery

Returns a delivery for a webhook configured in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.
path.delivery_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "hook_id": 1,
    "delivery_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Redeliver a delivery for an organization webhook — github.orgs.redeliver-webhook-delivery

Redeliver a delivery for a webhook configured in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.
path.delivery_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "hook_id": 1,
    "delivery_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Ping an organization webhook — github.orgs.ping-webhook

This will trigger a ping event to be sent to the hook.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "hook_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get route stats by actor — github.api-insights.get-route-stats-by-actor

Get API request count statistics for an actor broken down by route within a specified time frame.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.actor_type string Required The type of the actor enum: ["installation","classic_pat","fine_grained_pat","oauth_app","github_app_user_to_server"]
path.actor_id integer Required The ID of the actor
query object Required additionalProperties: false
query.min_timestamp string Required The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
query.max_timestamp string Optional The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.sort array Optional The property to sort the results by.
query.sort[] string Optional enum: ["last_rate_limited_timestamp","last_request_timestamp","rate_limited_request_count","http_method","api_route","total_request_count"]; default: "total_request_count"
query.api_route_substring string Optional Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "actor_type": "installation",
    "actor_id": 1
  },
  "query": {
    "min_timestamp": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get subject stats — github.api-insights.get-subject-stats

Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Required additionalProperties: false
query.min_timestamp string Required The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
query.max_timestamp string Optional The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.sort array Optional The property to sort the results by.
query.sort[] string Optional enum: ["last_rate_limited_timestamp","last_request_timestamp","rate_limited_request_count","subject_name","total_request_count"]; default: "total_request_count"
query.subject_name_substring string Optional Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "query": {
    "min_timestamp": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get summary stats — github.api-insights.get-summary-stats

Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Required additionalProperties: false
query.min_timestamp string Required The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
query.max_timestamp string Optional The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "query": {
    "min_timestamp": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get summary stats by user — github.api-insights.get-summary-stats-by-user

Get overall statistics of API requests within the organization for a user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.user_id string Required The ID of the user to query for stats
query object Required additionalProperties: false
query.min_timestamp string Required The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
query.max_timestamp string Optional The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "user_id": "example"
  },
  "query": {
    "min_timestamp": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get summary stats by actor — github.api-insights.get-summary-stats-by-actor

Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.actor_type string Required The type of the actor enum: ["installation","classic_pat","fine_grained_pat","oauth_app","github_app_user_to_server"]
path.actor_id integer Required The ID of the actor
query object Required additionalProperties: false
query.min_timestamp string Required The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
query.max_timestamp string Optional The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "actor_type": "installation",
    "actor_id": 1
  },
  "query": {
    "min_timestamp": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get time stats — github.api-insights.get-time-stats

Get the number of API requests and rate-limited requests made within an organization over a specified time period.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Required additionalProperties: false
query.min_timestamp string Required The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
query.max_timestamp string Optional The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
query.timestamp_increment string Required The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "query": {
    "min_timestamp": "example",
    "timestamp_increment": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get time stats by user — github.api-insights.get-time-stats-by-user

Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.user_id string Required The ID of the user to query for stats
query object Required additionalProperties: false
query.min_timestamp string Required The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
query.max_timestamp string Optional The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
query.timestamp_increment string Required The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "user_id": "example"
  },
  "query": {
    "min_timestamp": "example",
    "timestamp_increment": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get time stats by actor — github.api-insights.get-time-stats-by-actor

Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.actor_type string Required The type of the actor enum: ["installation","classic_pat","fine_grained_pat","oauth_app","github_app_user_to_server"]
path.actor_id integer Required The ID of the actor
query object Required additionalProperties: false
query.min_timestamp string Required The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
query.max_timestamp string Optional The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
query.timestamp_increment string Required The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "actor_type": "installation",
    "actor_id": 1
  },
  "query": {
    "min_timestamp": "example",
    "timestamp_increment": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get user stats — github.api-insights.get-user-stats

Get API usage statistics within an organization for a user broken down by the type of access.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.user_id string Required The ID of the user to query for stats
query object Required additionalProperties: false
query.min_timestamp string Required The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
query.max_timestamp string Optional The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.sort array Optional The property to sort the results by.
query.sort[] string Optional enum: ["last_rate_limited_timestamp","last_request_timestamp","rate_limited_request_count","subject_name","total_request_count"]; default: "total_request_count"
query.actor_name_substring string Optional Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "user_id": "example"
  },
  "query": {
    "min_timestamp": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization installation for the authenticated app — github.apps.get-org-installation

Enables an authenticated GitHub App to find the organization's installation information.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List app installations for an organization — github.orgs.list-app-installations

Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get interaction restrictions for an organization — github.interactions.get-restrictions-for-org

Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set interaction restrictions for an organization — github.interactions.set-restrictions-for-org

Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body — Required $ref: "#/definitions/interaction-limit"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "limit": "collaborators_only"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove interaction restrictions for an organization — github.interactions.remove-restrictions-for-org

Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get pull request creation cap for an org — github.interactions.get-pull-request-creation-cap-for-org

Gets the pull request creation cap configuration for an organization. The cap limits the total number of open pull requests a user can have across all public repositories in the organization at one time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update pull request creation cap for an org — github.interactions.update-pull-request-creation-cap-for-org

Updates the pull request creation cap for an organization. The cap limits the total number of open pull requests a user can have across all public repositories in the organization at one time.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.enabled boolean Required Whether the pull request creation cap is enabled
body.max_open_pull_requests integer Optional The maximum number of open pull requests a user can have at one time minimum: 1; maximum: 1000
body.include_drafts boolean Optional Whether draft pull requests count toward the pull request creation cap

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "enabled": true,
    "max_open_pull_requests": 1,
    "include_drafts": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List pending organization invitations — github.orgs.list-pending-invitations

The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, or hiring_manager. If the invitee is not a GitHub member, the login field in the return hash will be null.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.role string Optional Filter invitations by their member role. enum: ["all","admin","direct_member","billing_manager","hiring_manager"]; default: "all"
query.invitation_source string Optional Filter invitations by their invitation source. enum: ["all","member","scim"]; default: "all"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an organization invitation — github.orgs.create-invitation

Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Optional
body.invitee_id integer Optional Required unless you provide email. GitHub user ID for the person you are inviting.
body.email string Optional Required unless you provide invitee_id. Email address of the person you are inviting, which can be an existing GitHub user.
body.role string Optional The role for the new member. * admin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. * direct_member - Non-owner organization members with ability to see other members and join teams by invitation. * billing_manager - Non-owner organization members with ability to manage the billing settings of your organization. * reinstate - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. enum: ["admin","direct_member","billing_manager","reinstate"]; default: "direct_member"
body.team_ids array Optional Specify IDs for the teams you want to invite new members to.
body.team_ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Cancel an organization invitation — github.orgs.cancel-invitation

Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.invitation_id integer Required The unique identifier of the invitation.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "invitation_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization invitation teams — github.orgs.list-invitation-teams

List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.invitation_id integer Required The unique identifier of the invitation.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "invitation_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List issue fields for an organization — github.orgs.list-issue-fields

Lists all issue fields for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create issue field for an organization — github.orgs.create-issue-field

Creates a new issue field for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body — Required $ref: "#/definitions/organization-create-issue-field"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "name": "example",
    "data_type": "text"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update issue field for an organization — github.orgs.update-issue-field

Updates an issue field for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.issue_field_id integer Required The unique identifier of the issue field.
body — Required $ref: "#/definitions/organization-update-issue-field"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "issue_field_id": 1
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete issue field for an organization — github.orgs.delete-issue-field

Deletes an issue field for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.issue_field_id integer Required The unique identifier of the issue field.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "issue_field_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List issue types for an organization — github.orgs.list-issue-types

Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create issue type for an organization — github.orgs.create-issue-type

Create a new issue type for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body — Required $ref: "#/definitions/organization-create-issue-type"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "name": "example",
    "is_enabled": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update issue type for an organization — github.orgs.update-issue-type

Updates an issue type for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.issue_type_id integer Required The unique identifier of the issue type.
body — Required $ref: "#/definitions/organization-update-issue-type"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "issue_type_id": 1
  },
  "body": {
    "name": "example",
    "is_enabled": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete issue type for an organization — github.orgs.delete-issue-type

Deletes an issue type for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.issue_type_id integer Required The unique identifier of the issue type.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "issue_type_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization issues assigned to the authenticated user — github.issues.list-for-org

List issues in an organization assigned to the authenticated user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.filter string Optional Indicates 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, regardless of participation or creation. enum: ["assigned","created","mentioned","subscribed","repos","all"]; default: "assigned"
query.state string Optional Indicates the state of the issues to return. enum: ["open","closed","all"]; default: "open"
query.labels string Optional A list of comma separated label names. Example: bug,ui,@high
query.type string Optional Can be the name of an issue type.
query.sort string Optional What to sort results by. enum: ["created","updated","comments"]; default: "created"
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.since string Optional Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization members — github.orgs.list-members

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

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.filter string Optional Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. 2fa_insecure means that only members with insecure 2FA methods will be returned. These options are only available for organization owners. enum: ["2fa_disabled","2fa_insecure","all"]; default: "all"
query.role string Optional Filter members returned by their role. enum: ["all","admin","member"]; default: "all"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check organization membership for a user — github.orgs.check-membership-for-user

Check if a user is, publicly or privately, a member of the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove an organization member — github.orgs.remove-member

Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List codespaces for a user in organization — github.codespaces.get-codespaces-for-user-in-org

Lists the codespaces that a member of an organization has for repositories in that organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a codespace from the organization — github.codespaces.delete-from-organization

Deletes a user's codespace.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.
path.codespace_name string Required The name of the codespace.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example",
    "codespace_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Stop a codespace for an organization user — github.codespaces.stop-in-organization

Stops a user's codespace.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.
path.codespace_name string Required The name of the codespace.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example",
    "codespace_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Copilot seat assignment details for a user — github.copilot.get-copilot-seat-details-for-user

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get organization membership for a user — github.orgs.get-membership-for-user

In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set organization membership for a user — github.orgs.set-membership-for-user

Only authenticated organization owners can add a member to the organization or update the member's role.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.
body object Optional
body.role string Optional The role to give the user in the organization. Can be one of: * admin - The user will become an owner of the organization. * member - The user will become a non-owner member of the organization. enum: ["admin","member"]; default: "member"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove organization membership for a user — github.orgs.remove-membership-for-user

In order to remove a user's membership with an organization, the authenticated user must be an organization owner.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization migrations — github.migrations.list-for-org

Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.exclude array Optional Exclude attributes from the API response to improve performance
query.exclude[] string Optional Allowed values that can be passed to the exclude param. enum: ["repositories"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start an organization migration — github.migrations.start-for-org

Initiates the generation of a migration archive.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.repositories array Required A list of arrays indicating which repositories should be migrated.
body.repositories[] string Optional
body.lock_repositories boolean Optional Indicates whether repositories should be locked (to prevent manipulation) while migrating data. default: false
body.exclude_metadata boolean Optional Indicates whether metadata should be excluded and only git source should be included for the migration. default: false
body.exclude_git_data boolean Optional Indicates whether the repository git data should be excluded from the migration. default: false
body.exclude_attachments boolean Optional Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). default: false
body.exclude_releases boolean Optional Indicates whether releases should be excluded from the migration (to reduce migration archive file size). default: false
body.exclude_owner_projects boolean Optional Indicates whether projects owned by the organization or users should be excluded. from the migration. default: false
body.org_metadata_only boolean Optional Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). default: false
body.exclude array Optional Exclude related items from being returned in the response in order to improve performance of the request.
body.exclude[] string Optional enum: ["repositories"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "repositories": [
      "github/Hello-World"
    ],
    "lock_repositories": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization migration status — github.migrations.get-status-for-org

Fetches the status of a migration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.migration_id integer Required The unique identifier of the migration.
query object Optional additionalProperties: false
query.exclude array Optional Exclude attributes from the API response to improve performance
query.exclude[] string Optional Allowed values that can be passed to the exclude param. enum: ["repositories"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "migration_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an organization migration archive — github.migrations.delete-archive-for-org

Deletes a previous migration archive. Migration archives are automatically deleted after seven days.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.migration_id integer Required The unique identifier of the migration.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "migration_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Unlock an organization repository — github.migrations.unlock-repo-for-org

Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.migration_id integer Required The unique identifier of the migration.
path.repo_name string Required repo_name parameter

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "migration_id": 1,
    "repo_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repositories in an organization migration — github.migrations.list-repos-for-org

List all the repositories for this organization migration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.migration_id integer Required The unique identifier of the migration.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "migration_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all organization roles for an organization — github.orgs.list-org-roles

Lists the organization roles available in this organization. For more information on organization roles, see "Using organization roles."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove all organization roles for a team — github.orgs.revoke-all-org-roles-team

Removes all assigned organization roles from a team. For more information on organization roles, see "Using organization roles."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.team_slug string Required The slug of the team name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "team_slug": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Assign an organization role to a team — github.orgs.assign-team-to-org-role

Assigns an organization role to a team in an organization. For more information on organization roles, see "Using organization roles."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.team_slug string Required The slug of the team name.
path.role_id integer Required The unique identifier of the role.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "team_slug": "example",
    "role_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove an organization role from a team — github.orgs.revoke-org-role-team

Removes an organization role from a team. For more information on organization roles, see "Using organization roles."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.team_slug string Required The slug of the team name.
path.role_id integer Required The unique identifier of the role.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "team_slug": "example",
    "role_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove all organization roles for a user — github.orgs.revoke-all-org-roles-user

Revokes all assigned organization roles from a user. For more information on organization roles, see "Using organization roles."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Assign an organization role to a user — github.orgs.assign-user-to-org-role

Assigns an organization role to a member of an organization. For more information on organization roles, see "Using organization roles."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.
path.role_id integer Required The unique identifier of the role.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example",
    "role_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove an organization role from a user — github.orgs.revoke-org-role-user

Remove an organization role from a user. For more information on organization roles, see "Using organization roles."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.
path.role_id integer Required The unique identifier of the role.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example",
    "role_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization role — github.orgs.get-org-role

Gets an organization role that is available to this organization. For more information on organization roles, see "Using organization roles."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.role_id integer Required The unique identifier of the role.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "role_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List teams that are assigned to an organization role — github.orgs.list-org-role-teams

Lists the teams that are assigned to an organization role. For more information on organization roles, see "Using organization roles."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.role_id integer Required The unique identifier of the role.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "role_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List users that are assigned to an organization role — github.orgs.list-org-role-users

Lists organization members that are assigned to an organization role. For more information on organization roles, see "Using organization roles."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.role_id integer Required The unique identifier of the role.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "role_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List outside collaborators for an organization — github.orgs.list-outside-collaborators

List all users who are outside collaborators of an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.filter string Optional Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned. 2fa_insecure means that only outside collaborators with insecure 2FA methods will be returned. enum: ["2fa_disabled","2fa_insecure","all"]; default: "all"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Convert an organization member to outside collaborator — github.orgs.convert-member-to-outside-collaborator

When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "Converting an organization member to an outside collaborator". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "Enforcing repository management policies in your enterprise."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.
body object Optional
body.async boolean Optional When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove outside collaborator from an organization — github.orgs.remove-outside-collaborator

Removing a user from this list will remove them from all the organization's repositories.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List packages for an organization — github.packages.list-packages-for-organization

Lists packages in an organization readable by the user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
query.visibility string Optional The selected visibility of the packages. This parameter is optional and only filters an existing result set. The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private. For the list of GitHub Packages registries that support granular permissions, see "About permissions for GitHub Packages." enum: ["public","private","internal"]
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "package_type": "npm"
  },
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a package for an organization — github.packages.get-package-for-organization

Gets a specific package in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example",
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a package for an organization — github.packages.delete-package-for-org

Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example",
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Restore a package for an organization — github.packages.restore-package-for-org

Restores an entire package in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.token string Optional package token

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example",
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List package versions for a package owned by an organization — github.packages.get-all-package-versions-for-package-owned-by-org

Lists package versions for a package owned by an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.state string Optional The state of the package, either active or deleted. enum: ["active","deleted"]; default: "active"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example",
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a package version for an organization — github.packages.get-package-version-for-organization

Gets a specific package version in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
path.org string Required The organization name. The name is not case sensitive.
path.package_version_id integer Required Unique identifier of the package version.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example",
    "org": "example",
    "package_version_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete package version for an organization — github.packages.delete-package-version-for-org

Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
path.org string Required The organization name. The name is not case sensitive.
path.package_version_id integer Required Unique identifier of the package version.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example",
    "org": "example",
    "package_version_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Restore package version for an organization — github.packages.restore-package-version-for-org

Restores a specific package version in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
path.org string Required The organization name. The name is not case sensitive.
path.package_version_id integer Required Unique identifier of the package version.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example",
    "org": "example",
    "package_version_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List requests to access organization resources with fine-grained personal access tokens — github.orgs.list-pat-grant-requests

Lists requests from organization members to access organization resources with a fine-grained personal access token.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.sort string Optional The property by which to sort the results. enum: ["created_at"]; default: "created_at"
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.owner array Optional A list of owner usernames to use to filter the results. maxItems: 10
query.owner[] string Optional
query.repository string Optional The name of the repository to use to filter the results.
query.permission string Optional The permission to use to filter the results.
query.last_used_before string Optional Only show fine-grained personal access tokens used before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.last_used_after string Optional Only show fine-grained personal access tokens used after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.token_id array Optional The ID of the token maxItems: 50
query.token_id[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Review requests to access organization resources with fine-grained personal access tokens — github.orgs.review-pat-grant-requests-in-bulk

Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.pat_request_ids array Optional Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 pat_request_id values. minItems: 1; maxItems: 100
body.pat_request_ids[] integer Optional
body.action string Required Action to apply to the requests. enum: ["approve","deny"]
body.reason string | null Optional Reason for approving or denying the requests. Max 1024 characters. maxLength: 1024

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "pat_request_ids": [
      42,
      73
    ],
    "action": "deny",
    "reason": "Access is too broad."
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Review a request to access organization resources with a fine-grained personal access token — github.orgs.review-pat-grant-request

Approves or denies a pending request to access organization resources via a fine-grained personal access token.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.pat_request_id integer Required Unique identifier of the request for access via fine-grained personal access token.
body object Required
body.action string Required Action to apply to the request. enum: ["approve","deny"]
body.reason string | null Optional Reason for approving or denying the request. Max 1024 characters. maxLength: 1024

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "pat_request_id": 1
  },
  "body": {
    "action": "deny",
    "reason": "This request is denied because the access is too broad."
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repositories requested to be accessed by a fine-grained personal access token — github.orgs.list-pat-grant-request-repositories

Lists the repositories a fine-grained personal access token request is requesting access to.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.pat_request_id integer Required Unique identifier of the request for access via fine-grained personal access token.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "pat_request_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List fine-grained personal access tokens with access to organization resources — github.orgs.list-pat-grants

Lists approved fine-grained personal access tokens owned by organization members that can access organization resources.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.sort string Optional The property by which to sort the results. enum: ["created_at"]; default: "created_at"
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.owner array Optional A list of owner usernames to use to filter the results. maxItems: 10
query.owner[] string Optional
query.repository string Optional The name of the repository to use to filter the results.
query.permission string Optional The permission to use to filter the results.
query.last_used_before string Optional Only show fine-grained personal access tokens used before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.last_used_after string Optional Only show fine-grained personal access tokens used after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.token_id array Optional The ID of the token maxItems: 50
query.token_id[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the access to organization resources via fine-grained personal access tokens — github.orgs.update-pat-accesses

Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.action string Required Action to apply to the fine-grained personal access token. enum: ["revoke"]
body.pat_ids array Required The IDs of the fine-grained personal access tokens. minItems: 1; maxItems: 100
body.pat_ids[] integer Optional Unique identifier of the fine-grained personal access token.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "action": "revoke",
    "pat_ids": [
      1296269,
      1296280
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the access a fine-grained personal access token has to organization resources — github.orgs.update-pat-access

Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.pat_id integer Required The unique identifier of the fine-grained personal access token.
body object Required
body.action string Required Action to apply to the fine-grained personal access token. enum: ["revoke"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "pat_id": 1
  },
  "body": {
    "action": "revoke"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repositories a fine-grained personal access token has access to — github.orgs.list-pat-grant-repositories

Lists the repositories a fine-grained personal access token has access to.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.pat_id integer Required Unique identifier of the fine-grained personal access token.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "pat_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List private registries for an organization — github.private-registries.list-org-private-registries

Lists all private registry configurations available at the organization-level without revealing their encrypted values.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a private registry for an organization — github.private-registries.create-org-private-registry

Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API." For OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted. For anonymous registries (anonymous), the username, encrypted_value, and key_id fields must be omitted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.registry_type string Required The registry type. enum: ["maven_repository","nuget_feed","goproxy_server","npm_registry","rubygems_server","cargo_registry","composer_repository","docker_registry","git_source","helm_registry","hex_organization","hex_repository","pub_repository","python_index","terraform_registry"]
body.url string Required The URL of the private registry. format: "uri"
body.username string | null Optional The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.
body.replaces_base boolean Optional Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to true, Dependabot will only use this registry and will not fall back to the public registry. When set to false (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. default: false
body.encrypted_value string Optional The value for your secret, encrypted with LibSodium using the public key retrieved from the Get private registries public key for an organization endpoint. Required when auth_type is token or username_password. Should be omitted for OIDC auth types. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
body.key_id string Optional The ID of the key you used to encrypt the secret. Required when auth_type is token or username_password. Should be omitted for OIDC auth types.
body.visibility string Required Which type of organization repositories have access to the private registry. selected means only the repositories specified by selected_repository_ids can access the private registry. enum: ["all","private","selected"]
body.selected_repository_ids array Optional An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when visibility is set to selected. You can manage the list of selected repositories using the Update a private registry for an organization endpoint. This field should be omitted if visibility is set to all or private.
body.selected_repository_ids[] integer Optional
body.auth_type string Optional The authentication type for the private registry. Defaults to token if not specified. Use oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp for OIDC authentication. Use anonymous for registries that do not require authentication; username, encrypted_value, and key_id must be omitted. enum: ["token","username_password","oidc_azure","oidc_aws","oidc_jfrog","oidc_cloudsmith","oidc_gcp","anonymous"]
body.tenant_id string Optional The tenant ID of the Azure AD application. Required when auth_type is oidc_azure.
body.client_id string Optional The client ID of the Azure AD application. Required when auth_type is oidc_azure.
body.aws_region string Optional The AWS region. Required when auth_type is oidc_aws.
body.account_id string Optional The AWS account ID. Required when auth_type is oidc_aws.
body.role_name string Optional The AWS IAM role name. Required when auth_type is oidc_aws.
body.domain string Optional The CodeArtifact domain. Required when auth_type is oidc_aws.
body.domain_owner string Optional The CodeArtifact domain owner (AWS account ID). Required when auth_type is oidc_aws.
body.jfrog_oidc_provider_name string Optional The JFrog OIDC provider name. Required when auth_type is oidc_jfrog.
body.audience string Optional The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
body.identity_mapping_name string Optional The JFrog identity mapping name. Optional for oidc_jfrog auth type.
body.namespace string Optional The Cloudsmith organization namespace. Required when auth_type is oidc_cloudsmith.
body.service_slug string Optional The Cloudsmith service account slug. Required when auth_type is oidc_cloudsmith.
body.api_host string Optional The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
body.workload_identity_provider string Optional The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
body.service_account string Optional The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "registry_type": "maven_repository",
    "url": "https://maven.pkg.github.com/organization/",
    "username": "monalisa",
    "replaces_base": true,
    "encrypted_value": "c2VjcmV0",
    "key_id": "012345678912345678",
    "visibility": "private"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get private registries public key for an organization — github.private-registries.get-org-public-key

Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a private registry for an organization — github.private-registries.get-org-private-registry

Get the configuration of a single private registry defined for an organization, omitting its encrypted value.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a private registry for an organization — github.private-registries.update-org-private-registry

Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API." For OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted. For anonymous registries (anonymous), the username, encrypted_value, and key_id fields must be omitted, and auth_type cannot be changed to or from anonymous.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.
body object Required
body.registry_type string Optional The registry type. enum: ["maven_repository","nuget_feed","goproxy_server","npm_registry","rubygems_server","cargo_registry","composer_repository","docker_registry","git_source","helm_registry","hex_organization","hex_repository","pub_repository","python_index","terraform_registry"]
body.url string Optional The URL of the private registry. format: "uri"
body.username string | null Optional The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.
body.replaces_base boolean Optional Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to true, Dependabot will only use this registry and will not fall back to the public registry. When set to false (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. default: false
body.encrypted_value string Optional The value for your secret, encrypted with LibSodium using the public key retrieved from the Get private registries public key for an organization endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
body.key_id string Optional The ID of the key you used to encrypt the secret.
body.visibility string Optional Which type of organization repositories have access to the private registry. selected means only the repositories specified by selected_repository_ids can access the private registry. enum: ["all","private","selected"]
body.selected_repository_ids array Optional An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when visibility is set to selected. This field should be omitted if visibility is set to all or private.
body.selected_repository_ids[] integer Optional
body.auth_type string Optional The authentication type for the private registry. This field cannot be changed after creation. If provided, it must match the existing auth_type of the configuration. To change the authentication type, delete and recreate the configuration. enum: ["token","username_password","oidc_azure","oidc_aws","oidc_jfrog","oidc_cloudsmith","oidc_gcp","anonymous"]
body.tenant_id string Optional The tenant ID of the Azure AD application. Required when auth_type is oidc_azure.
body.client_id string Optional The client ID of the Azure AD application. Required when auth_type is oidc_azure.
body.aws_region string Optional The AWS region. Required when auth_type is oidc_aws.
body.account_id string Optional The AWS account ID. Required when auth_type is oidc_aws.
body.role_name string Optional The AWS IAM role name. Required when auth_type is oidc_aws.
body.domain string Optional The CodeArtifact domain. Required when auth_type is oidc_aws.
body.domain_owner string Optional The CodeArtifact domain owner (AWS account ID). Required when auth_type is oidc_aws.
body.jfrog_oidc_provider_name string Optional The JFrog OIDC provider name. Required when auth_type is oidc_jfrog.
body.audience string Optional The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
body.identity_mapping_name string Optional The JFrog identity mapping name. Optional for oidc_jfrog auth type.
body.namespace string Optional The Cloudsmith organization namespace. Required when auth_type is oidc_cloudsmith.
body.service_slug string Optional The Cloudsmith service account slug. Required when auth_type is oidc_cloudsmith.
body.api_host string Optional The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
body.workload_identity_provider string Optional The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
body.service_account string Optional The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  },
  "body": {
    "username": "monalisa",
    "encrypted_value": "c2VjcmV0",
    "key_id": "012345678912345678"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a private registry for an organization — github.private-registries.delete-org-private-registry

Delete a private registry configuration at the organization-level.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List projects for organization — github.projects.list-for-org

List all projects owned by a specific organization accessible by the authenticated user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.q string Optional Limit results to projects of the specified type.
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get project for organization — github.projects.get-for-org

Get a specific organization-owned project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_number integer Required The project's number.
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_number": 1,
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create draft item for organization owned project — github.projects.create-draft-item-for-org

Create draft issue item for the specified organization owned project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.project_number integer Required The project's number.
body object Required
body.title string Required The title of the draft issue item to create in the project.
body.body string Optional The body content of the draft issue item to create in the project.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "project_number": 1
  },
  "body": {
    "title": "Sample Draft Issue Title"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List project fields for organization — github.projects.list-fields-for-org

List all fields for a specific organization-owned project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_number integer Required The project's number.
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_number": 1,
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a field to an organization-owned project. — github.projects.add-field-for-org

Add a field to an organization-owned project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_number integer Required The project's number.
path.org string Required The organization name. The name is not case sensitive.
body — Required
body object Required oneOf[1]; additionalProperties: false
body.issue_field_id integer Required The ID of the IssueField to create the field for. oneOf[1]
body object Required oneOf[2]; additionalProperties: false
body.name string Required The name of the field. oneOf[2]
body.data_type string Required The field's data type. oneOf[2]; enum: ["text","number","date"]
body object Required oneOf[3]; additionalProperties: false
body.name string Required The name of the field. oneOf[3]
body.data_type string Required The field's data type. oneOf[3]; enum: ["single_select"]
body.single_select_options array Required The options available for single select fields. At least one option must be provided when creating a single select field. oneOf[3]
body.single_select_options[] — Optional oneOf[3]; $ref: "#/definitions/projects-v2-field-single-select-option"
body object Required oneOf[4]; additionalProperties: false
body.name string Required The name of the field. oneOf[4]
body.data_type string Required The field's data type. oneOf[4]; enum: ["iteration"]
body.iteration_configuration — Required oneOf[4]; $ref: "#/definitions/projects-v2-field-iteration-configuration"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_number": 1,
    "org": "example"
  },
  "body": {
    "name": "Team notes",
    "data_type": "text"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get project field for organization — github.projects.get-field-for-org

Get a specific field for an organization-owned project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_number integer Required The project's number.
path.field_id integer Required The unique identifier of the field.
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_number": 1,
    "field_id": 1,
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List items for an organization owned project — github.projects.list-items-for-org

List all items for a specific organization-owned project accessible by the authenticated user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_number integer Required The project's number.
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.q string Optional Search query to filter items, see Filtering projects for more information.
query.fields — Optional Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789
query.fields string Optional oneOf[1]
query.fields array Optional oneOf[2]; maxItems: 50
query.fields[] string Optional oneOf[2]
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_number": 1,
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add item to organization owned project — github.projects.add-item-for-org

Add an issue or pull request item to the specified organization owned project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.project_number integer Required The project's number.
body object Required additionalProperties: false
body.type string Required The type of item to add to the project. Must be either Issue or PullRequest. enum: ["Issue","PullRequest"]
body.id integer Optional The unique identifier of the issue or pull request to add to the project.
body.owner string Optional The repository owner login.
body.repo string Optional The repository name.
body.number integer Optional The issue or pull request number.
body — Required oneOf[1]
body — Required oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "project_number": 1
  },
  "body": {
    "type": "Issue",
    "id": 3
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an item for an organization owned project — github.projects.get-org-item

Get a specific item from an organization-owned project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_number integer Required The project's number.
path.org string Required The organization name. The name is not case sensitive.
path.item_id integer Required The unique identifier of the project item.
query object Optional additionalProperties: false
query.fields — Optional Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789
query.fields string Optional oneOf[1]
query.fields array Optional oneOf[2]; maxItems: 50
query.fields[] string Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_number": 1,
    "org": "example",
    "item_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update project item for organization — github.projects.update-item-for-org

Update a specific item in an organization-owned project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_number integer Required The project's number.
path.org string Required The organization name. The name is not case sensitive.
path.item_id integer Required The unique identifier of the project item.
body object Required
body.fields array Required A list of field updates to apply.
body.fields[] object Optional
body.fields[].id integer Required The ID of the project field to update.
body.fields[].value — Required The new value for the field: - For text, number, and date fields, provide the new value directly. - For single select and iteration fields, provide the ID of the option or iteration. - To clear the field, set this to null.
body.fields[].value string Required oneOf[1]
body.fields[].value number Required oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_number": 1,
    "org": "example",
    "item_id": 1
  },
  "body": {
    "fields": [
      {
        "id": 123,
        "value": "Updated text value"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete project item for organization — github.projects.delete-item-for-org

Delete a specific item from an organization-owned project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_number integer Required The project's number.
path.org string Required The organization name. The name is not case sensitive.
path.item_id integer Required The unique identifier of the project item.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_number": 1,
    "org": "example",
    "item_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a view for an organization-owned project — github.projects.create-view-for-org

Create a new view in an organization-owned project. Views allow you to customize how items in a project are displayed and filtered.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.project_number integer Required The project's number.
body object Required additionalProperties: false
body.name string Required The name of the view.
body.layout string Required The layout of the view. enum: ["table","board","roadmap"]
body.filter string Optional The filter query for the view. See Filtering projects for more information.
body.visible_fields array Optional visible_fields is not applicable to roadmap layout views. For table and board layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used.
body.visible_fields[] integer Optional
body.sort_by array Optional Sorting configuration for the view. Each element is a two-element array of [field_id, direction] where direction is "asc" or "desc". Supports multiple sort criteria applied in order.
body.sort_by[] array Optional minItems: 2; maxItems: 2
body.sort_by[][] — Optional
body.sort_by[][] integer Optional oneOf[1]
body.sort_by[][] string Optional oneOf[2]
body.group_by array Optional The field IDs to group items by (horizontal grouping). Supports a single field. The field must support grouping; fields such as Title, Reviewers, Linked pull requests, Sub-issues progress, Tracked by, and Tracks cannot be grouped on. maxItems: 1
body.group_by[] integer Optional
body.vertical_group_by array Optional The field IDs to use as columns in board layout (vertical grouping). Supports a single field. The field must support grouping; fields such as Title, Reviewers, Linked pull requests, Sub-issues progress, Tracked by, and Tracks cannot be grouped on. maxItems: 1
body.vertical_group_by[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "project_number": 1
  },
  "body": {
    "name": "All Issues",
    "layout": "table",
    "filter": "is:issue",
    "visible_fields": [
      123,
      456,
      789
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List items for an organization project view — github.projects.list-view-items-for-org

List items in an organization project with the saved view's filter applied.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_number integer Required The project's number.
path.org string Required The organization name. The name is not case sensitive.
path.view_number integer Required The number that identifies the project view.
query object Optional additionalProperties: false
query.fields — Optional Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789
query.fields string Optional oneOf[1]
query.fields array Optional oneOf[2]; maxItems: 50
query.fields[] string Optional oneOf[2]
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_number": 1,
    "org": "example",
    "view_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get registered app installations for external custom properties — github.orgs.external-properties-for-repos-get-organization-app-installations

Gets the registered GitHub App installations used to read and write external custom properties for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Register an app installation for external custom properties — github.orgs.external-properties-for-repos-register-organization-app-installation

Registers a GitHub App installation so it can read and write external custom properties for an organization, and assigns it a display name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.installation_id integer Optional The unique identifier of the GitHub App installation to register for managing external custom properties. When authenticating as a GitHub App installation, this defaults to the authenticated installation and can be omitted. It is required for all other callers (users and fine-grained personal access tokens).
body.display_name string Required The display name for this app installation's external custom properties in the organization. Must be 1 to 15 characters and contain only letters and numbers. Capitalization is preserved as entered. This can't be changed after the app installation is registered. minLength: 1; maxLength: 15; pattern: "^[a-zA-Z0-9]+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "installation_id": 67890,
    "display_name": "Acme"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all external custom properties for a GitHub App installation in an organization — github.orgs.external-properties-for-repos-get-organization-definitions

Gets all external custom properties defined for the authenticated GitHub App installation on an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update external custom property values for organization repositories — github.orgs.external-properties-for-repos-create-or-update-organization-values

Create new or update existing external custom property values for repositories in a batch that belong to an organization. Each target repository will have its external custom property values updated to match the values provided in the request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.repository_names array Required The names of repositories that the external custom property values will be applied to. minItems: 1; maxItems: 30
body.repository_names[] string Optional
body.properties array Required List of external custom property names and associated values to apply to the repositories.
body.properties[] — Optional $ref: "#/definitions/custom-property-value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "repository_names": [
      "example"
    ],
    "properties": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update external custom property values for a property across organization repositories — github.orgs.external-properties-for-repos-create-or-update-values-for-6035de2edd

Create new or update existing external custom property values for a single named property across repositories that belong to an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.property_name string Required The name of the external custom property
body object Required
body.repository_values array Required The names of repositories and the values that the named external custom property will be set to. minItems: 1; maxItems: 100
body.repository_values[] — Optional $ref: "#/definitions/repository-external-property-payload"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "property_name": "example"
  },
  "body": {
    "repository_values": [
      {
        "repository_name": "example",
        "value": "example"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove all external custom property values for a property across all organization repositories — github.orgs.external-properties-for-repos-delete-organization-values

Removes all external custom property values for a specified property name across all repositories that belong to an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.property_name string Required The name of the external custom property

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "property_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all custom properties for an organization — github.orgs.custom-properties-for-repos-get-organization-definitions

Gets all custom properties defined for an organization. Organization members can read these properties.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update custom properties for an organization — github.orgs.custom-properties-for-repos-create-or-update-organization-ed341b3e2b

Creates new or updates existing custom properties defined for an organization in a batch.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.properties array Required The array of custom properties to create or update. minItems: 1; maxItems: 100
body.properties[] — Optional $ref: "#/definitions/custom-property"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "properties": [
      {
        "property_name": "environment",
        "value_type": "single_select",
        "required": true,
        "default_value": "production",
        "description": "Prod or dev environment",
        "allowed_values": [
          "production",
          "development"
        ],
        "values_editable_by": "org_actors"
      },
      {
        "property_name": "service",
        "value_type": "string"
      },
      {
        "property_name": "team",
        "value_type": "string",
        "description": "Team owning the repository"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a custom property for an organization — github.orgs.custom-properties-for-repos-get-organization-definition

Gets a custom property that is defined for an organization. Organization members can read these properties.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.custom_property_name string Required The custom property name

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "custom_property_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update a custom property for an organization — github.orgs.custom-properties-for-repos-create-or-update-organization-definition

Creates a new or updates an existing custom property that is defined for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.custom_property_name string Required The custom property name
body — Required $ref: "#/definitions/custom-property-set-payload"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "custom_property_name": "example"
  },
  "body": {
    "value_type": "single_select"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove a custom property for an organization — github.orgs.custom-properties-for-repos-delete-organization-definition

Removes a custom property that is defined for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.custom_property_name string Required The custom property name

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "custom_property_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List custom property values for organization repositories — github.orgs.custom-properties-for-repos-get-organization-values

Lists organization repositories with all of their custom property values. Organization members can read these properties.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.repository_query string Optional Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See "Searching for repositories" for a detailed list of qualifiers.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update custom property values for organization repositories — github.orgs.custom-properties-for-repos-create-or-update-organization-values

Create new or update existing custom property values for repositories in a batch that belong to an organization. Each target repository will have its custom property values updated to match the values provided in the request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.repository_names array Required The names of repositories that the custom property values will be applied to. minItems: 1; maxItems: 30
body.repository_names[] string Optional
body.properties array Required List of custom property names and associated values to apply to the repositories.
body.properties[] — Optional $ref: "#/definitions/custom-property-value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "repository_names": [
      "example"
    ],
    "properties": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List public organization members — github.orgs.list-public-members

Members of an organization can choose to have their membership publicized or not.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check public organization membership for a user — github.orgs.check-public-membership-for-user

Check if the provided user is a public member of the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set public organization membership for the authenticated user — github.orgs.set-public-membership-for-authenticated-user

The user can publicize their own membership. (A user cannot publicize the membership for another user.)

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove public organization membership for the authenticated user — github.orgs.remove-public-membership-for-authenticated-user

Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization repositories — github.repos.list-for-org

Lists repositories for the specified organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.type string Optional Specifies the types of repositories you want returned. enum: ["all","public","private","forks","sources","member"]; default: "all"
query.sort string Optional The property to sort the results by. enum: ["created","updated","pushed","full_name"]; default: "created"
query.direction string Optional The order to sort by. Default: asc when using full_name, otherwise desc. enum: ["asc","desc"]
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an organization repository — github.repos.create-in-org

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

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.name string Required The name of the repository.
body.description string Optional A short description of the repository.
body.homepage string Optional A URL with more information about the repository.
body.private boolean Optional Whether the repository is private. default: false
body.visibility string Optional The visibility of the repository. enum: ["public","private"]
body.has_issues boolean Optional Either true to enable issues for this repository or false to disable them. default: true
body.has_projects boolean Optional Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error. default: true
body.has_wiki boolean Optional Either true to enable the wiki for this repository or false to disable it. default: true
body.has_downloads boolean Optional Whether downloads are enabled. default: true
body.is_template boolean Optional Either true to make this repo available as a template repository or false to prevent it. default: false
body.team_id integer Optional The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.
body.auto_init boolean Optional Pass true to create an initial commit with empty README. default: false
body.gitignore_template string Optional Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".
body.license_template string Optional Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, "mit" or "mpl-2.0".
body.allow_squash_merge boolean Optional Either true to allow squash-merging pull requests, or false to prevent squash-merging. default: true
body.allow_merge_commit boolean Optional Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits. default: true
body.allow_rebase_merge boolean Optional Either true to allow rebase-merging pull requests, or false to prevent rebase-merging. default: true
body.allow_auto_merge boolean Optional Either true to allow auto-merge on pull requests, or false to disallow auto-merge. default: false
body.delete_branch_on_merge boolean Optional Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion. The authenticated user must be an organization owner to set this property to true. default: false
body.use_squash_pr_title_as_default boolean Optional Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead. default: false
body.squash_merge_commit_title string Optional Required when using squash_merge_commit_message. The default value for a squash merge commit title: - PR_TITLE - default to the pull request's title. - COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). enum: ["PR_TITLE","COMMIT_OR_PR_TITLE"]
body.squash_merge_commit_message string Optional The default value for a squash merge commit message: - PR_BODY - default to the pull request's body. - COMMIT_MESSAGES - default to the branch's commit messages. - BLANK - default to a blank commit message. enum: ["PR_BODY","COMMIT_MESSAGES","BLANK"]
body.merge_commit_title string Optional Required when using merge_commit_message. The default value for a merge commit title. - PR_TITLE - default to the pull request's title. - MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). enum: ["PR_TITLE","MERGE_MESSAGE"]
body.merge_commit_message string Optional The default value for a merge commit message. - PR_TITLE - default to the pull request's title. - PR_BODY - default to the pull request's body. - BLANK - default to a blank commit message. enum: ["PR_BODY","PR_TITLE","BLANK"]
body.custom_properties object Optional The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "name": "Hello-World",
    "description": "This is your first repository",
    "homepage": "https://github.com",
    "private": false,
    "has_issues": true,
    "has_projects": true,
    "has_wiki": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all organization repository rulesets — github.repos.get-org-rulesets

Get all the repository rulesets for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.targets string Optional A comma-separated list of rule targets to filter by. If provided, only rulesets that apply to the specified targets will be returned. For example, branch,tag,push.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an organization repository ruleset — github.repos.create-org-ruleset

Create a repository ruleset for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.name string Required The name of the ruleset.
body.target string Optional The target of the ruleset enum: ["branch","tag","push","repository"]; default: "branch"
body.enforcement — Required $ref: "#/definitions/repository-rule-enforcement"
body.bypass_actors array Optional The actors that can bypass the rules in this ruleset
body.bypass_actors[] — Optional $ref: "#/definitions/repository-ruleset-bypass-actor"
body.conditions — Optional $ref: "#/definitions/org-ruleset-conditions"
body.rules array Optional An array of rules within the ruleset.
body.rules[] — Optional $ref: "#/definitions/org-rules"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "name": "super cool ruleset",
    "target": "branch",
    "enforcement": "active",
    "bypass_actors": [
      {
        "actor_id": 234,
        "actor_type": "Team",
        "bypass_mode": "always"
      }
    ],
    "conditions": {
      "ref_name": {
        "include": [
          "refs/heads/main",
          "refs/heads/master"
        ],
        "exclude": [
          "refs/heads/dev*"
        ]
      },
      "repository_name": {
        "include": [
          "important_repository",
          "another_important_repository"
        ],
        "exclude": [
          "unimportant_repository"
        ],
        "protected": true
      }
    },
    "rules": [
      {
        "type": "commit_author_email_pattern",
        "parameters": {
          "operator": "contains",
          "pattern": "github"
        }
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization rule suites — github.repos.get-org-rule-suites

Lists suites of rule evaluations at the organization level. For more information, see "Managing rulesets for repositories in your organization."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.ref string Optional The name of the ref. Cannot contain wildcard characters. Optionally prefix with refs/heads/ to limit to branches or refs/tags/ to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.
query.repository_name string Optional The name of the repository to filter on.
query.time_period string Optional The time period to filter by. For example, day will filter for rule suites that occurred in the past 24 hours, and week will filter for rule suites that occurred in the past 7 days (168 hours). enum: ["hour","day","week","month"]; default: "day"
query.actor_name string Optional The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.
query.rule_suite_result string Optional The rule suite results to filter on. When specified, only suites with this result will be returned. enum: ["pass","fail","bypass","all"]; default: "all"
query.evaluate_status string Optional The evaluate status to filter on. When specified, only rule suites resulting from rulesets with the specified evaluate status will be returned. - all - all rule suites will be returned. - active - only rule suites resulting from rulesets in active (non-evaluate) mode will be returned. - evaluate - only rule suites resulting from rulesets in evaluate mode will be returned. enum: ["all","active","evaluate"]; default: "all"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization rule suite — github.repos.get-org-rule-suite

Gets information about a suite of rule evaluations from within an organization. For more information, see "Managing rulesets for repositories in your organization."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.rule_suite_id integer Required The unique identifier of the rule suite result. To get this ID, you can use GET /repos/{owner}/{repo}/rulesets/rule-suites for repositories and GET /orgs/{org}/rulesets/rule-suites for organizations.
query object Optional additionalProperties: false
query.include_metadata boolean Optional When set to true, the response will include additional metadata for pull request and required status check rule evaluation. Results are capped at 50 entries. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "rule_suite_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization repository ruleset — github.repos.get-org-ruleset

Get a repository ruleset for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.ruleset_id integer Required The ID of the ruleset.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "ruleset_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an organization repository ruleset — github.repos.update-org-ruleset

Update a ruleset for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.ruleset_id integer Required The ID of the ruleset.
body object Optional
body.name string Optional The name of the ruleset.
body.target string Optional The target of the ruleset enum: ["branch","tag","push","repository"]
body.enforcement — Optional $ref: "#/definitions/repository-rule-enforcement"
body.bypass_actors array Optional The actors that can bypass the rules in this ruleset
body.bypass_actors[] — Optional $ref: "#/definitions/repository-ruleset-bypass-actor"
body.conditions — Optional $ref: "#/definitions/org-ruleset-conditions"
body.rules array Optional An array of rules within the ruleset.
body.rules[] — Optional $ref: "#/definitions/org-rules"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "ruleset_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an organization repository ruleset — github.repos.delete-org-ruleset

Delete a ruleset for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.ruleset_id integer Required The ID of the ruleset.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "ruleset_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get organization ruleset history — github.orgs.get-org-ruleset-history

Get the history of an organization ruleset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.ruleset_id integer Required The ID of the ruleset.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "ruleset_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get organization ruleset version — github.orgs.get-org-ruleset-version

Get a version of an organization ruleset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.ruleset_id integer Required The ID of the ruleset.
path.version_id integer Required The ID of the version

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "ruleset_id": 1,
    "version_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List secret scanning alerts for an organization — github.secret-scanning.list-alerts-for-org

Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.state string Optional Set to open or resolved to only list secret scanning alerts in a specific state. enum: ["open","resolved"]
query.secret_type string Optional A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "Supported secret scanning patterns" for a complete list of secret types.
query.exclude_secret_types string Optional A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the secret_type parameter. See "Supported secret scanning patterns" for a complete list of secret types.
query.exclude_providers string Optional A comma-separated list of provider slugs to exclude from the results. Provider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars). You can find the provider slug in the provider_slug field of each alert. Cannot be combined with the providers parameter.
query.providers string Optional A comma-separated list of provider slugs to filter by. Provider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars). You can find the provider slug in the provider_slug field of each alert. Cannot be combined with the exclude_providers parameter.
query.resolution string Optional A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.
query.assignee string Optional Filters alerts by assignee. Use * to get all assigned alerts, none to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.
query.sort string Optional The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved. enum: ["created","updated"]; default: "created"
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string.
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string.
query.validity string Optional A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are active, inactive, and unknown.
query.is_publicly_leaked boolean Optional A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. default: false
query.is_multi_repo boolean Optional A boolean value representing whether or not to filter alerts by the multi-repo tag being present. default: false
query.hide_secret boolean Optional A boolean value representing whether or not to hide literal secrets in the results. default: false
query.is_bypassed boolean Optional A boolean value (true or false) indicating whether to filter alerts by their push protection bypass status. When set to true, only alerts that were created because a push protection rule was bypassed will be returned. When set to false, only alerts that were not caused by a push protection bypass will be returned.
query.included_metadata string Optional A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the specified metadata fields attached will be returned. Possible values are: owner-email, owner-id, owner-name, secret-id, secret-name, secret-issued-date, secret-expiration-date, organization-name, organization-id, last-used-date, and has-organization-access.
query.owner_email_hash string Optional Filters alerts to only those whose attached owner_email metadata field matches the provided value. The value must be the lowercase hex-encoded SHA-256 hash of the email address to match (for example, the SHA-256 of [email protected]). Only alerts that have an owner_email metadata value whose SHA-256 hash equals this parameter are returned.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization custom patterns — github.secret-scanning.list-org-custom-patterns

Lists secret scanning custom patterns for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.state string Optional Filter custom patterns by state. When absent, returns patterns in all states. enum: ["published","unpublished"]
query.push_protection string Optional Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status. enum: ["enabled","disabled"]
query.sort string Optional The property to sort the results by. enum: ["created","updated","name"]; default: "created"
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Bulk create organization custom patterns — github.secret-scanning.bulk-create-org-custom-patterns

Bulk creates secret scanning custom patterns for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.patterns array Required The list of custom patterns to create (maximum 100). maxItems: 100
body.patterns[] — Optional $ref: "#/definitions/secret-scanning-custom-pattern-to-create"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "patterns": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Bulk delete organization custom patterns — github.secret-scanning.bulk-delete-org-custom-patterns

Bulk deletes secret scanning custom patterns for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.patterns array Required The list of custom patterns to delete. maxItems: 500
body.patterns[] — Optional $ref: "#/definitions/secret-scanning-custom-pattern-to-delete"
body.post_delete_action string Optional What to do with alerts associated with the deleted patterns. delete_alerts permanently removes the alerts. resolve_alerts resolves the alerts as "pattern deleted". Defaults to delete_alerts when not specified. enum: ["delete_alerts","resolve_alerts"]; default: "delete_alerts"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "patterns": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an organization custom pattern — github.secret-scanning.update-org-custom-pattern

Updates a secret scanning custom pattern for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.pattern_id integer Required The ID of the custom pattern.
body — Required $ref: "#/definitions/secret-scanning-custom-pattern-to-update"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "pattern_id": 1
  },
  "body": {
    "custom_pattern_version": "example",
    "pattern": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization pattern configurations — github.secret-scanning.list-org-pattern-configs

Lists the secret scanning pattern configurations for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update organization pattern configurations — github.secret-scanning.update-org-pattern-configs

Updates the secret scanning pattern configurations for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.pattern_config_version — Optional $ref: "#/definitions/secret-scanning-row-version"
body.provider_pattern_settings array Optional Pattern settings for provider patterns.
body.provider_pattern_settings[] object Optional
body.provider_pattern_settings[].token_type string Optional The ID of the pattern to configure.
body.provider_pattern_settings[].push_protection_setting string Optional Push protection setting to set for the pattern. enum: ["not-set","disabled","enabled"]
body.custom_pattern_settings array Optional Pattern settings for custom patterns.
body.custom_pattern_settings[] object Optional
body.custom_pattern_settings[].token_type string Optional The ID of the pattern to configure.
body.custom_pattern_settings[].custom_pattern_version — Optional $ref: "#/definitions/secret-scanning-row-version"
body.custom_pattern_settings[].push_protection_setting string Optional Push protection setting to set for the pattern. enum: ["disabled","enabled"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K",
    "provider_pattern_settings": [
      {
        "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN",
        "push_protection_setting": "enabled"
      }
    ],
    "custom_pattern_settings": [
      {
        "token_type": "cp_2",
        "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K",
        "push_protection_setting": "enabled"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository security advisories for an organization — github.security-advisories.list-org-repository-advisories

Lists repository security advisories for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.sort string Optional The property to sort the results by. enum: ["created","updated","published"]; default: "created"
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.per_page integer Optional The number of advisories to return per page. For more information, see "Using pagination in the REST API." default: 30; minimum: 1; maximum: 100
query.state string Optional Filter by the state of the repository advisories. Only advisories of this state will be returned. enum: ["triage","draft","published","closed"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get immutable releases settings for an organization — github.orgs.get-immutable-releases-settings

Gets the immutable releases policy for repositories in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set immutable releases settings for an organization — github.orgs.set-immutable-releases-settings

Sets the immutable releases policy for repositories in an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.enforced_repositories string Required The policy that controls how immutable releases are enforced in the organization. enum: ["all","none","selected"]
body.selected_repository_ids array Optional An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the enforced_repositories is set to selected. You can add and remove individual repositories using the Enable a selected repository for immutable releases in an organization and Disable a selected repository for immutable releases in an organization endpoints.
body.selected_repository_ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "enforced_repositories": "all"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List selected repositories for immutable releases enforcement — github.orgs.get-immutable-releases-settings-repositories

List all of the repositories that have been selected for immutable releases enforcement in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set selected repositories for immutable releases enforcement — github.orgs.set-immutable-releases-settings-repositories

Replaces all repositories that have been selected for immutable releases enforcement in an organization. To use this endpoint, the organization immutable releases policy for enforced_repositories must be configured to selected.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.selected_repository_ids array Required An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the enforced_repositories is set to selected. You can add and remove individual repositories using the Enable a selected repository for immutable releases in an organization and Disable a selected repository for immutable releases in an organization endpoints.
body.selected_repository_ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "selected_repository_ids": [
      64780797
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enable a selected repository for immutable releases in an organization — github.orgs.enable-selected-repository-immutable-releases-organization

Adds a repository to the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for enforced_repositories must be configured to selected.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.repository_id integer Required The unique identifier of the repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disable a selected repository for immutable releases in an organization — github.orgs.disable-selected-repository-immutable-releases-organization

Removes a repository from the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for enforced_repositories must be configured to selected.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.repository_id integer Required The unique identifier of the repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List hosted compute network configurations for an organization — github.hosted-compute.list-network-configurations-for-org

Lists all hosted compute network configurations configured in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a hosted compute network configuration for an organization — github.hosted-compute.create-network-configuration-for-org

Creates a hosted compute network configuration for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.name string Required Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.
body.compute_service string Optional The hosted compute service to use for the network configuration. enum: ["none","actions"]
body.network_settings_ids array Required A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. minItems: 1; maxItems: 1
body.network_settings_ids[] string Optional
body.failover_network_settings_ids array Optional A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. minItems: 0; maxItems: 1
body.failover_network_settings_ids[] string Optional
body.failover_network_enabled boolean Optional Indicates whether the failover network resource is enabled.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "name": "my-network-configuration",
    "network_settings_ids": [
      "23456789ABDCEF1"
    ],
    "compute_service": "actions"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a hosted compute network configuration for an organization — github.hosted-compute.get-network-configuration-for-org

Gets a hosted compute network configuration configured in an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.network_configuration_id string Required Unique identifier of the hosted compute network configuration.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "network_configuration_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a hosted compute network configuration for an organization — github.hosted-compute.update-network-configuration-for-org

Updates a hosted compute network configuration for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.network_configuration_id string Required Unique identifier of the hosted compute network configuration.
body object Required
body.name string Optional Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.
body.compute_service string Optional The hosted compute service to use for the network configuration. enum: ["none","actions"]
body.network_settings_ids array Optional A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. minItems: 0; maxItems: 1
body.network_settings_ids[] string Optional
body.failover_network_settings_ids array Optional A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. minItems: 0; maxItems: 1
body.failover_network_settings_ids[] string Optional
body.failover_network_enabled boolean Optional Indicates whether the failover network resource is enabled.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "network_configuration_id": "example"
  },
  "body": {
    "name": "my-network-configuration",
    "network_settings_ids": [
      "23456789ABDCEF1"
    ],
    "compute_service": "actions"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a hosted compute network configuration from an organization — github.hosted-compute.delete-network-configuration-from-org

Deletes a hosted compute network configuration from an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.network_configuration_id string Required Unique identifier of the hosted compute network configuration.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "network_configuration_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a hosted compute network settings resource for an organization — github.hosted-compute.get-network-settings-for-org

Gets a hosted compute network settings resource configured for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.network_settings_id string Required Unique identifier of the hosted compute network settings.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "network_settings_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List teams — github.teams.list

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

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.team_type string Optional Filter team results by their type. For more information, see "What kind of team should I use?" enum: ["all","enterprise","organization"]; default: "all"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a team — github.teams.create

To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "Setting team creation permissions."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.name string Required The name of the team.
body.description string Optional The description of the team.
body.maintainers array Optional List GitHub usernames for organization members who will become team maintainers.
body.maintainers[] string Optional
body.repo_names array Optional The full name (e.g., "organization-name/repository-name") of repositories to add the team to.
body.repo_names[] string Optional
body.privacy string Optional The level of privacy this team should have. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. Default: secret For a parent or child team: * closed - visible to all members of this organization. Default for child team: closed enum: ["secret","closed"]
body.notification_setting string Optional The notification setting the team has chosen. The options are: * notifications_enabled - team members receive notifications when the team is @mentioned. * notifications_disabled - no one receives notifications. Default: notifications_enabled enum: ["notifications_enabled","notifications_disabled"]
body.permission string Optional Closing down notice. The permission that new repositories will be added to the team with when none is specified. enum: ["pull","push"]; default: "pull"
body.parent_team_id integer Optional The ID of a team to set as the parent team.
body.parent_team_slug string Optional The slug of a team to set as the parent team. Ignored when parent_team_id is also provided.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "name": "Justice League",
    "description": "A great team",
    "permission": "push",
    "notification_setting": "notifications_enabled",
    "privacy": "closed"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a team by name — github.teams.get-by-name

Gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, "My TEam Näme" would become my-team-name.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.team_slug string Required The slug of the team name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "team_slug": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a team — github.teams.update-in-org

To edit a team, the authenticated user must either be an organization owner or a team maintainer.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.team_slug string Required The slug of the team name.
body object Optional
body.name string Optional The name of the team.
body.description string Optional The description of the team.
body.privacy string Optional The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. For a parent or child team: * closed - visible to all members of this organization. enum: ["secret","closed"]
body.notification_setting string Optional The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are: * notifications_enabled - team members receive notifications when the team is @mentioned. * notifications_disabled - no one receives notifications. enum: ["notifications_enabled","notifications_disabled"]
body.permission string Optional Closing down notice. The permission that new repositories will be added to the team with when none is specified. enum: ["pull","push","admin"]; default: "pull"
body.parent_team_id integer | null Optional The ID of a team to set as the parent team.
body.parent_team_slug string | null Optional The slug of a team to set as the parent team. Ignored when parent_team_id is also provided.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "team_slug": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a team — github.teams.delete-in-org

To delete a team, the authenticated user must be an organization owner or team maintainer.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.team_slug string Required The slug of the team name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "team_slug": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List pending team invitations — github.teams.list-pending-invitations-in-org

The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.team_slug string Required The slug of the team name.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "team_slug": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List team members — github.teams.list-members-in-org

Team members will include the members of child teams.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.team_slug string Required The slug of the team name.
query object Optional additionalProperties: false
query.role string Optional Filters members returned by their role in the team. enum: ["member","maintainer","all"]; default: "all"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "team_slug": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get team membership for a user — github.teams.get-membership-for-user-in-org

Team members will include the members of child teams.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.team_slug string Required The slug of the team name.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "team_slug": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add or update team membership for a user — github.teams.add-or-update-membership-for-user-in-org

Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.team_slug string Required The slug of the team name.
path.username string Required The handle for the GitHub user account.
body object Optional
body.role string Optional The role that this user should have in the team. enum: ["member","maintainer"]; default: "member"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "team_slug": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove team membership for a user — github.teams.remove-membership-for-user-in-org

To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.team_slug string Required The slug of the team name.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "team_slug": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List team repositories — github.teams.list-repos-in-org

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

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.team_slug string Required The slug of the team name.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "team_slug": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check team permissions for a repository — github.teams.check-permissions-for-repo-in-org

Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.team_slug string Required The slug of the team name.
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "team_slug": "example",
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add or update team repository permissions — github.teams.add-or-update-repo-permissions-in-org

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP method."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.team_slug string Required The slug of the team name.
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Optional
body.permission string Optional The permission to grant the team on this repository. We accept the following permissions to be set: pull, triage, push, maintain, admin and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "team_slug": "example",
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove a repository from a team — github.teams.remove-repo-in-org

If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.team_slug string Required The slug of the team name.
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "team_slug": "example",
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List child teams — github.teams.list-child-in-org

Lists the child teams of the team specified by {team_slug}.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
path.team_slug string Required The slug of the team name.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example",
    "team_slug": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get rate limit status for the authenticated user — github.rate-limit.get

> [!NOTE] > Accessing this endpoint does not count against your REST API rate limit.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository — github.repos.get

The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a repository — github.repos.update

Note: To edit a repository's topics, use the Replace all repository topics endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Optional
body.name string Optional The name of the repository.
body.description string Optional A short description of the repository.
body.homepage string Optional A URL with more information about the repository.
body.private boolean Optional Either true to make the repository private or false to make it public. Default: false. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. default: false
body.visibility string Optional The visibility of the repository. enum: ["public","private"]
body.security_and_analysis object | null Optional Specify which security and analysis features to enable or disable for the repository. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "Managing security managers in your organization." For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request: { "security_and_analysis": {"advanced_security": { "status": "enabled" } } }. You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.
body.security_and_analysis.advanced_security object Optional Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see "About GitHub Advanced Security." For standalone Code Scanning or Secret Protection products, this parameter cannot be used.
body.security_and_analysis.advanced_security.status string Optional Can be enabled or disabled.
body.security_and_analysis.code_security object Optional Use the status property to enable or disable GitHub Code Security for this repository.
body.security_and_analysis.code_security.status string Optional Can be enabled or disabled.
body.security_and_analysis.secret_scanning object Optional Use the status property to enable or disable secret scanning for this repository. For more information, see "About secret scanning."
body.security_and_analysis.secret_scanning.status string Optional Can be enabled or disabled.
body.security_and_analysis.secret_scanning_push_protection object Optional Use the status property to enable or disable secret scanning push protection for this repository. For more information, see "Protecting pushes with secret scanning."
body.security_and_analysis.secret_scanning_push_protection.status string Optional Can be enabled or disabled.
body.security_and_analysis.secret_scanning_ai_detection object Optional Use the status property to enable or disable secret scanning AI detection for this repository. For more information, see "Responsible detection of generic secrets with AI."
body.security_and_analysis.secret_scanning_ai_detection.status string Optional Can be enabled or disabled.
body.security_and_analysis.secret_scanning_non_provider_patterns object Optional Use the status property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "Supported secret scanning patterns."
body.security_and_analysis.secret_scanning_non_provider_patterns.status string Optional Can be enabled or disabled.
body.security_and_analysis.secret_scanning_delegated_alert_dismissal object Optional Use the status property to enable or disable secret scanning delegated alert dismissal for this repository.
body.security_and_analysis.secret_scanning_delegated_alert_dismissal.status string Optional Can be enabled or disabled.
body.security_and_analysis.secret_scanning_delegated_bypass object Optional Use the status property to enable or disable secret scanning delegated bypass for this repository.
body.security_and_analysis.secret_scanning_delegated_bypass.status string Optional Can be enabled or disabled.
body.security_and_analysis.secret_scanning_delegated_bypass_options object Optional Feature options for secret scanning delegated bypass. This object is only honored when security_and_analysis.secret_scanning_delegated_bypass.status is set to enabled. You can send this object in the same request as secret_scanning_delegated_bypass, or update just the options in a separate request.
body.security_and_analysis.secret_scanning_delegated_bypass_options.reviewers array Optional The bypass reviewers for secret scanning delegated bypass. If you omit this field, the existing set of reviewers is unchanged.
body.security_and_analysis.secret_scanning_delegated_bypass_options.reviewers[] object Optional
body.security_and_analysis.secret_scanning_delegated_bypass_options.reviewers[].reviewer_id integer Required The ID of the team or role selected as a bypass reviewer
body.security_and_analysis.secret_scanning_delegated_bypass_options.reviewers[].reviewer_type string Required The type of the bypass reviewer enum: ["TEAM","ROLE"]
body.security_and_analysis.secret_scanning_delegated_bypass_options.reviewers[].mode string Optional The bypass mode for the reviewer enum: ["ALWAYS","EXEMPT"]; default: "ALWAYS"
body.has_issues boolean Optional Either true to enable issues for this repository or false to disable them. default: true
body.has_projects boolean Optional Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error. default: true
body.has_wiki boolean Optional Either true to enable the wiki for this repository or false to disable it. default: true
body.has_pull_requests boolean Optional Either true to allow pull requests for this repository or false to prevent pull requests. default: true
body.pull_request_creation_policy string Optional The policy that controls who can create pull requests for this repository: all or collaborators_only. enum: ["all","collaborators_only"]
body.is_template boolean Optional Either true to make this repo available as a template repository or false to prevent it. default: false
body.default_branch string Optional Updates the default branch for this repository.
body.allow_squash_merge boolean Optional Either true to allow squash-merging pull requests, or false to prevent squash-merging. default: true
body.allow_merge_commit boolean Optional Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits. default: true
body.allow_rebase_merge boolean Optional Either true to allow rebase-merging pull requests, or false to prevent rebase-merging. default: true
body.allow_auto_merge boolean Optional Either true to allow auto-merge on pull requests, or false to disallow auto-merge. default: false
body.delete_branch_on_merge boolean Optional Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion. default: false
body.allow_update_branch boolean Optional Either true to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise. default: false
body.use_squash_pr_title_as_default boolean Optional Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead. default: false
body.squash_merge_commit_title string Optional Required when using squash_merge_commit_message. The default value for a squash merge commit title: - PR_TITLE - default to the pull request's title. - COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). enum: ["PR_TITLE","COMMIT_OR_PR_TITLE"]
body.squash_merge_commit_message string Optional The default value for a squash merge commit message: - PR_BODY - default to the pull request's body. - COMMIT_MESSAGES - default to the branch's commit messages. - BLANK - default to a blank commit message. enum: ["PR_BODY","COMMIT_MESSAGES","BLANK"]
body.merge_commit_title string Optional Required when using merge_commit_message. The default value for a merge commit title. - PR_TITLE - default to the pull request's title. - MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). enum: ["PR_TITLE","MERGE_MESSAGE"]
body.merge_commit_message string Optional The default value for a merge commit message. - PR_TITLE - default to the pull request's title. - PR_BODY - default to the pull request's body. - BLANK - default to a blank commit message. enum: ["PR_BODY","PR_TITLE","BLANK"]
body.archived boolean Optional Whether to archive this repository. false will unarchive a previously archived repository. default: false
body.allow_forking boolean Optional Either true to allow private forks, or false to prevent private forks. default: false
body.web_commit_signoff_required boolean Optional Either true to require contributors to sign off on web-based commits, or false to not require contributors to sign off on web-based commits. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a repository — github.repos.delete

Deleting a repository requires admin access.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List artifacts for a repository — github.actions.list-artifacts-for-repo

Lists all artifacts for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.name string Optional The name field of an artifact. When specified, only artifacts with this name will be returned.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an artifact — github.actions.get-artifact

Gets a specific artifact for a workflow run.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.artifact_id integer Required The unique identifier of the artifact.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "artifact_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an artifact — github.actions.delete-artifact

Deletes an artifact for a workflow run. OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.artifact_id integer Required The unique identifier of the artifact.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "artifact_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get GitHub Actions cache retention limit for a repository — github.actions.get-actions-cache-retention-limit-for-repository

Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if not manually removed or evicted due to size constraints.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set GitHub Actions cache retention limit for a repository — github.actions.set-actions-cache-retention-limit-for-repository

Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if not manually removed or evicted due to size constraints.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body — Required $ref: "#/definitions/actions-cache-retention-limit-for-repository"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get GitHub Actions cache storage limit for a repository — github.actions.get-actions-cache-storage-limit-for-repository

Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be stored before eviction occurs.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set GitHub Actions cache storage limit for a repository — github.actions.set-actions-cache-storage-limit-for-repository

Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be stored before eviction occurs.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body — Required $ref: "#/definitions/actions-cache-storage-limit-for-repository"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get GitHub Actions cache usage for a repository — github.actions.get-actions-cache-usage

Gets GitHub Actions cache usage for a repository. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List GitHub Actions caches for a repository — github.actions.get-actions-cache-list

Lists the GitHub Actions caches for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.ref string Optional The full Git reference for narrowing down the cache. The ref for a branch should be formatted as refs/heads/<branch name>. To reference a pull request use refs/pull/<number>/merge.
query.key string Optional An explicit key or prefix for identifying the cache
query.sort string Optional The property to sort the results by. created_at means when the cache was created. last_accessed_at means when the cache was last accessed. size_in_bytes is the size of the cache in bytes. enum: ["created_at","last_accessed_at","size_in_bytes"]; default: "last_accessed_at"
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete GitHub Actions caches for a repository (using a cache key) — github.actions.delete-actions-cache-by-key

Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Required additionalProperties: false
query.key string Required A key for identifying the cache.
query.ref string Optional The full Git reference for narrowing down the cache. The ref for a branch should be formatted as refs/heads/<branch name>. To reference a pull request use refs/pull/<number>/merge.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "query": {
    "key": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a GitHub Actions cache for a repository (using a cache ID) — github.actions.delete-actions-cache-by-id

Deletes a GitHub Actions cache for a repository, using a cache ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.cache_id integer Required The unique identifier of the GitHub Actions cache.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "cache_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List concurrency groups for a repository — github.actions.list-concurrency-groups-for-repository

Lists the active concurrency groups for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a concurrency group for a repository — github.actions.get-concurrency-group-for-repository

Gets a specific concurrency group for a repository, including all instances in the group's queue. Returns 404 if the group is inactive or does not exist.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.concurrency_group_name string Required The name of the concurrency group.
query object Optional additionalProperties: false
query.ahead_of_run integer Optional Filter to items ahead of this workflow run ID in the queue, plus the run itself. Matches workflow-level concurrency and reusable-workflow leases held on behalf of the run. Mutually exclusive with ahead_of_job. minimum: 1
query.ahead_of_job integer Optional Filter to items ahead of this job ID in the queue, plus the job itself. Matches job-level concurrency and reusable-workflow leases on the job's ancestor paths. Mutually exclusive with ahead_of_run. minimum: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "concurrency_group_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a job for a workflow run — github.actions.get-job-for-workflow-run

Gets a specific job in a workflow run.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.job_id integer Required The unique identifier of the job.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "job_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Re-run a job from a workflow run — github.actions.re-run-job-for-workflow-run

Re-run a job and its dependent jobs in a workflow run.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.job_id integer Required The unique identifier of the job.
body object | null Optional
body.enable_debug_logging boolean Optional Whether to enable debug logging for the re-run. default: false
body.enable_debugger boolean Optional Whether to enable the debugger for the re-run of this job. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "job_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the customization template for an OIDC subject claim for a repository — github.actions.get-custom-oidc-sub-claim-for-repo

Gets the customization template for an OpenID Connect (OIDC) subject claim.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set the customization template for an OIDC subject claim for a repository — github.actions.set-custom-oidc-sub-claim-for-repo

Sets the customization template and opt-in or opt-out flag for an OpenID Connect (OIDC) subject claim for a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required Actions OIDC subject customization for a repository
body.use_default boolean Required Whether to use the default template or not. If true, the include_claim_keys field is ignored.
body.include_claim_keys array Optional Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.
body.include_claim_keys[] string Optional
body.use_immutable_subject boolean Optional Whether to opt in to the immutable OIDC subject claim format for this repository. When true, OIDC tokens will use a stable, repository-ID-based sub claim.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "use_default": false,
    "include_claim_keys": [
      "repo",
      "context"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository organization secrets — github.actions.list-repo-organization-secrets

Lists all organization secrets shared with a repository without revealing their encrypted values.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository organization variables — github.actions.list-repo-organization-variables

Lists all organization variables shared with a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 30). For more information, see "Using pagination in the REST API." default: 10
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get GitHub Actions permissions for a repository — github.actions.get-github-actions-permissions-repository

Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set GitHub Actions permissions for a repository — github.actions.set-github-actions-permissions-repository

Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.enabled — Required $ref: "#/definitions/actions-enabled"
body.allowed_actions — Optional $ref: "#/definitions/allowed-actions"
body.sha_pinning_required — Optional $ref: "#/definitions/sha-pinning-required"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "enabled": true,
    "allowed_actions": "selected",
    "sha_pinning_required": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the level of access for workflows outside of the repository — github.actions.get-workflow-access-to-repository

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to private repositories. For more information, see "Allowing access to components in a private repository."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set the level of access for workflows outside of the repository — github.actions.set-workflow-access-to-repository

Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to private repositories. For more information, see "Allowing access to components in a private repository".

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body — Required $ref: "#/definitions/actions-workflow-access-to-repository"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "access_level": "none"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get artifact and log retention settings for a repository — github.actions.get-artifact-and-log-retention-settings-repository

Gets retention settings for checks, workflow runs, commit statuses, artifacts, and logs for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set artifact and log retention settings for a repository — github.actions.set-artifact-and-log-retention-settings-repository

Sets retention settings for checks, workflow runs, commit statuses, artifacts, and logs for a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body — Required $ref: "#/definitions/actions-artifact-and-log-retention"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "days": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get fork PR contributor approval permissions for a repository — github.actions.get-fork-pr-contributor-approval-permissions-repository

Gets the fork PR contributor approval policy for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set fork PR contributor approval permissions for a repository — github.actions.set-fork-pr-contributor-approval-permissions-repository

Sets the fork PR contributor approval policy for a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body — Required $ref: "#/definitions/actions-fork-pr-contributor-approval"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "approval_policy": "first_time_contributors_new_to_github"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get private repo fork PR workflow settings for a repository — github.actions.get-private-repo-fork-pr-workflows-settings-repository

Gets the settings for whether workflows from fork pull requests can run on a private repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set private repo fork PR workflow settings for a repository — github.actions.set-private-repo-fork-pr-workflows-settings-repository

Sets the settings for whether workflows from fork pull requests can run on a private repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body — Required $ref: "#/definitions/actions-fork-pr-workflows-private-repos-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "run_workflows_from_fork_pull_requests": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get allowed actions and reusable workflows for a repository — github.actions.get-allowed-actions-repository

Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions must be configured to selected. For more information, see "Set GitHub Actions permissions for a repository."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set allowed actions and reusable workflows for a repository — github.actions.set-allowed-actions-repository

Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see "Set GitHub Actions permissions for a repository."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body — Optional $ref: "#/definitions/selected-actions"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get default workflow permissions for a repository — github.actions.get-github-actions-default-workflow-permissions-repository

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, as well as if GitHub Actions can submit approving pull request reviews. For more information, see "Setting the permissions of the GITHUB_TOKEN for your repository."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set default workflow permissions for a repository — github.actions.set-github-actions-default-workflow-permissions-repository

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, and sets if GitHub Actions can submit approving pull request reviews. For more information, see "Setting the permissions of the GITHUB_TOKEN for your repository."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body — Required $ref: "#/definitions/actions-set-default-workflow-permissions"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository Actions policies — github.actions.get-repo-actions-policies

List all Actions policies for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.has_parents boolean Optional Include policies configured at higher levels that apply to this repository default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a repository Actions policy — github.actions.create-repo-actions-policy

Create an Actions policy for a repository. Omitting workflow_path targets all workflows without storing an explicit condition.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.name string Required The name of the policy.
body.enforcement — Required $ref: "#/definitions/repository-rule-enforcement"
body.conditions — Optional $ref: "#/definitions/actions-policy-repo-conditions"
body.rules array Optional An array of rules within the policy.
body.rules[] — Optional $ref: "#/definitions/actions-rule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "name": "Require approved actors",
    "enforcement": "active",
    "rules": [
      {
        "type": "restrict_actions_actors",
        "parameters": {
          "allowed_actors": [
            {
              "id": 1234,
              "type": "Team"
            }
          ]
        }
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository Actions policy — github.actions.get-repo-actions-policy

Get a specific Actions policy for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.policy_id integer Required The ID of the policy.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "policy_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a repository Actions policy — github.actions.update-repo-actions-policy

Update an Actions policy for a repository. Omitting workflow_path preserves the policy's existing workflow targeting.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.policy_id integer Required The ID of the policy.
body object Required
body.name string Optional The name of the policy.
body.enforcement — Optional $ref: "#/definitions/repository-rule-enforcement"
body.conditions — Optional $ref: "#/definitions/actions-policy-repo-conditions"
body.rules array Optional An array of rules within the policy.
body.rules[] — Optional $ref: "#/definitions/actions-rule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "policy_id": 1
  },
  "body": {
    "name": "Updated policy name",
    "enforcement": "active"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a repository Actions policy — github.actions.delete-repo-actions-policy

Delete an Actions policy for a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.policy_id integer Required The ID of the policy.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "policy_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List self-hosted runners for a repository — github.actions.list-self-hosted-runners-for-repo

Lists all self-hosted runners configured in a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.name string Optional The name of a self-hosted runner.
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get runner version end-of-life schedule for a repository — github.actions.get-runner-version-deprecation-for-repo

Gets the end-of-life schedule for a specific runner version in a repository. Returns the runner version and the dates when registration and runtime support will end.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.version string Required The runner version to look up.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "version": "2.328.0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List runner applications for a repository — github.actions.list-runner-applications-for-repo

Lists binaries for the runner application that you can download and run.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create configuration for a just-in-time runner for a repository — github.actions.generate-runner-jitconfig-for-repo

Generates a configuration that can be passed to the runner application at startup.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.name string Required The name of the new runner.
body.runner_group_id integer Required The ID of the runner group to register the runner to.
body.labels array Required The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100. minItems: 1; maxItems: 100
body.labels[] string Optional
body.work_folder string Optional The working directory to be used for job execution, relative to the runner install directory. default: "_work"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "name": "New runner",
    "runner_group_id": 1,
    "labels": [
      "self-hosted",
      "X64",
      "macOS",
      "no-gpu"
    ],
    "work_folder": "_work"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a registration token for a repository — github.actions.create-registration-token-for-repo

Returns a token that you can pass to the config script. The token expires after one hour.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a remove token for a repository — github.actions.create-remove-token-for-repo

Returns a token that you can pass to the config script to remove a self-hosted runner from an repository. The token expires after one hour.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a self-hosted runner for a repository — github.actions.get-self-hosted-runner-for-repo

Gets a specific self-hosted runner configured in a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.runner_id integer Required Unique identifier of the self-hosted runner.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "runner_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a self-hosted runner from a repository — github.actions.delete-self-hosted-runner-from-repo

Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.runner_id integer Required Unique identifier of the self-hosted runner.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "runner_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List labels for a self-hosted runner for a repository — github.actions.list-labels-for-self-hosted-runner-for-repo

Lists all labels for a self-hosted runner configured in a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.runner_id integer Required Unique identifier of the self-hosted runner.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "runner_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add custom labels to a self-hosted runner for a repository — github.actions.add-custom-labels-to-self-hosted-runner-for-repo

Adds custom labels to a self-hosted runner configured in a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.runner_id integer Required Unique identifier of the self-hosted runner.
body object Required
body.labels array Required The names of the custom labels to add to the runner. minItems: 1; maxItems: 100
body.labels[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "runner_id": 1
  },
  "body": {
    "labels": [
      "gpu",
      "accelerated"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set custom labels for a self-hosted runner for a repository — github.actions.set-custom-labels-for-self-hosted-runner-for-repo

Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.runner_id integer Required Unique identifier of the self-hosted runner.
body object Required
body.labels array Required The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. minItems: 0; maxItems: 100
body.labels[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "runner_id": 1
  },
  "body": {
    "labels": [
      "gpu",
      "accelerated"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove all custom labels from a self-hosted runner for a repository — github.actions.remove-all-custom-labels-from-self-hosted-runner-for-repo

Remove all custom labels from a self-hosted runner configured in a repository. Returns the remaining read-only labels from the runner.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.runner_id integer Required Unique identifier of the self-hosted runner.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "runner_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove a custom label from a self-hosted runner for a repository — github.actions.remove-custom-label-from-self-hosted-runner-for-repo

Remove a custom label from a self-hosted runner configured in a repository. Returns the remaining labels from the runner.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.runner_id integer Required Unique identifier of the self-hosted runner.
path.name string Required The name of a self-hosted runner's custom label.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "runner_id": 1,
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List workflow runs for a repository — github.actions.list-workflow-runs-for-repo

Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.actor string Optional Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.
query.branch string Optional Returns workflow runs associated with a branch. Use the name of the branch of the push.
query.event string Optional Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows."
query.status string Optional Returns workflow runs with the check run status or conclusion that you specify. For example, a conclusion can be success or a status can be in_progress. Only GitHub Actions can set a status of waiting, pending, or requested. enum: ["completed","action_required","cancelled","failure","neutral","skipped","stale","success","timed_out","in_progress","queued","requested","waiting","pending"]
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.created string Optional Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax." format: "date-time"
query.exclude_pull_requests boolean Optional If true pull requests are omitted from the response (empty array). default: false
query.check_suite_id integer Optional Returns workflow runs with the check_suite_id that you specify.
query.head_sha string Optional Only returns workflow runs that are associated with the specified head_sha.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a workflow run — github.actions.get-workflow-run

Gets a specific workflow run.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.run_id integer Required The unique identifier of the workflow run.
query object Optional additionalProperties: false
query.exclude_pull_requests boolean Optional If true pull requests are omitted from the response (empty array). default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "run_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a workflow run — github.actions.delete-workflow-run

Deletes a specific workflow run.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.run_id integer Required The unique identifier of the workflow run.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "run_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the review history for a workflow run — github.actions.get-reviews-for-run

Anyone with read access to the repository can use this endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.run_id integer Required The unique identifier of the workflow run.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "run_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Approve a workflow run for a fork pull request — github.actions.approve-workflow-run

Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see "Approving workflow runs from public forks."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.run_id integer Required The unique identifier of the workflow run.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "run_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List workflow run artifacts — github.actions.list-workflow-run-artifacts

Lists artifacts for a workflow run.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.run_id integer Required The unique identifier of the workflow run.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.name string Optional The name field of an artifact. When specified, only artifacts with this name will be returned.
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "run_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a workflow run attempt — github.actions.get-workflow-run-attempt

Gets a specific workflow run attempt.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.run_id integer Required The unique identifier of the workflow run.
path.attempt_number integer Required The attempt number of the workflow run.
query object Optional additionalProperties: false
query.exclude_pull_requests boolean Optional If true pull requests are omitted from the response (empty array). default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "run_id": 1,
    "attempt_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List jobs for a workflow run attempt — github.actions.list-jobs-for-workflow-run-attempt

Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.run_id integer Required The unique identifier of the workflow run.
path.attempt_number integer Required The attempt number of the workflow run.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "run_id": 1,
    "attempt_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Cancel a workflow run — github.actions.cancel-workflow-run

Cancels a workflow run using its id.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.run_id integer Required The unique identifier of the workflow run.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "run_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List concurrency groups for a workflow run — github.actions.list-concurrency-groups-for-workflow-run

Lists all concurrency groups associated with a workflow run or its jobs.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.run_id integer Required The unique identifier of the workflow run.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "run_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Review custom deployment protection rules for a workflow run — github.actions.review-custom-gates-for-run

Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "Using environments for deployment."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.run_id integer Required The unique identifier of the workflow run.
body — Required
body — Required anyOf[1]; $ref: "#/definitions/review-custom-gates-comment-required"
body — Required anyOf[2]; $ref: "#/definitions/review-custom-gates-state-required"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "run_id": 1
  },
  "body": {
    "environment_name": "prod-eus",
    "state": "approved",
    "comment": "All health checks passed."
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Force cancel a workflow run — github.actions.force-cancel-workflow-run

Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an always() condition on a job. You should only use this endpoint to cancel a workflow run when the workflow run is not responding to POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.run_id integer Required The unique identifier of the workflow run.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "run_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List jobs for a workflow run — github.actions.list-jobs-for-workflow-run

Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.run_id integer Required The unique identifier of the workflow run.
query object Optional additionalProperties: false
query.filter string Optional Filters jobs by their completed_at timestamp. latest returns jobs from the most recent execution of the workflow run. all returns all jobs for a workflow run, including from old executions of the workflow run. enum: ["latest","all"]; default: "latest"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "run_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete workflow run logs — github.actions.delete-workflow-run-logs

Deletes all logs for a workflow run.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.run_id integer Required The unique identifier of the workflow run.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "run_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get pending deployments for a workflow run — github.actions.get-pending-deployments-for-run

Get all deployment environments for a workflow run that are waiting for protection rules to pass.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.run_id integer Required The unique identifier of the workflow run.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "run_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Review pending deployments for a workflow run — github.actions.review-pending-deployments-for-run

Approve or reject pending deployments that are waiting on approval by a required reviewer.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.run_id integer Required The unique identifier of the workflow run.
body object Required
body.environment_ids array Required The list of environment ids to approve or reject
body.environment_ids[] integer Optional
body.state string Required Whether to approve or reject deployment to the specified environments. enum: ["approved","rejected"]
body.comment string Required A comment to accompany the deployment review

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "run_id": 1
  },
  "body": {
    "environment_ids": [
      161171787
    ],
    "state": "approved",
    "comment": "Ship it!"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Re-run a workflow — github.actions.re-run-workflow

Re-runs your workflow run using its id.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.run_id integer Required The unique identifier of the workflow run.
body object | null Optional
body.enable_debug_logging boolean Optional Whether to enable debug logging for the re-run. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "run_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Re-run failed jobs from a workflow run — github.actions.re-run-workflow-failed-jobs

Re-run all of the failed jobs and their dependent jobs in a workflow run using the id of the workflow run.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.run_id integer Required The unique identifier of the workflow run.
body object | null Optional
body.enable_debug_logging boolean Optional Whether to enable debug logging for the re-run. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "run_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get workflow run usage — github.actions.get-workflow-run-usage

> [!WARNING] > This endpoint is in the process of closing down. Refer to "Actions Get workflow usage and Get workflow run usage endpoints closing down" for more information.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.run_id integer Required The unique identifier of the workflow run.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "run_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository secrets — github.actions.list-repo-secrets

Lists all secrets available in a repository without revealing their encrypted values.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository public key — github.actions.get-repo-public-key

Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository secret — github.actions.get-repo-secret

Gets a single repository secret without revealing its encrypted value.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update a repository secret — github.actions.create-or-update-repo-secret

Creates or updates a repository secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.secret_name string Required The name of the secret.
body object Required
body.encrypted_value string Required Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
body.key_id string Required ID of the key you used to encrypt the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "secret_name": "example"
  },
  "body": {
    "encrypted_value": "c2VjcmV0",
    "key_id": "012345678912345678"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a repository secret — github.actions.delete-repo-secret

Deletes a secret in a repository using the secret name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository variables — github.actions.list-repo-variables

Lists all repository variables.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 30). For more information, see "Using pagination in the REST API." default: 10
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a repository variable — github.actions.create-repo-variable

Creates a repository variable that you can reference in a GitHub Actions workflow.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.name string Required The name of the variable.
body.value string Required The value of the variable.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "name": "USERNAME",
    "value": "octocat"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository variable — github.actions.get-repo-variable

Gets a specific variable in a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.name string Required The name of the variable.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a repository variable — github.actions.update-repo-variable

Updates a repository variable that you can reference in a GitHub Actions workflow.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.name string Required The name of the variable.
body object Required
body.name string Optional The name of the variable.
body.value string Optional The value of the variable.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "name": "example"
  },
  "body": {
    "name": "USERNAME",
    "value": "octocat"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a repository variable — github.actions.delete-repo-variable

Deletes a repository variable using the variable name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.name string Required The name of the variable.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository workflows — github.actions.list-repo-workflows

Lists the workflows in a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a workflow — github.actions.get-workflow

Gets a specific workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.workflow_id — Required The ID of the workflow. You can also pass the workflow file name as a string.
path.workflow_id integer Required oneOf[1]
path.workflow_id string Required oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "workflow_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disable a workflow — github.actions.disable-workflow

Disables a workflow and sets the state of the workflow to disabled_manually. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.workflow_id — Required The ID of the workflow. You can also pass the workflow file name as a string.
path.workflow_id integer Required oneOf[1]
path.workflow_id string Required oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "workflow_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a workflow dispatch event — github.actions.create-workflow-dispatch

You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.workflow_id — Required The ID of the workflow. You can also pass the workflow file name as a string.
path.workflow_id integer Required oneOf[1]
path.workflow_id string Required oneOf[2]
body object Required
body.ref string Required The git reference for the workflow. The reference can be a branch or tag name.
body.inputs object Optional Input keys and values configured in the workflow file. The maximum number of properties is 25. Any default properties configured in the workflow file will be used when inputs are omitted. maxProperties: 25; additionalProperties: true
body.return_run_details boolean Optional Whether the response should include the workflow run ID and URLs.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "workflow_id": 1
  },
  "body": {
    "ref": "topic-branch",
    "inputs": {
      "name": "Mona the Octocat",
      "home": "San Francisco, CA"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enable a workflow — github.actions.enable-workflow

Enables a workflow and sets the state of the workflow to active. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.workflow_id — Required The ID of the workflow. You can also pass the workflow file name as a string.
path.workflow_id integer Required oneOf[1]
path.workflow_id string Required oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "workflow_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List workflow runs for a workflow — github.actions.list-workflow-runs

List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.workflow_id — Required The ID of the workflow. You can also pass the workflow file name as a string.
path.workflow_id integer Required oneOf[1]
path.workflow_id string Required oneOf[2]
query object Optional additionalProperties: false
query.actor string Optional Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.
query.branch string Optional Returns workflow runs associated with a branch. Use the name of the branch of the push.
query.event string Optional Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows."
query.status string Optional Returns workflow runs with the check run status or conclusion that you specify. For example, a conclusion can be success or a status can be in_progress. Only GitHub Actions can set a status of waiting, pending, or requested. enum: ["completed","action_required","cancelled","failure","neutral","skipped","stale","success","timed_out","in_progress","queued","requested","waiting","pending"]
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.created string Optional Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax." format: "date-time"
query.exclude_pull_requests boolean Optional If true pull requests are omitted from the response (empty array). default: false
query.check_suite_id integer Optional Returns workflow runs with the check_suite_id that you specify.
query.head_sha string Optional Only returns workflow runs that are associated with the specified head_sha.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "workflow_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get workflow usage — github.actions.get-workflow-usage

> [!WARNING] > This endpoint is in the process of closing down. Refer to "Actions Get workflow usage and Get workflow run usage endpoints closing down" for more information.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.workflow_id — Required The ID of the workflow. You can also pass the workflow file name as a string.
path.workflow_id integer Required oneOf[1]
path.workflow_id string Required oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "workflow_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository activities — github.repos.list-activities

Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.ref string Optional The Git reference for the activities you want to list. The ref for a branch can be formatted either as refs/heads/BRANCH_NAME or BRANCH_NAME, where BRANCH_NAME is the name of your branch.
query.actor string Optional The GitHub username to use to filter by the actor who performed the activity.
query.time_period string Optional The time period to filter by. For example, day will filter for activity that occurred in the past 24 hours, and week will filter for activity that occurred in the past 7 days (168 hours). enum: ["day","week","month","quarter","year"]
query.activity_type string Optional The activity type to filter by. For example, you can choose to filter by "force_push", to see all force pushes to the repository. enum: ["push","force_push","branch_creation","branch_deletion","pr_merge","merge_queue_merge"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository organization secrets — github.agents.list-repo-organization-secrets

Lists all organization secrets shared with a repository without revealing their encrypted values.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository organization variables — github.agents.list-repo-organization-variables

Lists all organization variables shared with a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 30). For more information, see "Using pagination in the REST API." default: 10
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository secrets — github.agents.list-repo-secrets

Lists all secrets available in a repository without revealing their encrypted values.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository public key — github.agents.get-repo-public-key

Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository secret — github.agents.get-repo-secret

Gets a single repository secret without revealing its encrypted value.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update a repository secret — github.agents.create-or-update-repo-secret

Creates or updates a repository secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.secret_name string Required The name of the secret.
body object Required
body.encrypted_value string Required Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
body.key_id string Required ID of the key you used to encrypt the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "secret_name": "example"
  },
  "body": {
    "encrypted_value": "c2VjcmV0",
    "key_id": "012345678912345678"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a repository secret — github.agents.delete-repo-secret

Deletes a secret in a repository using the secret name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository variables — github.agents.list-repo-variables

Lists all repository variables.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 30). For more information, see "Using pagination in the REST API." default: 10
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a repository variable — github.agents.create-repo-variable

Creates a repository variable that you can reference in a GitHub Actions workflow.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.name string Required The name of the variable.
body.value string Required The value of the variable.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "name": "USERNAME",
    "value": "octocat"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository variable — github.agents.get-repo-variable

Gets a specific variable in a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.name string Required The name of the variable.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a repository variable — github.agents.update-repo-variable

Updates a repository variable that you can reference in a GitHub Actions workflow.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.name string Required The name of the variable.
body object Required
body.name string Optional The name of the variable.
body.value string Optional The value of the variable.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "name": "example"
  },
  "body": {
    "name": "USERNAME",
    "value": "octocat"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a repository variable — github.agents.delete-repo-variable

Deletes a repository variable using the variable name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.name string Required The name of the variable.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List assignees — github.issues.list-assignees

Lists the available assignees for issues in a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check if a user can be assigned — github.issues.check-user-can-be-assigned

Checks if a user has permission to be assigned to an issue in this repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.assignee string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "assignee": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an attestation — github.repos.create-attestation

Store an artifact attestation and associate it with a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.bundle object Required The attestation's Sigstore Bundle. Refer to the Sigstore Bundle Specification for more information.
body.bundle.mediaType string Optional
body.bundle.verificationMaterial object Optional additionalProperties: true
body.bundle.dsseEnvelope object Optional additionalProperties: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "bundle": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List attestations — github.repos.list-attestations

List a collection of artifact attestations with a given subject digest that are associated with a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.subject_digest string Required The parameter should be set to the attestation's subject's SHA256 digest, in the form sha256:HEX_DIGEST.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.predicate_type string Optional Optional filter for fetching attestations with a given predicate type. This option accepts provenance, sbom, release, or freeform text for custom predicate types.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "subject_digest": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check if Dependabot security updates are enabled for a repository — github.repos.check-automated-security-fixes

Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "Configuring Dependabot security updates".

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enable Dependabot security updates — github.repos.enable-automated-security-fixes

Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "Configuring Dependabot security updates".

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disable Dependabot security updates — github.repos.disable-automated-security-fixes

Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "Configuring Dependabot security updates".

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List branches — github.repos.list-branches

Run List branches with GitHub. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.protected boolean Optional Setting to true returns only branches protected by branch protections or rulesets. When set to false, only unprotected branches are returned. Omitting this parameter returns all branches.
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a branch — github.repos.get-branch

Run Get a branch with GitHub. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get branch protection — github.repos.get-branch-protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update branch protection — github.repos.update-branch-protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
body object Required
body.required_status_checks object | null Required Require status checks to pass before merging. Set to null to disable.
body.required_status_checks.strict boolean Required Require branches to be up to date before merging.
body.required_status_checks.contexts array Required Closing down notice: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
body.required_status_checks.contexts[] string Optional
body.required_status_checks.checks array Optional The list of status checks to require in order to merge into this branch.
body.required_status_checks.checks[] object Optional
body.required_status_checks.checks[].context string Required The name of the required check
body.required_status_checks.checks[].app_id integer Optional The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.
body.enforce_admins boolean | null Required Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.
body.required_pull_request_reviews object | null Required Require at least one approving review on a pull request, before merging. Set to null to disable.
body.required_pull_request_reviews.dismissal_restrictions object Optional Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.
body.required_pull_request_reviews.dismissal_restrictions.users array Optional The list of user logins with dismissal access
body.required_pull_request_reviews.dismissal_restrictions.users[] string Optional
body.required_pull_request_reviews.dismissal_restrictions.teams array Optional The list of team slugs with dismissal access
body.required_pull_request_reviews.dismissal_restrictions.teams[] string Optional
body.required_pull_request_reviews.dismissal_restrictions.apps array Optional The list of app slugs with dismissal access
body.required_pull_request_reviews.dismissal_restrictions.apps[] string Optional
body.required_pull_request_reviews.dismiss_stale_reviews boolean Optional Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.
body.required_pull_request_reviews.require_code_owner_reviews boolean Optional Blocks merging pull requests until code owners review them.
body.required_pull_request_reviews.required_approving_review_count integer Optional Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.
body.required_pull_request_reviews.require_last_push_approval boolean Optional Whether the most recent push must be approved by someone other than the person who pushed it. Default: false. default: false
body.required_pull_request_reviews.bypass_pull_request_allowances object Optional Allow specific users, teams, or apps to bypass pull request requirements.
body.required_pull_request_reviews.bypass_pull_request_allowances.users array Optional The list of user logins allowed to bypass pull request requirements.
body.required_pull_request_reviews.bypass_pull_request_allowances.users[] string Optional
body.required_pull_request_reviews.bypass_pull_request_allowances.teams array Optional The list of team slugs allowed to bypass pull request requirements.
body.required_pull_request_reviews.bypass_pull_request_allowances.teams[] string Optional
body.required_pull_request_reviews.bypass_pull_request_allowances.apps array Optional The list of app slugs allowed to bypass pull request requirements.
body.required_pull_request_reviews.bypass_pull_request_allowances.apps[] string Optional
body.restrictions object | null Required Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.
body.restrictions.users array Required The list of user logins with push access
body.restrictions.users[] string Optional
body.restrictions.teams array Required The list of team slugs with push access
body.restrictions.teams[] string Optional
body.restrictions.apps array Optional The list of app slugs with push access
body.restrictions.apps[] string Optional
body.required_linear_history boolean Optional Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see "Requiring a linear commit history" in the GitHub Help documentation.
body.allow_force_pushes boolean | null Optional Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see "Enabling force pushes to a protected branch" in the GitHub Help documentation."
body.allow_deletions boolean Optional Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see "Enabling force pushes to a protected branch" in the GitHub Help documentation.
body.block_creations boolean Optional If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.
body.required_conversation_resolution boolean Optional Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.
body.lock_branch boolean Optional Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. Default: false. default: false
body.allow_fork_syncing boolean Optional Whether users can pull changes from upstream when the branch is locked. Set to true to allow fork syncing. Set to false to prevent fork syncing. Default: false. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  },
  "body": {
    "required_status_checks": {
      "strict": true,
      "contexts": [
        "continuous-integration/travis-ci"
      ]
    },
    "enforce_admins": true,
    "required_pull_request_reviews": {
      "dismissal_restrictions": {
        "users": [
          "octocat"
        ],
        "teams": [
          "justice-league"
        ]
      },
      "dismiss_stale_reviews": true,
      "require_code_owner_reviews": true,
      "required_approving_review_count": 2,
      "require_last_push_approval": true,
      "bypass_pull_request_allowances": {
        "users": [
          "octocat"
        ],
        "teams": [
          "justice-league"
        ]
      }
    },
    "restrictions": {
      "users": [
        "octocat"
      ],
      "teams": [
        "justice-league"
      ],
      "apps": [
        "super-ci"
      ]
    },
    "required_linear_history": true,
    "allow_force_pushes": true,
    "allow_deletions": true,
    "block_creations": true,
    "required_conversation_resolution": true,
    "lock_branch": true,
    "allow_fork_syncing": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete branch protection — github.repos.delete-branch-protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get admin branch protection — github.repos.get-admin-branch-protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set admin branch protection — github.repos.set-admin-branch-protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete admin branch protection — github.repos.delete-admin-branch-protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get pull request review protection — github.repos.get-pull-request-review-protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update pull request review protection — github.repos.update-pull-request-review-protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
body object Optional
body.dismissal_restrictions object Optional Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.
body.dismissal_restrictions.users array Optional The list of user logins with dismissal access
body.dismissal_restrictions.users[] string Optional
body.dismissal_restrictions.teams array Optional The list of team slugs with dismissal access
body.dismissal_restrictions.teams[] string Optional
body.dismissal_restrictions.apps array Optional The list of app slugs with dismissal access
body.dismissal_restrictions.apps[] string Optional
body.dismiss_stale_reviews boolean Optional Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.
body.require_code_owner_reviews boolean Optional Blocks merging pull requests until code owners have reviewed.
body.required_approving_review_count integer Optional Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.
body.require_last_push_approval boolean Optional Whether the most recent push must be approved by someone other than the person who pushed it. Default: false default: false
body.bypass_pull_request_allowances object Optional Allow specific users, teams, or apps to bypass pull request requirements.
body.bypass_pull_request_allowances.users array Optional The list of user logins allowed to bypass pull request requirements.
body.bypass_pull_request_allowances.users[] string Optional
body.bypass_pull_request_allowances.teams array Optional The list of team slugs allowed to bypass pull request requirements.
body.bypass_pull_request_allowances.teams[] string Optional
body.bypass_pull_request_allowances.apps array Optional The list of app slugs allowed to bypass pull request requirements.
body.bypass_pull_request_allowances.apps[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete pull request review protection — github.repos.delete-pull-request-review-protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get commit signature protection — github.repos.get-commit-signature-protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create commit signature protection — github.repos.create-commit-signature-protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete commit signature protection — github.repos.delete-commit-signature-protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get status checks protection — github.repos.get-status-checks-protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update status check protection — github.repos.update-status-check-protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
body object Optional
body.strict boolean Optional Require branches to be up to date before merging.
body.contexts array Optional Closing down notice: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
body.contexts[] string Optional
body.checks array Optional The list of status checks to require in order to merge into this branch.
body.checks[] object Optional
body.checks[].context string Required The name of the required check
body.checks[].app_id integer Optional The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove status check protection — github.repos.remove-status-check-protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all status check contexts — github.repos.get-all-status-check-contexts

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add status check contexts — github.repos.add-status-check-contexts

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
body — Optional
body object Optional oneOf[1]
body.contexts array Required The name of the status checks oneOf[1]
body.contexts[] string Optional oneOf[1]
body array Optional The name of the status checks oneOf[2]
body[] string Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set status check contexts — github.repos.set-status-check-contexts

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
body — Optional
body object Optional oneOf[1]
body.contexts array Required The name of the status checks oneOf[1]
body.contexts[] string Optional oneOf[1]
body array Optional The name of the status checks oneOf[2]
body[] string Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove status check contexts — github.repos.remove-status-check-contexts

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
body — Optional
body object Optional oneOf[1]
body.contexts array Required The name of the status checks oneOf[1]
body.contexts[] string Optional oneOf[1]
body array Optional The name of the status checks oneOf[2]
body[] string Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get access restrictions — github.repos.get-access-restrictions

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete access restrictions — github.repos.delete-access-restrictions

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get apps with access to the protected branch — github.repos.get-apps-with-access-to-protected-branch

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add app access restrictions — github.repos.add-app-access-restrictions

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
body object Required
body.apps array Required The GitHub Apps that have push access to this branch. Use the slugified version of the app name. Note: The list of users, apps, and teams in total is limited to 100 items.
body.apps[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  },
  "body": {
    "apps": [
      "octoapp"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set app access restrictions — github.repos.set-app-access-restrictions

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
body object Required
body.apps array Required The GitHub Apps that have push access to this branch. Use the slugified version of the app name. Note: The list of users, apps, and teams in total is limited to 100 items.
body.apps[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  },
  "body": {
    "apps": [
      "octoapp"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove app access restrictions — github.repos.remove-app-access-restrictions

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
body object Required
body.apps array Required The GitHub Apps that have push access to this branch. Use the slugified version of the app name. Note: The list of users, apps, and teams in total is limited to 100 items.
body.apps[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  },
  "body": {
    "apps": [
      "my-app"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get teams with access to the protected branch — github.repos.get-teams-with-access-to-protected-branch

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add team access restrictions — github.repos.add-team-access-restrictions

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
body — Optional
body object Optional oneOf[1]
body.teams array Required The slug values for teams oneOf[1]
body.teams[] string Optional oneOf[1]
body array Optional The slug values for teams oneOf[2]
body[] string Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set team access restrictions — github.repos.set-team-access-restrictions

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
body — Optional
body object Optional oneOf[1]
body.teams array Required The slug values for teams oneOf[1]
body.teams[] string Optional oneOf[1]
body array Optional The slug values for teams oneOf[2]
body[] string Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove team access restrictions — github.repos.remove-team-access-restrictions

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
body — Optional
body object Optional oneOf[1]
body.teams array Required The slug values for teams oneOf[1]
body.teams[] string Optional oneOf[1]
body array Optional The slug values for teams oneOf[2]
body[] string Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get users with access to the protected branch — github.repos.get-users-with-access-to-protected-branch

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add user access restrictions — github.repos.add-user-access-restrictions

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
body object Required
body.users array Required The username for users
body.users[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  },
  "body": {
    "users": [
      "octocat"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set user access restrictions — github.repos.set-user-access-restrictions

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
body object Required
body.users array Required The username for users
body.users[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  },
  "body": {
    "users": [
      "octocat"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove user access restrictions — github.repos.remove-user-access-restrictions

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
body object Required
body.users array Required The username for users
body.users[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  },
  "body": {
    "users": [
      "octocat"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Rename a branch — github.repos.rename-branch

Renames a branch in a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
body object Required
body.new_name string Required The new name of the branch.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  },
  "body": {
    "new_name": "my_renamed_branch"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a check run — github.checks.create

Creates a new check run for a specific commit in a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.name string Required The name of the check. For example, "code-coverage".
body.head_sha string Required The SHA of the commit.
body.details_url string Optional The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.
body.external_id string Optional A reference for the run on the integrator's system.
body.status string Optional The current status of the check run. Only GitHub Actions can set a status of waiting, pending, or requested. enum: ["queued","in_progress","completed","waiting","requested","pending"]; default: "queued"
body.started_at string Optional The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
body.conclusion string Optional Required if you provide completed_at or a status of completed. The final conclusion of the check. Note: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this. enum: ["action_required","cancelled","failure","neutral","success","skipped","stale","timed_out"]
body.completed_at string Optional The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
body.output object Optional Check 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.
body.output.title string Required The title of the check run.
body.output.summary string Required The summary of the check run. This parameter supports Markdown. Maximum length: 65535 characters. maxLength: 65535
body.output.text string Optional The details of the check run. This parameter supports Markdown. Maximum length: 65535 characters. maxLength: 65535
body.output.annotations array Optional Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see "About status checks". maxItems: 50
body.output.annotations[] object Optional
body.output.annotations[].path string Required The path of the file to add an annotation to. For example, assets/css/main.css.
body.output.annotations[].start_line integer Required The start line of the annotation. Line numbers start at 1.
body.output.annotations[].end_line integer Required The end line of the annotation.
body.output.annotations[].start_column integer Optional The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values. Column numbers start at 1.
body.output.annotations[].end_column integer Optional The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.
body.output.annotations[].annotation_level string Required The level of the annotation. enum: ["notice","warning","failure"]
body.output.annotations[].message string Required A short description of the feedback for these lines of code. The maximum size is 64 KB.
body.output.annotations[].title string Optional The title that represents the annotation. The maximum size is 255 characters.
body.output.annotations[].raw_details string Optional Details about this annotation. The maximum size is 64 KB.
body.output.images array Optional Adds images to the output displayed in the GitHub pull request UI.
body.output.images[] object Optional
body.output.images[].alt string Required The alternative text for the image.
body.output.images[].image_url string Required The full URL of the image.
body.output.images[].caption string Optional A short image description.
body.actions array Optional Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "Check runs and requested actions." maxItems: 3
body.actions[] object Optional
body.actions[].label string Required The text to be displayed on a button in the web UI. The maximum size is 20 characters. maxLength: 20
body.actions[].description string Required A short explanation of what this action would do. The maximum size is 40 characters. maxLength: 40
body.actions[].identifier string Required A reference for the action on the integrator's system. The maximum size is 20 characters. maxLength: 20
body object Required oneOf[1]; additionalProperties: true
body.status — Required oneOf[1]; enum: ["completed"]
body object Required oneOf[2]; additionalProperties: true
body.status — Optional oneOf[2]; enum: ["queued","in_progress"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "name": "mighty_readme",
    "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
    "status": "in_progress",
    "external_id": "42",
    "started_at": "2018-05-04T01:14:52Z",
    "output": {
      "title": "Mighty Readme report",
      "summary": "",
      "text": ""
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a check run — github.checks.get

Gets a single check run using its id.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.check_run_id integer Required The unique identifier of the check run.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "check_run_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a check run — github.checks.update

Updates a check run for a specific commit in a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.check_run_id integer Required The unique identifier of the check run.
body object Required
body.name string Optional The name of the check. For example, "code-coverage".
body.details_url string Optional The URL of the integrator's site that has the full details of the check.
body.external_id string Optional A reference for the run on the integrator's system.
body.started_at string Optional This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
body.status string Optional The current status of the check run. Only GitHub Actions can set a status of waiting, pending, or requested. enum: ["queued","in_progress","completed","waiting","requested","pending"]
body.conclusion string Optional Required if you provide completed_at or a status of completed. The final conclusion of the check. Note: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this. enum: ["action_required","cancelled","failure","neutral","success","skipped","stale","timed_out"]
body.completed_at string Optional The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
body.output object Optional Check 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.
body.output.title string Optional Required.
body.output.summary string Required Can contain Markdown. maxLength: 65535
body.output.text string Optional Can contain Markdown. maxLength: 65535
body.output.annotations array Optional Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "About status checks". maxItems: 50
body.output.annotations[] object Optional
body.output.annotations[].path string Required The path of the file to add an annotation to. For example, assets/css/main.css.
body.output.annotations[].start_line integer Required The start line of the annotation. Line numbers start at 1.
body.output.annotations[].end_line integer Required The end line of the annotation.
body.output.annotations[].start_column integer Optional The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values. Column numbers start at 1.
body.output.annotations[].end_column integer Optional The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.
body.output.annotations[].annotation_level string Required The level of the annotation. enum: ["notice","warning","failure"]
body.output.annotations[].message string Required A short description of the feedback for these lines of code. The maximum size is 64 KB.
body.output.annotations[].title string Optional The title that represents the annotation. The maximum size is 255 characters.
body.output.annotations[].raw_details string Optional Details about this annotation. The maximum size is 64 KB.
body.output.images array Optional Adds images to the output displayed in the GitHub pull request UI.
body.output.images[] object Optional
body.output.images[].alt string Required The alternative text for the image.
body.output.images[].image_url string Required The full URL of the image.
body.output.images[].caption string Optional A short image description.
body.actions array Optional Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "Check runs and requested actions." maxItems: 3
body.actions[] object Optional
body.actions[].label string Required The text to be displayed on a button in the web UI. The maximum size is 20 characters. maxLength: 20
body.actions[].description string Required A short explanation of what this action would do. The maximum size is 40 characters. maxLength: 40
body.actions[].identifier string Required A reference for the action on the integrator's system. The maximum size is 20 characters. maxLength: 20
body object Required anyOf[1]; additionalProperties: true
body.status — Optional anyOf[1]; enum: ["completed"]
body object Required anyOf[2]; additionalProperties: true
body.status — Optional anyOf[2]; enum: ["queued","in_progress"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "check_run_id": 1
  },
  "body": {
    "name": "mighty_readme",
    "started_at": "2018-05-04T01:14:52Z",
    "status": "completed",
    "conclusion": "success",
    "completed_at": "2018-05-04T01:14:52Z",
    "output": {
      "title": "Mighty Readme report",
      "summary": "There are 0 failures, 2 warnings, and 1 notices.",
      "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
      "annotations": [
        {
          "path": "README.md",
          "annotation_level": "warning",
          "title": "Spell Checker",
          "message": "Check your spelling for 'banaas'.",
          "raw_details": "Do you mean 'bananas' or 'banana'?",
          "start_line": 2,
          "end_line": 2
        },
        {
          "path": "README.md",
          "annotation_level": "warning",
          "title": "Spell Checker",
          "message": "Check your spelling for 'aples'",
          "raw_details": "Do you mean 'apples' or 'Naples'",
          "start_line": 4,
          "end_line": 4
        }
      ],
      "images": [
        {
          "alt": "Super bananas",
          "image_url": "http://example.com/images/42"
        }
      ]
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List check run annotations — github.checks.list-annotations

Lists annotations for a check run using the annotation id.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.check_run_id integer Required The unique identifier of the check run.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "check_run_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Rerequest a check run — github.checks.rerequest-run

Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhook event with the action rerequested. When a check run is rerequested, the status of the check suite it belongs to is reset to queued and the conclusion is cleared. The check run itself is not updated. GitHub apps recieving the check_run webhook with the rerequested action should then decide if the check run should be reset or updated and call the update check_run endpoint to update the check_run if desired.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.check_run_id integer Required The unique identifier of the check run.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "check_run_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a check suite — github.checks.create-suite

Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "Update repository preferences for check suites".

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.head_sha string Required The sha of the head commit.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update repository preferences for check suites — github.checks.set-suites-preferences

Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.auto_trigger_checks array Optional Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.
body.auto_trigger_checks[] object Optional
body.auto_trigger_checks[].app_id integer Required The id of the GitHub App.
body.auto_trigger_checks[].setting boolean Required Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them. default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "auto_trigger_checks": [
      {
        "app_id": 4,
        "setting": false
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a check suite — github.checks.get-suite

Gets a single check suite using its id.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.check_suite_id integer Required The unique identifier of the check suite.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "check_suite_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List check runs in a check suite — github.checks.list-for-suite

Lists check runs for a check suite using its id.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.check_suite_id integer Required The unique identifier of the check suite.
query object Optional additionalProperties: false
query.check_name string Optional Returns check runs with the specified name.
query.status string Optional Returns check runs with the specified status. enum: ["queued","in_progress","completed"]
query.filter string Optional Filters check runs by their completed_at timestamp. latest returns the most recent check runs. enum: ["latest","all"]; default: "latest"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "check_suite_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Rerequest a check suite — github.checks.rerequest-suite

Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.check_suite_id integer Required The unique identifier of the check suite.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "check_suite_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List code quality findings for a repository — github.code-quality.list-findings-for-repo

Lists code quality findings for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.state string Optional If specified, only code quality findings with this state will be returned. enum: ["open","dismissed"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a code quality finding — github.code-quality.get-finding

Gets a single code quality finding.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.finding_number integer Required The number that identifies a finding.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "finding_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a code quality setup configuration — github.code-quality.get-setup

Gets a code quality setup configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a code quality setup configuration — github.code-quality.update-setup

Updates a code quality setup configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body — Required $ref: "#/definitions/code-quality-setup-update"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "state": "configured"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get AI Scan enablement for a repository — github.code-scanning.get-ai-scan-enablement

Gets whether AI Scan is enabled for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List code scanning alerts for a repository — github.code-scanning.list-alerts-for-repo

Lists code scanning alerts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.tool_name — Optional The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both. $ref: "#/definitions/code-scanning-analysis-tool-name"
query.tool_guid — Optional The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both. $ref: "#/definitions/code-scanning-analysis-tool-guid"
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.ref — Optional The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge. $ref: "#/definitions/code-scanning-ref"
query.pr integer Optional The number of the pull request for the results you want to list.
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.sort string Optional The property by which to sort the results. enum: ["created","updated"]; default: "created"
query.state — Optional If specified, only code scanning alerts with this state will be returned. $ref: "#/definitions/code-scanning-alert-state-query"
query.severity — Optional If specified, only code scanning alerts with this severity will be returned. $ref: "#/definitions/code-scanning-alert-severity"
query.assignees string Optional Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot). Use * to list alerts with at least one assignee or none to list alerts with no assignees.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a code scanning alert — github.code-scanning.get-alert

Gets a single code scanning alert.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.alert_number — Required The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation. $ref: "#/definitions/alert-number"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "alert_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a code scanning alert — github.code-scanning.update-alert

Updates the status of a single code scanning alert. OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.alert_number — Required The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation. $ref: "#/definitions/alert-number"
body object Required
body.state — Optional $ref: "#/definitions/code-scanning-alert-set-state"
body.dismissed_reason — Optional $ref: "#/definitions/code-scanning-alert-dismissed-reason"
body.dismissed_comment — Optional $ref: "#/definitions/code-scanning-alert-dismissed-comment"
body.create_request — Optional $ref: "#/definitions/code-scanning-alert-create-request"
body.assignees — Optional $ref: "#/definitions/code-scanning-alert-assignees"
body — Required anyOf[1]
body — Required anyOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "alert_number": 1
  },
  "body": {
    "state": "dismissed",
    "dismissed_reason": "false positive",
    "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.",
    "create_request": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the status of an autofix for a code scanning alert — github.code-scanning.get-autofix

Gets the status and description of an autofix for a code scanning alert on the repository's default branch.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.alert_number — Required The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation. $ref: "#/definitions/alert-number"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "alert_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an autofix for a code scanning alert — github.code-scanning.create-autofix

Creates an autofix for a code scanning alert from the repository's default branch.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.alert_number — Required The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation. $ref: "#/definitions/alert-number"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "alert_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Commit an autofix for a code scanning alert — github.code-scanning.commit-autofix

Commits an autofix for a code scanning alert from the repository's default branch.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.alert_number — Required The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation. $ref: "#/definitions/alert-number"
body — Optional $ref: "#/definitions/code-scanning-autofix-commits"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "alert_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List instances of a code scanning alert — github.code-scanning.list-alert-instances

Lists all instances of the specified code scanning alert.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.alert_number — Required The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation. $ref: "#/definitions/alert-number"
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.ref — Optional The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge. $ref: "#/definitions/code-scanning-ref"
query.pr integer Optional The number of the pull request for the results you want to list.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "alert_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List code scanning analyses for a repository — github.code-scanning.list-recent-analyses

Lists the details of all code scanning analyses for a repository, starting with the most recent. The response is paginated and you can use the page and per_page parameters to list the analyses you're interested in. By default 30 analyses are listed per page.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.tool_name — Optional The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both. $ref: "#/definitions/code-scanning-analysis-tool-name"
query.tool_guid — Optional The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both. $ref: "#/definitions/code-scanning-analysis-tool-guid"
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.pr integer Optional The number of the pull request for the results you want to list.
query.ref — Optional The Git reference for the analyses you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge. $ref: "#/definitions/code-scanning-ref"
query.sarif_id — Optional Filter analyses belonging to the same SARIF upload. $ref: "#/definitions/code-scanning-analysis-sarif-id"
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.sort string Optional The property by which to sort the results. enum: ["created"]; default: "created"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a code scanning analysis for a repository — github.code-scanning.get-analysis

Gets a specified code scanning analysis for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.analysis_id integer Required The ID of the analysis, as returned from the GET /repos/{owner}/{repo}/code-scanning/analyses operation.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "analysis_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a code scanning analysis from a repository — github.code-scanning.delete-analysis

Deletes a specified code scanning analysis from a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.analysis_id integer Required The ID of the analysis, as returned from the GET /repos/{owner}/{repo}/code-scanning/analyses operation.
query object Optional additionalProperties: false
query.confirm_delete string | null Optional Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to true, you'll get a 400 response with the message: Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "analysis_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List CodeQL databases for a repository — github.code-scanning.list-codeql-databases

Lists the CodeQL databases that are available in a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a CodeQL database for a repository — github.code-scanning.get-codeql-database

Gets a CodeQL database for a language in a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.language string Required The language of the CodeQL database.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "language": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a CodeQL database — github.code-scanning.delete-codeql-database

Deletes a CodeQL database for a language in a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.language string Required The language of the CodeQL database.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "language": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a CodeQL variant analysis — github.code-scanning.create-variant-analysis

Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required additionalProperties: false
body.language — Required $ref: "#/definitions/code-scanning-variant-analysis-language"
body.query_pack string Required A Base64-encoded tarball containing a CodeQL query and all its dependencies
body.repositories array Optional List of repository names (in the form owner/repo-name) to run the query against. Precisely one property from repositories, repository_lists and repository_owners is required.
body.repositories[] string Optional
body.repository_lists array Optional List of repository lists to run the query against. Precisely one property from repositories, repository_lists and repository_owners is required. maxItems: 1
body.repository_lists[] string Optional
body.repository_owners array Optional List of organization or user names whose repositories the query should be run against. Precisely one property from repositories, repository_lists and repository_owners is required. maxItems: 1
body.repository_owners[] string Optional
body — Required oneOf[1]
body — Required oneOf[2]
body — Required oneOf[3]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "language": "csharp",
    "query_pack": "aGVsbG8=",
    "repositories": [
      "octocat/Hello-World",
      "octocat/example"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the summary of a CodeQL variant analysis — github.code-scanning.get-variant-analysis

Gets the summary of a CodeQL variant analysis.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.codeql_variant_analysis_id integer Required The unique identifier of the variant analysis.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "codeql_variant_analysis_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the analysis status of a repository in a CodeQL variant analysis — github.code-scanning.get-variant-analysis-repo-task

Gets the analysis status of a repository in a CodeQL variant analysis.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the controller repository.
path.codeql_variant_analysis_id integer Required The ID of the variant analysis.
path.repo_owner string Required The account owner of the variant analysis repository. The name is not case sensitive.
path.repo_name string Required The name of the variant analysis repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "codeql_variant_analysis_id": 1,
    "repo_owner": "example",
    "repo_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a code scanning default setup configuration — github.code-scanning.get-default-setup

Gets a code scanning default setup configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a code scanning default setup configuration — github.code-scanning.update-default-setup

Updates a code scanning default setup configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body — Required $ref: "#/definitions/code-scanning-default-setup-update"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Upload an analysis as SARIF data — github.code-scanning.upload-sarif

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "Troubleshooting SARIF uploads."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required additionalProperties: false
body.commit_sha — Required $ref: "#/definitions/code-scanning-analysis-commit-sha"
body.ref — Required $ref: "#/definitions/code-scanning-ref-full"
body.sarif — Required $ref: "#/definitions/code-scanning-analysis-sarif-file"
body.checkout_uri string Optional The base directory used in the analysis, as it appears in the SARIF file. This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. format: "uri"
body.started_at string Optional The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
body.tool_name string Optional The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.
body.validate boolean Optional Whether the SARIF file will be validated according to the code scanning specifications. This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "commit_sha": "4b6472266afd7b471e86085a6659e8c7f2b119da",
    "ref": "refs/heads/master",
    "sarif": "H4sICMLGdF4AA2V4YW1wbGUuc2FyaWYAvVjdbts2FL7PUxDCijaA/CM7iRNfLkPXYgHSNstumlzQ0pHFVCI1korjFgH2ONtr7Ul2KFmy/mOn6QIkjsjDw0/nfN85NL8dEGL9pNwAImqRObECrWM1H40kXQ2XTAfJIlEgXcE1cD10RTQSVDE10K4aKSqZP1AxuKOIKg1ydJU60jSfSh8Hk6EzHA/vlOCWbfa7B6kYPpj90rlsWCZcmbHP5Bs+4oAWIjQD2SMOeJLh2vIQDnIaQerqXHjw8YIgxohybxAyDsS4cAPKsp03K4RcUs6+Up2D+JXpd8mibKIQN9fM/aMCdbyBujGSSQgVxJtx5qX2d2qUcIweQhEuDQf3GBO6CKHkogx/N3MVCKl/AeVKFuf4y5ubsMGDTj1ep+5I7sgmLIpxtU38hLtmMRGSuCFVyip5eKzs5ydh+LztVL6f2m6oih1BkYiuyQIIJWodxVpERPj4sEiWBNNH8EWT0DMG8EAjzKVHXCrB4FkPu/F64NMk1OeC+2yZSNoBOoR7CC0EzYWGbm+xFDFIzbI011+cLjfZtyJkmMZfumAh02uL3NpV2y+MZ6RAjxibyKrNxxJcVjANSb4eBGwZ1M0KsuyR2poLr5rMl8vaDSeVn6eTWEO2j2xIEcmhwlTKNOi4GMOI8gfuZYkvJ7b4v5Tiumyz7RnHeodFzpS8ASIZCH/AYdWi2z3sG8JtFxJ6fF9yR9CdifBr9Pd6d5V2+zbJKjjCFGGmsHuYFy2ytJq9tUxcLSRSQecppOGKrpUxYfxefMEFK+wOGa4hudQByBVT0L+EKtyACxnRsABhEx1QjVDs1KNI9MbpnhqfE45B6FJvu3hRu5VRU9MhZLmK7fqkKyQSTHNoyMqUFMqXCV3CwAeqEwmVokraK8IuBaGvHjQ0gMYrKjnjyw7uk9uD8tgmsBbFMPnU1bV2ZhkJNkuolUiWys3UPWzs5aaIUz9TBe8zMb+6+nT+6fLy91dlE3xzeDDT4zYszb0bW6NjJd0Rvn2EnLvWLFSdKPpBzInzfRgu8ETyMcH8nIfMnJCeC2PyfTA+UKngcnGH7Hw2hGkVQs5YlIRCtdWZYQ4/73es2JlxkfViOEIhoWJq5Oo6UBBfiKIqFBWhiE3jJGbFwVoxBHTRSuIS67sMeplei24X20shLjG+8gqbKC/bESiNMC+wd5q5id0yeS7CJEqXzmrTWNq3k05l84P6f4/bEmXFJjI0fIt1BGQssUnUDkBYeVhE5TqPnMH3jqogDcP0zKcTgLPTMSzOjhbjuVOmW23l1fYNStulfo6sXlFsGLhbDy5RECPRYGCTgOj2bd4nUQEivEd0H7KKYxqnEhFohuur3a3UPskbH/+Yg0+M5P2MHRJu3ziHh3Z2NCrWt3XF1rWTw8Ne/pfbWYXnDSE0SNZQQt1i18q7te2vOhu7ehWuvVyeu0wbLZi24mhoo6aOOTltzG/lgdVvVoXQq5V+pewkFIzL8fjEcadT55jOjpzFzHuOTtDNrMkJPMVQDd7F09RID72O/UPZ0tmctqZ7kWX6EmSZnDpP8GU67SXM8XE3YSrxbKsx6UReZ4y6n/FVZfJjs9Z7stma75W5yQtkzjk5eSJxk1lv4o7+j8TlhaJ2lsKWZO6lruDPBLib3x5ZN/KGWzZ+pn///evv7OOf4iIBv3oY9L/l1wiJ9p0Tc+F1zZnOE9NxXWEus6IQhr5pMfoqxi8WPsuu0azsns4UC6WzNzHIzbeEx4P/AJ3SefgcFAAA"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get information about a SARIF upload — github.code-scanning.get-sarif

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "Get a code scanning analysis for a repository." OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.sarif_id string Required The SARIF ID obtained after uploading.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "sarif_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the code security configuration associated with a repository — github.code-security.get-configuration-for-repository

Get the code security configuration that manages a repository's code security settings.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List CODEOWNERS errors — github.repos.codeowners-errors

List any syntax errors that are detected in the CODEOWNERS file.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.ref string Optional A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. main)

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List codespaces in a repository for the authenticated user — github.codespaces.list-in-repository-for-authenticated-user

Lists the codespaces associated to a specified repository and the authenticated user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a codespace in a repository — github.codespaces.create-with-repo-for-authenticated-user

Creates a codespace owned by the authenticated user in the specified repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object | null Required
body.ref string Optional Git ref (typically a branch name) for this codespace
body.location string Optional The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.
body.geo string Optional The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces location, which is closing down. enum: ["EuropeWest","SoutheastAsia","UsEast","UsWest"]
body.client_ip string Optional IP for location auto-detection when proxying a request
body.machine string Optional Machine type to use for this codespace
body.devcontainer_path string Optional Path to devcontainer.json config to use for this codespace
body.multi_repo_permissions_opt_out boolean Optional Whether to authorize requested permissions from devcontainer.json
body.working_directory string Optional Working directory for this codespace
body.idle_timeout_minutes integer Optional Time in minutes before codespace stops from inactivity
body.display_name string Optional Display name for this codespace
body.retention_period_minutes integer Optional Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "ref": "main",
    "machine": "standardLinux32gb"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List devcontainer configurations in a repository for the authenticated user — github.codespaces.list-devcontainers-in-repository-for-authenticated-user

Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files specify launchpoint configurations for codespaces created within the repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List available machine types for a repository — github.codespaces.repo-machines-for-authenticated-user

List the machine types available for a given repository based on its configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.location string Optional The location to check for available machines. Assigned by IP if not provided.
query.client_ip string Optional IP for location auto-detection when proxying a request
query.ref string Optional The branch or commit to check for prebuild availability and devcontainer restrictions.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get default attributes for a codespace — github.codespaces.pre-flight-with-repo-for-authenticated-user

Gets the default attributes for codespaces created by the user with the repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.ref string Optional The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked.
query.client_ip string Optional An alternative IP for default location auto-detection, such as when proxying a request.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check if permissions defined by a devcontainer have been accepted by the authenticated user — github.codespaces.check-permissions-for-devcontainer

Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Required additionalProperties: false
query.ref string Required The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of ref will typically be a branch name (heads/BRANCH_NAME). For more information, see "Git References" in the Git documentation.
query.devcontainer_path string Required Path to the devcontainer.json configuration to use for the permission check.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "query": {
    "ref": "master",
    "devcontainer_path": ".devcontainer/example/devcontainer.json"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository secrets — github.codespaces.list-repo-secrets

Lists all development environment secrets available in a repository without revealing their encrypted values.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository public key — github.codespaces.get-repo-public-key

Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository secret — github.codespaces.get-repo-secret

Gets a single repository development environment secret without revealing its encrypted value.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update a repository secret — github.codespaces.create-or-update-repo-secret

Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.secret_name string Required The name of the secret.
body object Required
body.encrypted_value string Optional Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
body.key_id string Optional ID of the key you used to encrypt the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "secret_name": "example"
  },
  "body": {
    "encrypted_value": "c2VjcmV0",
    "key_id": "012345678912345678"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a repository secret — github.codespaces.delete-repo-secret

Deletes a development environment secret in a repository using the secret name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository collaborators — github.repos.list-collaborators

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. The permissions hash returned in the response contains the base role permissions of the collaborator. The role_name is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.affiliation string Optional Filter collaborators returned by their affiliation. outside means all outside collaborators of an organization-owned repository. direct means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. all means all collaborators the authenticated user can see. enum: ["outside","direct","all"]; default: "all"
query.permission string Optional Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. enum: ["pull","triage","triage_plus","push","maintain","admin"]
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check if a user is a repository collaborator — github.repos.check-collaborator

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a repository collaborator — github.repos.add-collaborator

Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "Adding outside collaborators to repositories" to learn more about these collaborator types.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.
body object Optional
body.permission string Optional The permission to grant the collaborator. Only valid on organization-owned repositories. We accept the following permissions to be set: pull, triage, triage_plus, push, maintain, admin and you can also specify a custom repository role name, if the owning organization has defined any. default: "push"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove a repository collaborator — github.repos.remove-collaborator

Removes a collaborator from a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get repository permissions for a user — github.repos.get-collaborator-permission-level

Checks the repository permission and role of a collaborator.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List commit comments for a repository — github.repos.list-commit-comments-for-repo

Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a commit comment — github.repos.get-commit-comment

Gets a specified commit comment.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a commit comment — github.repos.update-commit-comment

Updates the contents of a specified commit comment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.
body object Required
body.body string Required The contents of the comment

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1
  },
  "body": {
    "body": "Nice change"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a commit comment — github.repos.delete-commit-comment

Run Delete a commit comment with GitHub. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List reactions for a commit comment — github.reactions.list-for-commit-comment

List the reactions to a commit comment.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.
query object Optional additionalProperties: false
query.content string Optional Returns a single reaction type. Omit this parameter to list all reactions to a commit comment. enum: ["+1","-1","laugh","confused","heart","hooray","rocket","eyes"]
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create reaction for a commit comment — github.reactions.create-for-commit-comment

Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.
body object Required
body.content string Required The reaction type to add to the commit comment. enum: ["+1","-1","laugh","confused","heart","hooray","rocket","eyes"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1
  },
  "body": {
    "content": "heart"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a commit comment reaction — github.reactions.delete-for-commit-comment

> [!NOTE] > You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.
path.reaction_id integer Required The unique identifier of the reaction.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1,
    "reaction_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List commits — github.repos.list-commits

Signature verification object

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.sha string Optional SHA or branch to start listing commits from. Default: the repository’s default branch (usually main).
query.path string Optional Only commits containing this file path will be returned.
query.author string Optional GitHub username or email address to use to filter by commit author.
query.committer string Optional GitHub username or email address to use to filter by commit committer.
query.since string Optional Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. format: "date-time"
query.until string Optional Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. format: "date-time"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List branches for HEAD commit — github.repos.list-branches-for-head-commit

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.commit_sha string Required The SHA of the commit.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "commit_sha": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List commit comments — github.repos.list-comments-for-commit

Lists the comments for a specified commit.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.commit_sha string Required The SHA of the commit.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "commit_sha": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a commit comment — github.repos.create-commit-comment

Create a comment for a commit using its :commit_sha.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.commit_sha string Required The SHA of the commit.
body object Required
body.body string Required The contents of the comment.
body.path string Optional Relative path of the file to comment on.
body.position integer Optional Line index in the diff to comment on.
body.line integer Optional Closing down notice. Use position parameter instead. Line number in the file to comment on.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "commit_sha": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "body": {
    "body": "Great stuff",
    "path": "file1.txt",
    "position": 4,
    "line": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List pull requests associated with a commit — github.repos.list-pull-requests-associated-with-commit

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.commit_sha string Required The SHA of the commit.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "commit_sha": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a commit — github.repos.get-commit

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ref string Required The commit reference. Can be a commit SHA, branch name (heads/BRANCH_NAME), or tag name (tags/TAG_NAME). For more information, see "Git References" in the Git documentation.
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ref": "heads/main"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List check runs for a Git reference — github.checks.list-for-ref

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

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ref string Required The commit reference. Can be a commit SHA, branch name (heads/BRANCH_NAME), or tag name (tags/TAG_NAME). For more information, see "Git References" in the Git documentation.
query object Optional additionalProperties: false
query.check_name string Optional Returns check runs with the specified name.
query.status string Optional Returns check runs with the specified status. enum: ["queued","in_progress","completed"]
query.filter string Optional Filters check runs by their completed_at timestamp. latest returns the most recent check runs. enum: ["latest","all"]; default: "latest"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.app_id integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ref": "heads/main"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List check suites for a Git reference — github.checks.list-suites-for-ref

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ref string Required The commit reference. Can be a commit SHA, branch name (heads/BRANCH_NAME), or tag name (tags/TAG_NAME). For more information, see "Git References" in the Git documentation.
query object Optional additionalProperties: false
query.app_id integer Optional Filters check suites by GitHub App id.
query.check_name string Optional Returns check runs with the specified name.
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ref": "heads/main"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the combined status for a specific reference — github.repos.get-combined-status-for-ref

Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ref string Required The commit reference. Can be a commit SHA, branch name (heads/BRANCH_NAME), or tag name (tags/TAG_NAME). For more information, see "Git References" in the Git documentation.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ref": "heads/main"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List commit statuses for a reference — github.repos.list-commit-statuses-for-ref

Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ref string Required The commit reference. Can be a commit SHA, branch name (heads/BRANCH_NAME), or tag name (tags/TAG_NAME). For more information, see "Git References" in the Git documentation.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ref": "heads/main"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get community profile metrics — github.repos.get-community-profile-metrics

Returns all community profile metrics for a repository. The repository cannot be a fork.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Compare two commits — github.repos.compare-commits

Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "Understanding connections between repositories."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.basehead string Required The base branch and head branch to compare. This parameter expects the format BASE...HEAD. Both must be branch names in repo. To compare with a branch that exists in a different repository in the same network as repo, the basehead parameter expects the format USERNAME:BASE...USERNAME:HEAD.
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "basehead": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update file contents — github.repos.create-or-update-file-contents

Creates a new file or replaces an existing file in a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.path string Required path parameter
body object Required
body.message string Required The commit message.
body.content string Required The new file content, using Base64 encoding.
body.sha string Optional Required if you are updating a file. The blob SHA of the file being replaced.
body.branch string Optional The branch name. Default: the repository’s default branch.
body.committer object Optional The person that committed the file. Default: the authenticated user.
body.committer.name string Required The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
body.committer.email string Required The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
body.committer.date string Optional
body.author object Optional The author of the file. Default: The committer or the authenticated user if you omit committer.
body.author.name string Required The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
body.author.email string Required The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
body.author.date string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "path": "example"
  },
  "body": {
    "message": "my commit message",
    "committer": {
      "name": "Monalisa Octocat",
      "email": "[email protected]"
    },
    "content": "bXkgbmV3IGZpbGUgY29udGVudHM="
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a file — github.repos.delete-file

Deletes a file in a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.path string Required path parameter
body object Required
body.message string Required The commit message.
body.sha string Required The blob SHA of the file being deleted.
body.branch string Optional The branch name. Default: the repository’s default branch
body.committer object Optional object containing information about the committer.
body.committer.name string Optional The name of the author (or committer) of the commit
body.committer.email string Optional The email of the author (or committer) of the commit
body.author object Optional object containing information about the author.
body.author.name string Optional The name of the author (or committer) of the commit
body.author.email string Optional The email of the author (or committer) of the commit

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "path": "example"
  },
  "body": {
    "message": "my commit message",
    "committer": {
      "name": "Monalisa Octocat",
      "email": "[email protected]"
    },
    "sha": "329688480d39049927147c162b9d2deaf885005f"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository contributors — github.repos.list-contributors

Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.anon string Optional Set to 1 or true to include anonymous contributors in results.
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Copilot cloud agent configuration for a repository — github.copilot.get-copilot-cloud-agent-configuration

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Dependabot alerts for a repository — github.dependabot.list-alerts-for-repo

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.classification string Optional A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned. Can be: malware, general
query.state string Optional A comma-separated list of states. If specified, only alerts with these states will be returned. Can be: auto_dismissed, dismissed, fixed, open
query.severity string Optional A comma-separated list of severities. If specified, only alerts with these severities will be returned. Can be: low, medium, high, critical
query.ecosystem string Optional A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. Can be: composer, go, maven, npm, nuget, pip, pub, rubygems, rust
query.package string Optional A comma-separated list of package names. If specified, only alerts for these packages will be returned.
query.manifest string Optional A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned.
query.epss_percentage string Optional CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: - An exact number (n) - Comparators such as >n, <n, >=n, <=n - A range like n..n, where n is a number from 0.0 to 1.0 Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.
query.has — Optional Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. Multiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.
query.has string Optional oneOf[1]
query.has array Optional oneOf[2]
query.has[] string Optional oneOf[2]; enum: ["patch"]
query.assignee string Optional Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot) to return alerts assigned to any of the specified users. Use * to list alerts with at least one assignee or none to list alerts with no assignees.
query.scope string Optional The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. enum: ["development","runtime"]
query.relationship string Optional A comma-separated list of relationships of the vulnerable dependency to your project. If specified, only alerts with these relationships will be returned. > [!NOTE] > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems.
query.sort string Optional The property by which to sort the results. created means when the alert was created. updated means when the alert's state last changed. epss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. enum: ["created","updated","epss_percentage"]; default: "created"
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Dependabot alert — github.dependabot.get-alert

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.alert_number — Required The number that identifies a Dependabot alert in its repository. You can find this at the end of the URL for a Dependabot alert within GitHub, or in number fields in the response from the GET /repos/{owner}/{repo}/dependabot/alerts operation. $ref: "#/definitions/alert-number"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "alert_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Dependabot alert — github.dependabot.update-alert

The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "Granting access to security alerts."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.alert_number — Required The number that identifies a Dependabot alert in its repository. You can find this at the end of the URL for a Dependabot alert within GitHub, or in number fields in the response from the GET /repos/{owner}/{repo}/dependabot/alerts operation. $ref: "#/definitions/alert-number"
body object Required additionalProperties: false
body.state string Optional The state of the Dependabot alert. A dismissed_reason must be provided when setting the state to dismissed. enum: ["dismissed","open"]
body.dismissed_reason string Optional Required when state is dismissed. A reason for dismissing the alert. enum: ["fix_started","inaccurate","no_bandwidth","not_used","tolerable_risk"]
body.dismissed_comment string Optional An optional comment associated with dismissing the alert. maxLength: 280
body.assignees array Optional Usernames to assign to this Dependabot Alert. Pass one or more user logins to replace the set of assignees on this alert. Send an empty array ([]) to clear all assignees from the alert. To assign an AI agent, include the bot login (for example, copilot-swe-agent[bot]).
body.assignees[] string Optional
body.agent_assignment object Optional Parameters for AI agent assignment. Only used when an agent bot login is included in assignees. Ignored when no agent is being assigned. additionalProperties: false
body.agent_assignment.custom_instructions string Optional Custom instructions for the agent.
body.agent_assignment.custom_agent string Optional A custom agent identifier.
body.agent_assignment.model string Optional The model to use for the agent.
body — Required anyOf[1]
body — Required anyOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "alert_number": 1
  },
  "body": {
    "state": "dismissed",
    "dismissed_reason": "tolerable_risk",
    "dismissed_comment": "This alert is accurate but we use a sanitizer."
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository secrets — github.dependabot.list-repo-secrets

Lists all secrets available in a repository without revealing their encrypted values.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository public key — github.dependabot.get-repo-public-key

Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository secret — github.dependabot.get-repo-secret

Gets a single repository secret without revealing its encrypted value.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update a repository secret — github.dependabot.create-or-update-repo-secret

Creates or updates a repository secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.secret_name string Required The name of the secret.
body object Required
body.encrypted_value string Optional Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
body.key_id string Optional ID of the key you used to encrypt the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "secret_name": "example"
  },
  "body": {
    "encrypted_value": "c2VjcmV0",
    "key_id": "012345678912345678"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a repository secret — github.dependabot.delete-repo-secret

Deletes a secret in a repository using the secret name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a diff of the dependencies between commits — github.dependency-graph.diff-range

Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.basehead string Required The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format {base}...{head}.
query object Optional additionalProperties: false
query.name string Optional The full path, relative to the repository root, of the dependency manifest file.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "basehead": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch a software bill of materials (SBOM) for a repository. — github.dependency-graph.fetch-sbom-report

Fetches a previously generated software bill of materials (SBOM) for a repository. When the SBOM is ready, the response is a 302 redirect to a temporary download URL for the SBOM in SPDX JSON format. The generated SBOM report may be retained for up to one week from the original request. The temporary download URL returned by this endpoint expires separately, and its expiry is set when the fetch request is made.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.sbom_uuid string Required The unique identifier of the SBOM export.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "sbom_uuid": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Request generation of a software bill of materials (SBOM) for a repository. — github.dependency-graph.generate-sbom-report

Triggers a job to generate a software bill of materials (SBOM) for a repository in SPDX JSON format.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a snapshot of dependencies for a repository — github.dependency-graph.create-repository-snapshot

Create a new snapshot of a repository's dependencies.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body — Required $ref: "#/definitions/snapshot"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "detector": {
      "name": "docker buildtime detector",
      "version": "1.0.0",
      "url": "http://example.com/docker-buildtimer-detector"
    },
    "version": 1,
    "ref": "refs/heads/main",
    "sha": "ddc951f4b1293222421f2c8df679786153acf689",
    "job": {
      "id": "5622a2b0-63f6-4732-8c34-a1ab27e102a11",
      "correlator": "yourworkflowname_yourjobname"
    },
    "scanned": "2020-06-13T14:52:50-05:00"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List deployments — github.repos.list-deployments

Simple filtering of deployments is available via query parameters:

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.sha string Optional The SHA recorded at creation time. default: "none"
query.ref string Optional The name of the ref. This can be a branch, tag, or SHA. default: "none"
query.task string Optional The name of the task for the deployment (e.g., deploy or deploy:migrations). default: "none"
query.environment string | null Optional The name of the environment that was deployed to (e.g., staging or production). default: "none"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a deployment — github.repos.create-deployment

Deployments offer a few configurable parameters with certain defaults.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.ref string Required The ref to deploy. This can be a branch, tag, or SHA.
body.task string Optional Specifies a task to execute (e.g., deploy or deploy:migrations). default: "deploy"
body.auto_merge boolean Optional Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. default: true
body.required_contexts array Optional The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.
body.required_contexts[] string Optional
body.payload — Optional
body.payload object Optional oneOf[1]; additionalProperties: true
body.payload string Optional JSON payload with extra information about the deployment. oneOf[2]; default: ""
body.environment string Optional Name for the target deployment environment (e.g., production, staging, qa). default: "production"
body.description string | null Optional Short description of the deployment. default: ""
body.transient_environment boolean Optional Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false default: false
body.production_environment boolean Optional Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "ref": "topic-branch",
    "payload": "{ \"deploy\": \"migrate\" }",
    "description": "Deploy request from hubot"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a deployment — github.repos.get-deployment

Run Get a deployment with GitHub. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.deployment_id integer Required deployment_id parameter

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "deployment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a deployment — github.repos.delete-deployment

If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.deployment_id integer Required deployment_id parameter

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "deployment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List deployment statuses — github.repos.list-deployment-statuses

Users with pull access can view deployment statuses for a deployment:

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.deployment_id integer Required deployment_id parameter
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "deployment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a deployment status — github.repos.create-deployment-status

Users with push access can create deployment statuses for a given deployment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.deployment_id integer Required deployment_id parameter
body object Required
body.state string Required The state of the status. When you set a transient deployment to inactive, the deployment will be shown as destroyed in GitHub. enum: ["error","failure","inactive","in_progress","queued","pending","success"]
body.target_url string Optional The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. > [!NOTE] > It's recommended to use the log_url parameter, which replaces target_url. default: ""
body.log_url string Optional The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: "" default: ""
body.description string Optional A short description of the status. The maximum description length is 140 characters. default: ""
body.environment string Optional Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used.
body.environment_url string Optional Sets the URL for accessing your environment. Default: "" default: ""
body.auto_inactive boolean Optional Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "deployment_id": 1
  },
  "body": {
    "environment": "production",
    "state": "success",
    "log_url": "https://example.com/deployment/42/output",
    "description": "Deployment finished successfully."
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a deployment status — github.repos.get-deployment-status

Users with pull access can view a deployment status for a deployment:

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.deployment_id integer Required deployment_id parameter
path.status_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "deployment_id": 1,
    "status_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a repository dispatch event — github.repos.create-dispatch-event

You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs. For an example repository_dispatch webhook payload, see "RepositoryDispatchEvent."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.event_type string Required A custom webhook event name. Must be 100 characters or fewer. minLength: 1; maxLength: 100
body.client_payload object Optional JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. maxProperties: 10; additionalProperties: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "event_type": "on-demand-test",
    "client_payload": {
      "unit": false,
      "integration": true
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List environments — github.repos.get-all-environments

Lists the environments for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an environment — github.repos.get-environment

> [!NOTE] > To get information about name patterns that branches must match in order to deploy to this environment, see "Get a deployment branch policy."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "environment_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update an environment — github.repos.create-or-update-environment

Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "Environments."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
body object | null Optional additionalProperties: false
body.wait_timer — Optional $ref: "#/definitions/wait-timer"
body.prevent_self_review — Optional $ref: "#/definitions/prevent-self-review"
body.reviewers array | null Optional The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.
body.reviewers[] object Optional
body.reviewers[].type — Optional $ref: "#/definitions/deployment-reviewer-type"
body.reviewers[].id integer Optional The id of the user or team who can review the deployment
body.deployment_branch_policy — Optional $ref: "#/definitions/deployment-branch-policy-settings"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "environment_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an environment — github.repos.delete-an-environment

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "environment_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List deployment branch policies — github.repos.list-deployment-branch-policies

Lists the deployment branch policies for an environment.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "environment_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a deployment branch policy — github.repos.create-deployment-branch-policy

Creates a deployment branch or tag policy for an environment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
body — Required $ref: "#/definitions/deployment-branch-policy-name-pattern-with-type"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "environment_name": "example"
  },
  "body": {
    "name": "release/*"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a deployment branch policy — github.repos.get-deployment-branch-policy

Gets a deployment branch or tag policy for an environment.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
path.branch_policy_id integer Required The unique identifier of the branch policy.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "environment_name": "example",
    "branch_policy_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a deployment branch policy — github.repos.update-deployment-branch-policy

Updates a deployment branch or tag policy for an environment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
path.branch_policy_id integer Required The unique identifier of the branch policy.
body — Required $ref: "#/definitions/deployment-branch-policy-name-pattern"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "environment_name": "example",
    "branch_policy_id": 1
  },
  "body": {
    "name": "release/*"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a deployment branch policy — github.repos.delete-deployment-branch-policy

Deletes a deployment branch or tag policy for an environment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
path.branch_policy_id integer Required The unique identifier of the branch policy.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "environment_name": "example",
    "branch_policy_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all deployment protection rules for an environment — github.repos.get-all-deployment-protection-rules

Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "Using environments for deployment."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.owner string Required The account owner of the repository. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "environment_name": "example",
    "repo": "hello-world",
    "owner": "octocat"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a custom deployment protection rule on an environment — github.repos.create-deployment-protection-rule

Enable a custom deployment protection rule for an environment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.owner string Required The account owner of the repository. The name is not case sensitive.
body object Required
body.integration_id integer Optional The ID of the custom app that will be enabled on the environment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "environment_name": "example",
    "repo": "hello-world",
    "owner": "octocat"
  },
  "body": {
    "integration_id": 5
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List custom deployment rule integrations available for an environment — github.repos.list-custom-deployment-rule-integrations

Gets all custom deployment protection rule integrations that are available for an environment.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.owner string Required The account owner of the repository. The name is not case sensitive.
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "environment_name": "example",
    "repo": "hello-world",
    "owner": "octocat"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a custom deployment protection rule — github.repos.get-custom-deployment-protection-rule

Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "Using environments for deployment."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
path.protection_rule_id integer Required The unique identifier of the protection rule.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "environment_name": "example",
    "protection_rule_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disable a custom protection rule for an environment — github.repos.disable-deployment-protection-rule

Disables a custom deployment protection rule for an environment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.protection_rule_id integer Required The unique identifier of the protection rule.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "environment_name": "example",
    "repo": "hello-world",
    "owner": "octocat",
    "protection_rule_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List environment secrets — github.actions.list-environment-secrets

Lists all secrets available in an environment without revealing their encrypted values.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "environment_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an environment public key — github.actions.get-environment-public-key

Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "environment_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an environment secret — github.actions.get-environment-secret

Gets a single environment secret without revealing its encrypted value.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "environment_name": "example",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update an environment secret — github.actions.create-or-update-environment-secret

Creates or updates an environment secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
path.secret_name string Required The name of the secret.
body object Required
body.encrypted_value string Required Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
body.key_id string Required ID of the key you used to encrypt the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "environment_name": "example",
    "secret_name": "example"
  },
  "body": {
    "encrypted_value": "c2VjcmV0",
    "key_id": "012345678912345678"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an environment secret — github.actions.delete-environment-secret

Deletes a secret in an environment using the secret name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "environment_name": "example",
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List environment variables — github.actions.list-environment-variables

Lists all environment variables.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 30). For more information, see "Using pagination in the REST API." default: 10
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "environment_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an environment variable — github.actions.create-environment-variable

Create an environment variable that you can reference in a GitHub Actions workflow.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
body object Required
body.name string Required The name of the variable.
body.value string Required The value of the variable.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "environment_name": "example"
  },
  "body": {
    "name": "USERNAME",
    "value": "octocat"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an environment variable — github.actions.get-environment-variable

Gets a specific variable in an environment.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
path.name string Required The name of the variable.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "environment_name": "example",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an environment variable — github.actions.update-environment-variable

Updates an environment variable that you can reference in a GitHub Actions workflow.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.name string Required The name of the variable.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
body object Required
body.name string Optional The name of the variable.
body.value string Optional The value of the variable.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "name": "example",
    "environment_name": "example"
  },
  "body": {
    "name": "USERNAME",
    "value": "octocat"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an environment variable — github.actions.delete-environment-variable

Deletes an environment variable using the variable name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.name string Required The name of the variable.
path.environment_name string Required The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "name": "example",
    "environment_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository events — github.activity.list-repo-events

> [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List forks — github.repos.list-forks

Run List forks with GitHub. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.sort string Optional The sort order. stargazers will sort by star count. enum: ["newest","oldest","stargazers","watchers"]; default: "newest"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a fork — github.repos.create-fork

Create a fork for the authenticated user.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object | null Optional
body.organization string Optional Optional parameter to specify the organization name if forking into an organization.
body.name string Optional When forking from an existing repository, a new name for the fork.
body.default_branch_only boolean Optional When forking from an existing repository, fork with only the default branch.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a blob — github.git.create-blob

Run Create a blob with GitHub. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.content string Required The new blob's content.
body.encoding string Optional The encoding used for content. Currently, "utf-8" and "base64" are supported. default: "utf-8"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "content": "Content of the blob",
    "encoding": "utf-8"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a blob — github.git.get-blob

The content in the response will always be Base64 encoded.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.file_sha string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "file_sha": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a commit — github.git.create-commit

Creates a new Git commit object.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.message string Required The commit message
body.tree string Required The SHA of the tree object this commit points to
body.parents array Optional The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.
body.parents[] string Optional
body.author object Optional Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.
body.author.name string Required The name of the author (or committer) of the commit
body.author.email string Required The email of the author (or committer) of the commit
body.author.date string Optional Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
body.committer object Optional Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.
body.committer.name string Optional The name of the author (or committer) of the commit
body.committer.email string Optional The email of the author (or committer) of the commit
body.committer.date string Optional Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
body.signature string Optional The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "message": "my commit message",
    "author": {
      "name": "Mona Octocat",
      "email": "[email protected]",
      "date": "2008-07-09T16:13:30+12:00"
    },
    "parents": [
      "7d1b31e74ee336d15cbd21741bc88a537ed063a0"
    ],
    "tree": "827efc6d56897b048c772eb4087f854f46256132",
    "signature": "-----BEGIN PGP SIGNATURE-----\n\niQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv\n7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI\nDkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n\n2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA\nOQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k\nnrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU\n+NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB\njHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ\n3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+\nUpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr\nX11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp\neSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc=\n=5Io4\n-----END PGP SIGNATURE-----\n"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a commit object — github.git.get-commit

Gets a Git commit object.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.commit_sha string Required The SHA of the commit.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "commit_sha": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List matching references — github.git.list-matching-refs

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ref string Required The Git reference. For more information, see "Git References" in the Git documentation.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ref": "heads/feature-a"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a reference — github.git.get-ref

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ref string Required The Git reference. For more information, see "Git References" in the Git documentation.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ref": "heads/feature-a"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a reference — github.git.create-ref

Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.ref string Required The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.
body.sha string Required The SHA1 value for this reference.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "ref": "refs/heads/featureA",
    "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a reference — github.git.update-ref

Updates the provided reference to point to a new SHA. For more information, see "Git References" in the Git documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ref string Required The Git reference. For more information, see "Git References" in the Git documentation.
body object Required
body.sha string Required The SHA1 value to set this reference to
body.force boolean Optional Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ref": "heads/feature-a"
  },
  "body": {
    "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
    "force": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a reference — github.git.delete-ref

Deletes the provided reference.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ref string Required The Git reference. For more information, see "Git References" in the Git documentation.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ref": "heads/feature-a"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a tag object — github.git.create-tag

Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.tag string Required The tag's name. This is typically a version (e.g., "v0.0.1").
body.message string Required The tag message.
body.object string Required The SHA of the git object this is tagging.
body.type string Required The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob. enum: ["commit","tree","blob"]
body.tagger object Optional An object with information about the individual creating the tag.
body.tagger.name string Required The name of the author of the tag
body.tagger.email string Required The email of the author of the tag
body.tagger.date string Optional When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "tag": "v0.0.1",
    "message": "initial version",
    "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
    "type": "commit",
    "tagger": {
      "name": "Monalisa Octocat",
      "email": "[email protected]",
      "date": "2011-06-17T14:53:35-07:00"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a tag — github.git.get-tag

Signature verification object

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.tag_sha string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "tag_sha": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a tree — github.git.create-tree

The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.tree array Required Objects (of path, mode, type, and sha) specifying a tree structure.
body.tree[] object Optional
body.tree[].path string Optional The file referenced in the tree.
body.tree[].mode string Optional The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink. enum: ["100644","100755","040000","160000","120000"]
body.tree[].type string Optional Either blob, tree, or commit. enum: ["blob","tree","commit"]
body.tree[].sha string | null Optional The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted. Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
body.tree[].content string Optional The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha. Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
body.base_tree string Optional The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. If not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
    "tree": [
      {
        "path": "file.rb",
        "mode": "100644",
        "type": "blob",
        "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a tree — github.git.get-tree

Returns a single tree using the SHA1 value or ref name for that tree.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.tree_sha string Required The SHA1 value or ref (branch or tag) name of the tree.
query object Optional additionalProperties: false
query.recursive string Optional Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in :tree_sha. For example, setting recursive to any of the following will enable returning objects or subtrees: 0, 1, "true", and "false". Omit this parameter to prevent recursively returning objects or subtrees.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "tree_sha": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the hash algorithm for a repository — github.repos.get-hash-algorithm

Returns the hash algorithm used to store repository objects.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository webhooks — github.repos.list-webhooks

Lists webhooks for a repository. last response may return null if there have not been any deliveries within 30 days.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a repository webhook — github.repos.create-webhook

Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can share the same config as long as those webhooks do not have any events that overlap.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object | null Optional additionalProperties: false
body.name string Optional Use web to create a webhook. Default: web. This parameter only accepts the value web.
body.config object Optional Key/value pairs to provide settings for this webhook.
body.config.url — Optional $ref: "#/definitions/webhook-config-url"
body.config.content_type — Optional $ref: "#/definitions/webhook-config-content-type"
body.config.secret — Optional $ref: "#/definitions/webhook-config-secret"
body.config.insecure_ssl — Optional $ref: "#/definitions/webhook-config-insecure-ssl"
body.events array Optional Determines what events the hook is triggered for. default: ["push"]
body.events[] string Optional
body.active boolean Optional Determines if notifications are sent when the webhook is triggered. Set to true to send notifications. default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository webhook — github.repos.get-webhook

Returns a webhook configured in a repository. To get only the webhook config properties, see "Get a webhook configuration for a repository."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "hook_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a repository webhook — github.repos.update-webhook

Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use "Update a webhook configuration for a repository."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.
body object Required
body.config — Optional $ref: "#/definitions/webhook-config"
body.events array Optional Determines what events the hook is triggered for. This replaces the entire array of events. default: ["push"]
body.events[] string Optional
body.add_events array Optional Determines a list of events to be added to the list of events that the Hook triggers for.
body.add_events[] string Optional
body.remove_events array Optional Determines a list of events to be removed from the list of events that the Hook triggers for.
body.remove_events[] string Optional
body.active boolean Optional Determines if notifications are sent when the webhook is triggered. Set to true to send notifications. default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "hook_id": 1
  },
  "body": {
    "active": true,
    "add_events": [
      "pull_request"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a repository webhook — github.repos.delete-webhook

Delete a webhook for an organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "hook_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a webhook configuration for a repository — github.repos.get-webhook-config-for-repo

Returns the webhook configuration for a repository. To get more information about the webhook, including the active state and events, use "Get a repository webhook."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "hook_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a webhook configuration for a repository — github.repos.update-webhook-config-for-repo

Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use "Update a repository webhook."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.
body object Optional additionalProperties: false
body.url — Optional $ref: "#/definitions/webhook-config-url"
body.content_type — Optional $ref: "#/definitions/webhook-config-content-type"
body.secret — Optional $ref: "#/definitions/webhook-config-secret"
body.insecure_ssl — Optional $ref: "#/definitions/webhook-config-insecure-ssl"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "hook_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List deliveries for a repository webhook — github.repos.list-webhook-deliveries

Returns a list of webhook deliveries for a webhook configured in a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.cursor string Optional Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the link header for the next and previous page cursors.
query.status string Optional Returns webhook deliveries filtered by delivery outcome classification based on status_code range. A status of success returns deliveries with a status_code in the 200-399 range (inclusive). A status of failure returns deliveries with a status_code in the 400-599 range (inclusive). enum: ["success","failure"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "hook_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a delivery for a repository webhook — github.repos.get-webhook-delivery

Returns a delivery for a webhook configured in a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.
path.delivery_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "hook_id": 1,
    "delivery_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Redeliver a delivery for a repository webhook — github.repos.redeliver-webhook-delivery

Redeliver a webhook delivery for a webhook configured in a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.
path.delivery_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "hook_id": 1,
    "delivery_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Ping a repository webhook — github.repos.ping-webhook

This will trigger a ping event to be sent to the hook.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "hook_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Test the push repository webhook — github.repos.test-push-webhook

This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.hook_id integer Required The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "hook_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check if immutable releases are enabled for a repository — github.repos.check-immutable-releases

Shows whether immutable releases are enabled or disabled. Also identifies whether immutability is being enforced by the repository owner. The authenticated user must have admin read access to the repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enable immutable releases — github.repos.enable-immutable-releases

Enables immutable releases for a repository. The authenticated user must have admin access to the repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disable immutable releases — github.repos.disable-immutable-releases

Disables immutable releases for a repository. The authenticated user must have admin access to the repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository installation for the authenticated app — github.apps.get-repo-installation

Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get interaction restrictions for a repository — github.interactions.get-restrictions-for-repo

Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set interaction restrictions for a repository — github.interactions.set-restrictions-for-repo

Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a 409 Conflict response and will not be able to use this endpoint to change the interaction limit for a single repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body — Required $ref: "#/definitions/interaction-limit"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "limit": "collaborators_only"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove interaction restrictions for a repository — github.interactions.remove-restrictions-for-repo

Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a 409 Conflict response and will not be able to use this endpoint to change the interaction limit for a single repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get pull request creation cap bypass list for a repository — github.interactions.get-pull-request-bypass-list-for-repo

Lists the users that are on the pull request creation cap bypass list for a repository. Users on this list can create pull requests regardless of any configured pull request creation cap.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add users to the pull request creation cap bypass list for a repository — github.interactions.set-pull-request-bypass-list-for-repo

Adds users to the pull request creation cap bypass list for a repository. Users on this list can create pull requests regardless of any configured pull request creation cap.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body — Required $ref: "#/definitions/interaction-limit-pull-request-bypass-list"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "users": [
      "octocat",
      "monalisa"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove users from the pull request creation cap bypass list for a repository — github.interactions.remove-pull-request-bypass-list-for-repo

Removes users from the pull request creation cap bypass list for a repository. Removed users will be subject to any configured pull request creation cap.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body — Required $ref: "#/definitions/interaction-limit-pull-request-bypass-list"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "users": [
      "octocat",
      "monalisa"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get pull request creation cap for a repository — github.interactions.get-pull-request-creation-cap-for-repo

Gets the pull request creation cap configuration for a repository. The cap limits the number of open pull requests a user can have at one time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update pull request creation cap for a repository — github.interactions.update-pull-request-creation-cap-for-repo

Updates the pull request creation cap for a repository. The cap limits the number of open pull requests a user can have at one time.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.enabled boolean Required Whether the pull request creation cap is enabled
body.max_open_pull_requests integer Optional The maximum number of open pull requests a user can have at one time minimum: 1; maximum: 1000
body.include_drafts boolean Optional Whether draft pull requests count toward the pull request creation cap

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "enabled": true,
    "max_open_pull_requests": 1,
    "include_drafts": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository invitations — github.repos.list-invitations

When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a repository invitation — github.repos.update-invitation

Run Update a repository invitation with GitHub. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.invitation_id integer Required The unique identifier of the invitation.
body object Optional
body.permissions string Optional The permissions that the associated user will have on the repository. Valid values are read, write, maintain, triage, and admin. enum: ["read","write","maintain","triage","admin"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "invitation_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a repository invitation — github.repos.delete-invitation

Run Delete a repository invitation with GitHub. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.invitation_id integer Required The unique identifier of the invitation.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "invitation_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List issue types for a repository — github.repos.list-issue-types

Lists enabled issue types inherited from the repository owner. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. Fine-grained access tokens require the "Metadata" repository permission (read).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository issues — github.issues.list-for-repo

List issues in a repository. Only open issues will be listed.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.milestone string Optional If an integer is passed, it should refer to a milestone by its number field. If the string * is passed, issues with any milestone are accepted. If the string none is passed, issues without milestones are returned.
query.state string Optional Indicates the state of the issues to return. enum: ["open","closed","all"]; default: "open"
query.assignee string Optional Can be the name of a user. Pass in none for issues with no assigned user, and * for issues assigned to any user.
query.type string Optional Can be the name of an issue type. If the string * is passed, issues with any type are accepted. If the string none is passed, issues without type are returned.
query.creator string Optional The user that created the issue.
query.mentioned string Optional A user that's mentioned in the issue.
query.issue_field_values string Optional A comma-separated list of issue field filters in field_slug:value format. Only issues matching all specified field values are returned. Requires issue fields to be enabled for the repository. Issue fields are not available for user-owned repositories, and field availability for organization-owned public repositories depends on the organization's visibility settings. For example, priority:Urgent,severity:High filters issues where the priority field is Urgent AND the severity field is High.
query.labels string Optional A list of comma separated label names. Example: bug,ui,@high
query.sort string Optional What to sort results by. enum: ["created","updated","comments"]; default: "created"
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.since string Optional Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an issue — github.issues.create

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.title — Required The title of the issue.
body.title string Required oneOf[1]
body.title integer Required oneOf[2]
body.body string Optional The contents of the issue.
body.assignee string | null Optional Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is closing down.
body.milestone — Optional
body.milestone string Optional oneOf[1]
body.milestone integer Optional The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise. oneOf[2]
body.labels array Optional Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.
body.labels[] — Optional
body.labels[] string Optional oneOf[1]
body.labels[] object Optional oneOf[2]
body.labels[].id integer Optional oneOf[2]
body.labels[].name string Optional oneOf[2]
body.labels[].description string | null Optional oneOf[2]
body.labels[].color string | null Optional oneOf[2]
body.assignees array Optional Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.
body.assignees[] string Optional
body.issue_field_values array Optional An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields are only available for organization-owned repositories with the feature enabled. Field values are silently dropped otherwise.
body.issue_field_values[] object Optional additionalProperties: false
body.issue_field_values[].field_id integer Required The ID of the issue field to set
body.issue_field_values[].value — Required The value to set for the field. For multi-select fields, provide an array of option names.
body.issue_field_values[].value string Required oneOf[1]
body.issue_field_values[].value number Required oneOf[2]
body.issue_field_values[].value array Required oneOf[3]
body.issue_field_values[].value[] string Optional oneOf[3]
body.type string | null Optional The name of the issue type to associate with this issue. NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise.
body.parent_issue_id integer Optional The id of the parent issue to add this issue to as a sub-issue. NOTE: Only users with triage access to both the parent issue's repository and this repository can set the parent issue.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "title": "Found a bug",
    "body": "I'm having a problem with this.",
    "assignees": [
      "octocat"
    ],
    "milestone": 1,
    "labels": [
      "bug"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List issue comments for a repository — github.issues.list-comments-for-repo

You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.sort string Optional The property to sort the results by. enum: ["created","updated"]; default: "created"
query.direction string Optional Either asc or desc. Ignored without the sort parameter. enum: ["asc","desc"]
query.since string Optional Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an issue comment — github.issues.get-comment

You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an issue comment — github.issues.update-comment

You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.
body object Required
body.body string Required The contents of the comment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1
  },
  "body": {
    "body": "Me too"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an issue comment — github.issues.delete-comment

You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Pin an issue comment — github.issues.pin-comment

You can use the REST API to pin comments on issues.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Unpin an issue comment — github.issues.unpin-comment

You can use the REST API to unpin comments on issues.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List reactions for an issue comment — github.reactions.list-for-issue-comment

List the reactions to an issue comment.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.
query object Optional additionalProperties: false
query.content string Optional Returns a single reaction type. Omit this parameter to list all reactions to an issue comment. enum: ["+1","-1","laugh","confused","heart","hooray","rocket","eyes"]
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create reaction for an issue comment — github.reactions.create-for-issue-comment

Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.
body object Required
body.content string Required The reaction type to add to the issue comment. enum: ["+1","-1","laugh","confused","heart","hooray","rocket","eyes"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1
  },
  "body": {
    "content": "heart"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an issue comment reaction — github.reactions.delete-for-issue-comment

> [!NOTE] > You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.
path.reaction_id integer Required The unique identifier of the reaction.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1,
    "reaction_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List issue events for a repository — github.issues.list-events-for-repo

Lists events for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an issue event — github.issues.get-event

Gets a single event by the event id.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.event_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "event_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an issue — github.issues.get

The API returns a 301 Moved Permanently status if the issue was transferred to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe to the issues webhook.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an issue — github.issues.update

Issue owners and users with push access or Triage role can edit an issue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
body object Optional
body.title — Optional The title of the issue.
body.title string Optional oneOf[1]
body.title integer Optional oneOf[2]
body.body string | null Optional The contents of the issue.
body.assignee string | null Optional Username to assign to this issue. This field is closing down.
body.state string Optional The open or closed state of the issue. enum: ["open","closed"]
body.state_reason string | null Optional The reason for the state change. Ignored unless state is changed. enum: ["completed","not_planned","duplicate","reopened"]
body.duplicate_issue_id integer Optional The ID of the issue that this issue duplicates, used when marking this issue as a duplicate with status: Duplicate or state_reason: duplicate. The issue must exist and be accessible to the authenticated user.
body.milestone — Optional
body.milestone string Optional oneOf[1]
body.milestone integer Optional The number of the milestone to associate this issue with or use null to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped. oneOf[2]
body.labels array Optional Labels to associate with this issue. Pass one or more labels to replace the set of labels on this issue. Send an empty array ([]) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.
body.labels[] — Optional
body.labels[] string Optional oneOf[1]
body.labels[] object Optional oneOf[2]
body.labels[].id integer Optional oneOf[2]
body.labels[].name string Optional oneOf[2]
body.labels[].description string | null Optional oneOf[2]
body.labels[].color string | null Optional oneOf[2]
body.labels[].rationale string Optional Optional reasoning for selecting this label. oneOf[2]
body.labels[].suggest boolean Optional If true, the change is stored as a pending suggestion for human review rather than applied directly. oneOf[2]
body.labels[].confidence string Optional The confidence level for this label choice. oneOf[2]; enum: ["low","medium","high"]
body.assignees array Optional Usernames to assign to this issue. Pass one or more user logins to replace the set of assignees on this issue. Send an empty array ([]) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.
body.assignees[] — Optional
body.assignees[] string Optional oneOf[1]
body.assignees[] object Optional oneOf[2]
body.assignees[].login string Optional oneOf[2]
body.assignees[].rationale string Optional Optional reasoning for selecting this assignee. oneOf[2]
body.assignees[].suggest boolean Optional If true, the change is stored as a pending suggestion for human review rather than applied directly. oneOf[2]
body.assignees[].confidence string Optional The confidence level for this assignee choice. oneOf[2]; enum: ["low","medium","high"]
body.issue_field_values array Optional An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Only users with push access can set field values for issues
body.issue_field_values[] object Optional additionalProperties: false
body.issue_field_values[].field_id integer Required The ID of the issue field to set
body.issue_field_values[].value — Required The value to set for the field. For multi-select fields, provide an array of option names.
body.issue_field_values[].value string Required oneOf[1]
body.issue_field_values[].value number Required oneOf[2]
body.issue_field_values[].value array Required oneOf[3]
body.issue_field_values[].value[] string Optional oneOf[3]
body.issue_field_values[].rationale string Optional Optional reasoning for setting this field value.
body.issue_field_values[].suggest boolean Optional If true, the change is stored as a pending suggestion for human review rather than applied directly.
body.issue_field_values[].confidence string Optional The confidence level for this field value choice. enum: ["low","medium","high"]
body.type — Optional The issue type to associate with this issue. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.
body.type string Optional The name of the issue type. oneOf[1]
body.type object Optional The issue type with optional metadata. oneOf[2]
body.type.value string | null Optional The name of the issue type to associate with this issue, or null to remove the current issue type. oneOf[2]
body.type.rationale string Optional Optional reasoning for selecting this type. oneOf[2]
body.type.suggest boolean Optional If true, the change is stored as a pending suggestion for human review rather than applied directly. oneOf[2]
body.type.confidence string Optional The confidence level for this type choice. oneOf[2]; enum: ["low","medium","high"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List issue artifacts — github.issues.list-issue-artifacts

Lists artifacts attached to an issue. Results are ordered by artifact number.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
query object Optional additionalProperties: false
query.type string Optional The artifact type to return. enum: ["generic","link","plan","embedded_html"]
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an issue artifact — github.issues.create-issue-artifact

Creates an artifact attached to an issue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
body object Required
body.type string Optional The artifact type. enum: ["generic","link","plan","embedded_html"]; default: "generic"
body.name string Required The human-readable name of the artifact. minLength: 1
body.body string Required The artifact content. For embedded_html artifacts, provide the HTML source. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  },
  "body": {
    "type": "generic",
    "name": "Research notes",
    "body": "## Findings\n\nThe API supports issue artifacts."
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an issue artifact — github.issues.get-issue-artifact

Returns an artifact attached to an issue by its per-issue artifact number, along with its version history ordered from newest to oldest.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
path.artifact_number integer Required The artifact number within the issue.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1,
    "artifact_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an issue artifact — github.issues.update-issue-artifact

Updates the name, body, or both for an artifact attached to an issue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
path.artifact_number integer Required The artifact number within the issue.
body object Required
body.name string Optional The new human-readable name of the artifact. minLength: 1
body.body string Optional The new artifact content. minLength: 1
body — Required anyOf[1]
body — Required anyOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1,
    "artifact_number": 1
  },
  "body": {
    "name": "Revised implementation plan",
    "body": "## Plan\n\nBuild and validate the feature."
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an issue artifact — github.issues.delete-issue-artifact

Permanently deletes an artifact attached to an issue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
path.artifact_number integer Required The artifact number within the issue.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1,
    "artifact_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add assignees to an issue — github.issues.add-assignees

Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
body object Optional
body.assignees array Optional Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.
body.assignees[] — Optional
body.assignees[] string Optional oneOf[1]
body.assignees[] object Optional oneOf[2]
body.assignees[].login string Required The login of the user to assign. oneOf[2]
body.assignees[].rationale string Optional Optional reasoning for adding this assignee. oneOf[2]
body.assignees[].suggest boolean Optional If true, the assignee is stored as a pending suggestion for human review rather than applied directly. oneOf[2]
body.assignees[].confidence string Optional The confidence level for this assignee choice. oneOf[2]; enum: ["low","medium","high"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove assignees from an issue — github.issues.remove-assignees

Removes one or more assignees from an issue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
body object Optional
body.assignees array Optional Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.
body.assignees[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check if a user can be assigned to a issue — github.issues.check-user-can-be-assigned-to-issue

Checks if a user has permission to be assigned to a specific issue.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
path.assignee string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1,
    "assignee": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List issue comments — github.issues.list-comments

You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
query object Optional additionalProperties: false
query.since string Optional Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an issue comment — github.issues.create-comment

You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
body object Required
body.body string Required The contents of the comment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  },
  "body": {
    "body": "Me too"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List dependencies an issue is blocked by — github.issues.list-dependencies-blocked-by

You can use the REST API to list the dependencies an issue is blocked by.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a dependency an issue is blocked by — github.issues.add-blocked-by-dependency

You can use the REST API to add a 'blocked by' relationship to an issue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
body object Required
body.issue_id integer Required The id of the issue that blocks the current issue

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  },
  "body": {
    "issue_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove dependency an issue is blocked by — github.issues.remove-dependency-blocked-by

You can use the REST API to remove a dependency that an issue is blocked by.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
path.issue_id integer Required The id of the blocking issue to remove as a dependency

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1,
    "issue_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List dependencies an issue is blocking — github.issues.list-dependencies-blocking

You can use the REST API to list the dependencies an issue is blocking.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List issue events — github.issues.list-events

Lists all events for an issue.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List issue field values for an issue — github.issues.list-issue-field-values-for-issue

Lists all issue field values for an issue.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add issue field values to an issue — github.issues.add-issue-field-values

Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. Adding an empty array will clear all existing field values for the issue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
body object Required
body.issue_field_values array Optional An array of issue field values to add to this issue. Each field value must include the field ID and the value to set. maxItems: 25
body.issue_field_values[] object Optional additionalProperties: false
body.issue_field_values[].field_id integer Required The ID of the issue field to set
body.issue_field_values[].value — Required The value to set for the field. The type depends on the field's data type: - For text fields: provide a string value - For single_select fields: provide the option name as a string (must match an existing option) - For number fields: provide a numeric value - For multi_select fields: provide an array of option names (must match existing options) - For date fields: provide an ISO 8601 date string
body.issue_field_values[].value string Required The value to set for text, single_select, or date fields oneOf[1]
body.issue_field_values[].value number Required The value to set for number fields oneOf[2]
body.issue_field_values[].value array Required The value to set for multi_select fields (array of option names) oneOf[3]
body.issue_field_values[].value[] string Optional oneOf[3]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  },
  "body": {
    "issue_field_values": [
      {
        "field_id": 123,
        "value": "Critical"
      },
      {
        "field_id": 456,
        "value": 5
      },
      {
        "field_id": 789,
        "value": "2024-12-31"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set issue field values for an issue — github.issues.set-issue-field-values

Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
body object Required
body.issue_field_values array Optional An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced. maxItems: 25
body.issue_field_values[] object Optional additionalProperties: false
body.issue_field_values[].field_id integer Required The ID of the issue field to set
body.issue_field_values[].value — Required The value to set for the field. The type depends on the field's data type: - For text fields: provide a string value - For single_select fields: provide the option name as a string (must match an existing option) - For number fields: provide a numeric value - For date fields: provide an ISO 8601 date string
body.issue_field_values[].value string Required The value to set for text, single_select, or date fields oneOf[1]
body.issue_field_values[].value number Required The value to set for number fields oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  },
  "body": {
    "issue_field_values": [
      {
        "field_id": 123,
        "value": "Critical"
      },
      {
        "field_id": 456,
        "value": 5
      },
      {
        "field_id": 789,
        "value": "2024-12-31"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an issue field value from an issue — github.issues.delete-issue-field-value

Remove a specific custom field value from an issue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
path.issue_field_id integer Required The unique identifier of the issue field.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1,
    "issue_field_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List labels for an issue — github.issues.list-labels-on-issue

Lists all labels for an issue.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add labels to an issue — github.issues.add-labels

Adds labels to an issue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
body — Optional
body object Optional oneOf[1]
body.labels array Optional The labels to add to the issue's existing labels. You can also pass an array of labels directly, but GitHub recommends passing an object with the labels key. To replace all of the labels for an issue, use "Set labels for an issue." oneOf[1]; minItems: 1
body.labels[] — Optional oneOf[1]
body.labels[] string Optional oneOf[1]; oneOf[1]
body.labels[] object Optional oneOf[1]; oneOf[2]
body.labels[].name string Required The name of the label to add. oneOf[1]; oneOf[2]
body.labels[].rationale string Optional Optional reasoning for adding this label. oneOf[1]; oneOf[2]
body.labels[].suggest boolean Optional If true, the label is stored as a pending suggestion for human review rather than applied directly. oneOf[1]; oneOf[2]
body.labels[].confidence string Optional The confidence level for this label choice. oneOf[1]; oneOf[2]; enum: ["low","medium","high"]
body array Optional oneOf[2]
body[] string Optional oneOf[2]
body array Optional oneOf[3]
body[] object Optional oneOf[3]
body[].name string Required oneOf[3]
body[].rationale string Optional Optional reasoning for adding this label. oneOf[3]
body[].suggest boolean Optional If true, the label is stored as a pending suggestion for human review rather than applied directly. oneOf[3]
body[].confidence string Optional The confidence level for this label choice. oneOf[3]; enum: ["low","medium","high"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set labels for an issue — github.issues.set-labels

Removes any previous labels and sets the new labels for an issue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
body — Optional
body object Optional oneOf[1]
body.labels array Optional The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see "Add labels to an issue." oneOf[1]; minItems: 1
body.labels[] string Optional oneOf[1]
body array Optional oneOf[2]; minItems: 1
body[] string Optional oneOf[2]
body object Optional oneOf[3]
body.labels array Optional oneOf[3]; minItems: 1
body.labels[] object Optional oneOf[3]
body.labels[].name string Required oneOf[3]
body array Optional oneOf[4]; minItems: 1
body[] object Optional oneOf[4]
body[].name string Required oneOf[4]
body string Optional oneOf[5]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove all labels from an issue — github.issues.remove-all-labels

Removes all labels from an issue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove a label from an issue — github.issues.remove-label

Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
path.name string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1,
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Lock an issue — github.issues.lock

Users with push access can lock an issue or pull request's conversation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
body object | null Optional
body.lock_reason string Optional The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: * off-topic * too heated * resolved * spam enum: ["off-topic","too heated","resolved","spam"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Unlock an issue — github.issues.unlock

Users with push access can unlock an issue's conversation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get parent issue — github.issues.get-parent

You can use the REST API to get the parent issue of a sub-issue.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List reactions for an issue — github.reactions.list-for-issue

List the reactions to an issue.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
query object Optional additionalProperties: false
query.content string Optional Returns a single reaction type. Omit this parameter to list all reactions to an issue. enum: ["+1","-1","laugh","confused","heart","hooray","rocket","eyes"]
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create reaction for an issue — github.reactions.create-for-issue

Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
body object Required
body.content string Required The reaction type to add to the issue. enum: ["+1","-1","laugh","confused","heart","hooray","rocket","eyes"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  },
  "body": {
    "content": "heart"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an issue reaction — github.reactions.delete-for-issue

> [!NOTE] > You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
path.reaction_id integer Required The unique identifier of the reaction.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1,
    "reaction_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List issues related to an issue — github.issues.list-relates-to

You can use the REST API to list the issues that are related to an issue.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a related issue — github.issues.add-relates-to

You can use the REST API to mark an issue as related to another issue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
body object Required
body.issue_id integer Required The id of the issue to mark as related to the current issue

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  },
  "body": {
    "issue_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove a related issue — github.issues.remove-relates-to

You can use the REST API to remove a 'relates to' relationship between two issues.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
path.issue_id integer Required The id of the related issue to remove

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1,
    "issue_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove sub-issue — github.issues.remove-sub-issue

You can use the REST API to remove a sub-issue from an issue. Removing content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API." This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass a specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
body object Required
body.sub_issue_id integer Required The id of the sub-issue to remove

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  },
  "body": {
    "sub_issue_id": 6
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List sub-issues — github.issues.list-sub-issues

You can use the REST API to list the sub-issues on an issue.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add sub-issue — github.issues.add-sub-issue

You can use the REST API to add sub-issues to issues.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
body object Required
body.sub_issue_id integer Required The id of the sub-issue to add. The sub-issue must belong to the same repository owner as the parent issue
body.replace_parent boolean Optional Option that, when true, instructs the operation to replace the sub-issues current parent issue

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  },
  "body": {
    "sub_issue_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Reprioritize sub-issue — github.issues.reprioritize-sub-issue

You can use the REST API to reprioritize a sub-issue to a different position in the parent list.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
body object Required
body.sub_issue_id integer Required The id of the sub-issue to reprioritize
body.after_id integer Optional The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified).
body.before_id integer Optional The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified).

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  },
  "body": {
    "sub_issue_id": 6,
    "after_id": 5
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List issue suggestions — github.issues.list-suggestions

Lists the suggestions on an issue. A suggestion is an agent-proposed change to an issue's type, labels, fields, assignees, or closed state that a maintainer can approve or dismiss.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
query object Optional additionalProperties: false
query.state string Optional Filter suggestions by their state. enum: ["pending","applied","approved","dismissed","replaced","invalidated","all"]; default: "pending"
query.action string Optional Filter suggestions by the change they propose. enum: ["set_type","add_label","add_field","add_assignee","close_issue"]
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Approve an issue suggestion — github.issues.approve-suggestion

Approves a pending suggestion on an issue. Applies the proposed change (creating the corresponding timeline event), transitions the suggestion to approved, and dismisses any competing pending suggestions for the same change.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
path.suggestion_id integer Required The unique identifier of the suggestion.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1,
    "suggestion_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Dismiss an issue suggestion — github.issues.dismiss-suggestion

Dismisses a pending suggestion on an issue. Transitions the suggestion to dismissed without applying any change or creating a timeline event.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
path.suggestion_id integer Required The unique identifier of the suggestion.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1,
    "suggestion_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List timeline events for an issue — github.issues.list-events-for-timeline

List all timeline events for an issue.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.issue_number integer Required The number that identifies the issue.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.exclude string Optional A comma-separated list of timeline event names to exclude from the response.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "issue_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List deploy keys — github.repos.list-deploy-keys

Run List deploy keys with GitHub. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a deploy key — github.repos.create-deploy-key

You can create a read-only deploy key.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.title string Optional A name for the key.
body.key string Required The contents of the key.
body.read_only boolean Optional If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "Repository permission levels for an organization" and "Permission levels for a user account repository."

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "title": "octocat@octomac",
    "key": "ssh-rsa AAA...",
    "read_only": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a deploy key — github.repos.get-deploy-key

Run Get a deploy key with GitHub. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.key_id integer Required The unique identifier of the key.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "key_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a deploy key — github.repos.delete-deploy-key

Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.key_id integer Required The unique identifier of the key.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "key_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List labels for a repository — github.issues.list-labels-for-repo

Lists all labels for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a label — github.issues.create-label

Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid hexadecimal color code.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.name string Required The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji :strawberry:. For a full list of available emoji and codes, see "Emoji cheat sheet."
body.color string Optional The hexadecimal color code for the label, without the leading #.
body.description string Optional A short description of the label. Must be 100 characters or fewer.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "name": "bug",
    "description": "Something isn't working",
    "color": "f29513"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a label — github.issues.get-label

Gets a label using the given name.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.name string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a label — github.issues.update-label

Updates a label using the given label name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.name string Required
body object Optional
body.new_name string Optional The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji :strawberry:. For a full list of available emoji and codes, see "Emoji cheat sheet."
body.color string Optional The hexadecimal color code for the label, without the leading #.
body.description string Optional A short description of the label. Must be 100 characters or fewer.
body.archived boolean Optional Whether to archive or unarchive the label. Archived labels cannot be added to issues or pull requests. For more information, see "Archiving labels."

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a label — github.issues.delete-label

Deletes a label using the given label name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.name string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository languages — github.repos.list-languages

Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the license for a repository — github.licenses.get-for-repo

This method returns the contents of the repository's license file, if one is detected.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.ref — Optional The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/&lt;branch name&gt; or simply &lt;branch name&gt;. To reference a pull request use refs/pull/&lt;number&gt;/merge. $ref: "#/definitions/code-scanning-ref"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Sync a fork branch with the upstream repository — github.repos.merge-upstream

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

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.branch string Required The name of the branch which should be updated to match upstream.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "branch": "main"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Merge a branch — github.repos.merge

Run Merge a branch with GitHub. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.base string Required The name of the base branch that the head will be merged into.
body.head string Required The head to merge. This can be a branch name or a commit SHA1.
body.commit_message string Optional Commit message to use for the merge commit. If omitted, a default message will be used.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "base": "master",
    "head": "cool_feature",
    "commit_message": "Shipped cool_feature!"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List milestones — github.issues.list-milestones

Lists milestones for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.state string Optional The state of the milestone. Either open, closed, or all. enum: ["open","closed","all"]; default: "open"
query.sort string Optional What to sort results by. Either due_on or completeness. enum: ["due_on","completeness"]; default: "due_on"
query.direction string Optional The direction of the sort. Either asc or desc. enum: ["asc","desc"]; default: "asc"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a milestone — github.issues.create-milestone

Creates a milestone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.title string Required The title of the milestone.
body.state string Optional The state of the milestone. Either open or closed. enum: ["open","closed"]; default: "open"
body.description string Optional A description of the milestone.
body.due_on string Optional The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "title": "v1.0",
    "state": "open",
    "description": "Tracking milestone for version 1.0",
    "due_on": "2012-10-09T23:39:01Z"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a milestone — github.issues.get-milestone

Gets a milestone using the given milestone number.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.milestone_number integer Required The number that identifies the milestone.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "milestone_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a milestone — github.issues.update-milestone

Run Update a milestone with GitHub. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.milestone_number integer Required The number that identifies the milestone.
body object Optional
body.title string Optional The title of the milestone.
body.state string Optional The state of the milestone. Either open or closed. enum: ["open","closed"]; default: "open"
body.description string Optional A description of the milestone.
body.due_on string Optional The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "milestone_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a milestone — github.issues.delete-milestone

Deletes a milestone using the given milestone number.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.milestone_number integer Required The number that identifies the milestone.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "milestone_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List labels for issues in a milestone — github.issues.list-labels-for-milestone

Lists labels for issues in a milestone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.milestone_number integer Required The number that identifies the milestone.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "milestone_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository notifications for the authenticated user — github.activity.list-repo-notifications-for-authenticated-user

Lists all notifications for the current user in the specified repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.all boolean Optional If true, show notifications marked as read. default: false
query.participating boolean Optional If true, only shows notifications in which the user is directly participating or mentioned. default: false
query.since string Optional Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.before string Optional Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Mark repository notifications as read — github.activity.mark-repo-notifications-as-read

Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the List repository notifications for the authenticated user endpoint and pass the query parameter all=false.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Optional
body.last_read_at string Optional Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp. format: "date-time"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a GitHub Pages site — github.repos.get-pages

Gets information about a GitHub Pages site.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a GitHub Pages site — github.repos.create-pages-site

Configures a GitHub Pages site. For more information, see "About GitHub Pages."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object | null Required The source branch and directory used to publish your Pages site.
body.build_type string Optional The process in which the Page will be built. Possible values are "legacy" and "workflow". enum: ["legacy","workflow"]
body.source object Optional The source branch and directory used to publish your Pages site.
body.source.branch string Required The repository branch used to publish your site's source files.
body.source.path string Optional The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: / enum: ["/","/docs"]; default: "/"
body — Required anyOf[1]
body — Required anyOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "source": {
      "branch": "main",
      "path": "/docs"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update information about a GitHub Pages site — github.repos.update-information-about-pages-site

Updates information for a GitHub Pages site. For more information, see "About GitHub Pages.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.cname string | null Optional Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see "Using a custom domain with GitHub Pages."
body.https_enforced boolean Optional Specify whether HTTPS should be enforced for the repository.
body.build_type string Optional The process by which the GitHub Pages site will be built. workflow means that the site is built by a custom GitHub Actions workflow. legacy means that the site is built by GitHub when changes are pushed to a specific branch. enum: ["legacy","workflow"]
body.source — Optional
body.source string Optional Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory /docs. Possible values are "gh-pages", "master", and "master /docs". anyOf[1]; enum: ["gh-pages","master","master /docs"]
body.source object Optional Update the source for the repository. Must include the branch name and path. anyOf[2]
body.source.branch string Required The repository branch used to publish your site's source files. anyOf[2]
body.source.path string Required The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. anyOf[2]; enum: ["/","/docs"]
body — Required anyOf[1]
body — Required anyOf[2]
body — Required anyOf[3]
body — Required anyOf[4]
body — Required anyOf[5]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "cname": "octocatblog.com",
    "source": {
      "branch": "main",
      "path": "/"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a GitHub Pages site — github.repos.delete-pages-site

Deletes a GitHub Pages site. For more information, see "About GitHub Pages.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List GitHub Pages builds — github.repos.list-pages-builds

Lists builts of a GitHub Pages site.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Request a GitHub Pages build — github.repos.request-pages-build

You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get latest Pages build — github.repos.get-latest-pages-build

Gets information about the single most recent build of a GitHub Pages site.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get GitHub Pages build — github.repos.get-pages-build

Gets information about a GitHub Pages build.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.build_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "build_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a GitHub Pages deployment — github.repos.create-pages-deployment

Create a GitHub Pages deployment for a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required The object used to create GitHub Pages deployment
body.artifact_id number Optional The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either artifact_id or artifact_url are required.
body.artifact_url string Optional The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either artifact_id or artifact_url are required.
body.environment string Optional The target environment for this GitHub Pages deployment. default: "github-pages"
body.pages_build_version string Required A unique string that represents the version of the build for this deployment. default: "GITHUB_SHA"
body.oidc_token string Required The OIDC token issued by GitHub Actions certifying the origin of the deployment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "artifact_url": "https://example.com/",
    "environment": "github-pages",
    "pages_build_version": "4fd754f7e594640989b406850d0bc8f06a121251",
    "oidc_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IlV2R1h4SUhlY0JFc1JCdEttemUxUEhfUERiVSIsImtpZCI6IjUyRjE5N0M0ODFERTcwMTEyQzQ0MUI0QTlCMzdCNTNDN0ZDRjBEQjUifQ.eyJqdGkiOiJhMWIwNGNjNy0zNzZiLTQ1N2QtOTMzNS05NTY5YmVjZDExYTIiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjYiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM5MDAwODU2LCJleHAiOjE2MzkwMDE3NTYsImlhdCI6MTYzOTAwMTQ1Nn0.VP8WictbQECKozE2SgvKb2FqJ9hisWsoMkYRTqfBrQfZTCXi5IcFEdgDMB2X7a99C2DeUuTvHh9RMKXLL2a0zg3-Sd7YrO7a2ll2kNlnvyIypcN6AeIc7BxHsTTnZN9Ud_xmEsTrSRGOEKmzCFkULQ6N4zlVD0sidypmXlMemmWEcv_ZHqhioEI_VMp5vwXQurketWH7qX4oDgG4okyYtPrv5RQHbfQcVo9izaPJ_jnsDd0CBA0QOx9InjPidtIkMYQLyUgJy33HLJy86EFNUnAf8UhBQuQi5mAsEpEzBBuKpG3PDiPtYCHOk64JZkZGd5mR888a5sbHRiaF8hm8YA"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the status of a GitHub Pages deployment — github.repos.get-pages-deployment

Gets the current status of a GitHub Pages deployment.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pages_deployment_id — Required The ID of the Pages deployment. You can also give the commit SHA of the deployment.
path.pages_deployment_id integer Required oneOf[1]
path.pages_deployment_id string Required oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pages_deployment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Cancel a GitHub Pages deployment — github.repos.cancel-pages-deployment

Cancels a GitHub Pages deployment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pages_deployment_id — Required The ID of the Pages deployment. You can also give the commit SHA of the deployment.
path.pages_deployment_id integer Required oneOf[1]
path.pages_deployment_id string Required oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pages_deployment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a DNS health check for GitHub Pages — github.repos.get-pages-health-check

Gets a health check of the DNS settings for the CNAME record configured for a repository's GitHub Pages.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check if private vulnerability reporting is enabled for a repository — github.repos.check-private-vulnerability-reporting

Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "Evaluating the security settings of a repository".

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enable private vulnerability reporting for a repository — github.repos.enable-private-vulnerability-reporting

Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "Privately reporting a security vulnerability."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disable private vulnerability reporting for a repository — github.repos.disable-private-vulnerability-reporting

Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "Privately reporting a security vulnerability".

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all custom property values for a repository — github.repos.custom-properties-for-repos-get-repository-values

Gets all custom property values that are set for a repository. Users with read access to the repository can use this endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update custom property values for a repository — github.repos.custom-properties-for-repos-create-or-update-repository-values

Create new or update existing custom property values for a repository. Using a value of null for a custom property will remove or 'unset' the property value from the repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.properties array Required A list of custom property names and associated values to apply to the repositories.
body.properties[] — Optional $ref: "#/definitions/custom-property-value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "properties": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List pull requests — github.pulls.list

Lists pull requests in a specified repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.state string Optional Either open, closed, or all to filter by state. enum: ["open","closed","all"]; default: "open"
query.head string Optional Filter pulls by head user or head organization and branch name in the format of user:ref-name or organization:ref-name. For example: github:new-script-format or octocat:test-branch.
query.base string Optional Filter pulls by base branch name. Example: gh-pages.
query.sort string Optional What to sort results by. popularity will sort by the number of comments. long-running will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month. enum: ["created","updated","popularity","long-running"]; default: "created"
query.direction string Optional The direction of the sort. Default: desc when sort is created or sort is not specified, otherwise asc. enum: ["asc","desc"]
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a pull request — github.pulls.create

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.title string Optional The title of the new pull request. Required unless issue is specified.
body.head string Required The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.
body.head_repo string Optional The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization.
body.base string Required The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.
body.body string Optional The contents of the pull request.
body.maintainer_can_modify boolean Optional Indicates whether maintainers can modify the pull request.
body.draft boolean Optional Indicates whether the pull request is a draft. See "Draft Pull Requests" in the GitHub Help documentation to learn more.
body.issue integer Optional An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "title": "Amazing new feature",
    "body": "Please pull these awesome changes in!",
    "head": "octocat:new-feature",
    "base": "master"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List review comments in a repository — github.pulls.list-review-comments-for-repo

Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.sort string Optional enum: ["created","updated","created_at"]
query.direction string Optional The direction to sort results. Ignored without sort parameter. enum: ["asc","desc"]
query.since string Optional Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a review comment for a pull request — github.pulls.get-review-comment

Provides details for a specified review comment.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a review comment for a pull request — github.pulls.update-review-comment

Edits the content of a specified review comment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.
body object Required
body.body string Required The text of the reply to the review comment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1
  },
  "body": {
    "body": "I like this too!"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a review comment for a pull request — github.pulls.delete-review-comment

Deletes a review comment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List reactions for a pull request review comment — github.reactions.list-for-pull-request-review-comment

List the reactions to a pull request review comment.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.
query object Optional additionalProperties: false
query.content string Optional Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment. enum: ["+1","-1","laugh","confused","heart","hooray","rocket","eyes"]
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create reaction for a pull request review comment — github.reactions.create-for-pull-request-review-comment

Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.
body object Required
body.content string Required The reaction type to add to the pull request review comment. enum: ["+1","-1","laugh","confused","heart","hooray","rocket","eyes"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1
  },
  "body": {
    "content": "heart"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a pull request comment reaction — github.reactions.delete-for-pull-request-comment

> [!NOTE] > You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.comment_id integer Required The unique identifier of the comment.
path.reaction_id integer Required The unique identifier of the reaction.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "comment_id": 1,
    "reaction_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a pull request — github.pulls.get

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a pull request — github.pulls.update

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
body object Optional
body.title string Optional The title of the pull request.
body.body string Optional The contents of the pull request.
body.state string Optional State of this Pull Request. Either open or closed. enum: ["open","closed"]
body.base string Optional The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.
body.maintainer_can_modify boolean Optional Indicates whether maintainers can modify the pull request.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a codespace from a pull request — github.codespaces.create-with-pr-for-authenticated-user

Creates a codespace owned by the authenticated user for the specified pull request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
body object | null Required
body.location string Optional The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.
body.geo string Optional The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces location, which is closing down. enum: ["EuropeWest","SoutheastAsia","UsEast","UsWest"]
body.client_ip string Optional IP for location auto-detection when proxying a request
body.machine string Optional Machine type to use for this codespace
body.devcontainer_path string Optional Path to devcontainer.json config to use for this codespace
body.multi_repo_permissions_opt_out boolean Optional Whether to authorize requested permissions from devcontainer.json
body.working_directory string Optional Working directory for this codespace
body.idle_timeout_minutes integer Optional Time in minutes before codespace stops from inactivity
body.display_name string Optional Display name for this codespace
body.retention_period_minutes integer Optional Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1
  },
  "body": {
    "repository_id": 1,
    "ref": "main"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List review comments on a pull request — github.pulls.list-review-comments

Lists all review comments for a specified pull request. By default, review comments are in ascending order by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
query object Optional additionalProperties: false
query.sort string Optional The property to sort the results by. enum: ["created","updated"]; default: "created"
query.direction string Optional The direction to sort results. Ignored without sort parameter. enum: ["asc","desc"]
query.since string Optional Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a review comment for a pull request — github.pulls.create-review-comment

Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "Create an issue comment."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
body object Required
body.body string Required The text of the review comment.
body.commit_id string Required The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.
body.path string Required The relative path to the file that necessitates a comment.
body.position integer Optional This parameter is closing down. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
body.side string Optional In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation. enum: ["LEFT","RIGHT"]
body.line integer Optional Required unless using subject_type:file. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.
body.start_line integer Optional Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.
body.start_side string Optional Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context. enum: ["LEFT","RIGHT","side"]
body.in_reply_to integer Optional The ID of the review comment to reply to. To find the ID of a review comment with "List review comments on a pull request". When specified, all parameters other than body in the request body are ignored.
body.subject_type string Optional The level at which the comment is targeted. enum: ["line","file"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1
  },
  "body": {
    "body": "Great stuff!",
    "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
    "path": "file1.txt",
    "start_line": 1,
    "start_side": "RIGHT",
    "line": 2,
    "side": "RIGHT"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a reply for a review comment — github.pulls.create-reply-for-review-comment

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
path.comment_id integer Required The unique identifier of the comment.
body object Required
body.body string Required The text of the review comment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1,
    "comment_id": 1
  },
  "body": {
    "body": "Great stuff!"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List commits on a pull request — github.pulls.list-commits

Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List pull requests files — github.pulls.list-files

Lists the files in a specified pull request.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check if a pull request has been merged — github.pulls.check-if-merged

Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Merge a pull request — github.pulls.merge

> [!NOTE] > We recommend using the asynchronous merge API instead. This endpoint does not support stacked pull requests or merging with a merge queue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
body object | null Optional
body.commit_title string Optional Title for the automatic commit message.
body.commit_message string Optional Extra detail to append to automatic commit message.
body.sha string Optional SHA that pull request head must match to allow merge.
body.merge_method string Optional The merge method to use. enum: ["merge","squash","rebase"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Merge a pull request asynchronously — github.pulls.merge-async

Merges a pull request into the base branch in the background or adds it to a merge queue. Background processing allows certain types of errors to be retried and reduces the risk of timeouts for complex merges.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
body object | null Optional
body.commit_title string Optional Title for the automatic commit message. Only supported for direct merges.
body.commit_message string Optional Extra detail to append to automatic commit message. Only supported for direct merges.
body.sha string Optional SHA that pull request head must match to allow merge. If not provided, the current head of the PR at the time of the request will be used; if the PR is pushed in between the merge being requested and being executed, the merge will be cancelled.
body.merge_method string Optional The merge method to use for a direct merge. Only supported for direct merges. enum: ["merge","squash","rebase"]
body.merge_action string Optional The action that will be taken to merge the pull request. direct_merge merges the pull request directly without using a merge queue; merge_queue adds the pull request to a merge queue; default uses a merge queue if one is configured for the target branch, or merges directly otherwise. If omitted, defaults to default. enum: ["default","direct_merge","merge_queue"]
body.bypass_rules boolean Optional Whether to bypass repository rules that the authenticated actor is permitted to bypass. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the result of an asynchronous merge — github.pulls.get-merge-async-result

Fetches the current result of an asynchronous merge request, identified by the UUID that was returned when the merge was requested.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
path.uuid string Required The UUID of the asynchronous merge request, as returned when the merge was requested.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1,
    "uuid": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all requested reviewers for a pull request — github.pulls.list-requested-reviewers

Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Request reviewers for a pull request — github.pulls.request-reviewers

Requests reviews for a pull request from a given set of users and/or teams. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
body object Optional
body.reviewers array Optional An array of user logins that will be requested.
body.reviewers[] string Optional
body.team_reviewers array Optional An array of team slugs that will be requested.
body.team_reviewers[] string Optional
body — Optional anyOf[1]
body — Optional anyOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove requested reviewers from a pull request — github.pulls.remove-requested-reviewers

Removes review requests from a pull request for a given set of users and/or teams.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
body object Required
body.reviewers array Required An array of user logins that will be removed.
body.reviewers[] string Optional
body.team_reviewers array Optional An array of team slugs that will be removed.
body.team_reviewers[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1
  },
  "body": {
    "reviewers": [
      "octocat",
      "hubot",
      "other_user"
    ],
    "team_reviewers": [
      "justice-league"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Rerequest reviewers for a pull request — github.pulls.rerequest-reviewers

Rerequests reviews for a pull request from a given set of users and/or teams. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
body object Optional
body.reviewers array Optional An array of user logins whose reviews will be rerequested.
body.reviewers[] string Optional
body.team_reviewers array Optional An array of team slugs whose reviews will be rerequested.
body.team_reviewers[] string Optional
body — Optional anyOf[1]
body — Optional anyOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List reviews for a pull request — github.pulls.list-reviews

Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a review for a pull request — github.pulls.create-review

Creates a review on a specified pull request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
body object Optional
body.commit_id string Optional The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.
body.body string Optional Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.
body.event string Optional The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready. enum: ["APPROVE","REQUEST_CHANGES","COMMENT"]
body.comments array Optional Use the following table to specify the location, destination, and contents of the draft review comment.
body.comments[] object Optional
body.comments[].path string Required The relative path to the file that necessitates a review comment.
body.comments[].position integer Optional The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
body.comments[].body string Required Text of the review comment.
body.comments[].line integer Optional
body.comments[].side string Optional
body.comments[].start_line integer Optional
body.comments[].start_side string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a review for a pull request — github.pulls.get-review

Retrieves a pull request review by its ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
path.review_id integer Required The unique identifier of the review.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1,
    "review_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a review for a pull request — github.pulls.update-review

Updates the contents of a specified review summary comment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
path.review_id integer Required The unique identifier of the review.
body object Required
body.body string Required The body text of the pull request review.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1,
    "review_id": 1
  },
  "body": {
    "body": "This is close to perfect! Please address the suggested inline change. And add more about this."
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a pending review for a pull request — github.pulls.delete-pending-review

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
path.review_id integer Required The unique identifier of the review.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1,
    "review_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List comments for a pull request review — github.pulls.list-comments-for-review

Lists comments for a specific pull request review.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
path.review_id integer Required The unique identifier of the review.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1,
    "review_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Dismiss a review for a pull request — github.pulls.dismiss-review

Dismisses a specified review on a pull request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
path.review_id integer Required The unique identifier of the review.
body object Required
body.message string Required The message for the pull request review dismissal
body.event string Optional enum: ["DISMISS"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1,
    "review_id": 1
  },
  "body": {
    "message": "You are dismissed",
    "event": "DISMISS"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Submit a review for a pull request — github.pulls.submit-review

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "Create a review for a pull request."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
path.review_id integer Required The unique identifier of the review.
body object Required
body.body string Optional The body text of the pull request review
body.event string Required The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action. enum: ["APPROVE","REQUEST_CHANGES","COMMENT"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1,
    "review_id": 1
  },
  "body": {
    "body": "Here is the body for the review.",
    "event": "REQUEST_CHANGES"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a pull request branch — github.pulls.update-branch

Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pull_number integer Required The number that identifies the pull request.
body object | null Optional
body.expected_head_sha string Optional The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the "List commits" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pull_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository README — github.repos.get-readme

Gets the preferred README for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.ref string Optional The name of the commit/branch/tag. Default: the repository’s default branch.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository README for a directory — github.repos.get-readme-in-directory

Gets the README from a repository directory.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.dir string Required The alternate path to look for a README file
query object Optional additionalProperties: false
query.ref string Optional The name of the commit/branch/tag. Default: the repository’s default branch.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "dir": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List releases — github.repos.list-releases

This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a release — github.repos.create-release

Users with push access to the repository can create a release.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.tag_name string Required The name of the tag.
body.target_commitish string Optional Specifies 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.
body.name string Optional The name of the release.
body.body string Optional Text describing the contents of the tag.
body.draft boolean Optional true to create a draft (unpublished) release, false to create a published one. default: false
body.prerelease boolean Optional true to identify the release as a prerelease. false to identify the release as a full release. default: false
body.discussion_category_name string Optional If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "Managing categories for discussions in your repository."
body.generate_release_notes boolean Optional Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes. default: false
body.make_latest string Optional Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to true for newly published releases. legacy specifies that the latest release should be determined based on the release creation date and higher semantic version. enum: ["true","false","legacy"]; default: "true"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "tag_name": "v1.0.0",
    "target_commitish": "master",
    "name": "v1.0.0",
    "body": "Description of the release",
    "draft": false,
    "prerelease": false,
    "generate_release_notes": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a release asset — github.repos.get-release-asset

To download the asset's binary content:

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.asset_id integer Required The unique identifier of the asset.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "asset_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a release asset — github.repos.update-release-asset

Users with push access to the repository can edit a release asset.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.asset_id integer Required The unique identifier of the asset.
body object Optional
body.name string Optional The file name of the asset.
body.label string Optional An alternate short description of the asset. Used in place of the filename.
body.state string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "asset_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a release asset — github.repos.delete-release-asset

Run Delete a release asset with GitHub. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.asset_id integer Required The unique identifier of the asset.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "asset_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Generate release notes content for a release — github.repos.generate-release-notes

Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.tag_name string Required The tag name for the release. This can be an existing tag or a new one.
body.target_commitish string Optional Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.
body.previous_tag_name string Optional The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.
body.configuration_file_path string Optional Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "tag_name": "v1.0.0",
    "target_commitish": "main",
    "previous_tag_name": "v0.9.2",
    "configuration_file_path": ".github/custom_release_config.yml"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the latest release — github.repos.get-latest-release

View the latest published full release for the repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a release by tag name — github.repos.get-release-by-tag

Get a published release with the specified tag.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.tag string Required tag parameter

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "tag": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a release — github.repos.get-release

Gets a public release with the specified release ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.release_id integer Required The unique identifier of the release.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "release_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a release — github.repos.update-release

Users with push access to the repository can edit a release.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.release_id integer Required The unique identifier of the release.
body object Optional
body.tag_name string Optional The name of the tag.
body.target_commitish string Optional Specifies 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.
body.name string Optional The name of the release.
body.body string Optional Text describing the contents of the tag.
body.draft boolean Optional true makes the release a draft, and false publishes the release.
body.prerelease boolean Optional true to identify the release as a prerelease, false to identify the release as a full release.
body.make_latest string Optional Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to true for newly published releases. legacy specifies that the latest release should be determined based on the release creation date and higher semantic version. enum: ["true","false","legacy"]; default: "true"
body.discussion_category_name string Optional If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "Managing categories for discussions in your repository."

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "release_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a release — github.repos.delete-release

Users with push access to the repository can delete a release.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.release_id integer Required The unique identifier of the release.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "release_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List release assets — github.repos.list-release-assets

Run List release assets with GitHub. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.release_id integer Required The unique identifier of the release.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "release_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List reactions for a release — github.reactions.list-for-release

List the reactions to a release.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.release_id integer Required The unique identifier of the release.
query object Optional additionalProperties: false
query.content string Optional Returns a single reaction type. Omit this parameter to list all reactions to a release. enum: ["+1","laugh","heart","hooray","rocket","eyes"]
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "release_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create reaction for a release — github.reactions.create-for-release

Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.release_id integer Required The unique identifier of the release.
body object Required
body.content string Required The reaction type to add to the release. enum: ["+1","laugh","heart","hooray","rocket","eyes"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "release_id": 1
  },
  "body": {
    "content": "heart"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a release reaction — github.reactions.delete-for-release

> [!NOTE] > You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.release_id integer Required The unique identifier of the release.
path.reaction_id integer Required The unique identifier of the reaction.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "release_id": 1,
    "reaction_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get rules for a branch — github.repos.get-branch-rules

Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" enforcement statuses are not returned.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.branch string Required The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all repository rulesets — github.repos.get-repo-rulesets

Get all the rulesets for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.includes_parents boolean Optional Include rulesets configured at higher levels that apply to this repository default: true
query.targets string Optional A comma-separated list of rule targets to filter by. If provided, only rulesets that apply to the specified targets will be returned. For example, branch,tag,push.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a repository ruleset — github.repos.create-repo-ruleset

Create a ruleset for a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.name string Required The name of the ruleset.
body.target string Optional The target of the ruleset enum: ["branch","tag","push"]; default: "branch"
body.enforcement — Required $ref: "#/definitions/repository-rule-enforcement"
body.bypass_actors array Optional The actors that can bypass the rules in this ruleset
body.bypass_actors[] — Optional $ref: "#/definitions/repository-ruleset-bypass-actor"
body.conditions — Optional $ref: "#/definitions/repository-ruleset-conditions"
body.rules array Optional An array of rules within the ruleset.
body.rules[] — Optional $ref: "#/definitions/repository-rule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "name": "super cool ruleset",
    "target": "branch",
    "enforcement": "active",
    "bypass_actors": [
      {
        "actor_id": 234,
        "actor_type": "Team",
        "bypass_mode": "always"
      }
    ],
    "conditions": {
      "ref_name": {
        "include": [
          "refs/heads/main",
          "refs/heads/master"
        ],
        "exclude": [
          "refs/heads/dev*"
        ]
      }
    },
    "rules": [
      {
        "type": "commit_author_email_pattern",
        "parameters": {
          "operator": "contains",
          "pattern": "github"
        }
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository rule suites — github.repos.get-repo-rule-suites

Lists suites of rule evaluations at the repository level. For more information, see "Managing rulesets for a repository."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.ref string Optional The name of the ref. Cannot contain wildcard characters. Optionally prefix with refs/heads/ to limit to branches or refs/tags/ to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.
query.time_period string Optional The time period to filter by. For example, day will filter for rule suites that occurred in the past 24 hours, and week will filter for rule suites that occurred in the past 7 days (168 hours). enum: ["hour","day","week","month"]; default: "day"
query.actor_name string Optional The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.
query.rule_suite_result string Optional The rule suite results to filter on. When specified, only suites with this result will be returned. enum: ["pass","fail","bypass","all"]; default: "all"
query.evaluate_status string Optional The evaluate status to filter on. When specified, only rule suites resulting from rulesets with the specified evaluate status will be returned. - all - all rule suites will be returned. - active - only rule suites resulting from rulesets in active (non-evaluate) mode will be returned. - evaluate - only rule suites resulting from rulesets in evaluate mode will be returned. enum: ["all","active","evaluate"]; default: "all"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository rule suite — github.repos.get-repo-rule-suite

Gets information about a suite of rule evaluations from within a repository. For more information, see "Managing rulesets for a repository."

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.rule_suite_id integer Required The unique identifier of the rule suite result. To get this ID, you can use GET /repos/{owner}/{repo}/rulesets/rule-suites for repositories and GET /orgs/{org}/rulesets/rule-suites for organizations.
query object Optional additionalProperties: false
query.include_metadata boolean Optional When set to true, the response will include additional metadata for pull request and required status check rule evaluation. Results are capped at 50 entries. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "rule_suite_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository ruleset — github.repos.get-repo-ruleset

Get a ruleset for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ruleset_id integer Required The ID of the ruleset.
query object Optional additionalProperties: false
query.includes_parents boolean Optional Include rulesets configured at higher levels that apply to this repository default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ruleset_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a repository ruleset — github.repos.update-repo-ruleset

Update a ruleset for a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ruleset_id integer Required The ID of the ruleset.
body object Optional
body.name string Optional The name of the ruleset.
body.target string Optional The target of the ruleset enum: ["branch","tag","push"]
body.enforcement — Optional $ref: "#/definitions/repository-rule-enforcement"
body.bypass_actors array Optional The actors that can bypass the rules in this ruleset
body.bypass_actors[] — Optional $ref: "#/definitions/repository-ruleset-bypass-actor"
body.conditions — Optional $ref: "#/definitions/repository-ruleset-conditions"
body.rules array Optional An array of rules within the ruleset.
body.rules[] — Optional $ref: "#/definitions/repository-rule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ruleset_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a repository ruleset — github.repos.delete-repo-ruleset

Delete a ruleset for a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ruleset_id integer Required The ID of the ruleset.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ruleset_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get repository ruleset history — github.repos.get-repo-ruleset-history

Get the history of a repository ruleset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ruleset_id integer Required The ID of the ruleset.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ruleset_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get repository ruleset version — github.repos.get-repo-ruleset-version

Get a version of a repository ruleset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ruleset_id integer Required The ID of the ruleset.
path.version_id integer Required The ID of the version

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ruleset_id": 1,
    "version_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List secret scanning alerts for a repository — github.secret-scanning.list-alerts-for-repo

Lists secret scanning alerts for an eligible repository, from newest to oldest.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.state string Optional Set to open or resolved to only list secret scanning alerts in a specific state. enum: ["open","resolved"]
query.secret_type string Optional A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "Supported secret scanning patterns" for a complete list of secret types.
query.exclude_secret_types string Optional A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the secret_type parameter. See "Supported secret scanning patterns" for a complete list of secret types.
query.exclude_providers string Optional A comma-separated list of provider slugs to exclude from the results. Provider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars). You can find the provider slug in the provider_slug field of each alert. Cannot be combined with the providers parameter.
query.providers string Optional A comma-separated list of provider slugs to filter by. Provider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars). You can find the provider slug in the provider_slug field of each alert. Cannot be combined with the exclude_providers parameter.
query.resolution string Optional A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.
query.assignee string Optional Filters alerts by assignee. Use * to get all assigned alerts, none to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.
query.sort string Optional The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved. enum: ["created","updated"]; default: "created"
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string.
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string.
query.validity string Optional A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are active, inactive, and unknown.
query.is_publicly_leaked boolean Optional A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. default: false
query.is_multi_repo boolean Optional A boolean value representing whether or not to filter alerts by the multi-repo tag being present. default: false
query.hide_secret boolean Optional A boolean value representing whether or not to hide literal secrets in the results. default: false
query.is_bypassed boolean Optional A boolean value (true or false) indicating whether to filter alerts by their push protection bypass status. When set to true, only alerts that were created because a push protection rule was bypassed will be returned. When set to false, only alerts that were not caused by a push protection bypass will be returned.
query.included_metadata string Optional A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the specified metadata fields attached will be returned. Possible values are: owner-email, owner-id, owner-name, secret-id, secret-name, secret-issued-date, secret-expiration-date, organization-name, organization-id, last-used-date, and has-organization-access.
query.owner_email_hash string Optional Filters alerts to only those whose attached owner_email metadata field matches the provided value. The value must be the lowercase hex-encoded SHA-256 hash of the email address to match (for example, the SHA-256 of [email protected]). Only alerts that have an owner_email metadata value whose SHA-256 hash equals this parameter are returned.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a secret scanning alert — github.secret-scanning.get-alert

Gets a single secret scanning alert detected in an eligible repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.alert_number — Required The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation. $ref: "#/definitions/alert-number"
query object Optional additionalProperties: false
query.hide_secret boolean Optional A boolean value representing whether or not to hide literal secrets in the results. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "alert_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a secret scanning alert — github.secret-scanning.update-alert

Updates the status of a secret scanning alert in an eligible repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.alert_number — Required The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation. $ref: "#/definitions/alert-number"
body object Required
body.state — Optional $ref: "#/definitions/secret-scanning-alert-state"
body.resolution — Optional $ref: "#/definitions/secret-scanning-alert-resolution"
body.resolution_comment — Optional $ref: "#/definitions/secret-scanning-alert-resolution-comment"
body.assignee — Optional $ref: "#/definitions/secret-scanning-alert-assignee"
body.validity string | null Optional Sets the validity of the secret scanning alert. Can be active, inactive, or null to clear the override. enum: ["active","inactive"]
body — Required anyOf[1]
body — Required anyOf[2]
body — Required anyOf[3]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "alert_number": 1
  },
  "body": {
    "state": "resolved",
    "resolution": "false_positive"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List locations for a secret scanning alert — github.secret-scanning.list-locations-for-alert

Lists all locations for a given secret scanning alert for an eligible repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.alert_number — Required The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation. $ref: "#/definitions/alert-number"
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "alert_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository custom patterns — github.secret-scanning.list-repo-custom-patterns

Lists secret scanning custom patterns for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.state string Optional Filter custom patterns by state. When absent, returns patterns in all states. enum: ["published","unpublished"]
query.push_protection string Optional Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status. enum: ["enabled","disabled"]
query.sort string Optional The property to sort the results by. enum: ["created","updated","name"]; default: "created"
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Bulk create repository custom patterns — github.secret-scanning.bulk-create-repo-custom-patterns

Bulk creates secret scanning custom patterns for a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.patterns array Required The list of custom patterns to create (maximum 100). maxItems: 100
body.patterns[] — Optional $ref: "#/definitions/secret-scanning-custom-pattern-to-create"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "patterns": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Bulk delete repository custom patterns — github.secret-scanning.bulk-delete-repo-custom-patterns

Bulk deletes secret scanning custom patterns for a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.patterns array Required The list of custom patterns to delete. maxItems: 500
body.patterns[] — Optional $ref: "#/definitions/secret-scanning-custom-pattern-to-delete"
body.post_delete_action string Optional What to do with alerts associated with the deleted patterns. delete_alerts permanently removes the alerts. resolve_alerts resolves the alerts as "pattern deleted". Defaults to delete_alerts when not specified. enum: ["delete_alerts","resolve_alerts"]; default: "delete_alerts"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "patterns": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a repository custom pattern — github.secret-scanning.update-repo-custom-pattern

Updates a secret scanning custom pattern for a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.pattern_id integer Required The ID of the custom pattern.
body — Required $ref: "#/definitions/secret-scanning-custom-pattern-to-update"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "pattern_id": 1
  },
  "body": {
    "custom_pattern_version": "example",
    "pattern": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a push protection bypass — github.secret-scanning.create-push-protection-bypass

Creates a bypass for a previously push protected secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.reason — Required $ref: "#/definitions/secret-scanning-push-protection-bypass-reason"
body.placeholder_id — Required $ref: "#/definitions/secret-scanning-push-protection-bypass-placeholder-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "reason": "will_fix_later",
    "placeholder_id": "2k4dM4tseyC5lPIsjl5emX9sPNk"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get secret scanning scan history for a repository — github.secret-scanning.get-scan-history

Lists the latest default incremental and backfill scans by type for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository security advisories — github.security-advisories.list-repository-advisories

Lists security advisories in a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.sort string Optional The property to sort the results by. enum: ["created","updated","published"]; default: "created"
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.per_page integer Optional The number of advisories to return per page. For more information, see "Using pagination in the REST API." default: 30; minimum: 1; maximum: 100
query.state string Optional Filter by state of the repository advisories. Only advisories of this state will be returned. enum: ["triage","draft","published","closed"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a repository security advisory — github.security-advisories.create-repository-advisory

Creates a new repository security advisory.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body — Required $ref: "#/definitions/repository-advisory-create"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "summary": "example",
    "description": "example",
    "vulnerabilities": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Privately report a security vulnerability — github.security-advisories.create-private-vulnerability-report

Report a security vulnerability to the maintainers of the repository. See "Privately reporting a security vulnerability" for more information about private vulnerability reporting.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body — Required $ref: "#/definitions/private-vulnerability-report-create"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "summary": "example",
    "description": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository security advisory — github.security-advisories.get-repository-advisory

Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ghsa_id string Required The GHSA (GitHub Security Advisory) identifier of the advisory.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ghsa_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a repository security advisory — github.security-advisories.update-repository-advisory

Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ghsa_id string Required The GHSA (GitHub Security Advisory) identifier of the advisory.
body — Required $ref: "#/definitions/repository-advisory-update"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ghsa_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository security advisory comments — github.security-advisories.list-repository-advisory-comments

Lists comments on a repository security advisory.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ghsa_id string Required The GHSA (GitHub Security Advisory) identifier of the advisory.
query object Optional additionalProperties: false
query.since string Optional Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ghsa_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a repository advisory comment — github.security-advisories.create-repository-advisory-comment

Creates a comment on a repository security advisory.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ghsa_id string Required The GHSA (GitHub Security Advisory) identifier of the advisory.
body object Required
body.body string Required The contents of the comment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ghsa_id": "example"
  },
  "body": {
    "body": "Thanks for the report. We are working on a fix."
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository advisory comment — github.security-advisories.get-repository-advisory-comment

Get a comment on a repository security advisory using the comment's ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ghsa_id string Required The GHSA (GitHub Security Advisory) identifier of the advisory.
path.comment_id integer Required The unique identifier of the comment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ghsa_id": "example",
    "comment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a repository advisory comment — github.security-advisories.update-repository-advisory-comment

Update the body of a comment on a repository security advisory using the comment's ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ghsa_id string Required The GHSA (GitHub Security Advisory) identifier of the advisory.
path.comment_id integer Required The unique identifier of the comment.
body object Required
body.body string Required The contents of the comment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ghsa_id": "example",
    "comment_id": 1
  },
  "body": {
    "body": "Updated comment body."
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Request a CVE for a repository security advisory — github.security-advisories.create-repository-advisory-cve-request

If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "Requesting a CVE identification number."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ghsa_id string Required The GHSA (GitHub Security Advisory) identifier of the advisory.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ghsa_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a temporary private fork — github.security-advisories.create-fork

Create a temporary private fork to collaborate on fixing a security vulnerability in a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.ghsa_id string Required The GHSA (GitHub Security Advisory) identifier of the advisory.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "ghsa_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List pull request stacks — github.pull-request-stacks.list

Lists pull request stacks in a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.pull_request integer Optional Filter to the stack containing this repository pull request number.
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a pull request stack — github.pull-request-stacks.create

Creates a stack from an ordered list of pull request numbers. Provide the pull request numbers from the bottom of the stack to the top. Each pull request's base ref must match the previous pull request's head ref.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.pull_requests array Required An ordered list of pull request numbers forming the stack from bottom to top. minItems: 2; maxItems: 100
body.pull_requests[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "pull_requests": [
      101,
      102,
      103
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a pull request stack — github.pull-request-stacks.get

Gets a pull request stack by providing its stack number.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.stack_number integer Required The number that identifies the pull request stack.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "stack_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add pull requests to a pull request stack — github.pull-request-stacks.add

Appends an ordered list of pull request numbers onto the top of an existing stack. Provide only the pull requests you want to add, from the current top of the stack upward. The first new pull request's base ref must match the current top pull request's head ref.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.stack_number integer Required The number that identifies the pull request stack.
body object Required
body.pull_requests array Required An ordered list of pull request numbers to append to the stack, from the current top upward. minItems: 1; maxItems: 100
body.pull_requests[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "stack_number": 1
  },
  "body": {
    "pull_requests": [
      104,
      102
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove pull requests from a pull request stack — github.pull-request-stacks.unstack

Removes the unmerged pull requests from a stack. Pull requests that cannot be unstacked (for example, those that are queued for merge) are left in place. When pull requests remain in the stack, the updated stack is returned with a 200. When no pull requests remain, the stack is dissolved and a 204 is returned.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.stack_number integer Required The number that identifies the pull request stack.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "stack_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List stargazers — github.activity.list-stargazers-for-repo

Lists the people that have starred the repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get stargazer count — github.activity.get-stargazer-count-for-repo

Gets the current number of users who have starred the repository. Users who previously starred the repository but later removed their star are not included.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get repository star history — github.activity.get-stargazer-history-for-repo

Returns repository stars grouped by calendar weeks, most recent first. Pages move backward toward the repository's creation week, and weeks within a page are ordered newest to oldest, so concatenating pages produces one continuous series. Weeks without stars contain zero counts. Week and day boundaries are not guaranteed to align with UTC. The days array contains the number of stars created on each day of the week, starting on Sunday.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 30). For more information, see "Using pagination in the REST API." default: 30; minimum: 1; maximum: 30
query.page integer Optional The page number of the results to fetch (max 100). For more information, see "Using pagination in the REST API." default: 1; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the weekly commit activity — github.repos.get-code-frequency-stats

Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the last year of commit activity — github.repos.get-commit-activity-stats

Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all contributor commit activity — github.repos.get-contributors-stats

Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the weekly commit count — github.repos.get-participation-stats

Returns the total commit counts for the owner and total commit counts in all. all is everyone combined, including the owner in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract owner from all.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the hourly commit count for each day — github.repos.get-punch-card-stats

Each array contains the day number, hour number, and number of commits:

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a commit status — github.repos.create-commit-status

Users with push access in a repository can create commit statuses for a given SHA.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
path.sha string Required
body object Required
body.state string Required The state of the status. enum: ["error","failure","pending","success"]
body.target_url string | null Optional The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: http://ci.example.com/user/repo/build/sha
body.description string | null Optional A short description of the status.
body.context string Optional A string label to differentiate this status from the status of other systems. This field is case-insensitive. default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world",
    "sha": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "body": {
    "state": "success",
    "target_url": "https://example.com/build/status",
    "description": "The build succeeded!",
    "context": "continuous-integration/jenkins"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List watchers — github.activity.list-watchers-for-repo

Lists the people watching the specified repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository subscription — github.activity.get-repo-subscription

Gets information about whether the authenticated user is subscribed to the repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set a repository subscription — github.activity.set-repo-subscription

If you would like to watch a repository, set subscribed to true. If you would like to ignore notifications made within a repository, set ignored to true. If you would like to stop watching a repository, delete the repository's subscription completely.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Optional
body.subscribed boolean Optional Determines if notifications should be received from this repository.
body.ignored boolean Optional Determines if all notifications should be blocked from this repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a repository subscription — github.activity.delete-repo-subscription

This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository tags — github.repos.list-tags

Run List repository tags with GitHub. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository teams — github.repos.list-teams

Lists the teams that have access to the specified repository and that are also visible to the authenticated user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all repository topics — github.repos.get-all-topics

Run Get all repository topics with GitHub. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace all repository topics — github.repos.replace-all-topics

Run Replace all repository topics with GitHub. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.names array Required An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names will be saved as lowercase.
body.names[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "names": [
      "octocat",
      "atom",
      "electron",
      "api"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get repository clones — github.repos.get-clones

Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per string Optional The time frame to display results for. enum: ["day","week"]; default: "day"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top referral paths — github.repos.get-top-paths

Get the top 10 popular contents over the last 14 days.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top referral sources — github.repos.get-top-referrers

Get the top 10 referrers over the last 14 days.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get page views — github.repos.get-views

Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
query object Optional additionalProperties: false
query.per string Optional The time frame to display results for. enum: ["day","week"]; default: "day"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Transfer a repository — github.repos.transfer

A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.
body object Required
body.new_owner string Required The username or organization name the repository will be transferred to.
body.new_name string Optional The new name to be given to the repository.
body.team_ids array Optional ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.
body.team_ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  },
  "body": {
    "new_owner": "github",
    "team_ids": [
      12,
      345
    ],
    "new_name": "octorepo"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check if vulnerability alerts are enabled for a repository — github.repos.check-vulnerability-alerts

Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "About security alerts for vulnerable dependencies".

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enable vulnerability alerts — github.repos.enable-vulnerability-alerts

Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "About security alerts for vulnerable dependencies".

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disable vulnerability alerts — github.repos.disable-vulnerability-alerts

Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "About security alerts for vulnerable dependencies".

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a repository using a template — github.repos.create-using-template

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.template_owner string Required The account owner of the template repository. The name is not case sensitive.
path.template_repo string Required The name of the template repository without the .git extension. The name is not case sensitive.
body object Required
body.owner string Optional The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.
body.name string Required The name of the new repository.
body.description string Optional A short description of the new repository.
body.include_all_branches boolean Optional Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false. default: false
body.private boolean Optional Either true to create a new private repository or false to create a new public one. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "template_owner": "example",
    "template_repo": "example"
  },
  "body": {
    "owner": "octocat",
    "name": "Hello-World",
    "description": "This is your first repository",
    "include_all_branches": false,
    "private": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List public repositories — github.repos.list-public

Lists all public repositories in the order that they were created.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.since integer Optional A repository ID. Only return repositories with an ID greater than this ID.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search code — github.search.code

Searches for query terms inside of a file. This method returns up to 100 results per page.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.q string Required The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See "Searching code" for a detailed list of qualifiers.
query.sort string Optional This field is closing down. Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: best match enum: ["indexed"]
query.order string Optional This field is closing down. Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort. enum: ["desc","asc"]; default: "desc"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "q": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search commits — github.search.commits

Find commits via various criteria on the default branch (usually main). This method returns up to 100 results per page.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.q string Required The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See "Searching commits" for a detailed list of qualifiers.
query.sort string Optional Sorts the results of your query by author-date or committer-date. Default: best match enum: ["author-date","committer-date"]
query.order string Optional Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort. enum: ["desc","asc"]; default: "desc"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "q": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search issues and pull requests — github.search.issues-and-pull-requests

Find issues by state and keyword. This method returns up to 100 results per page.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.q string Required The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See "Searching issues and pull requests" for a detailed list of qualifiers.
query.sort string Optional Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match enum: ["comments","reactions","reactions-+1","reactions--1","reactions-smile","reactions-thinking_face","reactions-heart","reactions-tada","interactions","created","updated"]
query.order string Optional Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort. enum: ["desc","asc"]; default: "desc"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.advanced_search string Optional Set to true to use advanced search. Example: http://api.github.com/search/issues?q={query}&amp;advanced_search=true
query.search_type string Optional The type of search to perform on issues. When not specified, the default is lexical search. - semantic — performs a pure semantic (vector) search using embedding-based understanding. - hybrid — combines semantic search with lexical search for best results. Semantic and hybrid search require authentication and are rate limited to 10 requests per minute. Only applies to issue searches (/search/issues). enum: ["semantic","hybrid"]

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "q": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search labels — github.search.labels

Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.repository_id integer Required The id of the repository.
query.q string Required The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see Constructing a search query.
query.sort string Optional Sorts the results of your query by when the label was created or updated. Default: best match enum: ["created","updated"]
query.order string Optional Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort. enum: ["desc","asc"]; default: "desc"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "repository_id": 1,
    "q": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search repositories — github.search.repos

Find repositories via various criteria. This method returns up to 100 results per page.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.q string Required The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See "Searching for repositories" for a detailed list of qualifiers.
query.sort string Optional Sorts the results of your query by number of stars, forks, or help-wanted-issues or how recently the items were updated. Default: best match enum: ["stars","forks","help-wanted-issues","updated"]
query.order string Optional Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort. enum: ["desc","asc"]; default: "desc"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "q": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search topics — github.search.topics

Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See "Searching topics" for a detailed list of qualifiers.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.q string Required The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query.
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "q": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search users — github.search.users

Find users via various criteria. This method returns up to 100 results per page.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.q string Required The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See "Searching users" for a detailed list of qualifiers.
query.sort string Optional Sorts the results of your query by number of followers or repositories, or when the person joined GitHub. Default: best match enum: ["followers","repositories","joined"]
query.order string Optional Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort. enum: ["desc","asc"]; default: "desc"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "q": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the authenticated user — github.users.get-authenticated

OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the authenticated user — github.users.update-authenticated

Note: If your email is set to private and you send an email parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.name string Optional The new name of the user.
body.email string Optional The publicly visible email address of the user.
body.blog string Optional The new blog URL of the user.
body.twitter_username string | null Optional The new Twitter username of the user.
body.company string Optional The new company of the user.
body.location string Optional The new location of the user.
body.hireable boolean Optional The new hiring availability of the user.
body.bio string Optional The new short biography of the user.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List users blocked by the authenticated user — github.users.list-blocked-by-authenticated-user

List the users you've blocked on your personal account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check if a user is blocked by the authenticated user — github.users.check-blocked

Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Block a user — github.users.block

Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Unblock a user — github.users.unblock

Unblocks the given user and returns a 204.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List codespaces for the authenticated user — github.codespaces.list-for-authenticated-user

Lists the authenticated user's codespaces.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.repository_id integer Optional ID of the Repository to filter on

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a codespace for the authenticated user — github.codespaces.create-for-authenticated-user

Creates a new codespace, owned by the authenticated user.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required
body object Required oneOf[1]
body.repository_id integer Required Repository id for this codespace oneOf[1]
body.ref string Optional Git ref (typically a branch name) for this codespace oneOf[1]
body.location string Optional The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. oneOf[1]
body.geo string Optional The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces location, which is closing down. oneOf[1]; enum: ["EuropeWest","SoutheastAsia","UsEast","UsWest"]
body.client_ip string Optional IP for location auto-detection when proxying a request oneOf[1]
body.machine string Optional Machine type to use for this codespace oneOf[1]
body.devcontainer_path string Optional Path to devcontainer.json config to use for this codespace oneOf[1]
body.multi_repo_permissions_opt_out boolean Optional Whether to authorize requested permissions from devcontainer.json oneOf[1]
body.working_directory string Optional Working directory for this codespace oneOf[1]
body.idle_timeout_minutes integer Optional Time in minutes before codespace stops from inactivity oneOf[1]
body.display_name string Optional Display name for this codespace oneOf[1]
body.retention_period_minutes integer Optional Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). oneOf[1]
body object Required oneOf[2]
body.pull_request object Required Pull request number for this codespace oneOf[2]
body.pull_request.pull_request_number integer Required Pull request number oneOf[2]
body.pull_request.repository_id integer Required Repository id for this codespace oneOf[2]
body.location string Optional The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. oneOf[2]
body.geo string Optional The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces location, which is closing down. oneOf[2]; enum: ["EuropeWest","SoutheastAsia","UsEast","UsWest"]
body.machine string Optional Machine type to use for this codespace oneOf[2]
body.devcontainer_path string Optional Path to devcontainer.json config to use for this codespace oneOf[2]
body.working_directory string Optional Working directory for this codespace oneOf[2]
body.idle_timeout_minutes integer Optional Time in minutes before codespace stops from inactivity oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "repository_id": 1,
    "ref": "main",
    "geo": "UsWest"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List secrets for the authenticated user — github.codespaces.list-secrets-for-authenticated-user

Lists all development environment secrets available for a user's codespaces without revealing their encrypted values.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get public key for the authenticated user — github.codespaces.get-public-key-for-authenticated-user

Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a secret for the authenticated user — github.codespaces.get-secret-for-authenticated-user

Gets a development environment secret available to a user's codespaces without revealing its encrypted value.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update a secret for the authenticated user — github.codespaces.create-or-update-secret-for-authenticated-user

Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.secret_name string Required The name of the secret.
body object Required
body.encrypted_value string Optional Value for your secret, encrypted with LibSodium using the public key retrieved from the Get the public key for the authenticated user endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
body.key_id string Required ID of the key you used to encrypt the secret.
body.selected_repository_ids array Optional An array of repository ids that can access the user secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Set selected repositories for a user secret, and Remove a selected repository from a user secret endpoints.
body.selected_repository_ids[] — Optional
body.selected_repository_ids[] integer Optional anyOf[1]
body.selected_repository_ids[] string Optional anyOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "secret_name": "example"
  },
  "body": {
    "encrypted_value": "c2VjcmV0",
    "key_id": "012345678912345678",
    "selected_repository_ids": [
      "1234567",
      "2345678"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a secret for the authenticated user — github.codespaces.delete-secret-for-authenticated-user

Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List selected repositories for a user secret — github.codespaces.list-repositories-for-secret-for-authenticated-user

List the repositories that have been granted the ability to use a user's development environment secret.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.secret_name string Required The name of the secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "secret_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a selected repository to a user secret — github.codespaces.add-repository-for-secret-for-authenticated-user

Adds a repository to the selected repositories for a user's development environment secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.secret_name string Required The name of the secret.
path.repository_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "secret_name": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove a selected repository from a user secret — github.codespaces.remove-repository-for-secret-for-authenticated-user

Removes a repository from the selected repositories for a user's development environment secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.secret_name string Required The name of the secret.
path.repository_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "secret_name": "example",
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a codespace for the authenticated user — github.codespaces.get-for-authenticated-user

Gets information about a user's codespace.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.codespace_name string Required The name of the codespace.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "codespace_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a codespace for the authenticated user — github.codespaces.update-for-authenticated-user

Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.codespace_name string Required The name of the codespace.
body object Optional
body.machine string Optional A valid machine to transition this codespace to.
body.display_name string Optional Display name for this codespace
body.recent_folders array Optional Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.
body.recent_folders[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "codespace_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a codespace for the authenticated user — github.codespaces.delete-for-authenticated-user

Deletes a user's codespace.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.codespace_name string Required The name of the codespace.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "codespace_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Export a codespace for the authenticated user — github.codespaces.export-for-authenticated-user

Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.codespace_name string Required The name of the codespace.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "codespace_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get details about a codespace export — github.codespaces.get-export-details-for-authenticated-user

Gets information about an export of a codespace.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.codespace_name string Required The name of the codespace.
path.export_id string Required The ID of the export operation, or latest. Currently only latest is currently supported.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "codespace_name": "example",
    "export_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List machine types for a codespace — github.codespaces.codespace-machines-for-authenticated-user

List the machine types a codespace can transition to use.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.codespace_name string Required The name of the codespace.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "codespace_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a repository from an unpublished codespace — github.codespaces.publish-for-authenticated-user

Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.codespace_name string Required The name of the codespace.
body object Required
body.name string Optional A name for the new repository.
body.private boolean Optional Whether the new repository should be private. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "codespace_name": "example"
  },
  "body": {
    "repository": "monalisa-octocat-hello-world-g4wpq6h95q",
    "private": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start a codespace for the authenticated user — github.codespaces.start-for-authenticated-user

Starts a user's codespace.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.codespace_name string Required The name of the codespace.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "codespace_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Stop a codespace for the authenticated user — github.codespaces.stop-for-authenticated-user

Stops a user's codespace.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.codespace_name string Required The name of the codespace.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "codespace_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get list of conflicting packages during Docker migration for authenticated-user — github.packages.list-docker-migration-conflicting-packages-for-authen-63152eb7cf

Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set primary email visibility for the authenticated user — github.users.set-primary-email-visibility-for-authenticated-user

Sets the visibility for your primary email addresses.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Required
body.visibility string Required Denotes whether an email is publicly visible. enum: ["public","private"]

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "visibility": "private"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List email addresses for the authenticated user — github.users.list-emails-for-authenticated-user

Lists all of your email addresses, and specifies which one is visible to the public.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add an email address for the authenticated user — github.users.add-email-for-authenticated-user

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Optional
body object Optional oneOf[1]
body.emails array Required Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key. oneOf[1]; minItems: 1
body.emails[] string Optional oneOf[1]
body array Optional oneOf[2]; minItems: 1
body[] string Optional oneOf[2]
body string Optional oneOf[3]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an email address for the authenticated user — github.users.delete-email-for-authenticated-user

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Optional
body object Optional Deletes one or more email addresses from your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key. oneOf[1]
body.emails array Required Email addresses associated with the GitHub user account. oneOf[1]; minItems: 1
body.emails[] string Optional oneOf[1]
body array Optional oneOf[2]; minItems: 1
body[] string Optional oneOf[2]
body string Optional oneOf[3]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List followers of the authenticated user — github.users.list-followers-for-authenticated-user

Lists the people following the authenticated user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List the people the authenticated user follows — github.users.list-followed-by-authenticated-user

Lists the people who the authenticated user follows.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check if a person is followed by the authenticated user — github.users.check-person-is-followed-by-authenticated

Run Check if a person is followed by the authenticated user with GitHub. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Follow a user — github.users.follow

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Unfollow a user — github.users.unfollow

OAuth app tokens and personal access tokens (classic) need the user:follow scope to use this endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List GPG keys for the authenticated user — github.users.list-gpg-keys-for-authenticated-user

Lists the current user's GPG keys.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a GPG key for the authenticated user — github.users.create-gpg-key-for-authenticated-user

Adds a GPG key to the authenticated user's GitHub account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Required
body.name string Optional A descriptive name for the new key.
body.armored_public_key string Required A GPG key in ASCII-armored format.

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "name": "Octocat's GPG Key",
    "armored_public_key": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v1\n\nmQINBFnZ2ZIBEADQ2Z7Z7\n-----END PGP PUBLIC KEY BLOCK-----"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a GPG key for the authenticated user — github.users.get-gpg-key-for-authenticated-user

View extended details for a single GPG key.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gpg_key_id integer Required The unique identifier of the GPG key.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gpg_key_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a GPG key for the authenticated user — github.users.delete-gpg-key-for-authenticated-user

Removes a GPG key from the authenticated user's GitHub account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gpg_key_id integer Required The unique identifier of the GPG key.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gpg_key_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List app installations accessible to the user access token — github.apps.list-installations-for-authenticated-user

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repositories accessible to the user access token — github.apps.list-installation-repos-for-authenticated-user

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.installation_id integer Required The unique identifier of the installation.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "installation_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a repository to an app installation — github.apps.add-repo-to-installation-for-authenticated-user

Add a single repository to an installation. The authenticated user must have admin access to the repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.installation_id integer Required The unique identifier of the installation.
path.repository_id integer Required The unique identifier of the repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "installation_id": 1,
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove a repository from an app installation — github.apps.remove-repo-from-installation-for-authenticated-user

Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the repository_selection of selected.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.installation_id integer Required The unique identifier of the installation.
path.repository_id integer Required The unique identifier of the repository.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "installation_id": 1,
    "repository_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get interaction restrictions for your public repositories — github.interactions.get-restrictions-for-authenticated-user

Shows which type of GitHub user can interact with your public repositories and when the restriction expires.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set interaction restrictions for your public repositories — github.interactions.set-restrictions-for-authenticated-user

Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/interaction-limit"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "limit": "collaborators_only"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove interaction restrictions from your public repositories — github.interactions.remove-restrictions-for-authenticated-user

Removes any interaction restrictions from your public repositories.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List user account issues assigned to the authenticated user — github.issues.list-for-authenticated-user

List issues across owned and member repositories assigned to the authenticated user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.filter string Optional Indicates 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, regardless of participation or creation. enum: ["assigned","created","mentioned","subscribed","repos","all"]; default: "assigned"
query.state string Optional Indicates the state of the issues to return. enum: ["open","closed","all"]; default: "open"
query.labels string Optional A list of comma separated label names. Example: bug,ui,@high
query.sort string Optional What to sort results by. enum: ["created","updated","comments"]; default: "created"
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.since string Optional Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List public SSH keys for the authenticated user — github.users.list-public-ssh-keys-for-authenticated-user

Lists the public SSH keys for the authenticated user's GitHub account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a public SSH key for the authenticated user — github.users.get-public-ssh-key-for-authenticated-user

View extended details for a single public SSH key.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.key_id integer Required The unique identifier of the key.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "key_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a public SSH key for the authenticated user — github.users.delete-public-ssh-key-for-authenticated-user

Removes a public SSH key from the authenticated user's GitHub account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.key_id integer Required The unique identifier of the key.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "key_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List subscriptions for the authenticated user — github.apps.list-subscriptions-for-authenticated-user

Lists the active subscriptions for the authenticated user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List subscriptions for the authenticated user (stubbed) — github.apps.list-subscriptions-for-authenticated-user-stubbed

Lists the active subscriptions for the authenticated user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization memberships for the authenticated user — github.orgs.list-memberships-for-authenticated-user

Lists all of the authenticated user's organization memberships.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.state string Optional Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. enum: ["active","pending"]
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an organization membership for the authenticated user — github.orgs.get-membership-for-authenticated-user

If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a 404 is returned. This endpoint will return a 403 if the request is made by a GitHub App that is blocked by the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an organization membership for the authenticated user — github.orgs.update-membership-for-authenticated-user

Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.org string Required The organization name. The name is not case sensitive.
body object Required
body.state string Required The state that the membership should be in. Only "active" will be accepted. enum: ["active"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "org": "example"
  },
  "body": {
    "state": "active"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List user migrations — github.migrations.list-for-authenticated-user

Lists all migrations a user has started.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start a user migration — github.migrations.start-for-authenticated-user

Initiates the generation of a user migration archive.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Required
body.lock_repositories boolean Optional Lock the repositories being migrated at the start of the migration
body.exclude_metadata boolean Optional Indicates whether metadata should be excluded and only git source should be included for the migration.
body.exclude_git_data boolean Optional Indicates whether the repository git data should be excluded from the migration.
body.exclude_attachments boolean Optional Do not include attachments in the migration
body.exclude_releases boolean Optional Do not include releases in the migration
body.exclude_owner_projects boolean Optional Indicates whether projects owned by the organization or users should be excluded.
body.org_metadata_only boolean Optional Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). default: false
body.exclude array Optional Exclude attributes from the API response to improve performance
body.exclude[] string Optional Allowed values that can be passed to the exclude param. enum: ["repositories"]
body.repositories array Required
body.repositories[] string Optional Repository path, owner and name

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "repositories": [
      "octocat/Hello-World"
    ],
    "lock_repositories": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a user migration status — github.migrations.get-status-for-authenticated-user

Fetches a single user migration. The response includes the state of the migration, which can be one of the following values:

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.migration_id integer Required The unique identifier of the migration.
query object Optional additionalProperties: false
query.exclude array Optional
query.exclude[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "migration_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a user migration archive — github.migrations.delete-archive-for-authenticated-user

Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the List user migrations and Get a user migration status endpoints, will continue to be available even after an archive is deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.migration_id integer Required The unique identifier of the migration.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "migration_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Unlock a user repository — github.migrations.unlock-repo-for-authenticated-user

Unlocks a repository. You can lock repositories when you start a user migration. Once the migration is complete you can unlock each repository to begin using it again or delete the repository if you no longer need the source data. Returns a status of 404 Not Found if the repository is not locked.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.migration_id integer Required The unique identifier of the migration.
path.repo_name string Required repo_name parameter

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "migration_id": 1,
    "repo_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repositories for a user migration — github.migrations.list-repos-for-authenticated-user

Lists all the repositories for this user migration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.migration_id integer Required The unique identifier of the migration.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "migration_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organizations for the authenticated user — github.orgs.list-for-authenticated-user

List organizations for the authenticated user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List packages for the authenticated user's namespace — github.packages.list-packages-for-authenticated-user

Lists packages owned by the authenticated user within the user's namespace.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
query.visibility string Optional The selected visibility of the packages. This parameter is optional and only filters an existing result set. The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private. For the list of GitHub Packages registries that support granular permissions, see "About permissions for GitHub Packages." enum: ["public","private","internal"]
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "package_type": "npm"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a package for the authenticated user — github.packages.get-package-for-authenticated-user

Gets a specific package for a package owned by the authenticated user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a package for the authenticated user — github.packages.delete-package-for-authenticated-user

Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Restore a package for the authenticated user — github.packages.restore-package-for-authenticated-user

Restores a package owned by the authenticated user.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
query object Optional additionalProperties: false
query.token string Optional package token

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List package versions for a package owned by the authenticated user — github.packages.get-all-package-versions-for-package-owned-by-authenticated-user

Lists package versions for a package owned by the authenticated user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
query object Optional additionalProperties: false
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.state string Optional The state of the package, either active or deleted. enum: ["active","deleted"]; default: "active"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a package version for the authenticated user — github.packages.get-package-version-for-authenticated-user

Gets a specific package version for a package owned by the authenticated user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
path.package_version_id integer Required Unique identifier of the package version.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example",
    "package_version_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a package version for the authenticated user — github.packages.delete-package-version-for-authenticated-user

Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
path.package_version_id integer Required Unique identifier of the package version.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example",
    "package_version_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Restore a package version for the authenticated user — github.packages.restore-package-version-for-authenticated-user

Restores a package version owned by the authenticated user.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
path.package_version_id integer Required Unique identifier of the package version.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example",
    "package_version_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List public email addresses for the authenticated user — github.users.list-public-emails-for-authenticated-user

Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repositories for the authenticated user — github.repos.list-for-authenticated-user

Lists repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.visibility string Optional Limit results to repositories with the specified visibility. enum: ["all","public","private"]; default: "all"
query.affiliation string Optional Comma-separated list of values. Can include: * owner: Repositories that are owned by the authenticated user. * collaborator: Repositories that the user has been added to as a collaborator. * organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on. default: "owner,collaborator,organization_member"
query.type string Optional Limit results to repositories of the specified type. Will cause a 422 error if used in the same request as visibility or affiliation. enum: ["all","owner","public","private","member"]; default: "all"
query.sort string Optional The property to sort the results by. enum: ["created","updated","pushed","full_name"]; default: "full_name"
query.direction string Optional The order to sort by. Default: asc when using full_name, otherwise desc. enum: ["asc","desc"]
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.since string Optional Only show repositories updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.before string Optional Only show repositories updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a repository for the authenticated user — github.repos.create-for-authenticated-user

Creates a new repository for the authenticated user.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Required
body.name string Required The name of the repository.
body.description string Optional A short description of the repository.
body.homepage string Optional A URL with more information about the repository.
body.private boolean Optional Whether the repository is private. default: false
body.has_issues boolean Optional Whether issues are enabled. default: true
body.has_projects boolean Optional Whether projects are enabled. default: true
body.has_wiki boolean Optional Whether the wiki is enabled. default: true
body.has_discussions boolean Optional Whether discussions are enabled. default: false
body.team_id integer Optional The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.
body.auto_init boolean Optional Whether the repository is initialized with a minimal README. default: false
body.gitignore_template string Optional The desired language or platform to apply to the .gitignore.
body.license_template string Optional The license keyword of the open source license for this repository.
body.allow_squash_merge boolean Optional Whether to allow squash merges for pull requests. default: true
body.allow_merge_commit boolean Optional Whether to allow merge commits for pull requests. default: true
body.allow_rebase_merge boolean Optional Whether to allow rebase merges for pull requests. default: true
body.allow_auto_merge boolean Optional Whether to allow Auto-merge to be used on pull requests. default: false
body.delete_branch_on_merge boolean Optional Whether to delete head branches when pull requests are merged default: false
body.squash_merge_commit_title string Optional Required when using squash_merge_commit_message. The default value for a squash merge commit title: - PR_TITLE - default to the pull request's title. - COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). enum: ["PR_TITLE","COMMIT_OR_PR_TITLE"]
body.squash_merge_commit_message string Optional The default value for a squash merge commit message: - PR_BODY - default to the pull request's body. - COMMIT_MESSAGES - default to the branch's commit messages. - BLANK - default to a blank commit message. enum: ["PR_BODY","COMMIT_MESSAGES","BLANK"]
body.merge_commit_title string Optional Required when using merge_commit_message. The default value for a merge commit title. - PR_TITLE - default to the pull request's title. - MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). enum: ["PR_TITLE","MERGE_MESSAGE"]
body.merge_commit_message string Optional The default value for a merge commit message. - PR_TITLE - default to the pull request's title. - PR_BODY - default to the pull request's body. - BLANK - default to a blank commit message. enum: ["PR_BODY","PR_TITLE","BLANK"]
body.has_downloads boolean Optional Whether downloads are enabled. default: true
body.is_template boolean Optional Whether this repository acts as a template that can be used to generate new repositories. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "name": "Hello-World",
    "description": "This is your first repo!",
    "homepage": "https://github.com",
    "private": false,
    "is_template": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository invitations for the authenticated user — github.repos.list-invitations-for-authenticated-user

When authenticating as a user, this endpoint will list all currently open repository invitations for that user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Accept a repository invitation — github.repos.accept-invitation-for-authenticated-user

Run Accept a repository invitation with GitHub. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.invitation_id integer Required The unique identifier of the invitation.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "invitation_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Decline a repository invitation — github.repos.decline-invitation-for-authenticated-user

Run Decline a repository invitation with GitHub. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.invitation_id integer Required The unique identifier of the invitation.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "invitation_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List social accounts for the authenticated user — github.users.list-social-accounts-for-authenticated-user

Lists all of your social accounts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add social accounts for the authenticated user — github.users.add-social-account-for-authenticated-user

Add one or more social accounts to the authenticated user's profile.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Required
body.account_urls array Required Full URLs for the social media profiles to add.
body.account_urls[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "account_urls": [
      "https://facebook.com/GitHub",
      "https://www.youtube.com/@GitHub"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete social accounts for the authenticated user — github.users.delete-social-account-for-authenticated-user

Deletes one or more social accounts from the authenticated user's profile.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Required
body.account_urls array Required Full URLs for the social media profiles to delete.
body.account_urls[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "account_urls": [
      "https://facebook.com/GitHub",
      "https://www.youtube.com/@GitHub"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List SSH signing keys for the authenticated user — github.users.list-ssh-signing-keys-for-authenticated-user

Lists the SSH signing keys for the authenticated user's GitHub account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an SSH signing key for the authenticated user — github.users.get-ssh-signing-key-for-authenticated-user

Gets extended details for an SSH signing key.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ssh_signing_key_id integer Required The unique identifier of the SSH signing key.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ssh_signing_key_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an SSH signing key for the authenticated user — github.users.delete-ssh-signing-key-for-authenticated-user

Deletes an SSH signing key from the authenticated user's GitHub account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ssh_signing_key_id integer Required The unique identifier of the SSH signing key.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ssh_signing_key_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repositories starred by the authenticated user — github.activity.list-repos-starred-by-authenticated-user

Lists repositories the authenticated user has starred.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.sort string Optional The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to. enum: ["created","updated"]; default: "created"
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check if a repository is starred by the authenticated user — github.activity.check-repo-is-starred-by-authenticated-user

Whether the authenticated user has starred the repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Star a repository for the authenticated user — github.activity.star-repo-for-authenticated-user

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP method."

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Unstar a repository for the authenticated user — github.activity.unstar-repo-for-authenticated-user

Unstar a repository that the authenticated user has previously starred.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.owner string Required The account owner of the repository. The name is not case sensitive.
path.repo string Required The name of the repository without the .git extension. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "owner": "octocat",
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repositories watched by the authenticated user — github.activity.list-watched-repos-for-authenticated-user

Lists repositories the authenticated user is watching.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List teams for the authenticated user — github.teams.list-for-authenticated-user

List all of the teams across all of the organizations to which the authenticated user belongs.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a user using their ID — github.users.get-by-id

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id integer Required account_id parameter

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create draft item for user owned project — github.projects.create-draft-item-for-authenticated-user

Create draft issue item for the specified user owned project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.user_id string Required The unique identifier of the user.
path.project_number integer Required The project's number.
body object Required
body.title string Required The title of the draft issue item to create in the project.
body.body string Optional The body content of the draft issue item to create in the project.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "user_id": "example",
    "project_number": 1
  },
  "body": {
    "title": "Sample Draft Issue Title"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List users — github.users.list

Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.since integer Optional A user ID. Only return users with an ID greater than this ID.
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a view for a user-owned project — github.projects.create-view-for-user

Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.user_id string Required The unique identifier of the user.
path.project_number integer Required The project's number.
body object Required additionalProperties: false
body.name string Required The name of the view.
body.layout string Required The layout of the view. enum: ["table","board","roadmap"]
body.filter string Optional The filter query for the view. See Filtering projects for more information.
body.visible_fields array Optional visible_fields is not applicable to roadmap layout views. For table and board layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used.
body.visible_fields[] integer Optional
body.sort_by array Optional Sorting configuration for the view. Each element is a two-element array of [field_id, direction] where direction is "asc" or "desc". Supports multiple sort criteria applied in order.
body.sort_by[] array Optional minItems: 2; maxItems: 2
body.sort_by[][] — Optional
body.sort_by[][] integer Optional oneOf[1]
body.sort_by[][] string Optional oneOf[2]
body.group_by array Optional The field IDs to group items by (horizontal grouping). Supports a single field. The field must support grouping; fields such as Title, Reviewers, Linked pull requests, Sub-issues progress, Tracked by, and Tracks cannot be grouped on. maxItems: 1
body.group_by[] integer Optional
body.vertical_group_by array Optional The field IDs to use as columns in board layout (vertical grouping). Supports a single field. The field must support grouping; fields such as Title, Reviewers, Linked pull requests, Sub-issues progress, Tracked by, and Tracks cannot be grouped on. maxItems: 1
body.vertical_group_by[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "user_id": "example",
    "project_number": 1
  },
  "body": {
    "name": "All Issues",
    "layout": "table",
    "filter": "is:issue",
    "visible_fields": [
      123,
      456,
      789
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a user — github.users.get-by-username

Provides publicly available information about someone with a GitHub account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List attestations by bulk subject digests — github.users.list-attestations-bulk

List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
body object Required
body.subject_digests array Required List of subject digests to fetch attestations for. minItems: 1; maxItems: 1024
body.subject_digests[] string Optional
body.predicate_type string Optional Optional filter for fetching attestations with a given predicate type. This option accepts provenance, sbom, release, or freeform text for custom predicate types.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  },
  "body": {
    "subject_digests": [
      "example"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete attestations in bulk — github.users.delete-attestations-bulk

Delete artifact attestations in bulk by either subject digests or unique ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
body object Required The request body must include either subject_digests or attestation_ids, but not both.
body object Required oneOf[1]
body.subject_digests array Required List of subject digests associated with the artifact attestations to delete. oneOf[1]; minItems: 1; maxItems: 1024
body.subject_digests[] string Optional oneOf[1]
body object Required oneOf[2]
body.attestation_ids array Required List of unique IDs associated with the artifact attestations to delete. oneOf[2]; minItems: 1; maxItems: 1024
body.attestation_ids[] integer Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  },
  "body": {
    "subject_digests": [
      "sha256:abc123",
      "sha512:def456"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete attestations by subject digest — github.users.delete-attestations-by-subject-digest

Delete an artifact attestation by subject digest.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.subject_digest string Required Subject Digest

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "subject_digest": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete attestations by ID — github.users.delete-attestations-by-id

Delete an artifact attestation by unique ID that is associated with a repository owned by a user.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.attestation_id integer Required Attestation ID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "attestation_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List attestations — github.users.list-attestations

List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.predicate_type string Optional Optional filter for fetching attestations with a given predicate type. This option accepts provenance, sbom, release, or freeform text for custom predicate types.
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.subject_digest string Required Subject Digest

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "subject_digest": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Copilot Spaces for a user — github.copilot-spaces.list-for-user

Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). default: 30; minimum: 1; maximum: 100
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Copilot Space for a user — github.copilot-spaces.create-for-user

Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
body object Required
body.name string Required The name of the Copilot Space.
body.description string Optional A description of the Copilot Space.
body.general_instructions string Optional General instructions for the Copilot Space. maxLength: 4000
body.base_role string Optional The base role that determines default permissions for the space. - no_access: No default access (default) - reader: Makes the space publicly readable Note: User spaces do not support writer or admin base roles. enum: ["reader","no_access"]; default: "no_access"
body.resources_attributes array Optional Resources to attach to the space.
body.resources_attributes[] object Optional
body.resources_attributes[].resource_type string Optional The type of resource. enum: ["repository","github_file","free_text","github_issue","github_pull_request","media_content","uploaded_text_file"]
body.resources_attributes[].metadata object Optional Metadata specific to the resource type.
body.resources_attributes[].metadata.repository_id integer Optional Repository ID for repository or file resources.
body.resources_attributes[].metadata.file_path string Optional File path for file resources.
body.resources_attributes[].metadata.text string Optional Text content for free text resources.
body.resources_attributes[].metadata.name string Optional Name for the resource.
body.resources_attributes[].metadata.number integer Optional Issue or PR number.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  },
  "body": {
    "name": "My Development Space",
    "description": "Personal space for development assistance",
    "general_instructions": "Help me with React development patterns and best practices",
    "resources_attributes": [
      {
        "resource_type": "github_file",
        "metadata": {
          "repository_id": 789012,
          "file_path": "src/components/App.js"
        }
      },
      {
        "resource_type": "free_text",
        "metadata": {
          "name": "Development Notes",
          "text": "Focus on clean code principles and modern React patterns"
        }
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Copilot Space for a user — github.copilot-spaces.get-for-user

Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.space_number integer Required The unique identifier of the Copilot Space.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "space_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set a Copilot Space for a user — github.copilot-spaces.update-for-user

Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.space_number integer Required The unique identifier of the Copilot Space.
body object Required
body.name string Optional The name of the Copilot Space.
body.description string Optional A description of the Copilot Space.
body.general_instructions string Optional General instructions for the Copilot Space. maxLength: 4000
body.base_role string Optional The base role that determines default permissions for the space. Changing this field requires admin permissions. - no_access: No default access (default) - reader: Makes the space publicly readable Note: User spaces do not support writer or admin base roles. enum: ["reader","no_access"]
body.resources_attributes array Optional Resources to attach to the space.
body.resources_attributes[] object Optional
body.resources_attributes[].resource_type string Optional The type of resource. enum: ["repository","github_file","free_text","github_issue","github_pull_request","media_content","uploaded_text_file"]
body.resources_attributes[].metadata object Optional Metadata specific to the resource type.
body.resources_attributes[].metadata.repository_id integer Optional Repository ID for repository or file resources.
body.resources_attributes[].metadata.file_path string Optional File path for file resources.
body.resources_attributes[].metadata.text string Optional Text content for free text resources.
body.resources_attributes[].metadata.name string Optional Name for the resource.
body.resources_attributes[].metadata.number integer Optional Issue or PR number.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "space_number": 1
  },
  "body": {
    "name": "Updated Development Space",
    "description": "Updated personal space for development assistance",
    "general_instructions": "Updated instructions to help me with React development patterns and best practices",
    "resources_attributes": [
      {
        "resource_type": "github_file",
        "metadata": {
          "repository_id": 789012,
          "file_path": "src/components/UpdatedApp.js"
        }
      },
      {
        "id": 123,
        "_destroy": true
      },
      {
        "id": 456,
        "resource_type": "free_text",
        "metadata": {
          "name": "Updated Development Notes",
          "text": "Updated focus on clean code principles and modern React patterns"
        }
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Copilot Space for a user — github.copilot-spaces.delete-for-user

Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.space_number integer Required The unique identifier of the Copilot Space.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "space_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List collaborators for a Copilot Space for a user — github.copilot-spaces.list-collaborators-for-user

Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.space_number integer Required The unique identifier of the Copilot Space.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "space_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a collaborator to a Copilot Space for a user — github.copilot-spaces.add-collaborator-for-user

Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.space_number integer Required The unique identifier of the Copilot Space.
body object Required
body.actor_type string Required The type of actor (must be User for user-owned spaces; Team will be rejected). enum: ["User","Team"]
body.actor_identifier string Required The username of the collaborator. The numeric user ID is also accepted.
body.role string Required The role to grant to the collaborator. enum: ["reader","writer","admin"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "space_number": 1
  },
  "body": {
    "actor_type": "User",
    "actor_identifier": "octocat",
    "role": "writer"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set a collaborator role for a Copilot Space for a user — github.copilot-spaces.update-collaborator-for-user

Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.space_number integer Required The unique identifier of the Copilot Space.
path.actor_type string Required The type of actor (must be User for user-owned spaces; Team will be rejected). enum: ["User","Team"]
path.actor_identifier string Required The username of the collaborator. The numeric user ID is also accepted.
body object Required
body.role string Required The new role to grant to the collaborator. Use no_access to remove the collaborator. enum: ["reader","writer","admin","no_access"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "space_number": 1,
    "actor_type": "User",
    "actor_identifier": "example"
  },
  "body": {
    "role": "admin"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove a collaborator from a Copilot Space for a user — github.copilot-spaces.remove-collaborator-for-user

Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.space_number integer Required The unique identifier of the Copilot Space.
path.actor_type string Required The type of actor (must be User for user-owned spaces; Team will be rejected). enum: ["User","Team"]
path.actor_identifier string Required The username of the collaborator. The numeric user ID is also accepted.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "space_number": 1,
    "actor_type": "User",
    "actor_identifier": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List resources for a Copilot Space for a user — github.copilot-spaces.list-resources-for-user

Lists all resources attached to a specific Copilot Space owned by a user. The authenticated user must have appropriate permissions to view the space.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.space_number integer Required The unique identifier of the Copilot Space.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "space_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a resource for a Copilot Space for a user — github.copilot-spaces.create-resource-for-user

Creates a new resource in a specific Copilot Space owned by a user. The authenticated user must have write permissions on the space.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.space_number integer Required The unique identifier of the Copilot Space.
body object Required
body.resource_type string Required The type of resource to create. enum: ["repository","github_file","free_text","github_issue","github_pull_request"]
body.metadata object Required Resource-specific metadata. additionalProperties: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "space_number": 1
  },
  "body": {
    "resource_type": "free_text",
    "metadata": {
      "name": "notes.txt",
      "text": "Some helpful notes"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a resource for a Copilot Space for a user — github.copilot-spaces.get-resource-for-user

Gets a specific resource attached to a Copilot Space owned by a user. The authenticated user must have appropriate permissions to view the space.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.space_number integer Required The unique identifier of the Copilot Space.
path.space_resource_id integer Required The unique identifier of the resource.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "space_number": 1,
    "space_resource_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set a resource for a Copilot Space for a user — github.copilot-spaces.update-resource-for-user

Updates the metadata of a resource in a specific Copilot Space owned by a user. The authenticated user must have write permissions on the space.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.space_number integer Required The unique identifier of the Copilot Space.
path.space_resource_id integer Required The unique identifier of the resource.
body object Required
body.metadata object Optional Updated resource-specific metadata. additionalProperties: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "space_number": 1,
    "space_resource_id": 1
  },
  "body": {
    "metadata": {
      "name": "updated-notes.txt",
      "text": "Updated content"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a resource from a Copilot Space for a user — github.copilot-spaces.delete-resource-for-user

Deletes a resource from a specific Copilot Space owned by a user. The authenticated user must have write permissions on the space.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.space_number integer Required The unique identifier of the Copilot Space.
path.space_resource_id integer Required The unique identifier of the resource.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "space_number": 1,
    "space_resource_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get list of conflicting packages during Docker migration for user — github.packages.list-docker-migration-conflicting-packages-for-user

Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List events for the authenticated user — github.activity.list-events-for-authenticated-user

If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization events for the authenticated user — github.activity.list-org-events-for-authenticated-user

This is the user's organization dashboard. You must be authenticated as the user to view this.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.org string Required The organization name. The name is not case sensitive.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "org": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List public events for a user — github.activity.list-public-events-for-user

> [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List followers of a user — github.users.list-followers-for-user

Lists the people following the specified user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List the people a user follows — github.users.list-following-for-user

Lists the people who the specified user follows.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check if a user follows another user — github.users.check-following-for-user

Run Check if a user follows another user with GitHub. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.target_user string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "target_user": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List gists for a user — github.gists.list-for-user

Lists public gists for the specified user:

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.since string Optional Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. format: "date-time"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List GPG keys for a user — github.users.list-gpg-keys-for-user

Lists the GPG keys for a user. This information is accessible by anyone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get contextual information for a user — github.users.get-context-for-user

Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.subject_type string Optional Identifies which additional information you'd like to receive about the person's hovercard. Can be organization, repository, issue, pull_request. Required when using subject_id. enum: ["organization","repository","issue","pull_request"]
query.subject_id string Optional Uses the ID for the subject_type you specified. Required when using subject_type.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a user installation for the authenticated app — github.apps.get-user-installation

Enables an authenticated GitHub App to find the user’s installation information.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List public keys for a user — github.users.list-public-keys-for-user

Lists the _verified_ public SSH keys for a user. This is accessible by anyone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organizations for a user — github.orgs.list-for-user

List public organization memberships for the specified user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List packages for a user — github.packages.list-packages-for-user

Lists all packages in a user's namespace for which the requesting user has access.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
query.visibility string Optional The selected visibility of the packages. This parameter is optional and only filters an existing result set. The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private. For the list of GitHub Packages registries that support granular permissions, see "About permissions for GitHub Packages." enum: ["public","private","internal"]
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "package_type": "npm"
  },
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a package for a user — github.packages.get-package-for-user

Gets a specific package metadata for a public package owned by a user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a package for a user — github.packages.delete-package-for-user

Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Restore a package for a user — github.packages.restore-package-for-user

Restores an entire package for a user.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.token string Optional package token

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List package versions for a package owned by a user — github.packages.get-all-package-versions-for-package-owned-by-user

Lists package versions for a public package owned by a specified user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example",
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a package version for a user — github.packages.get-package-version-for-user

Gets a specific package version for a public package owned by a specified user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
path.package_version_id integer Required Unique identifier of the package version.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example",
    "package_version_id": 1,
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete package version for a user — github.packages.delete-package-version-for-user

Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
path.username string Required The handle for the GitHub user account.
path.package_version_id integer Required Unique identifier of the package version.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example",
    "username": "example",
    "package_version_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Restore package version for a user — github.packages.restore-package-version-for-user

Restores a specific package version for a user.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.package_type string Required The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry. enum: ["npm","maven","rubygems","docker","nuget","container"]
path.package_name string Required The name of the package.
path.username string Required The handle for the GitHub user account.
path.package_version_id integer Required Unique identifier of the package version.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "package_type": "npm",
    "package_name": "example",
    "username": "example",
    "package_version_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List projects for user — github.projects.list-for-user

List all projects owned by a specific user accessible by the authenticated user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.q string Optional Limit results to projects of the specified type.
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get project for user — github.projects.get-for-user

Get a specific user-owned project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_number integer Required The project's number.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_number": 1,
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List project fields for user — github.projects.list-fields-for-user

List all fields for a specific user-owned project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_number integer Required The project's number.
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_number": 1,
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add field to user owned project — github.projects.add-field-for-user

Add a field to a specified user owned project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.project_number integer Required The project's number.
body — Required
body object Required oneOf[1]; additionalProperties: false
body.name string Required The name of the field. oneOf[1]
body.data_type string Required The field's data type. oneOf[1]; enum: ["text","number","date"]
body object Required oneOf[2]; additionalProperties: false
body.name string Required The name of the field. oneOf[2]
body.data_type string Required The field's data type. oneOf[2]; enum: ["single_select"]
body.single_select_options array Required The options available for single select fields. At least one option must be provided when creating a single select field. oneOf[2]
body.single_select_options[] — Optional oneOf[2]; $ref: "#/definitions/projects-v2-field-single-select-option"
body object Required oneOf[3]; additionalProperties: false
body.name string Required The name of the field. oneOf[3]
body.data_type string Required The field's data type. oneOf[3]; enum: ["iteration"]
body.iteration_configuration — Required oneOf[3]; $ref: "#/definitions/projects-v2-field-iteration-configuration"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "project_number": 1
  },
  "body": {
    "name": "Team notes",
    "data_type": "text"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get project field for user — github.projects.get-field-for-user

Get a specific field for a user-owned project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_number integer Required The project's number.
path.field_id integer Required The unique identifier of the field.
path.username string Required The handle for the GitHub user account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_number": 1,
    "field_id": 1,
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List items for a user owned project — github.projects.list-items-for-user

List all items for a specific user-owned project accessible by the authenticated user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_number integer Required The project's number.
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.q string Optional Search query to filter items, see Filtering projects for more information.
query.fields — Optional Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: fields[]=123&amp;fields[]=456&amp;fields[]=789 or fields=123,456,789
query.fields string Optional oneOf[1]
query.fields array Optional oneOf[2]; maxItems: 50
query.fields[] string Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_number": 1,
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add item to user owned project — github.projects.add-item-for-user

Add an issue or pull request item to the specified user owned project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
path.project_number integer Required The project's number.
body object Required additionalProperties: false
body.type string Required The type of item to add to the project. Must be either Issue or PullRequest. enum: ["Issue","PullRequest"]
body.id integer Optional The unique identifier of the issue or pull request to add to the project.
body.owner string Optional The repository owner login.
body.repo string Optional The repository name.
body.number integer Optional The issue or pull request number.
body — Required oneOf[1]
body — Required oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example",
    "project_number": 1
  },
  "body": {
    "type": "Issue",
    "id": 3
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an item for a user owned project — github.projects.get-user-item

Get a specific item from a user-owned project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_number integer Required The project's number.
path.username string Required The handle for the GitHub user account.
path.item_id integer Required The unique identifier of the project item.
query object Optional additionalProperties: false
query.fields — Optional Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789
query.fields string Optional oneOf[1]
query.fields array Optional oneOf[2]; maxItems: 50
query.fields[] string Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_number": 1,
    "username": "example",
    "item_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update project item for user — github.projects.update-item-for-user

Update a specific item in a user-owned project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_number integer Required The project's number.
path.username string Required The handle for the GitHub user account.
path.item_id integer Required The unique identifier of the project item.
body object Required
body.fields array Required A list of field updates to apply.
body.fields[] object Optional
body.fields[].id integer Required The ID of the project field to update.
body.fields[].value — Required The new value for the field: - For text, number, and date fields, provide the new value directly. - For single select and iteration fields, provide the ID of the option or iteration. - To clear the field, set this to null.
body.fields[].value string Required oneOf[1]
body.fields[].value number Required oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_number": 1,
    "username": "example",
    "item_id": 1
  },
  "body": {
    "fields": [
      {
        "id": 123,
        "value": "Updated text value"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete project item for user — github.projects.delete-item-for-user

Delete a specific item from a user-owned project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_number integer Required The project's number.
path.username string Required The handle for the GitHub user account.
path.item_id integer Required The unique identifier of the project item.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_number": 1,
    "username": "example",
    "item_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List items for a user project view — github.projects.list-view-items-for-user

List items in a user project with the saved view's filter applied.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_number integer Required The project's number.
path.username string Required The handle for the GitHub user account.
path.view_number integer Required The number that identifies the project view.
query object Optional additionalProperties: false
query.fields — Optional Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: fields[]=123&amp;fields[]=456&amp;fields[]=789 or fields=123,456,789
query.fields string Optional oneOf[1]
query.fields array Optional oneOf[2]; maxItems: 50
query.fields[] string Optional oneOf[2]
query.before string Optional A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
query.after string Optional A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_number": 1,
    "username": "example",
    "view_number": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List events received by the authenticated user — github.activity.list-received-events-for-user

These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List public events received by a user — github.activity.list-received-public-events-for-user

> [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repositories for a user — github.repos.list-for-user

Lists public repositories for the specified user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.type string Optional Limit results to repositories of the specified type. enum: ["all","owner","member"]; default: "owner"
query.sort string Optional The property to sort the results by. enum: ["created","updated","pushed","full_name"]; default: "full_name"
query.direction string Optional The order to sort by. Default: asc when using full_name, otherwise desc. enum: ["asc","desc"]
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get billing AI credit usage report for a user — github.billing.get-github-billing-ai-credit-usage-report-user

Gets a report of AI credit usage for a user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.year integer Optional If specified, only return results for a single year. The value of year is an integer with four digits representing a year. For example, 2025. Default value is the current year.
query.month integer Optional If specified, only return results for a single month. The value of month is an integer between 1 and 12. Default value is the current month. If no year is specified the default year is used.
query.day integer Optional If specified, only return results for a single day. The value of day is an integer between 1 and 31. If no year or month is specified, the default year and month are used.
query.model string Optional The model name to query usage for. The name is not case sensitive.
query.product string Optional The product name to query usage for. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get billing premium request usage report for a user — github.billing.get-github-billing-premium-request-usage-report-user

Gets a report of premium request usage for a user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.year integer Optional If specified, only return results for a single year. The value of year is an integer with four digits representing a year. For example, 2025. Default value is the current year.
query.month integer Optional If specified, only return results for a single month. The value of month is an integer between 1 and 12. Default value is the current month. If no year is specified the default year is used.
query.day integer Optional If specified, only return results for a single day. The value of day is an integer between 1 and 31. If no year or month is specified, the default year and month are used.
query.model string Optional The model name to query usage for. The name is not case sensitive.
query.product string Optional The product name to query usage for. The name is not case sensitive.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get billing usage report for a user — github.billing.get-github-billing-usage-report-user

Gets a report of the total usage for a user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.year integer Optional If specified, only return results for a single year. The value of year is an integer with four digits representing a year. For example, 2025. Default value is the current year.
query.month integer Optional If specified, only return results for a single month. The value of month is an integer between 1 and 12. If no year is specified the default year is used.
query.day integer Optional If specified, only return results for a single day. The value of day is an integer between 1 and 31. If no year or month is specified, the default year and month are used.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get billing usage summary for a user — github.billing.get-github-billing-usage-summary-report-user

> [!NOTE] > This endpoint is in public preview and is subject to change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.year integer Optional If specified, only return results for a single year. The value of year is an integer with four digits representing a year. For example, 2025. Default value is the current year.
query.month integer Optional If specified, only return results for a single month. The value of month is an integer between 1 and 12. Default value is the current month. If no year is specified the default year is used.
query.day integer Optional If specified, only return results for a single day. The value of day is an integer between 1 and 31. If no year or month is specified, the default year and month are used.
query.repository string Optional The repository name to query for usage in the format owner/repository.
query.product string Optional The product name to query usage for. The name is not case sensitive.
query.sku string Optional The SKU to query for usage.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List social accounts for a user — github.users.list-social-accounts-for-user

Lists social media accounts for a user. This endpoint is accessible by anyone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List SSH signing keys for a user — github.users.list-ssh-signing-keys-for-user

Lists the SSH signing keys for a user. This operation is accessible by anyone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repositories starred by a user — github.activity.list-repos-starred-by-user

Lists repositories a user has starred.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.sort string Optional The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to. enum: ["created","updated"]; default: "created"
query.direction string Optional The direction to sort the results by. enum: ["asc","desc"]; default: "desc"
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repositories watched by a user — github.activity.list-repos-watched-by-user

Lists repositories a user is watching.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The handle for the GitHub user account.
query object Optional additionalProperties: false
query.per_page integer Optional The number of results per page (max 100). For more information, see "Using pagination in the REST API." default: 30
query.page integer Optional The page number of the results to fetch. For more information, see "Using pagination in the REST API." default: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all API versions — github.meta.get-all-versions

Get all supported GitHub API versions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the Zen of GitHub — github.meta.get-zen

Get a random sentence from the Zen of GitHub

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Errors

Check the key's expiry, revocation, workspace and allowed operations.

Reuse the same idempotency key only for the same request.

The connection or provider limit has been reached. Check the receipt before retrying.

Test the connection

Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.

Official provider documentation

Type to search…

↑↓ navigate↵ selectEsc close