docs/content/rest/about-the-rest-api/about-the-rest-api.md at main · github/docs · GitHub
Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 2.66 KB

about-the-rest-api.md

File metadata and controls

47 lines (34 loc) · 2.66 KB
title About the REST API
shortTitle About the REST API
intro Get oriented to the REST API documentation.
versions
fpt ghes ghec
*
*
*
redirect_from
/rest/overview/about-the-rest-api
category
Learn about the REST API

You can use {% data variables.product.company_short %}'s API to build scripts and applications that automate processes, integrate with {% data variables.product.company_short %}, and extend {% data variables.product.company_short %}. For example, you could use the API to triage issues, build an analytics dashboard, or manage releases.

Each REST API endpoint is documented individually, and the endpoints are categorized by the resource that they primarily affect. For example, you can find endpoints relating to issues in AUTOTITLE.

Getting started with the REST API

If you are new to REST APIs, start with the Quickstart or Getting Started guide:

If you are familiar with REST APIs but new to {% data variables.product.company_short %}'s REST API, see the authentication documentation:

If you are building scripts or applications that use the REST API, the following guides can help:

For a list of libraries to facilitate scripting with the REST API, see AUTOTITLE.

If you are building scripts or applications that use the REST API, you might also be interested in using webhooks to get notified about events or a {% data variables.product.prodname_github_app %} to access resources on behalf of a user or in an organization. For more information, see AUTOTITLE and AUTOTITLE.

Further reading