docs/content/rest/overview/permissions-required-for-github-apps.md

title, intro, redirect_from, versions, topics, miniTocMaxHeadingLevel, shortTitle

title	intro	redirect_from	versions	topics	miniTocMaxHeadingLevel	shortTitle
Permissions required for GitHub Apps	You can find the required permissions for each {% data variables.product.prodname_github_app %}-compatible endpoint.	/v3/apps/permissions /rest/reference/permissions-required-for-github-apps	fpt ghes ghae ghec * * * *	API	3	GitHub App permissions

About {% data variables.product.prodname_github_app %} permissions

{% data variables.product.prodname_github_apps %} are created with a set of permissions. Permissions define what resources the {% data variables.product.prodname_github_app %} can access via the API. For more information, see "Setting permissions for GitHub Apps."

Metadata

GitHub Apps have the Read-only metadata permission by default. The metadata permission provides access to a collection of read-only endpoints with metadata for various resources. These endpoints do not leak sensitive private repository information.

If you set the metadata permission to No access and select a permission that requires repository access, GitHub will override your selection and set the metadata permission back to Read-only. To set the metadata permission to No access, you must set all permissions that require repository access to No access first.

• GET /
• GET /codes_of_conduct
• GET /codes_of_conduct/:key
• GET /emojis
• GET /feeds
• GET /licenses
• GET /licenses/:key
• POST /markdown
• POST /markdown/raw
• GET /meta
• GET /organizations
• GET /orgs/:org
• GET /orgs/:org/projects
• GET /orgs/:org/repos
• GET /rate_limit
• GET /repos/:owner/:repo {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/community/profile {% endif -%}
• GET /repos/:owner/:repo/contributors
• GET /repos/:owner/:repo/forks
• GET /repos/:owner/:repo/languages
• GET /repos/:owner/:repo/license
• GET /repos/:owner/:repo/stargazers
• GET /repos/:owner/:repo/stats/code_frequency
• GET /repos/:owner/:repo/stats/commit_activity
• GET /repos/:owner/:repo/stats/contributors
• GET /repos/:owner/:repo/stats/participation
• GET /repos/:owner/:repo/stats/punch_card
• GET /repos/:owner/:repo/subscribers
• GET /repos/:owner/:repo/tags
• GET /repos/:owner/:repo/topics
• GET /repositories
• GET /user/repos
• GET /user/starred
• GET /user/subscriptions
• GET /users
• GET /users/:username
• GET /users/:username/followers
• GET /users/:username/following
• GET /users/:username/following/:target_user
• GET /users/:username/gpg_keys
• GET /users/:username/orgs
• GET /users/:username/received_events
• GET /users/:username/received_events/public
• GET /users/:username/repos
• GET /users/:username/subscriptions

Collaborators

• GET /repos/:owner/:repo/collaborators
• GET /repos/:owner/:repo/collaborators/:username

Commit comments

• GET /repos/:owner/:repo/comments
• GET /repos/:owner/:repo/comments/:comment_id
• GET /repos/:owner/:repo/comments/:comment_id/reactions
• GET /repos/:owner/:repo/commits/:sha/comments

Events

• GET /events
• GET /networks/:owner/:repo/events
• GET /orgs/:org/events
• GET /repos/:owner/:repo/events
• GET /repos/:owner/:repo/events/issues
• GET /users/:username/events
• GET /users/:username/events/public

Git

• GET /gitignore/templates
• GET /gitignore/templates/:key

Organization members

• GET /orgs/:org/members
• GET /orgs/:org/members/:username
• GET /orgs/:org/public_members
• GET /orgs/:org/public_members/:username

Search

• GET /search/code
• GET /search/commits
• GET /search/issues
• GET /search/labels
• GET /search/repositories
• GET /search/topics
• GET /search/users

SSH keys

• GET /users/:username/keys

{% ifversion fpt or ghes or ghec %}

Actions

• GET /repos/:owner/:repo/actions/artifacts (read)
• GET /repos/:owner/:repo/actions/artifacts/:artifact_id (read)
• DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id (write)
• GET /repos/:owner/:repo/actions/artifacts/:artifact_id/zip (read) {% ifversion actions-cache-management -%}
• GET /repos/:owner/:repo/actions/cache/usage (read) {% endif -%}
• GET /repos/:owner/:repo/actions/jobs/:job_id (read)
• GET /repos/:owner/:repo/actions/jobs/:job_id/logs (read)
• GET /repos/:owner/:repo/actions/runs (read)
• GET /repos/:owner/:repo/actions/runs/:run_id (read) {% ifversion fpt or ghec -%}
• POST /repos/:owner/:repo/actions/runs/:run_id/approve (write) {% endif -%}
• GET /repos/:owner/:repo/actions/runs/:run_id/artifacts (read)
• POST /repos/:owner/:repo/actions/runs/:run_id/cancel (write)
• GET /repos/:owner/:repo/actions/runs/:run_id/jobs (read)
• GET /repos/:owner/:repo/actions/runs/:run_id/logs (read)
• DELETE /repos/:owner/:repo/actions/runs/:run_id/logs (write)
• POST /repos/:owner/:repo/actions/runs/:run_id/rerun (write)
• GET /repos/:owner/:repo/actions/workflows (read)
• GET /repos/:owner/:repo/actions/workflows/:workflow_id (read)
• GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs (read) {% endif %}

Administration

• POST /orgs/:org/repos (write)
• PATCH /repos/:owner/:repo (write)
• DELETE /repos/:owner/:repo (write)
• GET /repos/:owner/:repo/actions/runners/downloads (read)
• GET /repos/:owner/:repo/actions/runners (read)
• GET /repos/:owner/:repo/actions/runners/:runner_id (read)
• DELETE /repos/:owner/:repo/actions/runners/:runner_id (write)
• GET /repos/:owner/:repo/actions/runners/:runner_id/labels (read)
• POST /repos/:owner/:repo/actions/runners/:runner_id/labels (write)
• PUT /repos/:owner/:repo/actions/runners/:runner_id/labels (write)
• DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels (write)
• DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels/:name (write) {% ifversion fpt or ghec or ghes -%}
• POST /repos/:owner/:repo/actions/runners/registration-token (write)
• POST /repos/:owner/:repo/actions/runners/remove-token (write) {% endif -%} {% ifversion fpt or ghec -%}
• PUT /repos/:owner/:repo/automated-security-fixes (write) {% endif -%} {% ifversion fpt or ghec -%}
• DELETE /repos/:owner/:repo/automated-security-fixes (write) {% endif -%}
• POST /repos/:owner/:repo/forks (write) {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/interaction-limits (read) {% endif -%} {% ifversion fpt or ghec -%}
• PUT /repos/:owner/:repo/interaction-limits (write) {% endif -%} {% ifversion fpt or ghec -%}
• DELETE /repos/:owner/:repo/interaction-limits (write) {% endif -%} {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/pages/health (write) {% endif -%} {% ifversion ghes > 3.3 -%}
• GET /repos/:owner/:repo/replicas/caches (read) {% endif -%}
• PUT /repos/:owner/:repo/topics (write)
• POST /repos/:owner/:repo/transfer (write) {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/vulnerability-alerts (read) {% endif -%} {% ifversion fpt or ghec -%}
• PUT /repos/:owner/:repo/vulnerability-alerts (write) {% endif -%} {% ifversion fpt or ghec -%}
• DELETE /repos/:owner/:repo/vulnerability-alerts (write) {% endif -%}
• PATCH /user/repository_invitations/:invitation_id (write)
• DELETE /user/repository_invitations/:invitation_id (write)

Branches

• GET /repos/:owner/:repo/branches/:branch/protection (read)
• PUT /repos/:owner/:repo/branches/:branch/protection (write)
• DELETE /repos/:owner/:repo/branches/:branch/protection (write)
• GET /repos/:owner/:repo/branches/:branch/protection/enforce_admins (read)
• POST /repos/:owner/:repo/branches/:branch/protection/enforce_admins (write)
• DELETE /repos/:owner/:repo/branches/:branch/protection/enforce_admins (write)
• GET /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews (read)
• PATCH /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews (write)
• DELETE /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews (write)
• GET /repos/:owner/:repo/branches/:branch/protection/required_signatures (read)
• POST /repos/:owner/:repo/branches/:branch/protection/required_signatures (write)
• DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures (write)
• GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks (read)
• PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks (write)
• DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks (write)
• GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts (read)
• POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts (write)
• PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts (write)
• DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts (write)
• GET /repos/:owner/:repo/branches/:branch/protection/restrictions (read)
• DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions (write)
• GET /repos/:owner/:repo/branches/:branch/protection/restrictions/teams (read)
• POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams (write)
• PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams (write)
• DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams (write)
• GET /repos/:owner/:repo/branches/:branch/protection/restrictions/users (read)
• POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users (write)
• PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users (write)
• DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users (write)
• POST /repos/:owner/:repo/branches/:branch/rename (write)

Collaborators

• PUT /repos/:owner/:repo/collaborators/:username (write)
• DELETE /repos/:owner/:repo/collaborators/:username (write)

Invitations

• GET /repos/:owner/:repo/invitations (read)
• PATCH /repos/:owner/:repo/invitations/:invitation_id (write)
• DELETE /repos/:owner/:repo/invitations/:invitation_id (write)

SSH keys

• GET /repos/:owner/:repo/keys (read)
• POST /repos/:owner/:repo/keys (write)
• GET /repos/:owner/:repo/keys/:key_id (read)
• DELETE /repos/:owner/:repo/keys/:key_id (write)

Teams

• GET /repos/:owner/:repo/teams (read)
• PUT /teams/:team_id/repos/:owner/:repo (write)
• DELETE /teams/:team_id/repos/:owner/:repo (write)

{% ifversion fpt or ghec %}

Traffic

• GET /repos/:owner/:repo/traffic/clones (read)
• GET /repos/:owner/:repo/traffic/popular/paths (read)
• GET /repos/:owner/:repo/traffic/popular/referrers (read)
• GET /repos/:owner/:repo/traffic/views (read) {% endif %}

{% ifversion fpt or ghec %}

Blocking users

• GET /user/blocks (read)
• GET /user/blocks/:username (read)
• PUT /user/blocks/:username (write)
• DELETE /user/blocks/:username (write) {% endif %}

Checks

• POST /repos/:owner/:repo/check-runs (write)
• GET /repos/:owner/:repo/check-runs/:check_run_id (read)
• PATCH /repos/:owner/:repo/check-runs/:check_run_id (write)
• GET /repos/:owner/:repo/check-runs/:check_run_id/annotations (read)
• POST /repos/:owner/:repo/check-suites (write)
• GET /repos/:owner/:repo/check-suites/:check_suite_id (read)
• GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs (read)
• POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest (write)
• PATCH /repos/:owner/:repo/check-suites/preferences (write)
• GET /repos/:owner/:repo/commits/:sha/check-runs (read)
• GET /repos/:owner/:repo/commits/:sha/check-suites (read)

Code scanning alerts

• GET /repos/:owner/:repo/code-scanning/alerts (read)
• GET /repos/:owner/:repo/code-scanning/alerts/:alert_number (read)
• PATCH /repos/:owner/:repo/code-scanning/alerts/:alert_number (write) {% ifversion fpt or ghec or ghes or ghae -%}
• GET /repos/:owner/:repo/code-scanning/alerts/:alert_number/instances (read) {% endif -%}
• GET /repos/:owner/:repo/code-scanning/analyses (read) {% ifversion fpt or ghec or ghes or ghae -%}
• GET /repos/:owner/:repo/code-scanning/analyses/:analysis_id (read) {% endif -%} {% ifversion fpt or ghec or ghes -%}
• DELETE /repos/:owner/:repo/code-scanning/analyses/:analysis_id (write) {% endif -%}
• POST /repos/:owner/:repo/code-scanning/sarifs (write) {% ifversion fpt or ghec or ghes or ghae -%}
• GET /repos/:owner/:repo/code-scanning/sarifs/:sarif_id (read) {% endif -%} {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 -%}
• GET /orgs/:org/code-scanning/alerts (read) {% endif -%}

{% ifversion fpt or ghec %}

Codespaces

• GET /repos/:owner/:repo/codespaces/machines {% endif %}

Commit statuses

• GET /repos/:owner/:repo/commits/:ref/status (read)
• GET /repos/:owner/:repo/commits/:ref/statuses (read)
• POST /repos/:owner/:repo/statuses/:sha (write)

Contents

• GET /repos/:owner/:repo/:archive_format/:ref (read) {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/actions/artifacts/:artifact_id (read) {% endif -%} {% ifversion fpt or ghec -%}
• DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id (write) {% endif -%} {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/actions/artifacts/:artifact_id/zip (read) {% endif -%} {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/actions/jobs/:job_id (read) {% endif -%} {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/actions/jobs/:job_id/logs (read) {% endif -%} {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/actions/runs (read) {% endif -%} {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/actions/runs/:run_id (read) {% endif -%} {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/actions/runs/:run_id/artifacts (read) {% endif -%} {% ifversion fpt -%}
• POST /repos/:owner/:repo/actions/runs/:run_id/cancel (write) {% endif -%} {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/actions/runs/:run_id/jobs (read) {% endif -%} {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/actions/runs/:run_id/logs (read) {% endif -%} {% ifversion fpt or ghec -%}
• DELETE /repos/:owner/:repo/actions/runs/:run_id/logs (write) {% endif -%} {% ifversion fpt -%}
• POST /repos/:owner/:repo/actions/runs/:run_id/rerun (write) {% endif -%} {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/actions/secrets (write) {% endif -%} {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/actions/secrets/:name (write) {% endif -%} {% ifversion fpt or ghec -%}
• PUT /repos/:owner/:repo/actions/secrets/:name (write) {% endif -%} {% ifversion fpt or ghec -%}
• DELETE /repos/:owner/:repo/actions/secrets/:name (write) {% endif -%} {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/actions/secrets/public-key (write) {% endif -%} {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/actions/workflows (read) {% endif -%} {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/actions/workflows/:workflow_id (read) {% endif -%} {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs (read) {% endif -%}
• GET /repos/:owner/:repo/check-runs/:check_run_id (read)
• GET /repos/:owner/:repo/check-runs/:check_run_id/annotations (read)
• GET /repos/:owner/:repo/check-suites/:check_suite_id (read)
• GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs (read)
• POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest (write) {% ifversion codeowners-errors %}
• GET /repos/:owner/:repo/codeowners/errors (read) {% endif %}
• GET /repos/:owner/:repo/commits (read)
• GET /repos/:owner/:repo/commits/:sha (read)
• GET /repos/:owner/:repo/commits/:sha/check-runs (read)
• GET /repos/:owner/:repo/commits/:sha/check-suites (read)
• GET /repos/:owner/:repo/community/code_of_conduct (read)
• GET /repos/:owner/:repo/compare/:base...:head (read)
• GET /repos/:owner/:repo/contents/:path (read)
• POST /repos/:owner/:repo/dispatches (write)
• POST /repos/:owner/:repo/forks (read)
• POST /repos/:owner/:repo/merges (write)
• PUT /repos/:owner/:repo/pulls/:pull_number/merge (write)
• GET /repos/:owner/:repo/readme(?:/(.*))? (read)

Branches

• GET /repos/:owner/:repo/branches (read)
• GET /repos/:owner/:repo/branches/:branch (read)
• GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps (write)
• POST /repos/:owner/:repo/branches/:branch/protection/restrictions/apps (write)
• PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/apps (write)
• DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/apps (write)
• POST /repos/:owner/:repo/branches/:branch/rename (write)

Commit comments

• PATCH /repos/:owner/:repo/comments/:comment_id (write)
• DELETE /repos/:owner/:repo/comments/:comment_id (write)
• POST /repos/:owner/:repo/comments/:comment_id/reactions (write)
• POST /repos/:owner/:repo/commits/:sha/comments (write)

Git

• POST /repos/:owner/:repo/git/blobs (write)
• GET /repos/:owner/:repo/git/blobs/:sha (read)
• POST /repos/:owner/:repo/git/commits (write)
• GET /repos/:owner/:repo/git/commits/:commit_id (read)
• POST /repos/:owner/:repo/git/refs (write)
• GET /repos/:owner/:repo/git/ref/:ref (read)
• GET /repos/:owner/:repo/git/matching-refs/:ref (read)
• PATCH /repos/:owner/:repo/git/refs/:ref (write)
• DELETE /repos/:owner/:repo/git/refs/:ref (write)
• POST /repos/:owner/:repo/git/tags (write)
• GET /repos/:owner/:repo/git/tags/:tag_id (read)
• POST /repos/:owner/:repo/git/trees (write)
• GET /repos/:owner/:repo/git/trees/:sha (read)

{% ifversion fpt or ghec %}

Import

• GET /repos/:owner/:repo/import (read)
• PUT /repos/:owner/:repo/import (write)
• PATCH /repos/:owner/:repo/import (write)
• DELETE /repos/:owner/:repo/import (write)
• GET /repos/:owner/:repo/import/authors (read)
• PATCH /repos/:owner/:repo/import/authors/:author_id (write)
• GET /repos/:owner/:repo/import/large_files (read)
• PATCH /repos/:owner/:repo/import/lfs (write) {% endif %}

Reactions

• DELETE /reactions/:reaction_id (write)
• DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id (write)
• DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id (write)
• DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id (write)
• DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id (write)
• DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id (write)
• DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id (write)

Releases

• GET /repos/:owner/:repo/releases (read)
• POST /repos/:owner/:repo/releases (write)
• GET /repos/:owner/:repo/releases/:release_id (read)
• PATCH /repos/:owner/:repo/releases/:release_id (write)
• DELETE /repos/:owner/:repo/releases/:release_id (write)
• GET /repos/:owner/:repo/releases/:release_id/assets (read)
• GET /repos/:owner/:repo/releases/assets/:asset_id (read)
• PATCH /repos/:owner/:repo/releases/assets/:asset_id (write)
• DELETE /repos/:owner/:repo/releases/assets/:asset_id (write)
• GET /repos/:owner/:repo/releases/latest (read)
• GET /repos/:owner/:repo/releases/tags/:tag (read)

{% ifversion dependabot-alerts-rest-api %}

Dependabot alerts

• GET /repos/:owner/:repo/dependabot/alerts (read)
• GET /repos/:owner/:repo/dependabot/alerts/:alert_number (read)
• PATCH /repos/:owner/:repo/dependabot/alerts/:alert_number (write) {% endif %}

{% ifversion fpt or ghec or ghes > 3.3%}

Dependabot secrets

• GET /repos/:owner/:repo/dependabot/secrets/public-key (read)
• GET /repos/:owner/:repo/dependabot/secrets (read)
• GET /repos/:owner/:repo/dependabot/secrets/:secret_name (read)
• PUT /repos/:owner/:repo/dependabot/secrets/:secret_name (write)
• DELETE /repos/:owner/:repo/dependabot/secrets/:secret_name (write)
• GET /orgs/:org/dependabot/secrets/public-key (read)
• GET /orgs/:org/dependabot/secrets (read)
• GET /orgs/:org/dependabot/secrets/:secret_name (read)
• PUT /orgs/:org/dependabot/secrets/:secret_name (write)
• GET /orgs/:org/dependabot/secrets/:secret_name/repositories (read)
• PUT /orgs/:org/dependabot/secrets/:secret_name/repositories (write)
• PUT /orgs/:org/dependabot/secrets/:secret_name/repositories/:repository_id (write)
• DELETE /orgs/:org/dependabot/secrets/:secret_name/repositories/:repository_id (write)
• DELETE /orgs/:org/dependabot/secrets/:secret_name (write) {% endif %}

Deployments

• GET /repos/:owner/:repo/deployments (read)
• POST /repos/:owner/:repo/deployments (write)
• GET /repos/:owner/:repo/deployments/:deployment_id (read)
• DELETE /repos/:owner/:repo/deployments/:deployment_id (write)
• GET /repos/:owner/:repo/deployments/:deployment_id/statuses (read)
• POST /repos/:owner/:repo/deployments/:deployment_id/statuses (write)
• GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id (read)

{% ifversion fpt or ghes or ghec %}

Email addresses

{% ifversion fpt or ghec -%}

• PATCH /user/email/visibility (write) {% endif -%}
• GET /user/emails (read)
• POST /user/emails (write)
• DELETE /user/emails (write)
• GET /user/public_emails (read) {% endif %}

Followers

• GET /user/followers (read)
• GET /user/following (read)
• GET /user/following/:username (read)
• PUT /user/following/:username (write)
• DELETE /user/following/:username (write)

Git SSH keys

• GET /user/keys (read)
• POST /user/keys (write)
• GET /user/keys/:key_id (read)
• DELETE /user/keys/:key_id (write)

GPG keys

• GET /user/gpg_keys (read)
• POST /user/gpg_keys (write)
• GET /user/gpg_keys/:gpg_key_id (read)
• DELETE /user/gpg_keys/:gpg_key_id (write)

{% ifversion fpt or ghec %}

Interaction limits

• GET /user/interaction-limits (read)
• PUT /user/interaction-limits (write)
• DELETE /user/interaction-limits (write) {% endif %}

Issues

Issues and pull requests are closely related. For more information, see "List issues assigned to the authenticated user." If your GitHub App has permissions on issues but not on pull requests, these endpoints will be limited to issues. Endpoints that return both issues and pull requests will be filtered. Endpoints that allow operations on both issues and pull requests will be restricted to issues.

• GET /repos/:owner/:repo/issues (read)
• POST /repos/:owner/:repo/issues (write)
• GET /repos/:owner/:repo/issues/:issue_number (read)
• PATCH /repos/:owner/:repo/issues/:issue_number (write)
• GET /repos/:owner/:repo/issues/:issue_number/comments (read)
• POST /repos/:owner/:repo/issues/:issue_number/comments (write)
• PUT /repos/:owner/:repo/issues/:issue_number/lock (write)
• DELETE /repos/:owner/:repo/issues/:issue_number/lock (write)
• GET /repos/:owner/:repo/issues/:issue_number/reactions (read)
• POST /repos/:owner/:repo/issues/:issue_number/reactions (write)
• GET /repos/:owner/:repo/issues/:issue_number/timeline (read)
• GET /repos/:owner/:repo/issues/comments (read)
• GET /repos/:owner/:repo/issues/comments/:comment_id (read)
• PATCH /repos/:owner/:repo/issues/comments/:comment_id (write)
• DELETE /repos/:owner/:repo/issues/comments/:comment_id (write)
• GET /repos/:owner/:repo/issues/comments/:comment_id/reactions (read)
• POST /repos/:owner/:repo/issues/comments/:comment_id/reactions (write)

Assignees

• GET /repos/:owner/:repo/assignees (read)
• GET /repos/:owner/:repo/assignees/:username (read)
• POST /repos/:owner/:repo/issues/:issue_number/assignees (write)
• DELETE /repos/:owner/:repo/issues/:issue_number/assignees (write)

Events

• GET /repos/:owner/:repo/issues/:issue_number/events (read)
• GET /repos/:owner/:repo/issues/events/:event_id (read)

Labels

• GET /repos/:owner/:repo/issues/:issue_number/labels (read)
• POST /repos/:owner/:repo/issues/:issue_number/labels (write)
• PUT /repos/:owner/:repo/issues/:issue_number/labels (write)
• DELETE /repos/:owner/:repo/issues/:issue_number/labels (write)
• DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name (write)
• GET /repos/:owner/:repo/labels (read)
• POST /repos/:owner/:repo/labels (write)
• GET /repos/:owner/:repo/labels/:name (read)
• PATCH /repos/:owner/:repo/labels/:name (write)
• DELETE /repos/:owner/:repo/labels/:name (write)

Milestones

• GET /repos/:owner/:repo/milestones (read)
• POST /repos/:owner/:repo/milestones (write)
• GET /repos/:owner/:repo/milestones/:milestone_number (read)
• PATCH /repos/:owner/:repo/milestones/:milestone_number (write)
• DELETE /repos/:owner/:repo/milestones/:milestone_number (write)
• GET /repos/:owner/:repo/milestones/:milestone_number/labels (read)

Reactions

• GET /repos/:owner/:repo/issues/comments/:comment_id/reactions (read)
• POST /repos/:owner/:repo/issues/comments/:comment_id/reactions (write)
• GET /repos/:owner/:repo/issues/:issue_number/reactions (read)
• POST /repos/:owner/:repo/issues/:issue_number/reactions (write)
• DELETE /reactions/:reaction_id (write)
• DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id (write)
• DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id (write)
• DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id (write)
• DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id (write)
• DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id (write)
• DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id (write)

Members

{% ifversion fpt or ghec -%}

• GET /organizations/:org_id/team/:team_id/team-sync/group-mappings (write) {% endif -%} {% ifversion fpt or ghec -%}
• PATCH /organizations/:org_id/team/:team_id/team-sync/group-mappings (write) {% endif -%}
• GET /orgs/:org/outside_collaborators (read)
• PUT /orgs/:org/outside_collaborators/:username (write)
• DELETE /orgs/:org/outside_collaborators/:username (write) {% ifversion fpt or ghec -%}
• GET /orgs/:org/team-sync/groups (write) {% endif -%}
• GET /orgs/:org/team/:team_id (read) {% ifversion fpt or ghec -%}
• GET /scim/v2/orgs/:org/Users (write) {% endif -%} {% ifversion fpt or ghec -%}
• POST /scim/v2/orgs/:org/Users (write) {% endif -%} {% ifversion fpt or ghec -%}
• GET /scim/v2/orgs/:org/Users/:external_identity_guid (write) {% endif -%} {% ifversion fpt or ghec -%}
• PUT /scim/v2/orgs/:org/Users/:external_identity_guid (write) {% endif -%} {% ifversion fpt or ghec -%}
• PATCH /scim/v2/orgs/:org/Users/:external_identity_guid (write) {% endif -%} {% ifversion fpt or ghec -%}
• DELETE /scim/v2/orgs/:org/Users/:external_identity_guid (write) {% endif %}

{% ifversion fpt or ghec %}

Invitations

• GET /orgs/:org/invitations (read)
• POST /orgs/:org/invitations (write)
• GET /orgs/:org/invitations/:invitation_id/teams (read)
• GET /teams/:team_id/invitations (read) {% endif %}

Organization members

• DELETE /orgs/:org/members/:username (write)
• GET /orgs/:org/memberships/:username (read)
• PUT /orgs/:org/memberships/:username (write)
• DELETE /orgs/:org/memberships/:username (write)
• PUT /orgs/:org/public_members/:username (write)
• DELETE /orgs/:org/public_members/:username (write)
• GET /user/memberships/orgs (read)
• GET /user/memberships/orgs/:org (read)
• PATCH /user/memberships/orgs/:org (write)

Team members

• GET /teams/:team_id/members (read)
• GET /teams/:team_id/memberships/:username (read)
• PUT /teams/:team_id/memberships/:username (write)
• DELETE /teams/:team_id/memberships/:username (write)

Teams

• GET /orgs/:org/teams (read)
• POST /orgs/:org/teams (write)
• GET /orgs/:org/teams/:team_slug (read)
• PATCH /teams/:team_id (write)
• DELETE /teams/:team_id (write)
• GET /teams/:team_id/projects (read)
• GET /teams/:team_id/projects/:project_id (read)
• PUT /teams/:team_id/projects/:project_id (read)
• DELETE /teams/:team_id/projects/:project_id (read)
• GET /teams/:team_id/repos (read)
• GET /teams/:team_id/repos/:owner/:repo (read)
• PUT /teams/:team_id/repos/:owner/:repo (read)
• DELETE /teams/:team_id/repos/:owner/:repo (write)
• GET /teams/:team_id/teams (read)

Organization administration

• PATCH /orgs/:org (write) {% ifversion actions-cache-management -%}
• GET /orgs/:org/actions/cache/usage (read)
• GET /orgs/:org/actions/cache/usage-by-repository (read) {% endif -%} {% ifversion fpt or ghec -%}
• GET /orgs/:org/interaction-limits (read) {% endif -%} {% ifversion fpt or ghec -%}
• PUT /orgs/:org/interaction-limits (write) {% endif -%} {% ifversion fpt or ghec -%}
• DELETE /orgs/:org/interaction-limits (write) {% endif %}

Organization events

• GET /users/:username/events/orgs/:org (read)

{% ifversion ghes %}

Organization pre-receive hooks

• GET /orgs/:org/pre-receive-hooks (read)
• GET /orgs/:org/pre-receive-hooks/:pre_receive_hook_id (read)
• PATCH /orgs/:org/pre-receive-hooks/:pre_receive_hook_id (write)
• DELETE /orgs/:org/pre-receive-hooks/:pre_receive_hook_id (write) {% endif %}

Organization projects

• POST /orgs/:org/projects (write)
• GET /projects/:project_id (read)
• PATCH /projects/:project_id (write)
• DELETE /projects/:project_id (write)
• POST /projects/:project_id/cards (write)
• GET /projects/:project_id/columns (read)
• POST /projects/:project_id/columns (write)
• GET /projects/columns/:column_id (read)
• PATCH /projects/columns/:column_id (write)
• DELETE /projects/columns/:column_id (write)
• GET /projects/columns/:column_id/cards (read)
• POST /projects/columns/:column_id/cards (write)
• POST /projects/columns/:column_id/moves (write)
• GET /projects/columns/cards/:card_id (read)
• PATCH /projects/columns/cards/:card_id (write)
• DELETE /projects/columns/cards/:card_id (write)
• POST /projects/columns/cards/:card_id/moves (write)

{% ifversion fpt or ghec %}

Organization user blocking

• GET /orgs/:org/blocks (read)
• GET /orgs/:org/blocks/:username (read)
• PUT /orgs/:org/blocks/:username (write)
• DELETE /orgs/:org/blocks/:username (write) {% endif %}

Organization webhooks

• GET /orgs/:org/hooks (read)
• POST /orgs/:org/hooks (write)
• GET /orgs/:org/hooks/:hook_id (read)
• PATCH /orgs/:org/hooks/:hook_id (write)
• DELETE /orgs/:org/hooks/:hook_id (write)
• POST /orgs/:org/hooks/:hook_id/pings (write)

Teams

• DELETE /teams/:team_id/projects/:project_id (read)

Pages

GitHub Pages can only be created or unpublished by a repository owner or administrator.

• GET /repos/:owner/:repo/pages (read)
• PUT /repos/:owner/:repo/pages (write)
• GET /repos/:owner/:repo/pages/builds (read)
• POST /repos/:owner/:repo/pages/builds (write)
• GET /repos/:owner/:repo/pages/builds/:build_id (read)
• GET /repos/:owner/:repo/pages/builds/latest (read) {% ifversion fpt or ghec -%}
• GET /repos/:owner/:repo/pages/health (write)
• POST /repos/:owner/:repo/pages/deployment (write) {% endif %}

Profile

• PATCH /user (write)

Pull requests

Pull requests and issues are closely related. If your GitHub App has permissions on pull requests but not on issues, these endpoints will be limited to pull requests. Endpoints that return both pull requests and issues will be filtered. Endpoints that allow operations on both pull requests and issues will be restricted to pull requests.

• PATCH /repos/:owner/:repo/issues/:issue_number (write)
• GET /repos/:owner/:repo/issues/:issue_number/comments (read)
• POST /repos/:owner/:repo/issues/:issue_number/comments (write)
• PUT /repos/:owner/:repo/issues/:issue_number/lock (write)
• DELETE /repos/:owner/:repo/issues/:issue_number/lock (write)
• GET /repos/:owner/:repo/issues/:issue_number/timeline (read)
• GET /repos/:owner/:repo/issues/comments (read)
• GET /repos/:owner/:repo/issues/comments/:comment_id (read)
• PATCH /repos/:owner/:repo/issues/comments/:comment_id (write)
• DELETE /repos/:owner/:repo/issues/comments/:comment_id (write)
• GET /repos/:owner/:repo/pulls (read)
• POST /repos/:owner/:repo/pulls (write)
• GET /repos/:owner/:repo/pulls/:pull_number (read)
• PATCH /repos/:owner/:repo/pulls/:pull_number (write)
• GET /repos/:owner/:repo/pulls/:pull_number/comments (read)
• POST /repos/:owner/:repo/pulls/:pull_number/comments (write)
• GET /repos/:owner/:repo/pulls/:pull_number/commits (read)
• GET /repos/:owner/:repo/pulls/:pull_number/files (read)
• GET /repos/:owner/:repo/pulls/:pull_number/merge (read)
• GET /repos/:owner/:repo/pulls/comments (read)
• GET /repos/:owner/:repo/pulls/comments/:comment_id (read)
• PATCH /repos/:owner/:repo/pulls/comments/:comment_id (write)
• DELETE /repos/:owner/:repo/pulls/comments/:comment_id (write)

Assignees

• GET /repos/:owner/:repo/assignees (read)
• GET /repos/:owner/:repo/assignees/:username (read)
• POST /repos/:owner/:repo/issues/:issue_number/assignees (write)
• DELETE /repos/:owner/:repo/issues/:issue_number/assignees (write)

Events

• GET /repos/:owner/:repo/issues/:issue_number/events (read)
• GET /repos/:owner/:repo/issues/events/:event_id (read)
• POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events (write)

Labels

• GET /repos/:owner/:repo/issues/:issue_number/labels (read)
• POST /repos/:owner/:repo/issues/:issue_number/labels (write)
• PUT /repos/:owner/:repo/issues/:issue_number/labels (write)
• DELETE /repos/:owner/:repo/issues/:issue_number/labels (write)
• DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name (write)
• GET /repos/:owner/:repo/labels (read)
• POST /repos/:owner/:repo/labels (write)
• GET /repos/:owner/:repo/labels/:name (read)
• PATCH /repos/:owner/:repo/labels/:name (write)
• DELETE /repos/:owner/:repo/labels/:name (write)

Milestones

• GET /repos/:owner/:repo/milestones (read)
• POST /repos/:owner/:repo/milestones (write)
• GET /repos/:owner/:repo/milestones/:milestone_number (read)
• PATCH /repos/:owner/:repo/milestones/:milestone_number (write)
• DELETE /repos/:owner/:repo/milestones/:milestone_number (write)
• GET /repos/:owner/:repo/milestones/:milestone_number/labels (read)

Reactions

• POST /repos/:owner/:repo/issues/:issue_number/reactions (write)
• GET /repos/:owner/:repo/issues/comments/:comment_id/reactions (read)
• POST /repos/:owner/:repo/issues/comments/:comment_id/reactions (write)
• GET /repos/:owner/:repo/pulls/comments/:comment_id/reactions (read)
• POST /repos/:owner/:repo/pulls/comments/:comment_id/reactions (write)
• DELETE /reactions/:reaction_id (write)
• DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id (write)
• DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id (write)
• DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id (write)
• DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id (write)
• DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id (write)
• DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id (write)

Requested reviewers

• GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers (read)
• POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers (write)
• DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers (write)

Reviews

• GET /repos/:owner/:repo/pulls/:pull_number/reviews (read)
• POST /repos/:owner/:repo/pulls/:pull_number/reviews (write)
• GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id (read)
• PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id (write)
• DELETE /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id (write)
• GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments (read)
• PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals (write)

{% ifversion ghes %}

Repository pre-receive hooks

• GET /repos/:owner/:repo/pre-receive-hooks (read)
• GET /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id (read)
• PATCH /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id (write)
• DELETE /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id (write) {% endif %}

Repository projects

• GET /projects/:project_id (read)
• PATCH /projects/:project_id (write)
• DELETE /projects/:project_id (write)
• POST /projects/:project_id/cards (write)
• GET /projects/:project_id/columns (read)
• POST /projects/:project_id/columns (write)
• GET /projects/columns/:column_id (read)
• PATCH /projects/columns/:column_id (write)
• DELETE /projects/columns/:column_id (write)
• GET /projects/columns/:column_id/cards (read)
• POST /projects/columns/:column_id/cards (write)
• POST /projects/columns/:column_id/moves (write)
• GET /projects/columns/cards/:card_id (read)
• PATCH /projects/columns/cards/:card_id (write)
• DELETE /projects/columns/cards/:card_id (write)
• POST /projects/columns/cards/:card_id/moves (write)
• GET /repos/:owner/:repo/projects (read)
• POST /repos/:owner/:repo/projects (write)

Teams

• DELETE /teams/:team_id/projects/:project_id (read)

Repository webhooks

• GET /repos/:owner/:repo/hooks (read)
• POST /repos/:owner/:repo/hooks (write)
• GET /repos/:owner/:repo/hooks/:hook_id (read)
• PATCH /repos/:owner/:repo/hooks/:hook_id (write)
• DELETE /repos/:owner/:repo/hooks/:hook_id (write)
• POST /repos/:owner/:repo/hooks/:hook_id/pings (read)
• POST /repos/:owner/:repo/hooks/:hook_id/tests (read)

{% ifversion fpt or ghec %}

Secrets

• GET /repos/:owner/:repo/actions/secrets/public-key (read)
• GET /repos/:owner/:repo/actions/secrets (read)
• GET /repos/:owner/:repo/actions/secrets/:secret_name (read)
• PUT /repos/:owner/:repo/actions/secrets/:secret_name (write)
• DELETE /repos/:owner/:repo/actions/secrets/:secret_name (write)
• GET /orgs/:org/actions/secrets/public-key (read)
• GET /orgs/:org/actions/secrets (read)
• GET /orgs/:org/actions/secrets/:secret_name (read)
• PUT /orgs/:org/actions/secrets/:secret_name (write)
• GET /orgs/:org/actions/secrets/:secret_name/repositories (read)
• PUT /orgs/:org/actions/secrets/:secret_name/repositories (write)
• PUT /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id (write)
• DELETE /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id (write)
• DELETE /orgs/:org/actions/secrets/:secret_name (write) {% endif %}

{% ifversion ghes or ghec %}

Secret scanning alerts

• GET /repos/:owner/:repo/secret-scanning/alerts (read)
• GET /repos/:owner/:repo/secret-scanning/alerts/:alert_number (read)
• PATCH /repos/:owner/:repo/secret-scanning/alerts/:alert_number (write)
• GET /repos/:owner/:repo/secret-scanning/alerts/:alert_number/locations (read) {% endif %}

{% ifversion fpt or ghes or ghec %}

Self-hosted runners

• GET /orgs/:org/actions/runners/downloads (read)
• POST /orgs/:org/actions/runners/registration-token (write)
• GET /orgs/:org/actions/runners (read)
• GET /orgs/:org/actions/runners/:runner_id (read)
• POST /orgs/:org/actions/runners/remove-token (write)
• DELETE /orgs/:org/actions/runners/:runner_id (write)
• GET /orgs/:org/actions/runners/:runner_id/labels (read)
• POST /orgs/:org/actions/runners/:runner_id/labels (write)
• PUT /orgs/:org/actions/runners/:runner_id/labels (write)
• DELETE /orgs/:org/actions/runners/:runner_id/labels (write)
• DELETE /orgs/:org/actions/runners/:runner_id/labels/:name (write) {% endif %}

Single file

• GET /repos/:owner/:repo/contents/:path (read)
• PUT /repos/:owner/:repo/contents/:path (write)
• DELETE /repos/:owner/:repo/contents/:path (write)

Starring

• GET /user/starred/:owner/:repo (read)
• PUT /user/starred/:owner/:repo (write)
• DELETE /user/starred/:owner/:repo (write)

Team discussions

• GET /teams/:team_id/discussions (read)
• POST /teams/:team_id/discussions (write)
• GET /teams/:team_id/discussions/:discussion_number (read)
• PATCH /teams/:team_id/discussions/:discussion_number (write)
• DELETE /teams/:team_id/discussions/:discussion_number (write)
• GET /teams/:team_id/discussions/:discussion_number/comments (read)
• POST /teams/:team_id/discussions/:discussion_number/comments (write)
• GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number (read)
• PATCH /teams/:team_id/discussions/:discussion_number/comments/:comment_number (write)
• DELETE /teams/:team_id/discussions/:discussion_number/comments/:comment_number (write)
• GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions (read)
• POST /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions (write)
• GET /teams/:team_id/discussions/:discussion_number/reactions (read)
• POST /teams/:team_id/discussions/:discussion_number/reactions (write)