← 返回首页

GitHub REST API documentation - GitHub Docs

Version: Free, Pro, & Team

REST API

API Version: 2026-03-10 (latest)

Actions
- Artifacts
- Cache
- Actions concurrency groups
- GitHub-hosted runners
- OIDC
- Permissions
- Secrets
- Self-hosted runner groups
- Self-hosted runners
- Variables
- Workflow jobs
- Workflow runs
- Workflows
Activity
- Events
- Feeds
- Notifications
- Starring
- Watching
Agent tasks
- Agent tasks
REST endpoints for agents
- Secrets
- Variables
Apps
- GitHub Apps
- Installations
- Marketplace
- OAuth authorizations
- Webhooks
Billing
- Budgets
- Billing usage
Branches
- Branches
- Protected branches
Campaigns
- Security campaigns
Checks
- Check runs
- Check suites
Classroom
- Classroom
Code scanning
- Code scanning
Code security settings
- Configurations
Codes of conduct
- Codes of conduct
Codespaces
- Codespaces
- Organizations
- Organization secrets
- Machines
- Repository secrets
- User secrets
Collaborators
- Collaborators
- Invitations
Commits
- Commits
- Commit comments
- Commit statuses
Copilot
- Cloud agent repository management
- Copilot cloud agent management
- Copilot content exclusion management
- Copilot metrics
- Copilot usage metrics
- Copilot user management
Copilot Spaces
- Collaborators
- Copilot Spaces
- Resources
Credentials
- Revocation
Dependabot
- Alerts
- Repository access
- Secrets
Dependency graph
- Dependency review
- Dependency submission
- Software bill of materials (SBOM)
Deploy keys
- Deploy keys
Deployments
- Deployment branch policies
- Deployments
- Environments
- Protection rules
- Deployment statuses
Emojis
- Emojis
Enterprise teams
- Enterprise team members
- Enterprise team organizations
- Enterprise teams
Gists
- Gists
- Comments
Git database
- Blobs
- Commits
- References
- Tags
- Trees
Gitignore
- Gitignore
Interactions
- Organization
- Repository
- User
Issues
- Assignees
- Comments
- Events
- Issue dependencies
- Issue field values
- Issues
- Labels
- Milestones
- Sub-issues
- Timeline
Licenses
- Licenses
Markdown
- Markdown
Meta
- Meta
Metrics
- Community
- Statistics
- Traffic
Migrations
- Organizations
- Source endpoints
- Users
Models
- Catalog
- Embeddings
- Inference
Organizations
- API Insights
- Artifact metadata
- Artifact attestations
- Blocking users
- Custom properties
- Issue fields
- Issue types
- Members
- Network configurations
- Organization roles
- Organizations
- Outside collaborators
- Personal access tokens
- Rule suites
- Rules
- Security managers
- Webhooks
Packages
- Packages
Pages
- Pages
Private registries
- Organization configurations
Projects
- Draft Project items
- Project fields
- Project items
- Projects
- Project views
Pull requests
- Pull requests
- Review comments
- Review requests
- Reviews
Rate limit
- Rate limit
Reactions
- Reactions
Releases
- Releases
- Release assets
Repositories
- Attestations
- Autolinks
- Contents
- Custom properties
- Forks
- Repositories
- Rule suites
- Rules
- Webhooks
Search
- Search
Secret scanning
- Push protection
- Secret scanning
Security advisories
- Global security advisories
- Repository security advisories
Teams
- Members
- Teams
Users
- Attestations
- Blocking users
- Emails
- Followers
- GPG keys
- Git SSH keys
- Social accounts
- SSH signing keys
- Users

The REST API is now versioned. For more information, see "About API versioning."

GitHub REST API documentation

Create integrations, retrieve data, and automate your workflows with the GitHub REST API.

Overview Quickstart

Recommended

Quickstart for GitHub REST API

Learn how to get started with the GitHub REST API.

Getting started with the REST API

Learn how to use the GitHub REST API.

Authenticating to the REST API

You can authenticate to the REST API to access more endpoints and have a higher rate limit.

Articles

All categories

Learn about the REST API

About the OpenAPI description for the REST API

The GitHub REST API is fully described in an OpenAPI compliant document.

Learn about the REST API

About the REST API

Get oriented to the REST API documentation.

Learn about the REST API

API Versions

Learn how to specify which REST API version to use whenever you make a request to the REST API.

Authenticate API requests

Authenticating to the REST API

You can authenticate to the REST API to access more endpoints and have a higher rate limit.

Learn about the REST API

Best practices for using the REST API

Follow these best practices when using GitHub's API.

Administer enterprises and billing

Billing usage

Use the REST API to get billing usage information.

Learn about the REST API

Breaking changes

Learn about breaking changes that were introduced in each REST API version.

Administer enterprises and billing

Budgets

Use the REST API to get budget information.

Build apps and integrations

Building a CI server

Build your own CI system using the Status API.

Showing 1-9 of 198

Help and support

Did you find what you needed?

Yes No

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Learn how to contribute

Still need help?

Ask the GitHub community

Contact support

Legal