Deployment
objectA request for a specific ref(branch,sha,tag) to be deployed
Example:https://api.github.com/repos/octocat/example/deployments/1
Unique identifier of the deployment
Example:42
Example:MDEwOkRlcGxveW1lbnQx
Example:a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d
The ref to deploy. This can be a branch, tag, or sha.
Example:topic-branch
Parameter to specify a task to execute
Example:deploy
One OfExample:staging
Name for the target deployment environment.
Example:production
Example:Deploy request from hubot
Simple User
Show Child Parameters
Example:2012-07-20T01:19:13Z
Example:2012-07-20T01:19:13Z
Example:https://api.github.com/repos/octocat/example/deployments/1/statuses
Example:https://api.github.com/repos/octocat/example
Specifies if the given environment is will no longer exist at some point in the future. Default: false.
Example:true
Specifies if the given environment is one that end-users directly interact with. Default: false.
Example:true
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.
Show Child Parameters
Deployment Status
objectThe status of a deployment.
Example:https://api.github.com/repos/octocat/example/deployments/42/statuses/1
Example:1
Example:MDE2OkRlcGxveW1lbnRTdGF0dXMx
The state of the status.
Allowed values:errorfailureinactivependingsuccessqueuedin_progress
Example:success
Simple User
Show Child Parameters
A short description of the status.
Default:
<= 140 characters
Example:Deployment finished successfully.
The environment of the deployment that the status is for.
Default:
Example:production
Deprecated: the URL to associate with this status.
Default:
Example:https://example.com/deployment/42/output
Example:2012-07-20T01:19:13Z
Example:2012-07-20T01:19:13Z
Example:https://api.github.com/repos/octocat/example/deployments/42
Example:https://api.github.com/repos/octocat/example
The URL for accessing your environment.
Default:
Example:https://staging.example.com/
The URL to associate with this status.
Default:
Example:https://example.com/deployment/42/output
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.
Show Child Parameters
Short Blob
objectShort Blob
Blob
objectBlob
Git Commit
objectLow-level Git commit operations within a repository
SHA for the commit
Example:7638417db6d59f3c431d3e1f261cc637155684cd
Identifying information for the git-user
Show Child Parameters
Identifying information for the git-user
Show Child Parameters
Message describing the purpose of the commit
Example:Fix #42