Github Rest Api
Official documentation: https://docs.github.com/en/rest
Overview
This skill provides comprehensive documentation for github rest api.
Total references: 82 files (~372,555 tokens)
Topics covered: About source imports, apps, Add a field to an organization-owned project, List projects for organization, List requests to access organization resources with fine-grained personal access tokens, Retention of checks data, Get a repository README for a directory, About events, About Git database, Use conditional requests if appropriate, Remove teams from the Copilot subscription for an organization, Get the status of a GitHub Pages deployment...
Reference Files
Load only the reference files relevant to the user's question:
About The Rest Api
- About the OpenAPI description for the REST API and more (~2,503 tokens)
- Topics: About OpenAPI, About GitHubs OpenAPI description, Using the GitHub OpenAPI description
Actions
- REST API endpoints for GitHub Actions artifacts and more (~6,415 tokens)
- Topics: About artifacts in GitHub Actions, About the cache in GitHub Actions, List GitHub-hosted runners for an organization
Activity
- REST API endpoints for events and more (~1,807 tokens)
- Topics: About GitHub events, Get feeds, About GitHub notifications
Apps
- REST API endpoints for GitHub Apps and more (~639 tokens)
- Topics: About GitHub Apps, About GitHub App installations, About GitHub Marketplace
Authentication
- Authenticating to the REST API and more (~6,704 tokens)
- Topics: About authentication, Authenticating with a personal access token, Authenticating with a token generated by an app
- Endpoints available for GitHub App user access tokens and more (~4,212 tokens)
- Topics: actions, activity, apps
Billing
- Budgets and more (~1,833 tokens)
- Topics: Get all budgets for an organization, Get a budget by ID for an organization, Update a budget for an organization
Branches
- REST API endpoints for protected branches (~16,554 tokens)
- Topics: Get branch protection, Update branch protection, Delete branch protection
- REST API endpoints for branches (~2,633 tokens)
- Topics: List branches, Get a branch, Rename a branch
Campaigns
- REST API endpoints for security campaigns (~52 tokens)
Checks
- REST API endpoints for check runs and more (~250 tokens)
Classroom
- REST API endpoints for GitHub Classroom (~1,969 tokens)
- Topics: Get an assignment, List accepted assignments for an assignment, Get assignment grades
Code Scanning
- REST API endpoints for code scanning (~93 tokens)
- Topics: About code scanning
Code Security
- Configurations (~11,679 tokens)
- Topics: Get code security configurations for an enterprise, Create a code security configuration for an enterprise, Get default code security configurations for an enterprise
Codes Of Conduct
- REST API endpoints for codes of conduct (~1,025 tokens)
- Topics: Get all codes of conduct, Get a code of conduct
Codespaces
- REST API endpoints for Codespaces and more (~3,863 tokens)
- Topics: About GitHub Codespaces, About Codespaces machines, List organization secrets
Collaborators
- REST API endpoints for collaborators and more (~3,419 tokens)
- Topics: List repository collaborators, Check if a user is a repository collaborator, Add a repository collaborator
Commits
- REST API endpoints for commit comments and more (~6,965 tokens)
- Topics: About commit comments, List commits, List branches for HEAD commit
Copilot
- REST API endpoints for Copilot metrics and more (~4,166 tokens)
- Topics: Get Copilot seat information and settings for an organization, List all Copilot seat assignments for an organization, Add teams to the Copilot subscription for an organization
Credentials
- Revocation (~447 tokens)
- Topics: Revoke a list of credentials
Dependabot
- REST API endpoints for Dependabot alerts and more (~306 tokens)
- Topics: About Dependabot alerts, About Dependabot repository access, About Dependabot secrets
Dependency Graph
- REST API endpoints for dependency review and more (~930 tokens)
- Topics: About dependency review, About dependency submissions
Deploy Keys
- REST API endpoints for deploy keys (~351 tokens)
- Topics: About deploy keys
Deployments
- REST API endpoints for deployment branch policies and more (~4,621 tokens)
- Topics: About deployment branch policies, About deployments, About deployment environments
Emojis
- REST API endpoints for emojis (~5,073 tokens)
- Topics: Get emojis
Enterprise Teams
- REST API endpoints for enterprise team memberships and more (~521 tokens)
- Topics: About enterprise team members, About enterprise team organizations, About enterprise teams
General
- About the REST API and more (~7,580 tokens)
- Topics: About Git database
- GitHub REST API documentation and more (~6,526 tokens)
- Topics: Start here, Popular, Guides
- Quickstart for GitHub REST API and more (~5,536 tokens)
- Topics: Introduction, Using GitHub CLI in the command line, Using GitHub CLI in GitHub Actions
Gists
- REST API endpoints for gist comments and more (~391 tokens)
- Topics: About gist comments, About gists
Git
- REST API endpoints for Git blobs and more (~575 tokens)
- Topics: About Git blobs, About Git commits, About Git references
Gitignore
- REST API endpoints for gitignore (~85 tokens)
- Topics: About gitignore
Guides
- Best practices for using the REST API and more (~5,184 tokens)
- Topics: Avoid polling, Make authenticated requests, Avoid concurrent requests
- Getting started with the REST API (~6,614 tokens)
- Topics: Introduction, About requests to the REST API, Making a request
- Rendering data as graphs and more (~5,111 tokens)
- Topics: Setting up an OAuth app, Fetching repository information, Visualizing language counts
- Scripting with the REST API and Ruby and more (~7,715 tokens)
- Topics: About Octokitrb, Prerequisites, Instantiating and authenticating
Interactions
- REST API endpoints for organization interactions and more (~847 tokens)
- Topics: About organization interactions, About repository interactions, About user interactions
Issues
- REST API endpoints for issue assignees and more (~4,049 tokens)
- Topics: About issue and pull request assignees, About issue and pull request comments, About events
- REST API endpoints for issues (~9,102 tokens)
- Topics: List issues assigned to the authenticated user, List organization issues assigned to the authenticated user, List repository issues
- REST API endpoints for labels and more (~6,472 tokens)
- Topics: About labels, List milestones, Create a milestone
Licenses
- REST API endpoints for licenses (~426 tokens)
- Topics: About licenses
Markdown
- REST API endpoints for Markdown (~607 tokens)
- Topics: Render a Markdown document, Render a Markdown document in raw mode
Meta
- REST API endpoints for meta data (~1,300 tokens)
- Topics: GitHub API Root, Get GitHub meta information, Get Octocat
Metrics
- REST API endpoints for community metrics and more (~809 tokens)
- Topics: Get community profile metrics, About repository statistics, About repository traffic
Migrations
- REST API endpoints for organization migrations and more (~891 tokens)
- Topics: About organization migrations, About source imports, About user migrations
Models
- REST API endpoints for models catalog and more (~1,266 tokens)
- Topics: About GitHub Models catalog, Run an embedding request attributed to an organization, Run an embedding request
Orgs
- REST API endpoints for API Insights and more (~7,897 tokens)
- Topics: Get route stats by actor, Get subject stats, Get summary stats
- REST API endpoints for organization members (~7,187 tokens)
- Topics: List failed organization invitations, List pending organization invitations, Create an organization invitation
- REST API endpoints for network configurations and more (~5,952 tokens)
- Topics: List hosted compute network configurations for an organization, Create a hosted compute network configuration for an organization, Get a hosted compute network configuration for an organization
- REST API endpoints for organizations and more (~7,978 tokens)
- Topics: List organizations, Get an organization, Update an organization
- REST API endpoints for personal access tokens and more (~5,227 tokens)
- Topics: List requests to access organization resources with fine-grained personal access tokens, Review requests to access organization resources with fine-grained personal access tokens, Review a request to access organization resources with a fine-grained personal access token
- REST API endpoints for rules (~18,480 tokens)
- Topics: Get all organization repository rulesets, Create an organization repository ruleset, Get an organization repository ruleset
- REST API endpoints for security managers and more (~156 tokens)
- Topics: About security managers, About organization webhooks
Overview
- API Versions and more (~5,283 tokens)
- Topics: About API versioning, Specifying an API version, Upgrading to a new API version
- Getting started with the REST API and more (~7,126 tokens)
- Topics: Introduction, About requests to the REST API, Making a request
- Rate limits for the REST API and more (~7,750 tokens)
- Topics: About primary rate limits, About secondary rate limits, Checking the status of your rate limit
Packages
- REST API endpoints for packages (~263 tokens)
- Topics: About GitHub Packages
Pages
- REST API endpoints for GitHub Pages (~4,977 tokens)
- Topics: Get a GitHub Pages site, Create a GitHub Pages site, Update information about a GitHub Pages site
Private Registries
- Organization configurations (~2,549 tokens)
- Topics: List private registries for an organization, Create a private registry for an organization, Get private registries public key for an organization
Projects
- REST API endpoints for draft Project items and more (~4,134 tokens)
- Topics: Create draft item for organization owned project, Create draft item for user owned project, List project fields for organization
- REST API endpoints for Project items (~20,774 tokens)
- Topics: List items for an organization owned project, Add item to organization owned project, Get an item for an organization owned project
- REST API endpoints for Projects and more (~3,239 tokens)
- Topics: List projects for organization, Get project for organization, List projects for user
Pulls
- REST API endpoints for pull request review comments and more (~531 tokens)
- Topics: About pull request review comments, About pull requests, About review requests
Rate Limit
- REST API endpoints for rate limits (~444 tokens)
- Topics: About rate limits
Reactions
- REST API endpoints for reactions (~136 tokens)
- Topics: About reactions
Releases
- REST API endpoints for release assets and more (~2,207 tokens)
- Topics: Get a release asset, Update a release asset, Delete a release asset
Repos
- REST API endpoints for repository attestations and more (~7,944 tokens)
- Topics: Create an attestation, List attestations, About repository autolinks
- REST API endpoints for repositories (~21,914 tokens)
- Topics: List organization repositories, Create an organization repository, Get a repository
- REST API endpoints for rule suites (~1,002 tokens)
- Topics: List repository rule suites, Get a repository rule suite
- REST API endpoints for rules (~17,293 tokens)
- Topics: Get rules for a branch, Get all repository rulesets, Create a repository ruleset
- REST API endpoints for repository tags and more (~1,163 tokens)
- Topics: Closing down - List tag protection states for a repository, Closing down - Create a tag protection state for a repository, Closing down - Delete a tag protection state for a repository
Search
- REST API endpoints for search (~1,662 tokens)
- Topics: About search
Secret Scanning
- REST API endpoints for secret scanning push protection and more (~1,028 tokens)
- Topics: List organization pattern configurations, Update organization pattern configurations, About secret scanning
Security Advisories
- REST API endpoints for global security advisories (~1,576 tokens)
- Topics: List global security advisories, Get a global security advisory
- REST API endpoints for repository security advisories (~10,306 tokens)
- Topics: List repository security advisories for an organization, List repository security advisories, Create a repository security advisory
Teams
- REST API endpoints for team members and more (~322 tokens)
- Topics: About team members, About teams
Users
- REST API endpoints for artifact attestations and more (~5,807 tokens)
- Topics: List attestations by bulk subject digests, Delete attestations in bulk, Delete attestations by subject digest
Using The Rest Api
- Best practices for using the REST API and more (~7,689 tokens)
- Topics: Avoid polling, Make authenticated requests, Avoid concurrent requests
- GitHub event types (~3,282 tokens)
- Topics: Event object common properties, CommitCommentEvent, CreateEvent
- Issue event types (~11,021 tokens)
- Topics: Issue event object common properties, assigned, automatic_base_change_failed
- Libraries for the REST API and more (~6,536 tokens)
- Topics: About libraries, Official GitHub libraries, Third-party libraries
- Using pagination in the REST API (~1,604 tokens)
- Topics: About pagination, Usinglinkheaders, Changing the number of items per page
Usage Guidelines
- Identify relevant sections - Match the user's question to the appropriate reference file(s)
- Load minimally - Only read files directly relevant to the question to conserve context
- Cite sources - Reference specific sections when answering
- Combine knowledge - For complex questions, you may need multiple reference files
When to use each reference:
- About The Rest Api: About The Rest Api-related features and documentation
- Actions: Actions-related features and documentation
- Activity: Activity-related features and documentation
- Apps: Apps-related features and documentation
- Authentication: Authentication-related features and documentation
- Billing: Billing-related features and documentation
- Branches: Branches-related features and documentation
- Campaigns: Campaigns-related features and documentation
- Checks: Checks-related features and documentation
- Classroom: Classroom-related features and documentation
- Code Scanning: Code Scanning-related features and documentation
- Code Security: Code Security-related features and documentation
- Codes Of Conduct: Codes Of Conduct-related features and documentation
- Codespaces: Codespaces-related features and documentation
- Collaborators: Collaborators-related features and documentation
- Commits: Commits-related features and documentation
- Copilot: Copilot-related features and documentation
- Credentials: Credentials-related features and documentation
- Dependabot: Dependabot-related features and documentation
- Dependency Graph: Dependency Graph-related features and documentation
- Deploy Keys: Deploy Keys-related features and documentation
- Deployments: Deployments-related features and documentation
- Emojis: Emojis-related features and documentation
- Enterprise Teams: Enterprise Teams-related features and documentation
- General: General documentation, overview, and getting started
- Gists: Gists-related features and documentation
- Git: Git-related features and documentation
- Gitignore: Gitignore-related features and documentation
- Guides: Guides-related features and documentation
- Interactions: Interactions-related features and documentation
- Issues: Issues-related features and documentation
- Licenses: Licenses-related features and documentation
- Markdown: Markdown-related features and documentation
- Meta: Meta-related features and documentation
- Metrics: Metrics-related features and documentation
- Migrations: Migrations-related features and documentation
- Models: Models-related features and documentation
- Orgs: Orgs-related features and documentation
- Overview: Overview-related features and documentation
- Packages: Packages-related features and documentation
- Pages: Pages-related features and documentation
- Private Registries: Private Registries-related features and documentation
- Projects: Projects-related features and documentation
- Pulls: Pulls-related features and documentation
- Rate Limit: Rate Limit-related features and documentation
- Reactions: Reactions-related features and documentation
- Releases: Releases-related features and documentation
- Repos: Repos-related features and documentation
- Search: Search-related features and documentation
- Secret Scanning: Secret Scanning-related features and documentation
- Security Advisories: Security Advisories-related features and documentation
- Teams: Teams-related features and documentation
- Users: Users-related features and documentation
- Using The Rest Api: Using The Rest Api-related features and documentation