API previews

Ref. https://docs.github.com/en/rest/overview/api-previews

You can use API previews to try out new features and provide feedback before these features become official.

In this article

• Migrations
• Enhanced deployments
• Reactions
• Timeline
• Integrations
• Projects
• Commit search
• Community profile metrics
• User blocking
• Repository topics
• Codes of conduct
• Add lock reason
• Require signed commits
• Require multiple approving reviews
• Check runs and check suites API
• Project card details
• GitHub App Manifests
• Deployment statuses
• Repository creation permissions
• Content attachments
• Interaction restrictions for repositories and organizations
• Enable and disable Pages
• List branches or pull requests for a commit
• Enable or disable vulnerability alerts for a repository
• Update a pull request branch
• Enable or disable automated security fixes
• Create and use repository templates
• New visibility parameter for the Repositories API

API previews let you try out new APIs and changes to existing API methods before they become part of the official GitHub API.

During the preview period, we may change some features based on developer feedback. If we do make changes, we'll announce them on the developer blog without advance notice.

To access an API preview, you'll need to provide a custom media type in the Accept header for your requests. Feature documentation for each preview specifies which custom media type to provide.

Migrations

Allows you to download repositories from your GitHub user or organization account to review, backup, and migrate data to GitHub Enterprise Server.

Custom media type: wyandotte-preview Announced: 2018-05-24

Enhanced deployments

Exercise greater control over deployments with more information and finer granularity.

Custom media type: ant-man-preview Announced: 2016-04-06

Reactions

Manage reactions for commits, issues, and comments.

Custom media type: squirrel-girl-preview Announced: 2016-05-12 Update: 2016-06-07

Timeline

Get a list of events for an issue or pull request.

Custom media type: mockingbird-preview Announced: 2016-05-23

Integrations

Manage integrations through the API.

Custom media type: machine-man-preview Announced: 2016-09-14

Projects

Manage projects.

Custom media type: inertia-preview Announced: 2016-09-14 Update: 2016-10-27

Commit search

Search commits.

Custom media type: cloak-preview Announced: 2017-01-05

Community profile metrics

Retrieve community profile metrics (also known as community health) for any public repository.

Custom media type: black-panther-preview Announced: 2017-02-09

User blocking

Users can block other users. Organizations can block users, too.

Custom media type: giant-sentry-fist-preview Announced: 2011-05-31 Update 1: 2016-04-04 Update 2: 2016-08-17

Repository topics

View a list of repository topics in calls that return repository results.

Custom media type: mercy-preview Announced: 2017-01-31

Codes of conduct

View all codes of conduct or get which code of conduct a repository has currently.

Custom media type: scarlet-witch-preview

Add lock reason

You can now add a reason when you lock an issue.

Custom media type: sailor-v-preview Announced: 2018-01-10

Require signed commits

You can now use the API to manage the setting for requiring signed commits on protected branches.

Custom media type: zzzax-preview Announced: 2018-02-22

Require multiple approving reviews

You can now require multiple approving reviews for a pull request using the API.

Custom media type: luke-cage-preview Announced: 2018-03-16

Check runs and check suites API

Allows a GitHub App to run external checks on a repository's code. See the Check runs and Check suites APIs for more details.

Custom media type: antiope-preview Announced: 2018-05-07

Project card details

The REST API responses for issue events and issue timeline events now return the project_card field for project-related events.

Custom media type: starfox-preview Announced: 2018-09-05

GitHub App Manifests

GitHub App Manifests allow people to create preconfigured GitHub Apps. See "Creating GitHub Apps from a manifest" for more details.

Custom media type: fury-preview

Deployment statuses

You can now update the environment of a deployment status and use the in_progress and queued states. When you create deployment statuses, you can now use the auto_inactive parameter to mark old production deployments as inactive.

Custom media type: flash-preview Announced: 2018-10-16

Repository creation permissions

You can now configure whether organization members can create repositories and which types of repositories they can create. See "Update an organization" for more details.

Custom media types: surtur-preview Announced: 2019-12-03

Content attachments

You can now provide more information in GitHub for URLs that link to registered domains by using the Content Attachments API. See "Using content attachments" for more details.

Custom media types: corsair-preview Announced: 2018-12-10

Interaction restrictions for repositories and organizations

Allows you to temporarily restrict interactions, such as commenting, opening issues, and creating pull requests, for GitHub repositories or organizations. When enabled, only the specified group of GitHub users will be able to participate in these interactions. See the Repository interactions and Organization interactions APIs for more details.

Custom media type: sombra-preview Announced: 2018-12-18

Enable and disable Pages

You can use the new endpoints in the Pages API to enable or disable Pages. To learn more about Pages, see "GitHub Pages Basics".

Custom media types: switcheroo-preview Announced: 2019-03-14

List branches or pull requests for a commit

You can use two new endpoints in the Commits API to list branches or pull requests for a commit.

Custom media types: groot-preview Announced: 2019-04-11

Enable or disable vulnerability alerts for a repository

You can use two new endpoints in the Repos API to enable or disable vulnerability alerts.

Custom media types: dorian-preview Announced: 2019-04-24

Update a pull request branch

You can use a new endpoint to update a pull request branch with changes from the HEAD of the upstream branch.

Custom media types: lydian-preview Announced: 2019-05-29

Enable or disable automated security fixes

You can use a new set of endpoints to enable and disable automated security fixes.

Custom media types: london-preview Announced: 2019-06-04

Create and use repository templates

You can use a new endpoint to Create a repository using a template and Create a repository for the authenticated user that is a template repository by setting the is_template parameter to true. Get a repository to check whether it's set as a template repository using the is_template key.

Custom media types: baptiste-preview Announced: 2019-07-05

New visibility parameter for the Repositories API

You can set and retrieve the visibility of a repository in the Repositories API.

Custom media types: nebula-preview Announced: 2019-11-25