Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.
All products
REST API

This version of GitHub Enterprise was discontinued on 2023-03-15. 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. For help with the upgrade, contact GitHub Enterprise support.

OpenAPI description

In this article

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

About OpenAPI descriptions

OpenAPI is a standard specification for describing REST APIs. OpenAPI descriptions allow both humans and machines to discover the capabilities of an API without needing to first read documentation or understand the implementation. GitHub has made its REST API publicly available as an OpenAPI 3.0 compliant document.

Getting the GitHub OpenAPI description

You can find the description in the open source REST API OpenAPI Description repository.

We provide the description in two formats. The bundled version works for most cases, as it includes OpenAPI components for reuse and readability. If your tooling does not support inline references to components, we also provide a fully dereferenced version.

Using the GitHub OpenAPI description

There are many uses for an OpenAPI description. For example, you could:

  • Generate your own API client.
  • Validate and test a GitHub REST API integration.
  • Explore and interact with the GitHub Enterprise Server REST API using third-party tools, such as Insomnia or Postman.

For example, GitHub uses the REST OpenAPI description to generate the GitHub Enterprise Server REST API reference documentation.