This section of the documentation is intended to get you up-and-running with real-world GitHub Enterprise Server API applications. We'll go over everything you need to know, from authentication to results manipulation to integrating results with other apps. Every tutorial will include a project, and each project will be saved and documented in our public platform-samples repository.
This version of GitHub Enterprise Server was discontinued on 2024-07-09. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise Server. For help with the upgrade, contact GitHub Enterprise support.
Guides
Learn about getting started with the REST API, authentication, and how to use the REST API for a variety of tasks.
Scripting with the REST API and JavaScript
Write a script using the Octokit.js SDK to interact with the REST API.
Scripting with the REST API and Ruby
Learn how to write a script using the Octokit.rb SDK to interact with the REST API.
Discovering resources for a user
Learn how to find the repositories and organizations that your app can access for a user in a reliable way for your authenticated requests to the REST API.
Delivering deployments
Using the Deployments REST API, you can build custom tooling that interacts with your server and a third-party app.
Rendering data as graphs
Learn how to visualize the programming languages from your repository using the D3.js library and Ruby Octokit.
Working with comments
Using the REST API, you can access and manage comments in your pull requests, issues, or commits.
Building a CI server
Build your own CI system using the Status API.
Using the REST API to interact with your Git database
Use the REST API to read and write raw Git objects to your Git database on GitHub Enterprise Server and to list and update your references (branch heads and tags).
Using the REST API to interact with checks
You can use the REST API to build GitHub Apps that run powerful checks against code changes in a repository. You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits.
Encrypting secrets for the REST API
In order to create or update a secret with the REST API, you must encrypt the value of the secret.