Skip to main content
Manja / GitHub
Schema1.1.4object

deployment

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

Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Deployment

object

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

created_at string (date-time)
required

Example:2012-07-20T01:19:13Z

description string
requirednullable

Example:Deploy request from hubot

environment string
required

Name for the target deployment environment.

Example:production

id integer
required

Unique identifier of the deployment

Example:42

node_id string
required

Example:MDEwOkRlcGxveW1lbnQx

original_environment string
optional

Example:staging

payload
required
performed_via_github_app GitHub app object
optionalnullable

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.

production_environment boolean
optional

Specifies if the given environment is one that end-users directly interact with. Default: false.

Example:true

ref string
required

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

Example:topic-branch

repository_url string (uri)
required

Example:https://api.github.com/repos/octocat/example

sha string
required

Example:a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d

statuses_url string (uri)
required

Example:https://api.github.com/repos/octocat/example/deployments/1/statuses

task string
required

Parameter to specify a task to execute

Example:deploy

transient_environment boolean
optional

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

Example:true

updated_at string (date-time)
required

Example:2012-07-20T01:19:13Z

url string (uri)
required

Example:https://api.github.com/repos/octocat/example/deployments/1