|Unique identifier of the deployment|
|Parameter to specify a task to execute|
|Name for the target deployment environment.|
|A GitHub user.|
|The ref to deploy. This can be a branch, tag, or sha.|
|GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.|
|Specifies if the given environment is one that end-users directly interact with. Default: false.|
|Specifies if the given environment is will no longer exist at some point in the future. Default: false.|
|Name||Accessible by||Required Params||Description|
|Simple filtering of deployments is available via query parameters:|
|Deployments offer a few configurable parameters with certain defaults.|
before we merge a pull request.
multiple environments for verifying their applications, such as
makes it easier to track which environments have requested deployments. The default environment is
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, commit statuses for every submitted context must be in a
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.
field that will be passed on when a deployment event is dispatched.
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:
Auto-merge option is enabled in the repository
Topic branch does not include the latest changes on the base branch, which is
* There are no merge conflicts
If there are no new commits in the base branch, a new request to create a deployment should give a successful
Merge conflict response:
This error happens when the
be merged into the branch that's being deployed (in this case
Failed commit status checks:
This error happens when the
status for the commit to be deployed, but one or more of the required contexts do not have a state of
|If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with |
To set a deployment as inactive, you must:
Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
Mark the active deployment as inactive by adding any non-successful deployment status.
For more information, see "Create a deployment" and "Create a deployment status."