REST API endpoints for deployments

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.12

Enterprise Server 3.13

Enterprise Server 3.9

Free, Pro, & Team

REST API

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Help us make these docs great!

Domain name

Who can use this feature?

Actions

Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.

Enter a search term to find it in the GitHub Docs.

REST API endpoints for deployments - GitHub Docs

Use the REST API to create and delete deploy keys, deployments, and deployment environments.

Quickstart

About the REST API

Comparing GitHub's APIs

API Versions

Breaking changes

OpenAPI description

Getting started

Rate limits

Pagination

Libraries

Best practices

Troubleshooting

Timezones

CORS and JSONP

Issue event types

GitHub event types

Using the REST API

Authenticating

Keeping API credentials secure

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Endpoints for fine-grained PATs

Permissions for GitHub Apps

Permissions for fine-grained PATs

Authentication

Script with JavaScript

Script with Ruby

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Building a CI server

Get started - Git database

Get started - Checks

Encrypt secrets

Guides

Artifacts

Cache

OIDC

Permissions

Secrets

Self-hosted runners

Variables

Workflow jobs

Workflow runs

Workflows

Events

Feeds

Notifications

Starring

Watching

Activity

GitHub Apps

Installations

Marketplace

OAuth authorizations

Webhooks

Apps

Billing

Branches

Protected branches

Check runs

Check suites

Checks

Classroom

Code scanning

Codes of conduct

Codespaces

Organizations

Organization secrets

Machines

Repository secrets

User secrets

Collaborators

Invitations

Commits

Commit comments

Commit statuses

Copilot usage

Copilot user management

Copilot

Alerts

Dependabot

Dependency review

Dependency submission

Software bill of materials (SBOM)

Dependency graph

Deploy keys

Deployment branch policies

Deployments

Environments

Protection rules

Deployment statuses

Emojis

Gists

Comments

Blobs

References

Trees

Git database

Gitignore

Organization

Repository

User

Interactions

Issues

Assignees

Labels

Milestones

Timeline

Licenses

Markdown

Community

Statistics

Traffic

Metrics

Source endpoints

Users

Migrations

Blocking users

Custom properties

Members

Organization roles

Outside collaborators

Personal access tokens

Rule suites

Rules

Security managers

Packages

Pages

Boards

Cards

Columns

Projects (classic)

Pull requests

Review comments

Review requests

Reviews

Rate limit

Reactions

Releases

Release assets

Autolinks

Forks

Repositories

Search

Secret scanning

Global security advisories

Repository security advisories

Security advisories

Teams

Discussion comments

Discussions

Emails

Followers

GPG keys

Git SSH keys

SSH signing keys

Social accounts

A request for a specific ref(branch,sha,tag) to be deployed

Deployment

Simple filtering of deployments is available via query parameters:

The account owner of the repository. The name is not case sensitive.

owner

The name of the repository without the <code>.git</code> extension. The name is not case sensitive.

repo

The SHA recorded at creation time.

The name of the ref. This can be a branch, tag, or SHA.

The name of the task for the deployment (e.g., <code>deploy</code> or <code>deploy:migrations</code>).

task

The name of the environment that was deployed to (e.g., <code>staging</code> or <code>production</code>).

environment

The number of results per page (max 100). For more information, see "<a href="https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api">Using pagination in the REST API</a>."

per_page

The page number of the results to fetch. For more information, see "<a href="https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api">Using pagination in the REST API</a>."

page

List deployments

The ref to deploy. This can be a branch, tag, or SHA.

Specifies a task to execute (e.g., <code>deploy</code> or <code>deploy:migrations</code>).

Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

auto_merge

Deployments offer a few configurable parameters with certain defaults.
The <code>ref</code> parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them
before we merge a pull request.
The <code>environment</code> parameter allows deployments to be issued to different runtime environments. Teams often have
multiple environments for verifying their applications, such as <code>production</code>, <code>staging</code>, and <code>qa</code>. This parameter
makes it easier to track which environments have requested deployments. The default environment is <code>production</code>.
The <code>auto_merge</code> parameter is used to ensure that the requested ref is not behind the repository's default branch. If
the ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,
the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will
return a failure response.
By default, <a href="https://docs.github.com/rest/commits/statuses">commit statuses</a> for every submitted context must be in a <code>success</code>
state. The <code>required_contexts</code> parameter allows you to specify a subset of contexts that must be <code>success</code>, or to
specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do
not require any contexts or create any commit statuses, the deployment will always succeed.
The <code>payload</code> parameter is available for any extra information that a deployment system might need. It is a JSON text
field that will be passed on when a deployment event is dispatched.
The <code>task</code> parameter is used by the deployment system to allow different execution paths. In the web world this might
be <code>deploy:migrations</code> to run schema changes on the system. In the compiled world this could be a flag to compile an
application with debugging enabled.
Merged branch response:
You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating
a deployment. This auto-merge happens when:
<ul>
<li>Auto-merge option is enabled in the repository</li>
<li>Topic branch does not include the latest changes on the base branch, which is <code>master</code> in the response example</li>
<li>There are no merge conflicts</li>
</ul>
If there are no new commits in the base branch, a new request to create a deployment should give a successful
response.
Merge conflict response:
This error happens when the <code>auto_merge</code> option is enabled and when the default branch (in this case <code>master</code>), can't
be merged into the branch that's being deployed (in this case <code>topic-branch</code>), due to merge conflicts.
Failed commit status checks:
This error happens when the <code>required_contexts</code> parameter indicates that one or more contexts need to have a <code>success</code>
status for the commit to be deployed, but one or more of the required contexts do not have a state of <code>success</code>.
OAuth app tokens and personal access tokens (classic) need the <code>repo</code> or <code>repo_deployment</code> scope to use this endpoint.

Create a deployment

用于部署的 REST API 端点