GitHub v3 REST API
users
Copy Page
GitHub v3 REST API
meta
GitHub API Root
Get GitHub meta information
Get Octocat
Get all API versions
Get the Zen of GitHub
apps
Get the authenticated app
Create a GitHub App from a manifest
Get a webhook configuration for an app
Update a webhook configuration for an app
List deliveries for an app webhook
Get a delivery for an app webhook
Redeliver a delivery for an app webhook
List installations for the authenticated app
Delete an installation for the authenticated app
Get an installation for the authenticated app
Create an installation access token for an app
Revoke a grant for an application
Unsuspend an app installation
Suspend an app installation
Delete an app authorization
Delete an app token
Reset a token
Check a token
Revoke an authorization for an application
Create a scoped access token
Check an authorization
Reset an authorization
Get an app
List repositories accessible to the app installation
Create a content attachment
Revoke an installation access token
Get a subscription plan for an account
List plans
List accounts for a plan
Get a subscription plan for an account (stubbed)
List plans (stubbed)
List accounts for a plan (stubbed)
Get an organization installation for the authenticated app
Get a repository installation for the authenticated app
List app installations accessible to the user access token
List repositories accessible to the user access token
Remove a repository from an app installation
Add a repository to an app installation
List subscriptions for the authenticated user
List subscriptions for the authenticated user (stubbed)
Get a user installation for the authenticated app
oauth-authorizations
List your grants
Delete a grant
Get a single grant
List your authorizations
Create a new authorization
Get-or-create an authorization for a specific app
Get-or-create an authorization for a specific app and fingerprint
Delete an authorization
Get a single authorization
Update an existing authorization
codes-of-conduct
Get all codes of conduct
Get a code of conduct
Get the code of conduct for a repository
emojis
Get emojis
enterprise-admin
Get GitHub Actions permissions for an enterprise
Set GitHub Actions permissions for an enterprise
List selected organizations enabled for GitHub Actions in an enterprise
Set selected organizations enabled for GitHub Actions in an enterprise
Disable a selected organization for GitHub Actions in an enterprise
Enable a selected organization for GitHub Actions in an enterprise
Get allowed actions for an enterprise
Set allowed actions for an enterprise
List self-hosted runner groups for an enterprise
Create a self-hosted runner group for an enterprise
Delete a self-hosted runner group from an enterprise
Get a self-hosted runner group for an enterprise
Update a self-hosted runner group for an enterprise
List organization access to a self-hosted runner group in an enterprise
Set organization access for a self-hosted runner group in an enterprise
Remove organization access to a self-hosted runner group in an enterprise
Add organization access to a self-hosted runner group in an enterprise
List self-hosted runners in a group for an enterprise
Set self-hosted runners in a group for an enterprise
Remove a self-hosted runner from a group for an enterprise
Add a self-hosted runner to a group for an enterprise
List self-hosted runners for an enterprise
List runner applications for an enterprise
Create a registration token for an enterprise
Create a remove token for an enterprise
Delete a self-hosted runner from an enterprise
Get a self-hosted runner for an enterprise
List provisioned SCIM groups for an enterprise
Provision a SCIM enterprise group and invite users
Delete a SCIM group from an enterprise
Get SCIM provisioning information for an enterprise group
Update an attribute for a SCIM enterprise group
Set SCIM information for a provisioned enterprise group
List SCIM provisioned identities for an enterprise
Provision and invite a SCIM enterprise user
Delete a SCIM user from an enterprise
Get SCIM provisioning information for an enterprise user
Update an attribute for a SCIM enterprise user
Set SCIM information for a provisioned enterprise user
audit-log
Get the audit log for an enterprise
billing
Get GitHub Actions billing for an enterprise
Get GitHub Actions billing for an organization
Get GitHub Packages billing for an enterprise
Get GitHub Packages billing for an organization
Get shared storage billing for an enterprise
Get shared storage billing for an organization
Get GitHub Actions billing for a user
Get GitHub Packages billing for a user
Get shared storage billing for a user
activity
List public events
Get feeds
List public events for a network of repositories
List notifications for the authenticated user
Mark notifications as read
Get a thread
Mark a thread as read
Delete a thread subscription
Get a thread subscription for the authenticated user
Set a thread subscription
List public organization events
List repository events
List repository notifications for the authenticated user
Mark repository notifications as read
List stargazers
List watchers
Delete a repository subscription
Get a repository subscription
Set a repository subscription
List repositories starred by the authenticated user
Unstar a repository for the authenticated user
Check if a repository is starred by the authenticated user
Star a repository for the authenticated user
List repositories watched by the authenticated user
List events for the authenticated user
List organization events for the authenticated user
List public events for a user
List events received by the authenticated user
List public events received by a user
List repositories starred by a user
List repositories watched by a user
gists
List gists for the authenticated user
Create a gist
List public gists
List starred gists
Delete a gist
Get a gist
Update a gist
List gist comments
Create a gist comment
Delete a gist comment
Get a gist comment
Update a gist comment
List gist commits
List gist forks
Fork a gist
Unstar a gist
Check if a gist is starred
Star a gist
Get a gist revision
List gists for a user
gitignore
Get all gitignore templates
Get a gitignore template
issues
List issues assigned to the authenticated user
List organization issues assigned to the authenticated user
List assignees
Check if a user can be assigned
List repository issues
Create an issue
List issue comments for a repository
Delete an issue comment
Get an issue comment
Update an issue comment
List issue events for a repository
Get an issue event
Get an issue
Update an issue
Remove assignees from an issue
Add assignees to an issue
Check if a user can be assigned to a issue
List issue comments
Create an issue comment
List issue events
Remove all labels from an issue
List labels for an issue
Add labels to an issue
Set labels for an issue
Remove a label from an issue
Unlock an issue
Lock an issue
List timeline events for an issue
List labels for a repository
Create a label
Delete a label
Get a label
Update a label
List milestones
Create a milestone
Delete a milestone
Get a milestone
Update a milestone
List labels for issues in a milestone
List user account issues assigned to the authenticated user
licenses
Get all commonly used licenses
Get a license
Get the license for a repository
markdown
Render a Markdown document
Render a Markdown document in raw mode
orgs
List organizations
Get an organization
Update an organization
Get the audit log for an organization
List users blocked by an organization
Unblock a user from an organization
Check if a user is blocked by an organization
Block a user from an organization
List failed organization invitations
List SAML SSO authorizations for an organization
List organization webhooks
Remove a SAML SSO authorization for an organization
Create an organization webhook
Delete an organization webhook
Get an organization webhook
Update an organization webhook
Get a webhook configuration for an organization
Update a webhook configuration for an organization
List deliveries for an organization webhook
Get a webhook delivery for an organization webhook
Redeliver a delivery for an organization webhook
Ping an organization webhook
List app installations for an organization
List pending organization invitations
Create an organization invitation
Cancel an organization invitation
List organization invitation teams
List organization members
Remove an organization member
Check organization membership for a user
Remove organization membership for a user
Get organization membership for a user
Set organization membership for a user
List outside collaborators for an organization
Remove outside collaborator from an organization
Convert an organization member to outside collaborator
List public organization members
Remove public organization membership for the authenticated user
Check public organization membership for a user
Set public organization membership for the authenticated user
List security manager teams
Remove a security manager team
Add a security manager team
Enable or disable a security feature for an organization
List organization memberships for the authenticated user
Get an organization membership for the authenticated user
Update an organization membership for the authenticated user
List organizations for the authenticated user
List organizations for a user
actions
Get GitHub Actions cache usage for an organization
List repositories with GitHub Actions cache usage for an organization
Get GitHub Actions permissions for an organization
Set GitHub Actions permissions for an organization
List selected repositories enabled for GitHub Actions in an organization
Set selected repositories enabled for GitHub Actions in an organization
Disable a selected repository for GitHub Actions in an organization
Enable a selected repository for GitHub Actions in an organization
Get allowed actions and reusable workflows for an organization
List self-hosted runner groups for an organization
Set allowed actions and reusable workflows for an organization
Create a self-hosted runner group for an organization
Delete a self-hosted runner group from an organization
Get default workflow permissions for an organization
Get a self-hosted runner group for an organization
Set default workflow permissions for an organization
Update a self-hosted runner group for an organization
List required workflows
List repository access to a self-hosted runner group in an organization
Create a required workflow
Set repository access for a self-hosted runner group in an organization
Delete a required workflow
Remove repository access to a self-hosted runner group in an organization
Get a required workflow
Add repository access to a self-hosted runner group in an organization
Update a required workflow
List self-hosted runners in a group for an organization
List selected repositories for a required workflow
Set self-hosted runners in a group for an organization
Sets repositories for a required workflow
Remove a self-hosted runner from a group for an organization
Remove a selected repository from required workflow
Add a self-hosted runner to a group for an organization
Add a repository to a required workflow
List self-hosted runners for an organization
List runner applications for an organization
Create a registration token for an organization
Create a remove token for an organization
Delete a self-hosted runner from an organization
Get a self-hosted runner for an organization
Remove all custom labels from a self-hosted runner for an organization
List labels for a self-hosted runner for an organization
Add custom labels to a self-hosted runner for an organization
Set custom labels for a self-hosted runner for an organization
Remove a custom label from a self-hosted runner for an organization
List organization secrets
Get an organization public key
Delete an organization secret
Get an organization secret
Create or update an organization secret
List selected repositories for an organization secret
Set selected repositories for an organization secret
Remove selected repository from an organization secret
Add selected repository to an organization secret
List organization variables
Create an organization variable
Delete an organization variable
Get an organization variable
Update an organization variable
List selected repositories for an organization variable
Set selected repositories for an organization variable
Remove selected repository from an organization variable
Add selected repository to an organization variable
List repository required workflows
Get a required workflow entity for a repository
Get required workflow usage
List artifacts for a repository
Delete an artifact
Get an artifact
Download an artifact
Get GitHub Actions cache usage for a repository
Delete GitHub Actions caches for a repository (using a cache key)
List GitHub Actions caches for a repository
Delete a GitHub Actions cache for a repository (using a cache ID)
Get a job for a workflow run
Download job logs for a workflow run
Re-run a job from a workflow run
Get the customization template for an OIDC subject claim for a repository
Set the customization template for an OIDC subject claim for a repository
Get GitHub Actions permissions for a repository
Set GitHub Actions permissions for a repository
Get the level of access for workflows outside of the repository
Set the level of access for workflows outside of the repository
Get allowed actions and reusable workflows for a repository
Set allowed actions and reusable workflows for a repository
Get default workflow permissions for a repository
Set default workflow permissions for a repository
List workflow runs for a required workflow
List self-hosted runners for a repository
List runner applications for a repository
Create a registration token for a repository
Create a remove token for a repository
Delete a self-hosted runner from a repository
Get a self-hosted runner for a repository
Remove all custom labels from a self-hosted runner for a repository
List labels for a self-hosted runner for a repository
Add custom labels to a self-hosted runner for a repository
Set custom labels for a self-hosted runner for a repository
Remove a custom label from a self-hosted runner for a repository
List workflow runs for a repository
Delete a workflow run
Get a workflow run
Get the review history for a workflow run
Approve a workflow run for a fork pull request
List workflow run artifacts
Get a workflow run attempt
List jobs for a workflow run attempt
Download workflow run attempt logs
Cancel a workflow run
List jobs for a workflow run
Delete workflow run logs
Download workflow run logs
Get pending deployments for a workflow run
Review pending deployments for a workflow run
Re-run a workflow
Re-run failed jobs from a workflow run
Get workflow run usage
List repository secrets
Get a repository public key
Delete a repository secret
Get a repository secret
Create or update a repository secret
List repository variables
Create a repository variable
Delete a repository variable
Get a repository variable
Update a repository variable
List repository workflows
Get a workflow
Disable a workflow
Create a workflow dispatch event
Enable a workflow
List workflow runs for a workflow
Get workflow usage
List environment secrets
Get an environment public key
Delete an environment secret
Get an environment secret
Create or update an environment secret
List environment variables
Create an environment variable
Delete an environment variable
Get an environment variable
Update an environment variable
interactions
Remove interaction restrictions for an organization
Get interaction restrictions for an organization
Set interaction restrictions for an organization
Remove interaction restrictions for a repository
Get interaction restrictions for a repository
Set interaction restrictions for a repository
Remove interaction restrictions from your public repositories
Get interaction restrictions for your public repositories
Set interaction restrictions for your public repositories
migrations
List organization migrations
Start an organization migration
Get an organization migration status
Delete an organization migration archive
Download an organization migration archive
Unlock an organization repository
List repositories in an organization migration
Cancel an import
Get an import status
Update an import
Start an import
Get commit authors
Map a commit author
Get large files
Update Git LFS preference
List user migrations
Start a user migration
Get a user migration status
Delete a user migration archive
Download a user migration archive
Unlock a user repository
List repositories for a user migration
packages
List packages for an organization
Delete a package for an organization
Get a package for an organization
Restore a package for an organization
List package versions for a package owned by an organization
Delete package version for an organization
Get a package version for an organization
Restore package version for an organization
List packages for the authenticated user's namespace
Delete a package for the authenticated user
Get a package for the authenticated user
Restore a package for the authenticated user
List package versions for a package owned by the authenticated user
Delete a package version for the authenticated user
Get a package version for the authenticated user
Restore a package version for the authenticated user
List packages for a user
Delete a package for a user
Get a package for a user
Restore a package for a user
List package versions for a package owned by a user
Delete package version for a user
Get a package version for a user
Restore package version for a user
projects
List organization projects
Create an organization project
Delete a project card
Get a project card
Update an existing project card
Move a project card
Delete a project column
Get a project column
Update an existing project column
List project cards
Create a project card
Move a project column
Delete a project
Get a project
Update a project
List project collaborators
Remove user as a collaborator
Add project collaborator
Get project permission for a user
List project columns
Create a project column
List repository projects
Create a repository project
Create a user project
List user projects
repos
List organization repositories
Create an organization repository
Delete a repository
Get a repository
Update a repository
List all autolinks of a repository
Create an autolink reference for a repository
Delete an autolink reference from a repository
Get an autolink reference of a repository
Disable automated security fixes
Enable automated security fixes
List branches
Get a branch
Delete branch protection
Get branch protection
Update branch protection
Delete admin branch protection
Get admin branch protection
Set admin branch protection
Delete pull request review protection
Get pull request review protection
Update pull request review protection
Delete commit signature protection
Get commit signature protection
Create commit signature protection
Remove status check protection
Get status checks protection
Update status check protection
Remove status check contexts
Get all status check contexts
Add status check contexts
Set status check contexts
Delete access restrictions
Get access restrictions
Remove app access restrictions
Get apps with access to the protected branch
Add app access restrictions
Set app access restrictions
Remove team access restrictions
Get teams with access to the protected branch
Add team access restrictions
Set team access restrictions
Remove user access restrictions
Get users with access to the protected branch
Add user access restrictions
Set user access restrictions
Rename a branch
List CODEOWNERS errors
List repository collaborators
Remove a repository collaborator
Check if a user is a repository collaborator
Add a repository collaborator
Get repository permissions for a user
List commit comments for a repository
Delete a commit comment
Get a commit comment
Update a commit comment
List commits
List branches for HEAD commit
List commit comments
Create a commit comment
List pull requests associated with a commit
Compare two commits
Get a commit
Get the combined status for a specific reference
List commit statuses for a reference
Get community profile metrics
Compare two commits
Delete a file
Get repository content
Create or update file contents
List repository contributors
List deployments
Create a deployment
Delete a deployment
Get a deployment
List deployment statuses
Create a deployment status
Get a deployment status
Create a repository dispatch event
List environments
Delete an environment
Get an environment
Create or update an environment
List deployment branch policies
Create a deployment branch policy
Delete a deployment branch policy
Get a deployment branch policy
Update a deployment branch policy
List forks
Create a fork
List repository webhooks
Create a repository webhook
Delete a repository webhook
Get a repository webhook
Update a repository webhook
Get a webhook configuration for a repository
Update a webhook configuration for a repository
List deliveries for a repository webhook
Get a delivery for a repository webhook
Redeliver a delivery for a repository webhook
Ping a repository webhook
Test the push repository webhook
List repository invitations
Delete a repository invitation
Update a repository invitation
List deploy keys
Create a deploy key
Delete a deploy key
Get a deploy key
List repository languages
Disable Git LFS for a repository
Enable Git LFS for a repository
Sync a fork branch with the upstream repository
Merge a branch
Delete a GitHub Pages site
Get a GitHub Pages site
Create a GitHub Pages site
Update information about a GitHub Pages site
List GitHub Pages builds
Request a GitHub Pages build
Get latest Pages build
Get GitHub Pages build
Create a GitHub Pages deployment
Get a DNS health check for GitHub Pages
Get a repository README
Get a repository README for a directory
List releases
Create a release
Delete a release asset
Get a release asset
Update a release asset
Generate release notes content for a release
Get the latest release
Get a release by tag name
Delete a release
Get a release
Update a release
List release assets
Upload a release asset
Get the weekly commit activity
Get the last year of commit activity
Get all contributor commit activity
Get the weekly commit count
Get the hourly commit count for each day
Create a commit status
List repository tags
List tag protection states for a repository
Create a tag protection state for a repository
Delete a tag protection state for a repository
Download a repository archive (tar)
List repository teams
Get all repository topics
Replace all repository topics
Get repository clones
Get top referral paths
Get top referral sources
Get page views
Transfer a repository
Disable vulnerability alerts
Check if vulnerability alerts are enabled for a repository
Enable vulnerability alerts
Download a repository archive (zip)
Create a repository using a template
List public repositories
List repositories for the authenticated user
Create a repository for the authenticated user
List repository invitations for the authenticated user
Decline a repository invitation
Accept a repository invitation
List repositories for a user
teams
List IdP groups for an organization
List teams
Create a team
Delete a team
Get a team by name
Update a team
List discussions
Create a discussion
Delete a discussion
Get a discussion
Update a discussion
List discussion comments
Create a discussion comment
Delete a discussion comment
Get a discussion comment
Update a discussion comment
List pending team invitations
List team members
Remove team membership for a user
Get team membership for a user
Add or update team membership for a user
List team projects
Remove a project from a team
Check team permissions for a project
Add or update team project permissions
List team repositories
Remove a repository from a team
Check team permissions for a repository
Add or update team repository permissions
List child teams
List IdP groups for a team
Delete a team (Legacy)
Get a team (Legacy)
Create or update IdP group connections
Update a team (Legacy)
List discussions (Legacy)
Create a discussion (Legacy)
Delete a discussion (Legacy)
Get a discussion (Legacy)
Update a discussion (Legacy)
List discussion comments (Legacy)
Create a discussion comment (Legacy)
Delete a discussion comment (Legacy)
Get a discussion comment (Legacy)
Update a discussion comment (Legacy)
List pending team invitations (Legacy)
List team members (Legacy)
Remove team member (Legacy)
Get team member (Legacy)
Add team member (Legacy)
Remove team membership for a user (Legacy)
Get team membership for a user (Legacy)
Add or update team membership for a user (Legacy)
List team projects (Legacy)
Remove a project from a team (Legacy)
Check team permissions for a project (Legacy)
Add or update team project permissions (Legacy)
List team repositories (Legacy)
Remove a repository from a team (Legacy)
Check team permissions for a repository (Legacy)
Add or update team repository permissions (Legacy)
List child teams (Legacy)
List teams for the authenticated user
List IdP groups for a team (Legacy)
Create or update IdP group connections (Legacy)
reactions
List reactions for a team discussion comment
Create reaction for a team discussion comment
Delete team discussion comment reaction
List reactions for a team discussion
Create reaction for a team discussion
Delete team discussion reaction
Delete a reaction (Legacy)
List reactions for a commit comment
Create reaction for a commit comment
Delete a commit comment reaction
List reactions for an issue comment
Create reaction for an issue comment
Delete an issue comment reaction
List reactions for an issue
Create reaction for an issue
Delete an issue reaction
List reactions for a pull request review comment
Create reaction for a pull request review comment
Delete a pull request comment reaction
List reactions for a release
Create reaction for a release
Delete a release reaction
List reactions for a team discussion comment (Legacy)
Create reaction for a team discussion comment (Legacy)
List reactions for a team discussion (Legacy)
Create reaction for a team discussion (Legacy)
rate-limit
Get rate limit status for the authenticated user
checks
Create a check run
Get a check run
Update a check run
List check run annotations
Rerequest a check run
Create a check suite
Update repository preferences for check suites
Get a check suite
List check runs in a check suite
Rerequest a check suite
List check runs for a Git reference
List check suites for a Git reference
code-scanning
List code scanning alerts for an organization
List code scanning alerts for a repository
Get a code scanning alert
Update a code scanning alert
List instances of a code scanning alert
List code scanning analyses for a repository
Delete a code scanning analysis from a repository
Get a code scanning analysis for a repository
List CodeQL databases for a repository
Get a CodeQL database for a repository
Upload an analysis as SARIF data
Get information about a SARIF upload
git
Create a blob
Get a blob
Create a commit
Get a commit
List matching references
Get a reference
Create a reference
Delete a reference
Update a reference
Create a tag object
Get a tag
Create a tree
Get a tree
pulls
List pull requests
Create a pull request
List review comments in a repository
Delete a review comment for a pull request
Get a review comment for a pull request
Update a review comment for a pull request
Get a pull request
Update a pull request
List review comments on a pull request
Create a review comment for a pull request
Create a reply for a review comment
List commits on a pull request
List pull requests files
Check if a pull request has been merged
Merge a pull request
Remove requested reviewers from a pull request
Get all requested reviewers for a pull request
Request reviewers for a pull request
List reviews for a pull request
Create a review for a pull request
Delete a pending review for a pull request
Get a review for a pull request
Update a review for a pull request
List comments for a pull request review
Dismiss a review for a pull request
Submit a review for a pull request
Update a pull request branch
secret-scanning
List secret scanning alerts for an enterprise
List secret scanning alerts for an organization
List secret scanning alerts for a repository
Get a secret scanning alert
Update a secret scanning alert
List locations for a secret scanning alert
scim
List SCIM provisioned identities
Provision and invite a SCIM user
Delete a SCIM user from an organization
Get SCIM provisioning information for a user
Update an attribute for a SCIM user
Update a provisioned organization membership
search
Search code
Search commits
Search issues and pull requests
Search labels
Search repositories
Search topics
Search users
users
Get the authenticated user
GET
Update the authenticated user
PATCH
List users blocked by the authenticated user
GET
Unblock a user
DELETE
Check if a user is blocked by the authenticated user
GET
Block a user
PUT
Set primary email visibility for the authenticated user
PATCH
Delete an email address for the authenticated user
DELETE
List email addresses for the authenticated user
GET
Add an email address for the authenticated user
POST
List followers of the authenticated user
GET
List the people the authenticated user follows
GET
Unfollow a user
DELETE
Check if a person is followed by the authenticated user
GET
Follow a user
PUT
List GPG keys for the authenticated user
GET
Create a GPG key for the authenticated user
POST
Delete a GPG key for the authenticated user
DELETE
Get a GPG key for the authenticated user
GET
List public SSH keys for the authenticated user
GET
Create a public SSH key for the authenticated user
POST
Delete a public SSH key for the authenticated user
DELETE
Get a public SSH key for the authenticated user
GET
List public email addresses for the authenticated user
GET
List SSH signing keys for the authenticated user
GET
Create a SSH signing key for the authenticated user
POST
Delete an SSH signing key for the authenticated user
DELETE
Get an SSH signing key for the authenticated user
GET
List users
GET
Get a user
GET
List followers of a user
GET
List the people a user follows
GET
Check if a user follows another user
GET
List GPG keys for a user
GET
Get contextual information for a user
GET
List public keys for a user
GET
List SSH signing keys for a user
GET
dependabot
List Dependabot alerts for an enterprise
List Dependabot alerts for an organization
List organization secrets
Get an organization public key
Delete an organization secret
Get an organization secret
Create or update an organization secret
List selected repositories for an organization secret
Set selected repositories for an organization secret
Remove selected repository from an organization secret
Add selected repository to an organization secret
List Dependabot alerts for a repository
Get a Dependabot alert
Update a Dependabot alert
List repository secrets
Get a repository public key
Delete a repository secret
Get a repository secret
Create or update a repository secret
oidc
Get the customization template for an OIDC subject claim for an organization
Set the customization template for an OIDC subject claim for an organization
codespaces
List codespaces for the organization
Manage access control for organization codespaces
Removes users from Codespaces billing for an organization
Add users to Codespaces billing for an organization
List organization secrets
Get an organization public key
Delete an organization secret
Get an organization secret
Create or update an organization secret
List selected repositories for an organization secret
Set selected repositories for an organization secret
Remove selected repository from an organization secret
Add selected repository to an organization secret
List codespaces for a user in organization
Delete a codespace from the organization
Stop a codespace for an organization user
List codespaces in a repository for the authenticated user
Create a codespace in a repository
List devcontainer configurations in a repository for the authenticated user
List available machine types for a repository
Get default attributes for a codespace
List repository secrets
Get a repository public key
Delete a repository secret
Get a repository secret
Create or update a repository secret
Create a codespace from a pull request
List codespaces for the authenticated user
Create a codespace for the authenticated user
List secrets for the authenticated user
Get public key for the authenticated user
Delete a secret for the authenticated user
Get a secret for the authenticated user
Create or update a secret for the authenticated user
List selected repositories for a user secret
Set selected repositories for a user secret
Remove a selected repository from a user secret
Add a selected repository to a user secret
Delete a codespace for the authenticated user
Get a codespace for the authenticated user
Update a codespace for the authenticated user
Export a codespace for the authenticated user
Get details about a codespace export
List machine types for a codespace
Create a repository from an unpublished codespace
Start a codespace for the authenticated user
Stop a codespace for the authenticated user
dependency-graph
Get a diff of the dependencies between commits
Create a snapshot of dependencies for a repository
Schemas
Schemas
actions-billing-usage
actions-enabled
Repository actions caches
actions-enterprise-permissions
Actions Cache Usage by repository
actions-organization-permissions
actions-cache-usage-org-enterprise
ActionsPublicKey
actions-can-approve-pull-request-reviews
actions-repository-permissions
actions-default-workflow-permissions
Actions Secret
Actor
actions-get-default-workflow-permissions
alert-created-at
alert-html-url
ActionsPublicKey
alert-instances-url
alert-number
Actions Secret
alert-url
actions-set-default-workflow-permissions
allowed-actions
Actions Variable
Api Overview
actions-workflow-access-to-repository
App Permissions
Actor
Application Grant
Added to Project Issue Event
Artifact
audit-log-event
alert-dismissed-at
Authentication Token
alert-fixed-at
author_association
Authorization
Auto merge
Base Gist
alert-updated-at
Basic Error
Blob
Branch Protection
Api Overview
Branch Restriction Policy
App Permissions
Branch Short
Artifact
Branch With Protection
Assigned Issue Event
Check Annotation
Authentication Token
CheckRun
author_association
CheckSuite
Authorization
Check Suite Preference
Auto merge
Clone Traffic
Autolink reference
Code Frequency Stat
Base Gist
Code Of Conduct
Basic Error
Code Of Conduct Simple
Blob
code-scanning-alert
Branch Protection
code-scanning-alert-classification
Branch Restriction Policy
code-scanning-alert-dismissed-at
Branch Short
code-scanning-alert-dismissed-reason
Branch With Protection
code-scanning-alert-environment
Check Annotation
code-scanning-alert-instance
CheckRun
code-scanning-alert-items
CheckRun
code-scanning-alert-location
CheckSuite
code-scanning-alert-rule
Check Suite Preference
code-scanning-alert-rule-summary
Clone Traffic
code-scanning-alert-set-state
Code Frequency Stat
code-scanning-alert-state
Code Of Conduct
code-scanning-analysis
Code Of Conduct Simple
code-scanning-analysis-analysis-key
code-scanning-analysis-commit-sha
code-scanning-analysis-created-at
code-scanning-alert-dismissed-comment
Analysis deletion
code-scanning-analysis-environment
code-scanning-analysis-sarif-file
code-scanning-analysis-sarif-id
code-scanning-analysis-tool
code-scanning-analysis-tool-guid
code-scanning-analysis-tool-name
code-scanning-analysis-tool-version
code-scanning-analysis-url
code-scanning-alert-severity
code-scanning-ref
code-scanning-sarifs-receipt
code-scanning-sarifs-status
Code Search Result Item
code-scanning-analysis-category
Collaborator
combined-billing-usage
Combined Commit Status
Analysis deletion
Commit
Commit Activity
Commit Comment
Commit Comparison
Commit Search Result Item
Community Health File
Community Profile
Content Directory
Content File
CodeQL Database
ContentReferenceAttachment
code-scanning-organization-alert-items
Symlink Content
Symlink Content
Content Traffic
Content Tree
Code Search Result Item
Contributor
CODEOWNERS errors
Contributor Activity
Codespace
Credential Authorization
Fetches information about an export of a codespace.
Deploy Key
Codespace machine
Deployment
Codespace
deployment-reviewer-type
Codespaces Secret
Deployment
CodespacesPublicKey
Deployment Status
Codespaces Secret
deployment_branch_policy
CodespacesUserPublicKey
Diff Entry
Collaborator
Email
enabled-organizations
Combined Commit Status
enabled-repositories
Commit
Enterprise
Commit Activity
Environment
Commit Comment
Environment Approval
Commit Comparison
Event
Commit Search Result Item
Feed
Community Profile
File Commit
Content Directory
Full Repository
Content File
Gist Comment
Submodule Content
Gist Commit
Symlink Content
Gist Simple
Content Traffic
Git Commit
Content Tree
Git Reference
Contributor
Git Tag
Contributor Activity
Git Tree
Converted Note to Issue Issue Event
Git User
Demilestoned Issue Event
Gitignore Template
dependabot-alert
GPG Key
dependabot-alert-package
GroupMapping
dependabot-alert-security-advisory
Webhook
dependabot-alert-security-vulnerability
Hook Response
dependabot-alert-with-repository
Hovercard
DependabotPublicKey
Import
Dependabot Secret
Installation
dependency
Installation Token
Dependency Graph Diff
GitHub app
Deploy Key
interaction-expiry
Deployment
interaction-group
Deployment branch policy
Interaction Restrictions
Deployment branch policy name pattern
Interaction Limits
deployment-branch-policy-settings
Issue
Issue Comment
Deployment
Issue Event
Deployment Status
Issue Event Dismissed Review
Diff Entry
Issue Event for Issue
Discussion
Issue Event Label
Email
Issue Event Milestone
Empty Object
Issue Event Project Card
Issue Event Rename
Enterprise
Issue Search Result Item
Environment
Issue Simple
Environment Approval
Job
Event
Key
Feed
Key Simple
File Commit
Label
Full Repository
Label Search Result Item
Gist Comment
Language
Gist Commit
License
Gist History
License Content
Gist Simple
License Simple
Git Commit
Link
Git Reference
Link With Type
Git Tag
Marketplace Account
Git Tree
Marketplace Listing Plan
Gitignore Template
Marketplace Purchase
GPG Key
Migration
Webhook
Milestone
Webhook delivery
Minimal Repository
Simple webhook delivery
Org Hook
Hook Response
Org Membership
Hovercard
Actions Secret for an Organization
Import
Organization Full
Installation
Organization Invitation
Installation Token
Organization Simple
GitHub app
Package
Package Version
packages-billing-usage
Interaction Restrictions
GitHub Pages
Interaction Limits
Page Build
Issue
Page Build Status
Issue Comment
Pages Source Hash
Issue Event
Participation Stats
Issue Event Dismissed Review
Pending Deployment
Issue Event for Issue
Porter Author
Issue Event Label
Porter Large File
Issue Event Milestone
Private User
Issue Event Project Card
Project
Issue Event Rename
Project Card
Issue Search Result Item
Project Column
Job
Protected Branch
Key
Protected Branch Admin Enforced
Key Simple
Protected Branch Pull Request Review
Label
Public User
Label Search Result Item
Pull Request
Labeled Issue Event
Pull Request Merge Result
Language
Pull Request Minimal
License
Pull Request Review
License Content
Pull Request Review Comment
License Simple
Pull Request Review Request
Link
Pull Request Simple
Link With Type
Rate Limit
Locked Issue Event
Rate Limit Overview
manifest
Reaction
Marketplace Account
Reaction Rollup
Marketplace Listing Plan
Referrer Traffic
Marketplace Purchase
Release
Merged upstream
Release Asset
metadata
Repo Search Result Item
Migration
Repository
Milestone
Repository Collaborator Permission
Milestoned Issue Event
Repository Invitation
Minimal Repository
Repository Invitation
Moved Column in Project Issue Event
Legacy Review Comment
nullable-alert-updated-at
Self hosted runners
Code Of Conduct Simple
Runner Application
Codespace machine
runner-groups-enterprise
Collaborator
runner-groups-org
Community Health File
scim-enterprise-group
Git User
scim-enterprise-user
GitHub app
Scim Error
Issue
scim-group-list-enterprise
License Simple
SCIM /Users
Milestone
SCIM User List
Minimal Repository
scim-user-list-enterprise
Repository
Scoped Installation
Scoped Installation
Search Result Text Matches
Simple Commit
secret-scanning-alert
Simple User
secret-scanning-alert-resolution
Team Simple
secret-scanning-alert-state
Actions OIDC Subject customization
selected-actions
Actions OIDC subject customization for a repository
selected-actions-url
Org Hook
Short Blob
Org Membership
Short Branch
Actions Secret for an Organization
Simple Commit
Actions Variable for an Organization
Simple Commit Status
Dependabot Secret for an Organization
Simple User
Organization Full
Stargazer
Organization Invitation
Starred Repository
organization-secret-scanning-alert
Status
Organization Simple
Status Check Policy
Package
Tag
Package Version
Team
Team Discussion
GitHub Pages
Team Discussion Comment
Page Build
Full Team
Page Build Status
Team Membership
GitHub Pages
Team Project
Pages Health Check Status
Team Repository
Pages Https Certificate
Team Simple
Pages Source Hash
Thread
Participation Stats
Thread Subscription
Pending Deployment
Topic
Porter Author
Topic Search Result Item
Porter Large File
Traffic
Private User
User Marketplace Purchase
Project
User Search Result Item
Project Card
Validation Error
Project Collaborator Permission
Validation Error Simple
Project Column
Verification
Projects v2 Project
View Traffic
Projects v2 Item
wait-timer
Projects v2 Item Content Type
Webhook Configuration
Protected Branch
webhook-config-content-type
Protected Branch Admin Enforced
webhook-config-insecure-ssl
Protected Branch Pull Request Review
webhook-config-secret
Protected Branch Required Status Check
webhook-config-url
Public User
Workflow
Pull Request
Workflow Run
Pull Request Merge Result
Workflow Run Usage
Pull Request Minimal
Workflow Usage
Pull Request Review
Pull Request Review Comment
Pull Request Review Request
Pull Request Simple
Rate Limit
Rate Limit Overview
Reaction
Reaction Rollup
Referenced workflow
Referrer Traffic
Release
Release Asset
Generated Release Notes Content
Removed from Project Issue Event
Renamed Issue Event
Codespaces Secret
Required workflow
Repo Search Result Item
Repository
Repository Collaborator Permission
Repository Invitation
Repository Invitation
required-workflow
Legacy Review Comment
Review Dismissed Issue Event
Review Request Removed Issue Event
Review Requested Issue Event
root
Self hosted runners
Runner Application
Self hosted runner label
Scim Error
Search Result Text Matches
secret-scanning-alert-resolution-comment
secret-scanning-location
secret-scanning-location-commit
secret-scanning-location-issue-body
secret-scanning-location-issue-comment
secret-scanning-location-issue-title
security-and-analysis
Short Blob
Short Branch
simple-check-suite
Simple Commit
Simple Commit Status
Simple Installation
Simple Repository
Simple User
snapshot
SSH Signing Key
Stargazer
Starred Repository
State Change Issue Event
Status
Status Check Policy
Tag
Tag protection
Team
Team Discussion
Team Discussion Comment
Full Team
Team Membership
Team Organization
Team Project
Team Repository
Team Simple
Thread
Thread Subscription
Timeline Assigned Issue Event
Timeline Comment Event
Timeline Commit Commented Event
Timeline Committed Event
Timeline Cross Referenced Event
Timeline Event
Timeline Line Commented Event
Timeline Reviewed Event
Timeline Unassigned Issue Event
Topic
Topic Search Result Item
Traffic
Unassigned Issue Event
Unlabeled Issue Event
User Marketplace Purchase
User Search Result Item
Validation Error
Validation Error Simple
Verification
View Traffic
branch protection rule created event
branch protection rule deleted event
branch protection rule edited event
Check Run Completed Event
Check Run Completed Event
Check Run Created Event
Check Run Created Event
Check Run Requested Action Event
Check Run Requested Action Event
Check Run Re-Requested Event
Check Run Re-Requested Event
check_suite completed event
check_suite requested event
check_suite rerequested event
code_scanning_alert appeared_in_branch event
code_scanning_alert closed_by_user event
code_scanning_alert created event
code_scanning_alert fixed event
code_scanning_alert reopened event
code_scanning_alert reopened_by_user event
commit_comment created event
Webhook Configuration
create event
delete event
Dependabot alert created event
Dependabot alert dismissed event
Dependabot alert fixed event
Dependabot alert reintroduced event
Dependabot alert reopened event
deploy_key created event
deploy_key deleted event
deployment created event
deployment_status created event
discussion answered event
discussion category changed event
discussion_comment created event
discussion_comment deleted event
discussion_comment edited event
discussion created event
discussion deleted event
discussion edited event
discussion labeled event
discussion locked event
discussion pinned event
discussion transferred event
discussion unanswered event
discussion unlabeled event
discussion unlocked event
discussion unpinned event
fork event
github_app_authorization revoked event
gollum event
installation created event
installation deleted event
installation new_permissions_accepted event
installation_repositories added event
installation_repositories removed event
installation suspend event
webhook-installation-target-renamed
installation unsuspend event
issue_comment created event
issue_comment deleted event
issue_comment edited event
issues assigned event
issues closed event
issues deleted event
issues demilestoned event
issues edited event
issues labeled event
issues locked event
issues milestoned event
issues opened event
issues pinned event
issues reopened event
issues transferred event
issues unassigned event
issues unlabeled event
issues unlocked event
issues unpinned event
label created event
label deleted event
label edited event
marketplace_purchase cancelled event
marketplace_purchase changed event
marketplace_purchase pending_change event
marketplace_purchase pending_change_cancelled event
marketplace_purchase purchased event
member added event
member edited event
member removed event
membership added event
membership removed event
webhook-merge-group-checks-requested
meta deleted event
milestone closed event
milestone created event
milestone deleted event
milestone edited event
milestone opened event
org_block blocked event
org_block unblocked event
organization deleted event
organization member_added event
organization member_invited event
organization member_removed event
organization renamed event
package published event
package updated event
page_build event
webhook-ping
webhook-ping-form-encoded
project_card converted event
project_card created event
project_card deleted event
project_card edited event
project_card moved event
project closed event
project_column created event
project_column deleted event
project_column edited event
project_column moved event
project created event
project deleted event
project edited event
project reopened event
Projects v2 Item Archived Event
Projects v2 Item Converted Event
Projects v2 Item Created Event
Projects v2 Item Deleted Event
Projects v2 Item Edited Event
Projects v2 Item Reordered Event
Projects v2 Item Restored Event
Projects v2 Project Closed Event
webhook-projects-v2-project-created
Projects v2 Project Edited Event
Projects v2 Project Reopened Event
public event
pull_request assigned event
pull_request auto_merge_disabled event
pull_request auto_merge_enabled event
pull_request closed event
pull_request converted_to_draft event
pull_request demilestoned event
pull_request dequeued event
pull_request edited event
pull_request enqueued event
pull_request labeled event
pull_request locked event
pull_request milestoned event
pull_request opened event
pull_request ready_for_review event
pull_request reopened event
pull_request_review_comment created event
pull_request_review_comment deleted event
pull_request_review_comment edited event
pull_request_review dismissed event
pull_request_review edited event
pull_request_review submitted event
pull_request_review_thread resolved event
pull_request_review_thread unresolved event
pull_request synchronize event
pull_request unassigned event
pull_request unlabeled event
pull_request unlocked event
push event
webhook-registry-package-published
webhook-registry-package-updated
release created event
release deleted event
release edited event
release prereleased event
release published event
release released event
release unpublished event
repository archived event
repository created event
repository deleted event
repository_dispatch event
repository edited event
repository_import event
repository privatized event
repository publicized event
repository renamed event
repository transferred event
repository unarchived event
repository_vulnerability_alert create event
repository_vulnerability_alert dismiss event
repository_vulnerability_alert reopen event
repository_vulnerability_alert resolve event
secret_scanning_alert created event
Secret Scanning Alert Location Created Event
Secret Scanning Alert Location Created Event
secret_scanning_alert reopened event
secret_scanning_alert resolved event
secret_scanning_alert revoked event
security_advisory published event
security_advisory updated event
security_advisory withdrawn event
security_and_analysis event
sponsorship cancelled event
sponsorship created event
sponsorship edited event
sponsorship pending_cancellation event
sponsorship pending_tier_change event
sponsorship tier_changed event
star created event
star deleted event
status event
team_add event
team added_to_repository event
team created event
team deleted event
team edited event
team removed_from_repository event
watch started event
workflow_dispatch event
workflow_job completed event
workflow_job in_progress event
workflow_job queued event
workflow_job waiting event
workflow_run completed event
workflow_run in_progress event
workflow_run requested event
Workflow
Workflow Run
Workflow Run Usage
Workflow Usage
Response
bad_request
accepted
code_scanning_forbidden_read
actions_runner_labels
code_scanning_forbidden_write
actions_runner_labels_readonly
conflict
forbidden
forbidden_gist
gone
internal_error
not_found
preview_header_missing
requires_authentication
scim_bad_request
moved_permanently
scim_conflict
scim_forbidden
porter_maintenance
scim_internal_error
scim_not_found
service_unavailable
temporary_redirect
validation_failed
validation_failed_simple
users
MCP
Copy Page
Delete a public SSH key for the authenticated user
DELETE
/user/keys/{key_id}
Try it
Run in Apidog
Run in Apidog
Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least
admin:public_key
scope
.
Request
Path Params
Generate Code
Responses
🟢
204
Response
application/json
Generate Code
Body
Generate Code
🔵
304
304
ðŸŸ
401
401
ðŸŸ
403
403
ðŸŸ
404
404
Request
Request Example
Shell
JavaScript
Java
Swift
cURL
cURL-Windows
Httpie
wget
PowerShell
curl
--location
--request
DELETE
'https://api.github.com/user/keys/'
Response
Response Example
204 -
Example 1
{
}
Modified atÂ
2023-08-15 02:59:30
Previous
Create a public SSH key for the authenticated user
Next
Get a public SSH key for the authenticated user